https://mooseframework.inl.gov
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NeighborMooseVariableInterface< T > Class Template Reference

Enhances MooseVariableInterface interface provide values from neighbor elements. More...

#include <NeighborMooseVariableInterface.h>

Inheritance diagram for NeighborMooseVariableInterface< T >:
[legend]

Public Member Functions

 NeighborMooseVariableInterface (const MooseObject *moose_object, bool nodal, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_STANDARD)
 Constructing the object. More...
 
virtual ~NeighborMooseVariableInterface ()
 
MooseVariableBasemooseVariableBase () 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...
 

Protected Member Functions

virtual const OutputTools< T >::VariableValueneighborValue ()
 The value of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableValueneighborValueOld ()
 The old value of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableValueneighborValueOlder ()
 The older value of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableGradientneighborGradient ()
 The gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableGradientneighborGradientOld ()
 The old gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableGradientneighborGradientOlder ()
 The older gradient of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableSecondneighborSecond ()
 The second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableSecondneighborSecondOld ()
 The old second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableSecondneighborSecondOlder ()
 The older second derivative of the variable this object is operating on evaluated on the "neighbor" element. More...
 
virtual const OutputTools< T >::VariableTestSecondneighborSecondTest ()
 The second derivative of the neighbor's test function. More...
 
virtual const OutputTools< T >::VariablePhiSecondneighborSecondPhi ()
 The second derivative of the neighbor's shape function. More...
 
template<>
const VectorVariableValueneighborValue ()
 
template<>
const VectorVariableValueneighborValueOld ()
 
template<>
const VectorVariableValueneighborValueOlder ()
 
virtual const OutputTools< T >::VariableValuevalue ()
 The value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuevalueOld ()
 The old value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuevalueOlder ()
 The older value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedot ()
 The time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotDot ()
 The second time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotOld ()
 The old time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotDotOld ()
 The old second time derivative of the variable this object is operating on. More...
 
virtual const VariableValuedotDu ()
 The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
 
virtual const VariableValuedotDotDu ()
 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 >::VariableGradientgradient ()
 The gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableGradientgradientOld ()
 The old gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableGradientgradientOlder ()
 The older gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecond ()
 The second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecondOld ()
 The old second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecondOlder ()
 The older second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableTestSecondsecondTest ()
 The second derivative of the test function. More...
 
virtual const OutputTools< T >::VariableTestSecondsecondTestFace ()
 The second derivative of the test function on the current face. More...
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhi ()
 The second derivative of the trial function. More...
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhiFace ()
 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
 

Detailed Description

template<typename T>
class NeighborMooseVariableInterface< T >

Enhances MooseVariableInterface interface provide values from neighbor elements.

Definition at line 20 of file NeighborMooseVariableInterface.h.

Constructor & Destructor Documentation

◆ NeighborMooseVariableInterface()

template<typename T >
NeighborMooseVariableInterface< T >::NeighborMooseVariableInterface ( const MooseObject moose_object,
bool  nodal,
Moose::VarKindType  expected_var_type = Moose::VarKindType::VAR_ANY,
Moose::VarFieldType  expected_var_field_type = Moose::VarFieldType::VAR_FIELD_STANDARD 
)

Constructing the object.

Parameters
parametersParameters that come from constructing the object
nodaltrue if the variable is nodal

Definition at line 20 of file NeighborMooseVariableInterface.C.

26  moose_object, nodal, "variable", expected_var_type, expected_var_field_type)
27 {
28 }
Interface for objects that need to get values of MooseVariables.

◆ ~NeighborMooseVariableInterface()

template<typename T >
NeighborMooseVariableInterface< T >::~NeighborMooseVariableInterface ( )
virtual

Definition at line 31 of file NeighborMooseVariableInterface.C.

32 {
33 }

Member Function Documentation

◆ dot()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dot ( )
protectedvirtualinherited

The time derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 148 of file MooseVariableInterface.C.

