Interface for objects that need to get values of MooseVariables. More...
#include <MooseVariableInterface.h>
Public Member Functions | |
MooseVariableInterface (const MooseObject *moose_object, bool nodal, std::string var_param_name="variable", Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) | |
Constructing the object. More... | |
MooseVariableBase * | mooseVariableBase () const |
Get the variable that this object is using. More... | |
MooseVariableField< T > & | mooseVariableField () |
Return the MooseVariableField object that this interface acts on. More... | |
MooseVariableFE< T > * | mooseVariable () const |
Return the MooseVariableFE object that this interface acts on. More... | |
MooseVariableFV< T > * | mooseVariableFV () const |
Return the MooseVariableFV object that this interface acts on. More... | |
MooseLinearVariableFV< T > * | mooseLinearVariableFV () const |
Return the MooseLinearVariableFV object that this interface acts on. More... | |
virtual | ~MooseVariableInterface () |
Protected Member Functions | |
virtual const OutputTools< T >::VariableValue & | value () |
The value of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | valueOld () |
The old value of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | valueOlder () |
The older value of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | dot () |
The time derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | dotDot () |
The second time derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | dotOld () |
The old time derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableValue & | dotDotOld () |
The old second time derivative of the variable this object is operating on. More... | |
virtual const VariableValue & | dotDu () |
The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients. More... | |
virtual const VariableValue & | dotDotDu () |
The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients. More... | |
virtual const OutputTools< T >::VariableGradient & | gradient () |
The gradient of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableGradient & | gradientOld () |
The old gradient of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableGradient & | gradientOlder () |
The older gradient of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableSecond & | second () |
The second derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableSecond & | secondOld () |
The old second derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableSecond & | secondOlder () |
The older second derivative of the variable this object is operating on. More... | |
virtual const OutputTools< T >::VariableTestSecond & | secondTest () |
The second derivative of the test function. More... | |
virtual const OutputTools< T >::VariableTestSecond & | secondTestFace () |
The second derivative of the test function on the current face. More... | |
virtual const OutputTools< T >::VariablePhiSecond & | secondPhi () |
The second derivative of the trial function. More... | |
virtual const OutputTools< T >::VariablePhiSecond & | secondPhiFace () |
The second derivative of the trial function on the current face. More... | |
Protected Attributes | |
bool | _nodal |
Whether or not this object is acting only at nodes. More... | |
MooseVariableBase * | _var = nullptr |
The variable this object is acting on. More... | |
MooseVariableFE< T > * | _variable = nullptr |
MooseVariableFV< T > * | _fv_variable = nullptr |
MooseLinearVariableFV< T > * | _linear_fv_variable = nullptr |
MooseVariableField< T > * | _field_variable = nullptr |
Assembly * | _mvi_assembly |
Private Attributes | |
const MooseObject & | _moose_object |
Interface for objects that need to get values of MooseVariables.
Definition at line 30 of file MooseVariableInterface.h.
MooseVariableInterface< T >::MooseVariableInterface | ( | const MooseObject * | moose_object, |
bool | nodal, | ||
std::string | var_param_name = "variable" , |
||
Moose::VarKindType | expected_var_type = Moose::VarKindType::VAR_ANY , |
||
Moose::VarFieldType | expected_var_field_type = Moose::VarFieldType::VAR_FIELD_ANY |
||
) |
Constructing the object.
parameters | Parameters that come from constructing the object |
nodal | true if the variable is nodal |
var_param_name | the parameter name where we will find the coupled variable name |
Definition at line 23 of file MooseVariableInterface.C.
|
virtual |
Definition at line 51 of file MooseVariableInterface.C.
|
protectedvirtual |
The time derivative of the variable this object is operating on.
Definition at line 148 of file MooseVariableInterface.C.
|
protectedvirtual |
The second time derivative of the variable this object is operating on.
Definition at line 158 of file MooseVariableInterface.C.
|
protectedvirtual |
The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.
This is useful for creating Jacobian entries for residual statements that use _u_dotdot
Definition at line 238 of file MooseVariableInterface.C.
|
protectedvirtual |
The old second time derivative of the variable this object is operating on.
Definition at line 178 of file MooseVariableInterface.C.
|
protectedvirtual |
The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.
This is useful for creating Jacobian entries for residual statements that use _u_dot
Definition at line 228 of file MooseVariableInterface.C.
|
protectedvirtual |
The old time derivative of the variable this object is operating on.
Definition at line 168 of file MooseVariableInterface.C.
|
protectedvirtual |
The gradient of the variable this object is operating on.
This is computed by default and should already be available as _grad_u
Definition at line 248 of file MooseVariableInterface.C.
|
protectedvirtual |
The old gradient of the variable this object is operating on.
Definition at line 258 of file MooseVariableInterface.C.
|
protectedvirtual |
The older gradient of the variable this object is operating on.
Definition at line 268 of file MooseVariableInterface.C.
MooseLinearVariableFV< T > * MooseVariableInterface< T >::mooseLinearVariableFV | ( | ) | const |
Return the MooseLinearVariableFV
object that this interface acts on.
Definition at line 68 of file MooseVariableInterface.C.
MooseVariableFE< T > * MooseVariableInterface< T >::mooseVariable | ( | ) | const |
Return the MooseVariableFE
object that this interface acts on.
Definition at line 78 of file MooseVariableInterface.C.
Referenced by ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), and InterfaceKernelTempl< T >::InterfaceKernelTempl().
|
inline |
Get the variable that this object is using.
Definition at line 50 of file MooseVariableInterface.h.
MooseVariableField< T > & MooseVariableInterface< T >::mooseVariableField | ( | ) |
Return the MooseVariableField
object that this interface acts on.
Definition at line 354 of file MooseVariableInterface.C.
Referenced by DiracKernelTempl< T >::DiracKernelTempl().
MooseVariableFV< T > * MooseVariableInterface< T >::mooseVariableFV | ( | ) | const |
Return the MooseVariableFV
object that this interface acts on.
Definition at line 57 of file MooseVariableInterface.C.
|
protectedvirtual |
The second derivative of the variable this object is operating on.
Definition at line 278 of file MooseVariableInterface.C.
Referenced by MooseLinearVariableFV< Real >::getBoundaryCondition(), and MooseVariableFV< Real >::getDirichletBoundaryFaceValue().
|
protectedvirtual |
The old second derivative of the variable this object is operating on.
Definition at line 288 of file MooseVariableInterface.C.
|
protectedvirtual |
The older second derivative of the variable this object is operating on.
Definition at line 298 of file MooseVariableInterface.C.
|
protectedvirtual |
The second derivative of the trial function.
Definition at line 328 of file MooseVariableInterface.C.
|
protectedvirtual |
The second derivative of the trial function on the current face.
This should be called in e.g. IntegratedBC when you need second derivatives of the trial function function on the boundary.
Definition at line 341 of file MooseVariableInterface.C.
|
protectedvirtual |
The second derivative of the test function.
Definition at line 308 of file MooseVariableInterface.C.
|
protectedvirtual |
The second derivative of the test function on the current face.
This should be called in e.g. IntegratedBC when you need second derivatives of the test function function on the boundary.
Definition at line 318 of file MooseVariableInterface.C.
|
protectedvirtual |
The value of the variable this object is operating on.
This is computed by default and should already be available as _u
Definition at line 88 of file MooseVariableInterface.C.
Referenced by ReporterPointSource::fillPoint().
|
protectedvirtual |
The old value of the variable this object is operating on.
Definition at line 108 of file MooseVariableInterface.C.
|
protectedvirtual |
The older value of the variable this object is operating on.
Definition at line 128 of file MooseVariableInterface.C.
|
protected |
Definition at line 230 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().
|
protected |
Definition at line 228 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().
|
protected |
Definition at line 229 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().
|
private |
Definition at line 236 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().
|
protected |
Definition at line 233 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().
|
protected |
Whether or not this object is acting only at nodes.
Definition at line 223 of file MooseVariableInterface.h.
|
protected |
The variable this object is acting on.
Definition at line 226 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::mooseVariableBase(), and MooseVariableInterface< Real >::MooseVariableInterface().
|
protected |
Definition at line 227 of file MooseVariableInterface.h.
Referenced by MooseVariableInterface< Real >::MooseVariableInterface().