MooseVariableLinearFVReal

Overview

This variable is used for finite volume simulations where a linear system is solved with the following form:

var element = document.getElementById("moose-equation-7a712c82-6e9e-4aac-be65-c31741eca510");katex.render("A\\vec{x} = \\vec{b}~,", element, {displayMode:true,throwOnError:false});

where $var element = document.getElementById("moose-equation-c72dcfc4-c0ac-4d90-8344-5e020c1235a8");katex.render("\\vec{x}", element, {displayMode:false,throwOnError:false});$ is the vector containing the degrees of freedom for the declared variable, while $var element = document.getElementById("moose-equation-7043a0bc-5270-40b3-b866-3d3a91c0dbb5");katex.render("A", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-2668051c-7298-44ef-9a62-f83ba489d15a");katex.render("\\vec{b}", element, {displayMode:false,throwOnError:false});$ are the corresponding system matrix and right hand side, respectively.

note

This variable can only be used with linear systems and cannot be used for systems which need Jacobian and residual evaluations, such as nonlinear systems being solved by Newton or quasi-Newton methods.

Similarly to MooseVariableFVReal, this variable describes a field which has been discretized using the cell-centered finite volume method and can be evaluated using the functor system in MOOSE.

Example Input File Syntax

To create a MooseLinearVariableFVReal, users can do the following in their input files:


[Variables]
  [v]
    type = MooseLinearVariableFVReal
  []
[]

Note that unlike the case of finite element variables, the user needs to explicitly define the type of the variable.

Input Parameters

arrayFalseTrue to make this variable a array variable regardless of number of components. If 'components' > 1, this will automatically be set to true.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:True to make this variable a array variable regardless of number of components. If 'components' > 1, this will automatically be set to true.
blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
components1Number of components for an array variable
Default:1
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of components for an array variable
familyMONOMIALSpecifies the family of FE shape functions to use for this variable.
Default:MONOMIAL
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable.
fvTrueTrue to make this variable a finite volume variable
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:True to make this variable a finite volume variable
orderCONSTANTOrder of the FE shape function to use for this variable (additional orders not listed here are allowed, depending on the family).
Default:CONSTANT
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH, FIFTH, SIXTH, SEVENTH, EIGHTH, NINTH, TENTH, ELEVENTH, TWELFTH, THIRTEENTH, FOURTEENTH, FIFTEENTH, SIXTEENTH, SEVENTEENTH, EIGHTTEENTH, NINETEENTH, TWENTIETH, TWENTYFIRST, TWENTYSECOND, TWENTYTHIRD, TWENTYFOURTH, TWENTYFIFTH, TWENTYSIXTH, TWENTYSEVENTH, TWENTYEIGHTH, TWENTYNINTH, THIRTIETH, THIRTYFIRST, THIRTYSECOND, THIRTYTHIRD, THIRTYFOURTH, THIRTYFIFTH, THIRTYSIXTH, THIRTYSEVENTH, THIRTYEIGHTH, THIRTYNINTH, FORTIETH, FORTYFIRST, FORTYSECOND, FORTYTHIRD
Controllable:No
Description:Order of the FE shape function to use for this variable (additional orders not listed here are allowed, depending on the family).
solver_sysnl0If this variable is a solver variable, this is the solver system to which it should be added.
Default:nl0
C++ Type:SolverSystemName
Unit:(no unit assumed)
Controllable:No
Description:If this variable is a solver variable, this is the solver system to which it should be added.
use_dualFalseTrue to use dual basis for Lagrange multipliers
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:True to use dual basis for Lagrange multipliers

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
eigenFalseTrue to make this variable an eigen variable
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:True to make this variable an eigen variable
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
scalingSpecifies a scaling factor to apply to this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable

Advanced Parameters

Overview
Example Input File Syntax
Input Parameters