149 {
150  if (_nodal)
151  return _variable->dofValuesDot();
152  else
153  return _variable->uDot();
154 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & uDot() const
element dots
MooseVariableFE< T > * _variable
const DoFValue & dofValuesDot() const override

◆ dotDot()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotDot ( )
protectedvirtualinherited

The second time derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 158 of file MooseVariableInterface.C.

159 {
160  if (_nodal)
161  return _variable->dofValuesDotDot();
162  else
163  return _variable->uDotDot();
164 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesDotDot() const override
const FieldVariableValue & uDotDot() const
MooseVariableFE< T > * _variable

◆ dotDotDu()

template<typename T >
const VariableValue & MooseVariableInterface< T >::dotDotDu ( )
protectedvirtualinherited

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

Returns
The reference to be stored off and used later.

Definition at line 238 of file MooseVariableInterface.C.

239 {
240  if (_nodal)
241  return _variable->dofValuesDuDotDotDu();
242  else
243  return _variable->duDotDotDu();
244 }
const MooseArray< libMesh::Number > & dofValuesDuDotDotDu() const override
bool _nodal
Whether or not this object is acting only at nodes.
const VariableValue & duDotDotDu() const
MooseVariableFE< T > * _variable

◆ dotDotOld()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotDotOld ( )
protectedvirtualinherited

The old second time derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 178 of file MooseVariableInterface.C.

179 {
180  if (_nodal)
181  return _variable->dofValuesDotDotOld();
182  else
183  return _variable->uDotDotOld();
184 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & uDotDotOld() const
MooseVariableFE< T > * _variable
const DoFValue & dofValuesDotDotOld() const override

◆ dotDu()

template<typename T >
const VariableValue & MooseVariableInterface< T >::dotDu ( )
protectedvirtualinherited

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

Returns
The reference to be stored off and used later.

Definition at line 228 of file MooseVariableInterface.C.

229 {
230  if (_nodal)
231  return _variable->dofValuesDuDotDu();
232  else
233  return _variable->duDotDu();
234 }
const MooseArray< libMesh::Number > & dofValuesDuDotDu() const override
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const VariableValue & duDotDu() const

◆ dotOld()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotOld ( )
protectedvirtualinherited

The old time derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 168 of file MooseVariableInterface.C.

169 {
170  if (_nodal)
171  return _variable->dofValuesDotOld();
172  else
173  return _variable->uDotOld();
174 }
const DoFValue & dofValuesDotOld() const override
const FieldVariableValue & uDotOld() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ gradient()

template<typename T >
const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradient ( )
protectedvirtualinherited

The gradient of the variable this object is operating on.

This is computed by default and should already be available as _grad_u

Returns
The reference to be stored off and used later.

Definition at line 248 of file MooseVariableInterface.C.

249 {
250  if (_nodal)
251  mooseError("gradients are not defined at nodes");
252 
253  return _variable->gradSln();
254 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const FieldVariableGradient & gradSln() const override
element gradients
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ gradientOld()

template<typename T >
const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradientOld ( )
protectedvirtualinherited

The old gradient of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 258 of file MooseVariableInterface.C.

259 {
260  if (_nodal)
261  mooseError("gradients are not defined at nodes");
262 
263  return _variable->gradSlnOld();
264 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnOld() const override

◆ gradientOlder()

template<typename T >
const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradientOlder ( )
protectedvirtualinherited

The older gradient of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 268 of file MooseVariableInterface.C.

269 {
270  if (_nodal)
271  mooseError("gradients are not defined at nodes");
272 
273  return _variable->gradSlnOlder();
274 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnOlder() const

◆ mooseLinearVariableFV()

template<typename T >
MooseLinearVariableFV< T > * MooseVariableInterface< T >::mooseLinearVariableFV ( ) const
inherited

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 68 of file MooseVariableInterface.C.

69 {
71  mooseError(
72  "The variable defined in ", _moose_object.name(), " is not a MooseLinearVariableFV!");
73  return _linear_fv_variable;
74 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
MooseLinearVariableFV< T > * _linear_fv_variable
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
const MooseObject & _moose_object

◆ mooseVariable()

template<typename T >
MooseVariableFE< T > * MooseVariableInterface< T >::mooseVariable ( ) const
inherited

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().

79 {
80  if (!_variable)
81  mooseError(
82  "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
83  return _variable;
84 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
MooseVariableFE< T > * _variable
const MooseObject & _moose_object

◆ mooseVariableBase()

template<typename T>
MooseVariableBase* MooseVariableInterface< T >::mooseVariableBase ( ) const
inlineinherited

Get the variable that this object is using.

Returns
The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

50 { return _var; };
MooseVariableBase * _var
The variable this object is acting on.

◆ mooseVariableField()

template<typename T >
MooseVariableField< T > & MooseVariableInterface< T >::mooseVariableField ( )
inherited

Return the MooseVariableField object that this interface acts on.

Definition at line 354 of file MooseVariableInterface.C.

Referenced by DiracKernelTempl< T >::DiracKernelTempl().

355 {
356  return *_field_variable;
357 }
MooseVariableField< T > * _field_variable

◆ mooseVariableFV()

template<typename T >
MooseVariableFV< T > * MooseVariableInterface< T >::mooseVariableFV ( ) const
inherited

Return the MooseVariableFV object that this interface acts on.

Definition at line 57 of file MooseVariableInterface.C.

58 {
59  if (!_fv_variable)
60  mooseError("_fv_variable is null in ",
62  ". Did you forget to set fv = true in the Variables block?");
63  return _fv_variable;
64 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
MooseVariableFV< T > * _fv_variable
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
const MooseObject & _moose_object

◆ neighborGradient()

template<typename T >
const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradient ( )
protectedvirtual

The gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 97 of file NeighborMooseVariableInterface.C.

98 {
99  if (this->_nodal)
100  mooseError("Nodal variables do not have gradients");
101 
102  return this->_variable->gradSlnNeighbor();
103 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnNeighbor() const override
neighbor solution gradients

◆ neighborGradientOld()

template<typename T >
const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradientOld ( )
protectedvirtual

The old gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 107 of file NeighborMooseVariableInterface.C.

108 {
109  if (this->_nodal)
110  mooseError("Nodal variables do not have gradients");
111 
112  return this->_variable->gradSlnOldNeighbor();
113 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnOldNeighbor() const override

◆ neighborGradientOlder()

template<typename T >
const OutputTools< T >::VariableGradient & NeighborMooseVariableInterface< T >::neighborGradientOlder ( )
protectedvirtual

The older gradient of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 117 of file NeighborMooseVariableInterface.C.

118 {
119  if (this->_nodal)
120  mooseError("Nodal variables do not have gradients");
121 
122  return this->_variable->gradSlnOlderNeighbor();
123 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableGradient & gradSlnOlderNeighbor() const
MooseVariableFE< T > * _variable

◆ neighborSecond()

template<typename T >
const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecond ( )
protectedvirtual

The second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 127 of file NeighborMooseVariableInterface.C.

128 {
129  if (this->_nodal)
130  mooseError("Nodal variables do not have second derivatives");
131 
132  return this->_variable->secondSlnNeighbor();
133 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableSecond & secondSlnNeighbor() const
neighbor solution seconds
MooseVariableFE< T > * _variable

◆ neighborSecondOld()

template<typename T >
const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecondOld ( )
protectedvirtual

The old second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 137 of file NeighborMooseVariableInterface.C.

138 {
139  if (this->_nodal)
140  mooseError("Nodal variables do not have second derivatives");
141 
142  return this->_variable->secondSlnOldNeighbor();
143 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableSecond & secondSlnOldNeighbor() const
MooseVariableFE< T > * _variable

◆ neighborSecondOlder()

template<typename T >
const OutputTools< T >::VariableSecond & NeighborMooseVariableInterface< T >::neighborSecondOlder ( )
protectedvirtual

The older second derivative of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 147 of file NeighborMooseVariableInterface.C.

148 {
149  if (this->_nodal)
150  mooseError("Nodal variables do not have second derivatives");
151 
152  return this->_variable->secondSlnOlderNeighbor();
153 }
const FieldVariableSecond & secondSlnOlderNeighbor() const
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ neighborSecondPhi()

template<typename T >
const OutputTools< T >::VariablePhiSecond & NeighborMooseVariableInterface< T >::neighborSecondPhi ( )
protectedvirtual

The second derivative of the neighbor's shape function.

Returns
The reference to be stored off and used later.

Definition at line 167 of file NeighborMooseVariableInterface.C.

168 {
169  if (this->_nodal)
170  mooseError("Nodal variables do not have second derivatives");
171 
172  return this->_mvi_assembly->secondPhiFaceNeighbor(*this->_variable);
173 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const VariablePhiSecond & secondPhiFaceNeighbor(const MooseVariableField< Real > &) const
Definition: Assembly.h:1338

◆ neighborSecondTest()

template<typename T >
const OutputTools< T >::VariableTestSecond & NeighborMooseVariableInterface< T >::neighborSecondTest ( )
protectedvirtual

The second derivative of the neighbor's test function.

Returns
The reference to be stored off and used later.

Definition at line 157 of file NeighborMooseVariableInterface.C.

158 {
159  if (this->_nodal)
160  mooseError("Nodal variables do not have second derivatives");
161 
162  return this->_variable->secondPhiFaceNeighbor();
163 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariablePhiSecond & secondPhiFaceNeighbor() const override final
Return the rank-2 tensor of second derivatives of the variable&#39;s shape functions on a neighboring ele...

◆ neighborValue() [1/2]

template<typename T >
const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValue ( )
protectedvirtual

The value of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 37 of file NeighborMooseVariableInterface.C.

38 {
39  if (this->_nodal)
40  return this->_variable->dofValuesNeighbor();
41  else
42  return this->_variable->slnNeighbor();
43 }
const FieldVariableValue & slnNeighbor() const override
neighbor solutions
const DoFValue & dofValuesNeighbor() const override
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ neighborValue() [2/2]

template<>
const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValue ( )
protected

Definition at line 47 of file NeighborMooseVariableInterface.C.

48 {
49  if (this->_nodal)
50  mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
51  else
52  return this->_variable->slnNeighbor();
53 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const FieldVariableValue & slnNeighbor() const override
neighbor solutions
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ neighborValueOld() [1/2]

template<typename T >
const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValueOld ( )
protectedvirtual

The old value of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 57 of file NeighborMooseVariableInterface.C.

58 {
59  if (this->_nodal)
60  return this->_variable->dofValuesOldNeighbor();
61  else
62  return this->_variable->slnOldNeighbor();
63 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesOldNeighbor() const override
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOldNeighbor() const override

◆ neighborValueOld() [2/2]

template<>
const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValueOld ( )
protected

Definition at line 67 of file NeighborMooseVariableInterface.C.

68 {
69  if (this->_nodal)
70  mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
71  else
72  return this->_variable->slnOldNeighbor();
73 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOldNeighbor() const override

◆ neighborValueOlder() [1/2]

template<typename T >
const OutputTools< T >::VariableValue & NeighborMooseVariableInterface< T >::neighborValueOlder ( )
protectedvirtual

The older value of the variable this object is operating on evaluated on the "neighbor" element.

Returns
The reference to be stored off and used later.

Definition at line 77 of file NeighborMooseVariableInterface.C.

78 {
79  if (this->_nodal)
80  return this->_variable->dofValuesOlderNeighbor();
81  else
82  return this->_variable->slnOlderNeighbor();
83 }
const DoFValue & dofValuesOlderNeighbor() const override
const FieldVariableValue & slnOlderNeighbor() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ neighborValueOlder() [2/2]

template<>
const VectorVariableValue & NeighborMooseVariableInterface< RealVectorValue >::neighborValueOlder ( )
protected

Definition at line 87 of file NeighborMooseVariableInterface.C.

88 {
89  if (this->_nodal)
90  mooseError("Dofs are scalars while vector variables have vector values. Mismatch");
91  else
92  return this->_variable->slnOlderNeighbor();
93 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const FieldVariableValue & slnOlderNeighbor() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ second()

template<typename T >
const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::second ( )
protectedvirtualinherited

The second derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 278 of file MooseVariableInterface.C.

Referenced by MooseLinearVariableFV< Real >::getBoundaryCondition(), and MooseVariableFV< Real >::getDirichletBoundaryFaceValue().

279 {
280  if (_nodal)
281  mooseError("second derivatives are not defined at nodes");
282 
283  return _variable->secondSln();
284 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableSecond & secondSln() const
element seconds

◆ secondOld()

template<typename T >
const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::secondOld ( )
protectedvirtualinherited

The old second derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 288 of file MooseVariableInterface.C.

289 {
290  if (_nodal)
291  mooseError("second derivatives are not defined at nodes");
292 
293  return _variable->secondSlnOld();
294 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const FieldVariableSecond & secondSlnOld() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ secondOlder()

template<typename T >
const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::secondOlder ( )
protectedvirtualinherited

The older second derivative of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 298 of file MooseVariableInterface.C.

299 {
300  if (_nodal)
301  mooseError("second derivatives are not defined at nodes");
302 
303  return _variable->secondSlnOlder();
304 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableSecond & secondSlnOlder() const
MooseVariableFE< T > * _variable

◆ secondPhi()

template<typename T >
const OutputTools< T >::VariablePhiSecond & MooseVariableInterface< T >::secondPhi ( )
protectedvirtualinherited

The second derivative of the trial function.

Returns
The reference to be stored off and used later.

Definition at line 328 of file MooseVariableInterface.C.

329 {
330  if (_nodal)
331  mooseError("second derivatives are not defined at nodes");
332 
334  mooseError("second order shape function derivatives not available for linear FV variables");
335 
337 }
const VariablePhiSecond & secondPhi() const
Definition: Assembly.h:1299
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
MooseLinearVariableFV< T > * _linear_fv_variable
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ secondPhiFace()

template<typename T >
const OutputTools< T >::VariablePhiSecond & MooseVariableInterface< T >::secondPhiFace ( )
protectedvirtualinherited

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.

Returns
The reference to be stored off and used later.

Definition at line 341 of file MooseVariableInterface.C.

342 {
343  if (_nodal)
344  mooseError("second derivatives are not defined at nodes");
345 
347  mooseError("second order shape function derivatives not available for linear FV variables");
348 
350 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
MooseLinearVariableFV< T > * _linear_fv_variable
bool _nodal
Whether or not this object is acting only at nodes.
const VariablePhiSecond & secondPhiFace(const MooseVariableField< Real > &) const
Definition: Assembly.h:1312
MooseVariableFE< T > * _variable

◆ secondTest()

template<typename T >
const OutputTools< T >::VariableTestSecond & MooseVariableInterface< T >::secondTest ( )
protectedvirtualinherited

The second derivative of the test function.

Returns
The reference to be stored off and used later.

Definition at line 308 of file MooseVariableInterface.C.

309 {
310  if (_nodal)
311  mooseError("second derivatives are not defined at nodes");
312 
313  return _variable->secondPhi();
314 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const FieldVariablePhiSecond & secondPhi() const override final
Return the rank-2 tensor of second derivatives of the variable&#39;s elemental shape functions.
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ secondTestFace()

template<typename T >
const OutputTools< T >::VariableTestSecond & MooseVariableInterface< T >::secondTestFace ( )
protectedvirtualinherited

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.

Returns
The reference to be stored off and used later.

Definition at line 318 of file MooseVariableInterface.C.

319 {
320  if (_nodal)
321  mooseError("second derivatives are not defined at nodes");
322 
323  return _variable->secondPhiFace();
324 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariablePhiSecond & secondPhiFace() const override final
Return the rank-2 tensor of second derivatives of the variable&#39;s shape functions on an element face...
MooseVariableFE< T > * _variable

◆ value()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::value ( )
protectedvirtualinherited

The value of the variable this object is operating on.

This is computed by default and should already be available as _u

Returns
The reference to be stored off and used later.

Definition at line 88 of file MooseVariableInterface.C.

Referenced by ReporterPointSource::fillPoint().

89 {
90  if (_nodal)
91  return _variable->dofValues();
92  else
93  return _variable->sln();
94 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & sln() const override
element solutions
MooseVariableFE< T > * _variable
const DoFValue & dofValues() const override
dof values getters

◆ valueOld()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::valueOld ( )
protectedvirtualinherited

The old value of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 108 of file MooseVariableInterface.C.

109 {
110  if (_nodal)
111  return _variable->dofValuesOld();
112  else
113  return _variable->slnOld();
114 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesOld() const override
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOld() const override

◆ valueOlder()

template<typename T >
const OutputTools< T >::VariableValue & MooseVariableInterface< T >::valueOlder ( )
protectedvirtualinherited

The older value of the variable this object is operating on.

Returns
The reference to be stored off and used later.

Definition at line 128 of file MooseVariableInterface.C.

129 {
130  if (_nodal)
131  return _variable->dofValuesOlder();
132  else
133  return _variable->slnOlder();
134 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesOlder() const override
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOlder() const override

Member Data Documentation

◆ _field_variable

template<typename T>
MooseVariableField<T>* MooseVariableInterface< T >::_field_variable = nullptr
protectedinherited

◆ _fv_variable

template<typename T>
MooseVariableFV<T>* MooseVariableInterface< T >::_fv_variable = nullptr
protectedinherited

◆ _linear_fv_variable

template<typename T>
MooseLinearVariableFV<T>* MooseVariableInterface< T >::_linear_fv_variable = nullptr
protectedinherited

◆ _mvi_assembly

template<typename T>
Assembly* MooseVariableInterface< T >::_mvi_assembly
protectedinherited

◆ _nodal

template<typename T>
bool MooseVariableInterface< T >::_nodal
protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 223 of file MooseVariableInterface.h.

◆ _var

template<typename T>
MooseVariableBase* MooseVariableInterface< T >::_var = nullptr
protectedinherited

The variable this object is acting on.

Definition at line 226 of file MooseVariableInterface.h.

Referenced by MooseVariableInterface< Real >::mooseVariableBase(), and MooseVariableInterface< Real >::MooseVariableInterface().

◆ _variable

template<typename T>
MooseVariableFE<T>* MooseVariableInterface< T >::_variable = nullptr
protectedinherited

The documentation for this class was generated from the following files: