MooseVariableInterface< T > Class Template Reference

Interface for objects that need to get values of MooseVariables. More...

#include <MooseVariableInterface.h>

Inheritance diagram for MooseVariableInterface< T >:

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.
MooseVariableBase *	mooseVariableBase () const
	Get the variable that this object is using.
MooseVariableField< T > &	mooseVariableField ()
	Return the MooseVariableField object that this interface acts on.
MooseVariableFE< T > *	mooseVariable () const
	Return the MooseVariableFE object that this interface acts on.
MooseVariableFV< T > *	mooseVariableFV () const
	Return the MooseVariableFV object that this interface acts on.
MooseLinearVariableFV< T > *	mooseLinearVariableFV () const
	Return the MooseLinearVariableFV object that this interface acts on.
virtual	~MooseVariableInterface ()

Protected Member Functions
virtual const OutputTools< T >::VariableValue &	value ()
	The value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on.
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.
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.
virtual const OutputTools< T >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableTestSecond &	secondTest ()
	The second derivative of the test function.
virtual const OutputTools< T >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face.
virtual const OutputTools< T >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function.
virtual const OutputTools< T >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face.

Protected Attributes
bool	_nodal
	Whether or not this object is acting only at nodes.
MooseVariableBase *	_var = nullptr
	The variable this object is acting on.
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

Detailed Description

template<typename T>
class MooseVariableInterface< T >

Interface for objects that need to get values of MooseVariables.

Definition at line 30 of file MooseVariableInterface.h.

Constructor & Destructor Documentation

MooseVariableInterface()

template<typename T >

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

  : _nodal(nodal), _moose_object(*moose_object)
{
  const InputParameters & parameters = _moose_object.parameters();
 
  SubProblem & problem = *parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
 
  THREAD_ID tid = parameters.get<THREAD_ID>("_tid");
 
  _var = &problem.getVariable(tid,
                              parameters.varName(var_param_name, moose_object->name()),
                              expected_var_type,
                              expected_var_field_type);
  if (!(_variable = dynamic_cast<MooseVariableFE<T> *>(_var)))
    if (!(_fv_variable = dynamic_cast<MooseVariableFV<T> *>(_var)))
      _linear_fv_variable = dynamic_cast<MooseLinearVariableFV<T> *>(_var);
  if (!(_field_variable = dynamic_cast<MooseVariableField<T> *>(_var)))
    mooseError("The variable supplied to the variable interface is not of field type");
 
  _mvi_assembly =
      &problem.assembly(tid, (_var->kind() == Moose::VAR_SOLVER) ? _var->sys().number() : 0);
}

~MooseVariableInterface()

template<typename T >

MooseVariableInterface< T >::~MooseVariableInterface ( )

virtual

Definition at line 51 of file MooseVariableInterface.C.

{
}

Member Function Documentation

dot()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesDot();
  else
    return _variable->uDot();
}

dotDot()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesDotDot();
  else
    return _variable->uDotDot();
}

dotDotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::dotDotDu ( )

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

Returns

The reference to be stored off and used later.

Definition at line 238 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDotDu();
  else
    return _variable->duDotDotDu();
}

dotDotOld()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesDotDotOld();
  else
    return _variable->uDotDotOld();
}

dotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::dotDu ( )

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

Returns

The reference to be stored off and used later.

Definition at line 228 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDu();
  else
    return _variable->duDotDu();
}

dotOld()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesDotOld();
  else
    return _variable->uDotOld();
}

gradient()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSln();
}

Referenced by DiffusionFluxAux::computeValue().

gradientOld()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOld();
}

gradientOlder()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOlder();
}

mooseLinearVariableFV()

template<typename T >

MooseLinearVariableFV< T > * MooseVariableInterface< T >::mooseLinearVariableFV

(

)

const

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 68 of file MooseVariableInterface.C.

{
  if (!_linear_fv_variable)
    mooseError(
        "The variable defined in ", _moose_object.name(), " is not a MooseLinearVariableFV!");
  return _linear_fv_variable;
}

mooseVariable()

template<typename T >

MooseVariableFE< T > * MooseVariableInterface< T >::mooseVariable

(

)

const

Return the MooseVariableFE object that this interface acts on.

Definition at line 78 of file MooseVariableInterface.C.

{
  if (!_variable)
    mooseError(
        "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
  return _variable;
}

Referenced by ADDGKernel::ADDGKernel(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), DGKernel::DGKernel(), and InterfaceKernelTempl< T >::InterfaceKernelTempl().

mooseVariableBase()

template<typename T >

MooseVariableBase * MooseVariableInterface< T >::mooseVariableBase ( ) const

inline

Get the variable that this object is using.

Returns

The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

{ return _var; };

Referenced by ElementAdaptivityLevelAux::ElementAdaptivityLevelAux(), ElementLpNormAux::ElementLpNormAux(), and VolumeAux::VolumeAux().

mooseVariableField()

template<typename T >

MooseVariableField< T > & MooseVariableInterface< T >::mooseVariableField

(

)

Return the MooseVariableField object that this interface acts on.

Definition at line 354 of file MooseVariableInterface.C.

{
  return *_field_variable;
}

Referenced by DiracKernelTempl< T >::DiracKernelTempl(), and InternalSideIndicatorTempl< ComputeValueType >::InternalSideIndicatorTempl().

mooseVariableFV()

template<typename T >

MooseVariableFV< T > * MooseVariableInterface< T >::mooseVariableFV

(

)

const

Return the MooseVariableFV object that this interface acts on.

Definition at line 57 of file MooseVariableInterface.C.

{
  if (!_fv_variable)
    mooseError("_fv_variable is null in ",
               _moose_object.name(),
               ". Did you forget to set fv = true in the Variables block?");
  return _fv_variable;
}

second()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSln();
}

Referenced by MooseVariableFV< OutputType >::getDirichletBoundaryFaceValue().

secondOld()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOld();
}

secondOlder()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOlder();
}

secondPhi()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhi(*_variable);
}

secondPhiFace()

template<typename T >

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

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.

Returns

The reference to be stored off and used later.

Definition at line 341 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhiFace(*_variable);
}

secondTest()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhi();
}

secondTestFace()

template<typename T >

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

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.

Returns

The reference to be stored off and used later.

Definition at line 318 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhiFace();
}

value()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValues();
  else
    return _variable->sln();
}

Referenced by NodalConstraint::computeJacobian(), ConservativeAdvectionBCTempl< is_ad >::computeQpResidual(), BodyForceTempl< is_ad >::computeQpResidual(), ArrayBodyForce::computeQpResidual(), ElementUOAux::computeValue(), MeshDivisionAux::computeValue(), and ParsedVectorAux::computeValue().

valueOld()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesOld();
  else
    return _variable->slnOld();
}

valueOlder()

template<typename T >

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

protectedvirtual

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.

{
  if (_nodal)
    return _variable->dofValuesOlder();
  else
    return _variable->slnOlder();
}

Member Data Documentation

_field_variable

template<typename T >

MooseVariableField<T>* MooseVariableInterface< T >::_field_variable = nullptr

protected

Definition at line 230 of file MooseVariableInterface.h.

_fv_variable

template<typename T >

MooseVariableFV<T>* MooseVariableInterface< T >::_fv_variable = nullptr

protected

Definition at line 228 of file MooseVariableInterface.h.

_linear_fv_variable

template<typename T >

MooseLinearVariableFV<T>* MooseVariableInterface< T >::_linear_fv_variable = nullptr

protected

Definition at line 229 of file MooseVariableInterface.h.

_moose_object

template<typename T >

const MooseObject& MooseVariableInterface< T >::_moose_object

private

Definition at line 236 of file MooseVariableInterface.h.

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

_mvi_assembly

template<typename T >

Assembly* MooseVariableInterface< T >::_mvi_assembly

protected

Definition at line 233 of file MooseVariableInterface.h.

_nodal

template<typename T >

bool MooseVariableInterface< T >::_nodal

protected

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

protected

The variable this object is acting on.

Definition at line 226 of file MooseVariableInterface.h.

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

_variable

template<typename T >

MooseVariableFE<T>* MooseVariableInterface< T >::_variable = nullptr

protected

Definition at line 227 of file MooseVariableInterface.h.

---

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

• include/variables/MooseVariableInterface.h
• src/variables/MooseVariableInterface.C