Interface for objects that needs coupling capabilities. More...

#include <Coupleable.h>

Inheritance diagram for Coupleable:

Public Member Functions
	Coupleable (const MooseObject *moose_object, bool nodal, bool is_fv=false)
	Constructing the object. More...

	Coupleable (const Coupleable &object, const Moose::Kokkos::FunctorCopy &key)
	Special constructor used for Kokkos functor copy during parallel dispatch. More...

const std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > &	getCoupledVars () const
	Get the list of coupled variables. More...

const std::vector< MooseVariableFieldBase * > &	getCoupledMooseVars () const
	Get the list of all coupled variables. More...

const std::vector< MooseVariable * > &	getCoupledStandardMooseVars () const
	Get the list of standard coupled variables. More...

const std::vector< VectorMooseVariable * > &	getCoupledVectorMooseVars () const
	Get the list of vector coupled variables. More...

const std::vector< ArrayMooseVariable * > &	getCoupledArrayMooseVars () const
	Get the list of array coupled variables. More...

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

const std::set< TagID > &	getFEVariableCoupleableVectorTags () const

const std::set< TagID > &	getFEVariableCoupleableMatrixTags () const

auto &	getWritableCoupledVariables () const
	returns a reference to the set of writable coupled variables More...

bool	hasWritableCoupledVariables () const
	Checks whether the object has any writable coupled variables. More...

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the default value for Automatic Differentiation for an uncoupled variable. More...

const ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the default vector value for Automatic Differentiation for an uncoupled variable. More...

const ADVariableGradient &	getADDefaultGradient () const
	Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled variable. More...

const ADVectorVariableGradient &	getADDefaultVectorGradient () const
	Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled vector variable. More...

const ADVariableSecond &	getADDefaultSecond () const
	Helper method to return (and insert if necessary) the default second derivatives for Automatic Differentiation for an uncoupled variable. More...

const ADVectorVariableCurl &	getADDefaultCurl () const
	Helper method to return (and insert if necessary) the default curl value for Automatic Differentiation for an uncoupled variable. More...

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValuesByName (const std::string &var_name, const std::string &tag_name)

Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0)

Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradientsByName (const std::string &var_name, const std::string &tag_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledVectorTagNodalValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledVectorTagNodalValuesByName (const std::string &var_name, const std::string &tag_name)

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagValues (const std::string &var_name, const std::string &tag_param_name)

Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradient (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)

Moose::Kokkos::VariableGradient	kokkosCoupledVectorTagGradients (const std::string &var_name, const std::string &tag_param_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledVectorTagNodalValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledVectorTagNodalValues (const std::string &var_name, const std::string &tag_param_name)

Moose::Kokkos::VariableValue	kokkosCoupledValue (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledValues (const std::string &var_name)

Moose::Kokkos::VariableGradient	kokkosCoupledGradient (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableGradient	kokkosCoupledGradients (const std::string &var_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValue (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValues (const std::string &var_name)

Moose::Kokkos::VariableValue	kokkosCoupledValueOld (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledValuesOld (const std::string &var_name)

Moose::Kokkos::VariableGradient	kokkosCoupledGradientOld (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOld (const std::string &var_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValueOld (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValuesOld (const std::string &var_name)

Moose::Kokkos::VariableValue	kokkosCoupledValueOlder (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledValuesOlder (const std::string &var_name)

Moose::Kokkos::VariableGradient	kokkosCoupledGradientOlder (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableGradient	kokkosCoupledGradientsOlder (const std::string &var_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValueOlder (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalValuesOlder (const std::string &var_name)

Moose::Kokkos::VariableValue	kokkosCoupledDot (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosCoupledDots (const std::string &var_name)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalDot (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableNodalValue	kokkosCoupledNodalDots (const std::string &var_name)

Moose::Kokkos::Scalar< const Real >	kokkosCoupledDotDu (const std::string &var_name, unsigned int comp=0)

Moose::Kokkos::VariableValue	kokkosZeroValue ()

Moose::Kokkos::VariableGradient	kokkosZeroGradient ()

Moose::Kokkos::VariableNodalValue	kokkosZeroNodalValue ()

Protected Member Functions
virtual void	coupledCallback (const std::string &, bool) const
	A call-back function provided by the derived object for actions before coupling a variable with functions such as coupledValue. More...

virtual bool	isCoupled (const std::string &var_name, unsigned int i=0) const
	Returns true if a variables has been coupled as name. More...

virtual bool	isCoupledConstant (const std::string &var_name) const
	Returns true if a variable passed as a coupled value is really a constant. More...

unsigned int	coupledComponents (const std::string &var_name) const
	Number of coupled components. More...

VariableName	coupledName (const std::string &var_name, unsigned int comp=0) const
	Names of the variable in the Coupleable interface. More...

std::vector< VariableName >	coupledNames (const std::string &var_name) const
	Names of the variables in the Coupleable interface. More...

virtual unsigned int	coupled (const std::string &var_name, unsigned int comp=0) const
	Returns the index for a coupled variable by name. More...

std::vector< unsigned int >	coupledIndices (const std::string &var_name) const
	Returns the indices for a coupled variable's components. More...

virtual const VariableValue &	coupledValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled variable. More...

std::vector< const VariableValue * >	coupledValues (const std::string &var_name) const
	Returns the values for all of a coupled variable components. More...

std::vector< const VectorVariableValue * >	coupledVectorValues (const std::string &var_name) const
	Returns the values for all of a coupled vector variable's components. More...

template<bool is_ad>
const GenericVariableValue< is_ad > &	coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled variable for use in templated automatic differentiation classes. More...

template<bool is_ad>
const GenericVectorVariableValue< is_ad > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled vector variable for use in templated automatic differentiation classes. More...

template<bool is_ad>
std::vector< const GenericVariableValue< is_ad > * >	coupledGenericValues (const std::string &var_name) const
	Returns the values for all of a coupled variable's components for use in templated automatic differentiation classes. More...

template<bool is_ad>
const GenericVariableValue< is_ad > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
	Returns DOF value of a coupled variable for use in templated automatic differentiation classes. More...

template<bool is_ad>
const GenericVariableValue< is_ad > &	coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
	Returns time derivative of a coupled variable for use in templated automatic differentiation classes. More...

template<bool is_ad>
const GenericVariableValue< is_ad > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
	Returns the second time derivative of a coupled variable for use in templated automatic differentiation classes. More...

virtual const VariableValue &	coupledValueLower (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled lower-dimensional variable. More...

const ADVariableValue &	adCoupledValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled variable for use in Automatic Differentiation. More...

std::vector< const ADVariableValue * >	adCoupledValues (const std::string &var_name) const
	Returns the values for all of a coupled variable's components for use in Automatic Differentiation. More...

const ADVariableValue &	adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled lower-dimensional variable for use in Automatic Differentiation. More...

const ADVectorVariableValue &	adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled vector variable for use in Automatic Differentiation. More...

std::vector< const ADVectorVariableValue * >	adCoupledVectorValues (const std::string &var_name) const
	Returns the values for all of a coupled vector variable's components for use in Automatic Differentiation. More...

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
	Returns value of a coupled variable for a given tag. More...

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue * >	coupledVectorTagValues (const std::string &var_names, TagID tag) const
	Returns the values for all the coupled variables desired for a given tag. More...

std::vector< const VariableValue * >	coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
	Returns value of a coupled array variable for a given tag. More...

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableValue * >	coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
	Returns the values for all the coupled variables desired for a given tag. More...

std::vector< const ArrayVariableValue * >	coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
	Returns gradient of a coupled variable for a given tag. More...

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableGradient * >	coupledVectorTagGradients (const std::string &var_names, TagID tag) const
	Returns gradients for all the coupled variables desired for a given tag. More...

std::vector< const VariableGradient * >	coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
	Returns gradient of a coupled array variable for a given tag. More...

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableGradient * >	coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
	Returns gradients for all the coupled variables desired for a given tag. More...

std::vector< const ArrayVariableGradient * >	coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
	Returns dof value of a coupled variable for a given tag. More...

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

const ArrayVariableValue &	coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
	Returns evaluations of a tagged vector at the requested variable's degree of freedom indices. More...

std::vector< const VariableValue * >	coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
	Returns the dof values for all the coupled variables desired for a given tag. More...

std::vector< const VariableValue * >	coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
	Returns value of a coupled variable for a given tag. More...

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue * >	coupledMatrixTagValues (const std::string &var_names, TagID tag) const
	Returns the diagonal matrix values for all the coupled variables desired for a given tag. More...

std::vector< const VariableValue * >	coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled vector variable. More...

virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
	Returns value of a coupled array variable. More...

std::vector< const ArrayVariableValue * >	coupledArrayValues (const std::string &var_name) const
	Returns the values for all of a coupled array variable's components. More...

MooseWritableVariable &	writableVariable (const std::string &var_name, unsigned int comp=0)
	Returns a writable MooseVariable object for a nodal or elemental variable. More...

virtual VariableValue &	writableCoupledValue (const std::string &var_name, unsigned int comp=0)
	Returns a writable reference to a coupled variable for writing to multiple AuxVariables from a single AuxKernel or a UserObject. More...

void	checkWritableVar (MooseWritableVariable *var)
	Checks that the passed in variable is only accessed writable by one object in a given subdomain. More...

virtual const VariableValue &	coupledValueOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from previous time step of a coupled variable. More...

std::vector< const VariableValue * >	coupledValuesOld (const std::string &var_name) const
	Returns the old values for all of a coupled variable's components. More...

std::vector< const VectorVariableValue * >	coupledVectorValuesOld (const std::string &var_name) const
	Returns the old values for all of a coupled vector variable's components. More...

virtual const VariableValue &	coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from two time steps previous of a coupled variable. More...

std::vector< const VariableValue * >	coupledValuesOlder (const std::string &var_name) const
	Returns the older values for all of a coupled variable's components. More...

virtual const VariableValue &	coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
	Returns value of previous Newton iterate of a coupled variable. More...

virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from previous time step of a coupled vector variable. More...

virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from two time steps previous of a coupled vector variable. More...

virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from previous time step of a coupled array variable. More...

virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old value from two time steps previous of a coupled array variable. More...

virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled variable. More...

std::vector< const VariableGradient * >	coupledGradients (const std::string &var_name) const
	Returns the gradients for all of a coupled variable's components. More...

const ADVariableGradient &	adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled variable for use in Automatic Differentiation. More...

const ADVariableGradient &	adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled variable's time derivative for use in Automatic Differentiation. More...

std::vector< const ADVariableGradient * >	adCoupledGradients (const std::string &var_name) const
	Returns the gradients for all of a coupled variable's components for use in Automatic Differentiation. More...

template<bool is_ad>
const GenericVariableGradient< is_ad > &	coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled variable for use in templated automatic differentiation. More...

template<bool is_ad>
std::vector< const GenericVariableGradient< is_ad > * >	coupledGenericGradients (const std::string &var_name) const
	Returns the gradients for all of a coupled variable's components for use in templated automatic differentiation. More...

const ADVectorVariableGradient &	adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled vector variable for use in Automatic Differentiation. More...

const ADVariableSecond &	adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
	Returns second derivatives of a coupled variable for use in Automatic Differentiation. More...

const ADVectorVariableSecond &	adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
	Returns second derivatives of a coupled vector variable for use in Automatic Differentiation. More...

virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from previous time step of a coupled variable. More...

std::vector< const VariableGradient * >	coupledGradientsOld (const std::string &var_name) const
	Returns the old gradients for all of a coupled variable's components. More...

virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from two time steps previous of a coupled variable. More...

virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled variable for previous Newton iterate. More...

virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of the gradient of a coupled variable. More...

virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of the gradient of a coupled variable. More...

virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled vector variable. More...

virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from previous time step of a coupled vector variable. More...

virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from two time steps previous of a coupled vector variable. More...

virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
	Returns gradient of a coupled array variable. More...

virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from previous time step of a coupled array variable. More...

virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old gradient from two time steps previous of a coupled array variable. More...

virtual const ArrayVariableGradient &	coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
	Retun a gradient of a coupled array variable's time derivative. More...

virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0) const
	Returns curl of a coupled variable. More...

virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old curl from previous time step of a coupled variable. More...

virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old curl from two time steps previous of a coupled variable. More...

const ADVectorVariableCurl &	adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
	Returns curl of a coupled variable for use in objects utilizing Automatic Differentiation. More...

virtual const VectorVariableDivergence &	coupledDiv (const std::string &var_name, unsigned int comp=0) const
	Returns divergence of a coupled variable. More...

virtual const VectorVariableDivergence &	coupledDivOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old divergence from previous time step of a coupled variable. More...

virtual const VectorVariableDivergence &	coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old divergence from two time steps previous of a coupled variable. More...

virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0) const
	Returns second spatial derivatives of a coupled variable. More...

virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old second spatial derivatives from previous time step of a coupled variable. More...

virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old second derivative from two time steps previous of a coupled variable. More...

virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
	Returns second derivative of a coupled variable for the previous Newton iterate. More...

virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled variable. More...

std::vector< const VariableValue * >	coupledDots (const std::string &var_name) const
	Returns the time derivatives for all of a coupled variable's components. More...

virtual const VariableValue &	coupledDotDot (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled variable. More...

virtual const VariableValue &	coupledDotOld (const std::string &var_name, unsigned int comp=0) const
	Old time derivative of a coupled variable. More...

virtual const VariableValue &	coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
	Old second time derivative of a coupled variable. More...

const ADVariableValue &	adCoupledDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled variable for ad simulations. More...

std::vector< const ADVariableValue * >	adCoupledDots (const std::string &var_name) const
	Returns the time derivatives for all of a coupled variable's components for ad simulations. More...

const ADVariableValue &	adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled variable for ad simulations. More...

const ADVectorVariableValue &	adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a vector coupled variable for ad simulations. More...

virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled vector variable. More...

virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled vector variable. More...

virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
	Old time derivative of a coupled vector variable. More...

virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
	Old second time derivative of a coupled vector variable. More...

virtual const VariableValue &	coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled vector variable with respect to the coefficients. More...

virtual const VariableValue &	coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled vector variable with respect to the coefficients. More...

virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled array variable. More...

virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled array variable. More...

virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
	Old time derivative of a coupled array variable. More...

virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
	Old second time derivative of a coupled array variable. More...

virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled variable with respect to the coefficients. More...

virtual const VariableValue &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
	Second time derivative of a coupled variable with respect to the coefficients. More...

const VariableValue &	coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
	Time derivative of a coupled array variable with respect to the coefficients. More...

template<typename T >
const T &	coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
	Returns nodal values of a coupled variable. More...

template<typename T >
const Moose::ADType< T >::type &	adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
	Returns AD nodal values of a coupled variable. More...

template<typename T >
const T &	coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
	Returns an old nodal value from previous time step of a coupled variable. More...

template<typename T >
const T &	coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
	Returns an old nodal value from two time steps previous of a coupled variable. More...

template<typename T >
const T &	coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
	Returns nodal values of a coupled variable for previous Newton iterate. More...

template<typename T >
const T &	coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
	Nodal values of time derivative of a coupled variable. More...

virtual const VariableValue &	coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
	Nodal values of second time derivative of a coupled variable. More...

virtual const VariableValue &	coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
	Nodal values of old time derivative of a coupled variable. More...

virtual const VariableValue &	coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
	Nodal values of old second time derivative of a coupled variable. More...

virtual const VariableValue &	coupledDofValues (const std::string &var_name, unsigned int comp=0) const
	Returns DoFs in the current solution vector of a coupled variable for the local element. More...

std::vector< const VariableValue * >	coupledAllDofValues (const std::string &var_name) const
	Returns DoFs in the current solution vector of all of a coupled variable's components for the local element. More...

virtual const VariableValue &	coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
	Returns DoFs in the old solution vector of a coupled variable for the local element. More...

std::vector< const VariableValue * >	coupledAllDofValuesOld (const std::string &var_name) const
	Returns DoFs in the old solution vector of all of a coupled variable's components for the local element. More...

virtual const VariableValue &	coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
	Returns DoFs in the older solution vector of a coupled variable for the local element. More...

std::vector< const VariableValue * >	coupledAllDofValuesOlder (const std::string &var_name) const
	Returns DoFs in the older solution vector of all of a coupled variable's components for the local element. More...

virtual const ArrayVariableValue &	coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
	Returns DoFs in the current solution vector of a coupled array variable for the local element. More...

virtual const ADVariableValue &	adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
	Returns DOF value of a coupled variable for use in Automatic Differentiation. More...

const ADVariableValue &	adZeroValue () const
	method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects More...

const ADVariableGradient &	adZeroGradient () const
	method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects More...

const ADVariableSecond &	adZeroSecond () const
	Retrieve a zero second for automatic differentiation. More...

template<bool is_ad>
const GenericVariableValue< is_ad > &	genericZeroValue ()
	Returns zero value templated with automatic differentiation boolean. More...

template<bool is_ad>
const GenericVariableGradient< is_ad > &	genericZeroGradient ()
	Returns zero gradient templated with automatic differentiation boolean. More...

template<bool is_ad>
const GenericVariableSecond< is_ad > &	genericZeroSecond ()
	Returns zero second derivative templated with automatic differentiation boolean. More...

bool	checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
	Check that the right kind of variable is being coupled in. More...

const MooseVariableFieldBase *	getFEVar (const std::string &var_name, unsigned int comp) const
	Deprecated method. More...

const MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp) const

MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp)

template<typename T >
const T *	getVarHelper (const std::string &var_name, unsigned int comp) const
	Helper that that be used to retrieve a variable of arbitrary type `T`. More...

template<typename T >
T *	getVarHelper (const std::string &var_name, unsigned int comp)
	Helper that can be used to retrieve a variable of arbitrary type `T`. More...

MooseVariable *	getVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled variable. More...

VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled vector variable. More...

ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled array variable. More...

const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const
	Extract pointer to a coupled variable. More...

const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const
	Extract pointer to a coupled vector variable. More...

const ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp) const
	Extract pointer to a coupled array variable. More...

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const
	Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in. More...

template<typename T , typename Func >
std::vector< T >	coupledVectorHelper (const std::string &var_name, const Func &func) const

template<>
const GenericVariableValue< false > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< true > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVectorVariableValue< false > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVectorVariableValue< true > &	coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< false > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< true > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< false > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< true > &	coupledGenericDotDot (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< false > &	genericZeroValue ()

template<>
const GenericVariableValue< true > &	genericZeroValue ()

template<>
const GenericVariableGradient< false > &	genericZeroGradient ()

template<>
const GenericVariableGradient< true > &	genericZeroGradient ()

template<>
const GenericVariableSecond< false > &	genericZeroSecond ()

template<>
const GenericVariableSecond< true > &	genericZeroSecond ()

template<>
const GenericVariableGradient< false > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableGradient< true > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

template<>
std::vector< const GenericVariableValue< false > * >	coupledGenericValues (const std::string &var_name) const

template<>
std::vector< const GenericVariableValue< true > * >	coupledGenericValues (const std::string &var_name) const

template<>
std::vector< const GenericVariableGradient< false > * >	coupledGenericGradients (const std::string &var_name) const

template<>
std::vector< const GenericVariableGradient< true > * >	coupledGenericGradients (const std::string &var_name) const

template<>
const GenericVariableValue< false > &	coupledGenericDot (const std::string &var_name, unsigned int comp) const

template<>
const GenericVariableValue< true > &	coupledGenericDot (const std::string &var_name, unsigned int comp) const

Protected Attributes
const InputParameters &	_c_parameters

const std::string &	_c_name
	The name of the object this interface is part of. More...

const std::string &	_c_type
	The type of the object this interface is part of. More...

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys
	Pointer to the system object if the moose object this is an interface for has one. More...

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_coupled_vars
	Coupled vars whose values we provide. More...

std::vector< MooseVariableFieldBase * >	_coupled_moose_vars
	Vector of all coupled variables. More...

std::vector< MooseVariable * >	_coupled_standard_moose_vars
	Vector of standard coupled variables. More...

std::vector< VectorMooseVariable * >	_coupled_vector_moose_vars
	Vector of vector coupled variables. More...

std::vector< ArrayMooseVariable * >	_coupled_array_moose_vars
	Vector of array coupled variables. More...

std::vector< MooseVariableField< Real > * >	_coupled_fv_moose_vars
	Vector of all finite volume coupled variables. More...

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars
	map from new to deprecated variable names More...

bool	_c_nodal
	True if we provide coupling to nodal values. More...

bool	_c_is_implicit
	True if implicit value is required. More...

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid
	Thread ID of the thread using this object. More...

std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value
	Will hold the default value for optional coupled variables. More...

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > >	_ad_default_value
	Will hold the default value for optional coupled variables for automatic differentiation. More...

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value
	Will hold the default value for optional vector coupled variables. More...

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value
	Will hold the default value for optional array coupled variables. More...

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value
	Will hold the default value for optional vector coupled variables for automatic differentiation. More...

VariableValue	_default_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...

VariableGradient	_default_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...

MooseArray< ADRealVectorValue >	_ad_default_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient
	This will always be zero because the default values for optionally coupled vector variables is always constant. More...

VariableSecond	_default_second
	This will always be zero because the default values for optionally coupled variables is always constant. More...

MooseArray< ADRealTensorValue >	_ad_default_second
	This will always be zero because the default values for optionally coupled variables is always constant. More...

MooseArray< ADRealVectorValue >	_ad_default_curl
	This will always be zero because the default values for optionally coupled vector variables is always constant. More...

const VariableValue &	_zero
	Zero value of a variable. More...

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

const VariableGradient &	_grad_zero
	Zero gradient of a variable. More...

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero
	Zero gradient of trial function. More...

const VariableSecond &	_second_zero
	Zero second derivative of a variable. More...

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero
	Zero second derivative of a test function. More...

const VectorVariableValue &	_vector_zero
	Zero value of a vector variable. More...

const VectorVariableCurl &	_vector_curl_zero
	Zero value of the curl of a vector variable. More...

VectorVariableValue	_default_vector_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...

VectorVariableGradient	_default_vector_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...

VectorVariableCurl	_default_vector_curl
	This will always be zero because the default values for optionally coupled variables is always constant. More...

VectorVariableDivergence	_default_div
	This will always be zero because the default values for optionally coupled variables is always constant. More...

ArrayVariableValue	_default_array_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...

ArrayVariableGradient	_default_array_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...

bool	_coupleable_neighbor
	Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values. More...

Private Types
enum	FuncAge { FuncAge::Curr, FuncAge::Old, FuncAge::Older }

enum	VarType { VarType::Ignore, VarType::Gradient, VarType::Second, VarType::GradientDot, VarType::Dot }

Private Member Functions
template<typename T >
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, TagID tag, unsigned int index=0) const
	Generic helper method to get vector tag values based on tag ID. More...

template<typename T >
const OutputTools< T >::VariableValue &	vectorTagValueHelper (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
	Generic helper method to get vector tag values based on tag name. More...

template<typename T >
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, TagID tag, unsigned int comp=0) const
	Generic helper method to get vector tag degree of freedom values based on tag ID. More...

template<typename T >
const OutputTools< T >::VariableValue &	vectorTagDofValueHelper (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
	Generic helper method to get vector tag degree of freedom values based on tag name. More...

template<typename T >
void	requestStates (const std::string &var_name, const TagName &tag_name, const unsigned int comp)
	Method that may request additional solution states from the variable's system depending on the value of `tag_name`. More...

void	checkFuncType (const std::string var_name, VarType t, FuncAge age) const

const VariableValue *	getDefaultValue (const std::string &var_name, unsigned int comp) const
	Helper method to return (and insert if necessary) the default value for an uncoupled variable. More...

const VectorVariableValue *	getDefaultVectorValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the default value for an uncoupled vector variable. More...

const ArrayVariableValue *	getDefaultArrayValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the default value for an uncoupled array variable. More...

template<typename T >
const T &	getDefaultNodalValue (const std::string &var_name, unsigned int comp=0) const
	Get nodal default value. More...

template<typename T >
const Moose::Functor< T > &	getDefaultFunctor (const std::string &var_name) const

Moose::Kokkos::Variable	kokkosCoupledVectorTagVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp)

Moose::Kokkos::Variable	kokkosCoupledVectorTagVariables (const std::string &var_name, const std::string &tag_name)

Moose::Kokkos::Variable	kokkosZeroVariable ()

template<>
const RealVectorValue &	getDefaultNodalValue (const std::string &var_name, unsigned int) const

template<>
const RealEigenVector &	getDefaultNodalValue (const std::string &var_name, unsigned int) const

Private Attributes
unsigned int	_coupleable_max_qps
	Maximum qps for any element in this system. More...

std::unordered_map< std::string, std::vector< unsigned int > >	_optional_var_index
	Unique indices for optionally coupled vars that weren't provided. More...

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_c_coupled_scalar_vars
	Scalar variables coupled into this object (for error checking) More...

std::set< TagID >	_fe_coupleable_vector_tags

std::set< TagID >	_fe_coupleable_matrix_tags

const bool	_is_fv
	Whether the MooseObject is a finite volume object. More...

const MooseObject *const	_obj

const std::set< std::string >	_older_state_tags
	vector tag names for which we need to request older solution states from the system More...

std::vector< std::set< MooseWritableVariable * > >	_writable_coupled_variables
	keep a set of allocated writable variable references to make sure only one object can obtain them per thread More...

const Real	_kokkos_default_value_zero = 0
	kokkos-related variables and methods More...

Detailed Description

Interface for objects that needs coupling capabilities.

Definition at line 49 of file Coupleable.h.

Member Enumeration Documentation

◆ FuncAge

enum Coupleable::FuncAge

strongprivate

Enumerator
Curr
Old
Older

Definition at line 1587 of file Coupleable.h.

   {
     Curr,
     Old,
     Older,
   };

◆ VarType

enum Coupleable::VarType

strongprivate

Enumerator
Ignore
Gradient
Second
GradientDot
Dot

Definition at line 1594 of file Coupleable.h.

   {
     Ignore,
     Gradient,
     Second,
     GradientDot,
     Dot,
   };

Constructor & Destructor Documentation

◆ Coupleable() [1/2]

Coupleable::Coupleable	(	const MooseObject *	moose_object,
		bool	nodal,
		bool	is_fv = `false`
	)

Constructing the object.

Parameters

parameters	Parameters that come from constructing the object
nodal	true if we need to couple with nodal values, otherwise false
is_fv	Whether the `MooseObject` is a finite volume object

Definition at line 27 of file Coupleable.C.

   : _c_parameters(moose_object->parameters()),
     _c_name(moose_object->name()),
     _c_type(moose_object->type()),
     _c_fe_problem(*_c_parameters.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
     _c_sys(_c_parameters.isParamValid("_sys") ? _c_parameters.get<SystemBase *>("_sys") : nullptr),
     _new_to_deprecated_coupled_vars(_c_parameters.getNewToDeprecatedVarMap()),
     _c_nodal(nodal),
     _c_is_implicit(_c_parameters.have_parameter<bool>("implicit")
                        ? _c_parameters.get<bool>("implicit")
                        : true),
     _c_allow_element_to_nodal_coupling(
         _c_parameters.have_parameter<bool>("_allow_nodal_to_elemental_coupling")
             ? _c_parameters.get<bool>("_allow_nodal_to_elemental_coupling")
             : false),
     _c_tid(_c_parameters.get<THREAD_ID>("_tid")),
     _zero(_c_fe_problem._zero[_c_tid]),
     _phi_zero(_c_fe_problem._phi_zero[_c_tid]),
     _ad_zero(_c_fe_problem._ad_zero[_c_tid]),
     _grad_zero(_c_fe_problem._grad_zero[_c_tid]),
     _ad_grad_zero(_c_fe_problem._ad_grad_zero[_c_tid]),
     _grad_phi_zero(_c_fe_problem._grad_phi_zero[_c_tid]),
     _second_zero(_c_fe_problem._second_zero[_c_tid]),
     _ad_second_zero(_c_fe_problem._ad_second_zero[_c_tid]),
     _second_phi_zero(_c_fe_problem._second_phi_zero[_c_tid]),
     _vector_zero(_c_fe_problem._vector_zero[_c_tid]),
     _vector_curl_zero(_c_fe_problem._vector_curl_zero[_c_tid]),
     _coupleable_neighbor(_c_parameters.have_parameter<bool>("_neighbor")
                              ? _c_parameters.get<bool>("_neighbor")
                              : false),
     _coupleable_max_qps(Moose::constMaxQpsPerElem),
     _is_fv(is_fv),
     _obj(moose_object),
     _writable_coupled_variables(libMesh::n_threads())
 {
   SubProblem & problem = *_c_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");
   _obj->getMooseApp().registerInterfaceObject(*this);
 
   unsigned int optional_var_index_counter = 0;
 
   // Coupling
   for (auto iter = _c_parameters.coupledVarsBegin(); iter != _c_parameters.coupledVarsEnd(); ++iter)
   {
     std::string name = *iter;
 
     std::vector<std::string> vars = _c_parameters.getVecMooseType(name);
     if (vars.size() > 0)
     {
       for (const auto & coupled_var_name : vars)
       {
         if (problem.hasVariable(coupled_var_name))
         {
           MooseVariableFieldBase * moose_var =
               &problem.getVariable(_c_tid,
                                    coupled_var_name,
                                    Moose::VarKindType::VAR_ANY,
                                    Moose::VarFieldType::VAR_FIELD_ANY);
           _coupled_vars[name].push_back(moose_var);
           _coupled_moose_vars.push_back(moose_var);
           if (auto * tmp_var = dynamic_cast<MooseVariable *>(moose_var))
             _coupled_standard_moose_vars.push_back(tmp_var);
           else if (auto * tmp_var = dynamic_cast<VectorMooseVariable *>(moose_var))
             _coupled_vector_moose_vars.push_back(tmp_var);
           else if (auto * tmp_var = dynamic_cast<ArrayMooseVariable *>(moose_var))
             _coupled_array_moose_vars.push_back(tmp_var);
           else if (auto * tmp_var = dynamic_cast<MooseVariableFV<Real> *>(moose_var))
           {
             // We are using a finite volume variable through add*CoupledVar as opposed to getFunctor
             // so we can be reasonably confident that the variable values will be obtained using
             // traditional pre-evaluation and quadrature point indexing
             tmp_var->requireQpComputations();
             _coupled_fv_moose_vars.push_back(tmp_var);
           }
           else if (auto * tmp_var = dynamic_cast<MooseLinearVariableFV<Real> *>(moose_var))
             _coupled_fv_moose_vars.push_back(tmp_var);
           else
             _obj->paramError(name, "provided c++ type for variable parameter is not supported");
         }
         else if (problem.hasScalarVariable(coupled_var_name))
         {
           MooseVariableScalar * moose_scalar_var =
               &problem.getScalarVariable(_c_tid, coupled_var_name);
           _c_coupled_scalar_vars[name].push_back(moose_scalar_var);
         }
         else
           _obj->paramError(name, "coupled variable '", coupled_var_name, "' was not found");
       }
     }
     else // This means it was optional coupling.  Let's assign a unique id to this variable
     {
       _optional_var_index[name].assign(_c_parameters.numberDefaultCoupledValues(name), 0);
       for (unsigned int j = 0; j < _optional_var_index[name].size(); ++j)
         _optional_var_index[name][j] =
             std::numeric_limits<unsigned int>::max() - optional_var_index_counter;
       ++optional_var_index_counter;
     }
   }
 }

◆ Coupleable() [2/2]

Coupleable::Coupleable	(	const Coupleable &	object,
		const Moose::Kokkos::FunctorCopy &	key
	)

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 127 of file Coupleable.C.

   : _c_parameters(object._c_parameters),
     _c_name(object._c_name),
     _c_type(object._c_type),
     _c_fe_problem(object._c_fe_problem),
     _c_sys(object._c_sys),
     _new_to_deprecated_coupled_vars(object._new_to_deprecated_coupled_vars),
     _c_nodal(object._c_nodal),
     _c_is_implicit(object._c_is_implicit),
     _c_allow_element_to_nodal_coupling(object._c_allow_element_to_nodal_coupling),
     _c_tid(object._c_tid),
     _zero(object._zero),
     _phi_zero(object._phi_zero),
     _ad_zero(object._ad_zero),
     _grad_zero(object._grad_zero),
     _ad_grad_zero(object._ad_grad_zero),
     _grad_phi_zero(object._grad_phi_zero),
     _second_zero(object._second_zero),
     _ad_second_zero(object._ad_second_zero),
     _second_phi_zero(object._second_phi_zero),
     _vector_zero(object._vector_zero),
     _vector_curl_zero(object._vector_curl_zero),
     _coupleable_neighbor(object._coupleable_neighbor),
     _coupleable_max_qps(object._coupleable_max_qps),
     _is_fv(object._is_fv),
     _obj(object._obj),
     _writable_coupled_variables(object._writable_coupled_variables)
 {
 }

Member Function Documentation

◆ adCoupledCurl()

const ADVectorVariableCurl & Coupleable::adCoupledCurl	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns curl of a coupled variable for use in objects utilizing Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to an ADVectorVariableCurl containing the curl of the coupled variable

See also: Kernel::_curl_u

Definition at line 1788 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
 
   if (!var)
     return getADDefaultCurl();
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adCurlSln();
   return var->adCurlSlnNeighbor();
 }

◆ adCoupledDofValues()

const ADVariableValue & Coupleable::adCoupledDofValues	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns DOF value of a coupled variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to an ADVariableValue for the DoFs of the coupled variable

Definition at line 2131 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return *getADDefaultValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adDofValues();
   return var->adDofValuesNeighbor();
 }

◆ adCoupledDot()

const ADVariableValue & Coupleable::adCoupledDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Time derivative of a coupled variable for ad simulations.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable

See also: Kernel::dot

Definition at line 2281 of file Coupleable.C.

Referenced by adCoupledDots().

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return *getADDefaultValue(var_name);
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->adDofValuesDot();
     return var->adUDot();
   }
   else
   {
     if (_c_nodal)
       mooseError("AD neighbor nodal dof dot not implemented");
     return var->adUDotNeighbor();
   }
 }

◆ adCoupledDotDot()

const ADVariableValue & Coupleable::adCoupledDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Second time derivative of a coupled variable for ad simulations.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to an ADVariableValue containing the second time derivative of the coupled variable

Definition at line 2304 of file Coupleable.C.

 {
   const auto * const var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return *getADDefaultValue(var_name);
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (_c_nodal)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adUDotDot();
   return var->adUDotDotNeighbor();
 }

◆ adCoupledDots()

std::vector< const ADVariableValue * > Coupleable::adCoupledDots ( const std::string & var_name ) const

protected

Returns the time derivatives for all of a coupled variable's components for ad simulations.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2784 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &adCoupledDot(var_name, comp); };
   return coupledVectorHelper<const ADVariableValue *>(var_name, func);
 }

◆ adCoupledGradient()

const ADVariableGradient & Coupleable::adCoupledGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns gradient of a coupled variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to an ADVariableGradient containing the gradient of the coupled variable

See also: Kernel::gradient

Definition at line 2222 of file Coupleable.C.

Referenced by adCoupledGradients().

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return getADDefaultGradient();
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adGradSln();
   return var->adGradSlnNeighbor();
 }

◆ adCoupledGradientDot()

const ADVariableGradient & Coupleable::adCoupledGradientDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns gradient of a coupled variable's time derivative for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to an ADVariableGradient containing the gradient of the coupled variable's time derivative

Definition at line 2239 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return getADDefaultGradient();
   checkFuncType(var_name, VarType::GradientDot, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adGradSlnDot();
   return var->adGradSlnNeighborDot();
 }

◆ adCoupledGradients()

std::vector< const ADVariableGradient * > Coupleable::adCoupledGradients ( const std::string & var_name ) const

protected

Returns the gradients for all of a coupled variable's components for use in Automatic Differentiation.

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableGradient pointers for each component of var_name

Definition at line 2763 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &adCoupledGradient(var_name, comp); };
   return coupledVectorHelper<const ADVariableGradient *>(var_name, func);
 }

◆ adCoupledLowerValue()

const ADVariableValue & Coupleable::adCoupledLowerValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns value of a coupled lower-dimensional variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 2204 of file Coupleable.C.

 {
   auto var = getVarHelper<MooseVariableFE<Real>>(var_name, comp);
 
   if (!var)
     return *getADDefaultValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("adCoupledLowerValue cannot be called in a coupleable neighbor object");
 
   if (_c_nodal)
     return var->adDofValues();
   else
     return var->adSlnLower();
 }

◆ adCoupledNodalValue()

template<typename T >

template const ADRealVectorValue & Coupleable::adCoupledNodalValue< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns AD nodal values of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 2162 of file Coupleable.C.

 {
   static const typename Moose::ADType<T>::type zero = 0;
   if (!isCoupled(var_name))
     return zero;
 
   if (!_c_nodal)
     mooseError("The adCoupledNodalValue method should only be called for nodal computing objects");
   if (_coupleable_neighbor)
     mooseError(
         "The adCoupledNodalValue method shouldn't be called for neighbor computing objects. I "
         "don't even know what that would mean, although maybe someone could explain it to me.");
   if (!_c_is_implicit)
     mooseError("If you're going to use an explicit scheme, then use coupledNodalValue instead of "
                "adCoupledNodalValue");
 
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
 
   return var->adNodalValue();
 }

◆ adCoupledSecond()

const ADVariableSecond & Coupleable::adCoupledSecond	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns second derivatives of a coupled variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableSecond containing the second derivatives of the coupled variable

Definition at line 2256 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return getADDefaultSecond();
   checkFuncType(var_name, VarType::Second, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adSecondSln();
   else
     return var->adSecondSlnNeighbor();
 }

◆ adCoupledValue()

const ADVariableValue & Coupleable::adCoupledValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns value of a coupled variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 2184 of file Coupleable.C.

Referenced by adCoupledValues().

 {
   const auto * const var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
 
   if (!var)
     return *getADDefaultValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (_c_nodal)
     return var->adDofValues();
 
   if (!_coupleable_neighbor)
     return var->adSln();
   return var->adSlnNeighbor();
 }

◆ adCoupledValues()

std::vector< const ADVariableValue * > Coupleable::adCoupledValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled variable's components for use in Automatic Differentiation.

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableValue pointers for each component of var_name

Definition at line 2566 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &adCoupledValue(var_name, comp); };
   return coupledVectorHelper<const ADVariableValue *>(var_name, func);
 }

◆ adCoupledVectorDot()

const ADVectorVariableValue & Coupleable::adCoupledVectorDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Time derivative of a vector coupled variable for ad simulations.

Parameters

var_name	Name of vector coupled variable
comp	Component number

Returns: Reference to a VectorVariableValue containing the time derivative of the coupled variable

See also: Kernel::dot

Definition at line 2321 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getADDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (_c_nodal)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adUDot();
   return var->adUDotNeighbor();
 }

◆ adCoupledVectorGradient()

const ADVectorVariableGradient & Coupleable::adCoupledVectorGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns gradient of a coupled vector variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableGradient containing the gradient of the coupled variable

See also: Kernel::gradient

Definition at line 2355 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return getADDefaultVectorGradient();
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adGradSln();
   return var->adGradSlnNeighbor();
 }

◆ adCoupledVectorSecond()

const ADVectorVariableSecond& Coupleable::adCoupledVectorSecond	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns second derivatives of a coupled vector variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableSecond containing the second derivatives of the coupled variable

◆ adCoupledVectorValue()

const ADVectorVariableValue & Coupleable::adCoupledVectorValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns value of a coupled vector variable for use in Automatic Differentiation.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::value

Definition at line 2337 of file Coupleable.C.

Referenced by adCoupledVectorValues().

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getADDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (_c_nodal)
     mooseError("Not implemented");
   if (!_c_is_implicit)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adSln();
   return var->adSlnNeighbor();
 }

◆ adCoupledVectorValues()

std::vector< const ADVectorVariableValue * > Coupleable::adCoupledVectorValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled vector variable's components for use in Automatic Differentiation.

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableValue pointers for each component of var_name

Definition at line 2573 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp)
   { return &adCoupledVectorValue(var_name, comp); };
   return coupledVectorHelper<const ADVectorVariableValue *>(var_name, func);
 }

◆ addFEVariableCoupleableMatrixTag()

void Coupleable::addFEVariableCoupleableMatrixTag ( TagID tag )

inline

Definition at line 115 of file Coupleable.h.

Referenced by coupledMatrixTagValue().

115 { _fe_coupleable_matrix_tags.insert(tag); }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1809

◆ addFEVariableCoupleableVectorTag()

void Coupleable::addFEVariableCoupleableVectorTag ( TagID tag )

inline

Definition at line 113 of file Coupleable.h.

Referenced by coupledVectorTagArrayGradient(), coupledVectorTagGradient(), vectorTagDofValueHelper(), and vectorTagValueHelper().

113 { _fe_coupleable_vector_tags.insert(tag); }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1807

◆ adZeroGradient()

const ADVariableGradient & Coupleable::adZeroGradient ( ) const

protected

method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects

Definition at line 2437 of file Coupleable.C.

 {
   mooseDeprecated("Method adZeroGradient() is deprecated. Use '_ad_grad_zero' instead.");
   return _ad_grad_zero;
 }

◆ adZeroSecond()

const ADVariableSecond & Coupleable::adZeroSecond ( ) const

protected

Retrieve a zero second for automatic differentiation.

Definition at line 2444 of file Coupleable.C.

 {
   mooseDeprecated("Method adZeroSecond() is deprecated. Use '_ad_second_zero' instead.");
   return _ad_second_zero;
 }

◆ adZeroValue()

const ADVariableValue & Coupleable::adZeroValue ( ) const

protected

method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects

Definition at line 2430 of file Coupleable.C.

 {
   mooseDeprecated("Method adZeroValue() is deprecated. Use '_ad_zero' instead.");
   return _ad_zero;
 }

◆ checkFuncType()

void Coupleable::checkFuncType	(	const std::string	var_name,
		VarType	t,
		FuncAge	age
	)		const

private

Definition at line 222 of file Coupleable.C.

Referenced by adCoupledCurl(), adCoupledDofValues(), adCoupledDot(), adCoupledDotDot(), adCoupledGradient(), adCoupledGradientDot(), adCoupledLowerValue(), adCoupledSecond(), adCoupledValue(), adCoupledVectorDot(), adCoupledVectorGradient(), adCoupledVectorValue(), coupled(), coupledArrayDofValues(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), coupledArrayGradientOlder(), coupledArrayValue(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), coupledDiv(), coupledDivOld(), coupledDivOlder(), coupledDofValues(), coupledDofValuesOld(), coupledDofValuesOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledGradient(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), coupledGradientPreviousNL(), coupledMatrixTagValue(), coupledNodalDot(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledNodalValue(), coupledNodalValueOld(), coupledNodalValueOlder(), coupledNodalValuePreviousNL(), coupledSecond(), coupledSecondOld(), coupledSecondOlder(), coupledSecondPreviousNL(), coupledValue(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), coupledVectorTagArrayGradient(), coupledVectorTagGradient(), coupledVectorValue(), coupledVectorValueOld(), coupledVectorValueOlder(), vectorTagDofValueHelper(), and vectorTagValueHelper().

 {
   if (t == VarType::Gradient && _c_nodal)
     mooseError(_c_name, ": nodal variables do not have gradients at nodes");
 
   if (age == FuncAge::Old || age == FuncAge::Older || t == VarType::GradientDot ||
       t == VarType::Dot)
     validateExecutionerType(var_name, "coupled[Vector][Gradient/Dot]Old[er]");
   if (age == FuncAge::Older && !_c_is_implicit)
     mooseError("object '",
                _c_name,
                "' uses older variable values that are unavailable with explicit schemes");
 
   coupledCallback(var_name, age == FuncAge::Old || age == FuncAge::Older);
 }

◆ checkVar()

bool Coupleable::checkVar	(	const std::string &	var_name,
		unsigned int	comp = `0`,
		unsigned int	comp_bound = `0`
	)		const

protected

Check that the right kind of variable is being coupled in.

Parameters

var_name The name of the coupled variable

Definition at line 239 of file Coupleable.C.

Referenced by getVarHelper().

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
   auto it = _c_coupled_scalar_vars.find(var_name);
   if (it != _c_coupled_scalar_vars.end())
   {
     std::string cvars;
     for (auto jt : it->second)
       cvars += " " + jt->name();
 
     _obj->paramError(var_name,
                      "cannot couple '",
                      var_name,
                      "' to a scalar variable (",
                      cvars,
                      ") where field variable is expected");
   }
 
   if (!isCoupled(var_name, comp))
     return false; // return false since variable is *not* coupled
 
   auto vars_vector_it = _coupled_vars.find(var_name);
   if (vars_vector_it == _coupled_vars.end())
     mooseError(_c_name, ": Trying to get a coupled var ", var_name, " that doesn't exist");
 
   const auto & vars_vector = vars_vector_it->second;
 
   auto bound = comp_bound ? comp_bound : vars_vector.size();
   checkComponent(_obj, comp, bound, var_name);
 
   // We should know we have a variable now
   const auto * var = vars_vector[comp];
   if (!var)
     mooseError(
         _c_name,
         ": We did all our checks for the existence of a var, yet we still don't have a var!?");
 
   // Only perform the following checks for objects that feed into residuals/Jacobians, e.g. objects
   // that inherit from the TaggingInterface
   if (_c_parameters.have_parameter<MultiMooseEnum>("vector_tags"))
   {
     // Are we attempting to couple to a non-FV var in an FV object?
     if (!var->isFV() && _is_fv)
       mooseError("Attempting to couple non-FV variable ",
                  var->name(),
                  " into an FV object ",
                  _c_name,
                  ". This is not currently supported");
   }
 
   if (!(vars_vector[comp])->isNodal() && _c_nodal && !_c_allow_element_to_nodal_coupling)
     mooseError(_c_name, ": cannot couple elemental variables into nodal objects");
 
   return true;
 }

◆ checkWritableVar()

void Coupleable::checkWritableVar ( MooseWritableVariable * var )

protected

Checks that the passed in variable is only accessed writable by one object in a given subdomain.

Definition at line 982 of file Coupleable.C.

Referenced by writableCoupledValue(), and writableVariable().

 {
   // check domain restrictions for compatibility
   const auto * br = dynamic_cast<const BlockRestrictable *>(this);
   const auto * nfc = dynamic_cast<const NodeFaceConstraint *>(this);
 
   if (br && !var->hasBlocks(br->blockIDs()))
     mooseError("The variable '",
                var->name(),
                "' must be defined on all blocks '",
                _obj->name(),
                "' is defined on.");
 
   if (nfc && !var->hasBlocks(nfc->getSecondaryConnectedBlocks()))
     mooseError("The variable '",
                var->name(),
                " must be defined on all blocks '",
                _obj->name(),
                "'s secondary surface is defined on.");
 
   // make sure only one object can access a variable
   for (const auto & ci : _obj->getMooseApp().getInterfaceObjects<Coupleable>())
     if (ci != this && ci->_writable_coupled_variables[_c_tid].count(var))
     {
       // if both this and ci are block restrictable then we check if the block restrictions
       // are not overlapping. If they don't we permit the call.
       const auto * br_other = dynamic_cast<const BlockRestrictable *>(ci);
       if (br && br_other && br->blockRestricted() && br_other->blockRestricted() &&
           !MooseUtils::setsIntersect(br->blockIDs(), br_other->blockIDs()))
         continue;
       else if (nfc)
         continue;
 
       mooseError("'",
                  ci->_obj->name(),
                  "' already obtained a writable reference to '",
                  var->name(),
                  "'. Only one object can obtain such a reference per variable and subdomain in a "
                  "simulation.");
     }
 
   // var is unique across threads, so we could forego having a separate set per thread, but we
   // need quick access to the list of all variables that need to be inserted into the solution
   // vector by a given thread.
 
   _writable_coupled_variables[_c_tid].insert(var);
 }

◆ coupled()

unsigned int Coupleable::coupled	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns the index for a coupled variable by name.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Index of coupled variable, if this is an optionally coupled variable that wasn't provided this will return a unique "invalid" index.

Reimplemented in ShapeUserObject< ElementUserObject >, and ShapeUserObject< SideUserObject >.

Definition at line 472 of file Coupleable.C.

Referenced by coupledIndices(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), and KernelBase::KernelBase().

 {
   const auto * var = getFieldVar(var_name, comp);
   if (!var)
   {
     mooseAssert(_optional_var_index.find(var_name) != _optional_var_index.end(),
                 "optional var index for " << var_name << " does not exist!");
     // make sure we don't try to access default var ids that were not provided
     checkComponent(_obj, comp, _optional_var_index.at(var_name).size(), var_name);
     return _optional_var_index.at(var_name)[comp];
   }
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (var->kind() == Moose::VAR_SOLVER &&
       // are we not an object that feeds into the nonlinear system?
       (!_c_sys || _c_sys->varKind() != Moose::VAR_SOLVER ||
        // are we an object that impacts the nonlinear system and this variable is within our
        // nonlinear system?
        var->sys().number() == _c_sys->number()))
     return var->number();
   else
     // Avoid registering coupling to variables outside of our system (e.g. avoid potentially
     // creating bad Jacobians)
     return std::numeric_limits<unsigned int>::max() - var->number();
 }

◆ coupledAllDofValues()

std::vector< const VariableValue * > Coupleable::coupledAllDofValues ( const std::string & var_name ) const

protected

Returns DoFs in the current solution vector of all of a coupled variable's components for the local element.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of the coupled variable

Definition at line 2070 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledDofValues(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledAllDofValuesOld()

std::vector< const VariableValue * > Coupleable::coupledAllDofValuesOld ( const std::string & var_name ) const

protected

Returns DoFs in the old solution vector of all of a coupled variable's components for the local element.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each compontnet of the coupled variable

Definition at line 2090 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledDofValuesOld(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledAllDofValuesOlder()

std::vector< const VariableValue * > Coupleable::coupledAllDofValuesOlder ( const std::string & var_name ) const

protected

Returns DoFs in the older solution vector of all of a coupled variable's components for the local element.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of the coupled variable

Definition at line 2110 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp)
   { return &coupledDofValuesOlder(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledArrayDofValues()

const ArrayVariableValue & Coupleable::coupledArrayDofValues	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns DoFs in the current solution vector of a coupled array variable for the local element.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a VariableValue for the DoFs of the coupled variable

Definition at line 2118 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return *getDefaultArrayValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
   return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
 }

◆ coupledArrayDot()

const ArrayVariableValue & Coupleable::coupledArrayDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 1380 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_value_zero;
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDot();
     return var->uDot();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotNeighbor();
     return var->uDotNeighbor();
   }
 }

◆ coupledArrayDotDot()

const ArrayVariableValue & Coupleable::coupledArrayDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 1402 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_value_zero;
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotDot();
     return var->uDotDot();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotDotNeighbor();
     return var->uDotDotNeighbor();
   }
 }

◆ coupledArrayDotDotOld()

const ArrayVariableValue & Coupleable::coupledArrayDotDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old second time derivative of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 1446 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_value_zero;
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotDotOld();
     return var->uDotDotOld();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotDotOldNeighbor();
     return var->uDotDotOldNeighbor();
   }
 }

◆ coupledArrayDotDu()

const VariableValue & Coupleable::coupledArrayDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Time derivative of a coupled array variable with respect to the coefficients.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 1518 of file Coupleable.C.

 {
   const auto * const var = getArrayVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDuDotDu();
     return var->duDotDu();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDuDotDuNeighbor();
     return var->duDotDuNeighbor();
   }
 }

◆ coupledArrayDotOld()

const ArrayVariableValue & Coupleable::coupledArrayDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old time derivative of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 1424 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_value_zero;
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotOld();
     return var->uDotOld();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotOldNeighbor();
     return var->uDotOldNeighbor();
   }
 }

◆ coupledArrayGradient()

const ArrayVariableGradient & Coupleable::coupledArrayGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns gradient of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a VectorVariableGradient containing the gradient of the coupled array variable

Definition at line 1688 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_gradient;
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
   return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
 }

◆ coupledArrayGradientDot()

const ArrayVariableGradient & Coupleable::coupledArrayGradientDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Retun a gradient of a coupled array variable's time derivative.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableGradient containing the gradient of the time derivative the coupled array variable

Definition at line 1727 of file Coupleable.C.

 {
   const auto * const var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_gradient;
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->gradSlnDot();
   return var->gradSlnNeighborDot();
 }

◆ coupledArrayGradientOld()

const ArrayVariableGradient & Coupleable::coupledArrayGradientOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from previous time step of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a VectorVariableGradient containing the old gradient of the coupled array variable

Definition at line 1701 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_gradient;
   checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
   return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
 }

◆ coupledArrayGradientOlder()

const ArrayVariableGradient & Coupleable::coupledArrayGradientOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from two time steps previous of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableGradient containing the older gradient of the coupled array variable

Definition at line 1714 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return _default_array_gradient;
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->gradSlnOlder();
   return var->gradSlnOlderNeighbor();
 }

◆ coupledArrayValue()

const ArrayVariableValue & Coupleable::coupledArrayValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns value of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue for the coupled vector variable

See also: ArrayKernel::_u

Definition at line 879 of file Coupleable.C.

Referenced by coupledArrayValues().

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return *getDefaultArrayValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
     return (_c_is_implicit) ? var->sln() : var->slnOld();
   }
   else
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
     return (_c_is_implicit) ? var->slnNeighbor() : var->slnOldNeighbor();
   }
 }

◆ coupledArrayValueOld()

const ArrayVariableValue & Coupleable::coupledArrayValueOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from previous time step of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the old value of the coupled variable

See also: ArrayKernel::_u_old

Definition at line 1126 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return *getDefaultArrayValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
     return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
   }
   else
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
     return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
   }
 }

◆ coupledArrayValueOlder()

const ArrayVariableValue & Coupleable::coupledArrayValueOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from two time steps previous of a coupled array variable.

Parameters

var_name	Name of coupled array variable
comp	Component number for vector of coupled array variables

Returns: Reference to a ArrayVariableValue containing the older value of the coupled variable

See also: ArrayKernel::_u_older

Definition at line 1148 of file Coupleable.C.

 {
   const auto * var = getArrayVar(var_name, comp);
   if (!var)
     return *getDefaultArrayValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesOlder();
     return var->slnOlder();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesOlderNeighbor();
     return var->slnOlderNeighbor();
   }
 }

◆ coupledArrayValues()

std::vector< const ArrayVariableValue * > Coupleable::coupledArrayValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled array variable's components.

Parameters

var_name Name of coupled array variable

Returns: Vector of ArrayVariableValue pointers for each component of var_name

Definition at line 901 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledArrayValue(var_name, comp); };
   return coupledVectorHelper<const ArrayVariableValue *>(var_name, func);
 }

◆ coupledCallback()

virtual void Coupleable::coupledCallback	(	const std::string &	,
		bool
	)		const

inlineprotectedvirtual

A call-back function provided by the derived object for actions before coupling a variable with functions such as coupledValue.

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, and AuxKernelTempl< Real >.

Definition at line 146 of file Coupleable.h.

Referenced by checkFuncType().

146 {}

◆ coupledComponents()

unsigned int Coupleable::coupledComponents ( const std::string & var_name ) const

protected

Number of coupled components.

Parameters

var_name Name of the variable

Returns: number of components this variable has (usually 1)

Definition at line 188 of file Coupleable.C.

Referenced by coupledVectorHelper(), KernelBase::KernelBase(), SpatialAverageBase::SpatialAverageBase(), and VariableValueVolumeHistogram::VariableValueVolumeHistogram().

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
 
   if (isCoupled(var_name))
   {
     mooseAssert(_coupled_vars.find(var_name) != _coupled_vars.end(),
                 var_name << " must not actually be coupled!");
     return _coupled_vars.at(var_name).size();
   }
   else
   {
     if (_c_parameters.hasDefaultCoupledValue(var_name))
       return _c_parameters.numberDefaultCoupledValues(var_name);
     else
       return 0;
   }
 }

◆ coupledCurl()

const VectorVariableCurl & Coupleable::coupledCurl	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns curl of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableCurl containing the curl of the coupled variable

See also: Kernel::_curl_u

Definition at line 1740 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_curl.resize(_coupleable_max_qps);
     return _default_vector_curl;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->curlSln() : var->curlSlnOld();
   return (_c_is_implicit) ? var->curlSlnNeighbor() : var->curlSlnOldNeighbor();
 }

◆ coupledCurlOld()

const VectorVariableCurl & Coupleable::coupledCurlOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old curl from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableCurl containing the old curl of the coupled variable

See also: Kernel::_curl_u_old

Definition at line 1756 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_curl.resize(_coupleable_max_qps);
     return _default_vector_curl;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->curlSlnOld() : var->curlSlnOlder();
   return (_c_is_implicit) ? var->curlSlnOldNeighbor() : var->curlSlnOlderNeighbor();
 }

◆ coupledCurlOlder()

const VectorVariableCurl & Coupleable::coupledCurlOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old curl from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableCurl containing the older curl of the coupled variable

See also: Kernel::_curl_u_older

Definition at line 1772 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_curl.resize(_coupleable_max_qps);
     return _default_vector_curl;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->curlSlnOlder();
   return var->curlSlnOlderNeighbor();
 }

◆ coupledDiv()

const VectorVariableDivergence & Coupleable::coupledDiv	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns divergence of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableDivergence containing the divergence of the coupled variable

See also: Kernel::_div_u

Definition at line 1805 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_div.resize(_coupleable_max_qps);
     return _default_div;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->divSln() : var->divSlnOld();
   return (_c_is_implicit) ? var->divSlnNeighbor() : var->divSlnOldNeighbor();
 }

◆ coupledDivOld()

const VectorVariableDivergence & Coupleable::coupledDivOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old divergence from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableDivergence containing the old divergence of the coupled variable

See also: Kernel::_div_u_old

Definition at line 1821 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_div.resize(_coupleable_max_qps);
     return _default_div;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->divSlnOld() : var->divSlnOlder();
   return (_c_is_implicit) ? var->divSlnOldNeighbor() : var->divSlnOlderNeighbor();
 }

◆ coupledDivOlder()

const VectorVariableDivergence & Coupleable::coupledDivOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old divergence from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableDivergence containing the older divergence of the coupled variable

See also: Kernel::_div_u_older

Definition at line 1837 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_div.resize(_coupleable_max_qps);
     return _default_div;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->divSlnOlder();
   return var->divSlnOlderNeighbor();
 }

◆ coupledDofValues()

const VariableValue & Coupleable::coupledDofValues	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns DoFs in the current solution vector of a coupled variable for the local element.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the DoFs of the coupled variable

Definition at line 2057 of file Coupleable.C.

Referenced by coupledAllDofValues().

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
   return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
 }

◆ coupledDofValuesOld()

const VariableValue & Coupleable::coupledDofValuesOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns DoFs in the old solution vector of a coupled variable for the local element.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the old DoFs of the coupled variable

Definition at line 2077 of file Coupleable.C.

Referenced by coupledAllDofValuesOld().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
   return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
 }

◆ coupledDofValuesOlder()

const VariableValue & Coupleable::coupledDofValuesOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns DoFs in the older solution vector of a coupled variable for the local element.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the older DoFs of the coupled variable

Definition at line 2097 of file Coupleable.C.

Referenced by coupledAllDofValuesOlder().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->dofValuesOlder();
   return var->dofValuesOlderNeighbor();
 }

◆ coupledDot()

const VariableValue & Coupleable::coupledDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, and AuxKernelTempl< Real >.

Definition at line 1170 of file Coupleable.C.

Referenced by AuxKernelTempl< Real >::coupledDot(), and coupledDots().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDot();
     return var->uDot();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotNeighbor();
     return var->uDotNeighbor();
   }
 }

◆ coupledDotDot()

const VariableValue & Coupleable::coupledDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the second time derivative of the coupled variable

Definition at line 1195 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotDot();
     return var->uDotDot();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotDotNeighbor();
     return var->uDotDotNeighbor();
   }
 }

◆ coupledDotDotDu()

const VariableValue & Coupleable::coupledDotDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of a coupled variable with respect to the coefficients.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Definition at line 1493 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDuDotDotDu();
     return var->duDotDotDu();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDuDotDotDuNeighbor();
     return var->duDotDotDuNeighbor();
   }
 }

◆ coupledDotDotOld()

const VariableValue & Coupleable::coupledDotDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old second time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the old second time derivative of the coupled variable

Definition at line 1259 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotDotOld();
     return var->uDotDotOld();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotDotOldNeighbor();
     return var->uDotDotOldNeighbor();
   }
 }

◆ coupledDotDu()

const VariableValue & Coupleable::coupledDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of a coupled variable with respect to the coefficients.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, and AuxKernelTempl< Real >.

Definition at line 1468 of file Coupleable.C.

Referenced by AuxKernelTempl< Real >::coupledDotDu().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDuDotDu();
     return var->duDotDu();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDuDotDuNeighbor();
     return var->duDotDuNeighbor();
   }
 }

◆ coupledDotOld()

const VariableValue & Coupleable::coupledDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the old time derivative of the coupled variable

Definition at line 1234 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesDotOld();
     return var->uDotOld();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesDotOldNeighbor();
     return var->uDotOldNeighbor();
   }
 }

◆ coupledDots()

std::vector< const VariableValue * > Coupleable::coupledDots ( const std::string & var_name ) const

protected

Returns the time derivatives for all of a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2777 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledDot(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledGenericDofValue() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::coupledGenericDofValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns DOF value of a coupled variable for use in templated automatic differentiation classes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a GenericVariableValue for the coupled variable

◆ coupledGenericDofValue() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::coupledGenericDofValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 619 of file Coupleable.C.

 {
   return coupledDofValues(var_name, comp);
 }

◆ coupledGenericDofValue() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::coupledGenericDofValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 626 of file Coupleable.C.

 {
   return adCoupledDofValues(var_name, comp);
 }

◆ coupledGenericDot() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::coupledGenericDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns time derivative of a coupled variable for use in templated automatic differentiation classes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a GenericVariableValue for the coupled variable time derivative

◆ coupledGenericDot() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::coupledGenericDot	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 2792 of file Coupleable.C.

 {
   return coupledDot(var_name, comp);
 }

◆ coupledGenericDot() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::coupledGenericDot	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 2799 of file Coupleable.C.

 {
   return adCoupledDot(var_name, comp);
 }

◆ coupledGenericDotDot() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::coupledGenericDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns the second time derivative of a coupled variable for use in templated automatic differentiation classes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a GenericVariableValue for the coupled variable second time derivative

◆ coupledGenericDotDot() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::coupledGenericDotDot	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 1221 of file Coupleable.C.

 {
   return coupledDotDot(var_name, comp);
 }

◆ coupledGenericDotDot() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::coupledGenericDotDot	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 1228 of file Coupleable.C.

 {
   return adCoupledDotDot(var_name, comp);
 }

◆ coupledGenericGradient() [1/3]

template<bool is_ad>

const GenericVariableGradient<is_ad>& Coupleable::coupledGenericGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns gradient of a coupled variable for use in templated automatic differentiation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the gradient of the coupled variable

See also: Kernel::gradient

◆ coupledGenericGradient() [2/3]

template<>

const GenericVariableGradient<false>& Coupleable::coupledGenericGradient	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 2494 of file Coupleable.C.

 {
   return coupledGradient(var_name, comp);
 }

◆ coupledGenericGradient() [3/3]

template<>

const GenericVariableGradient<true>& Coupleable::coupledGenericGradient	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 2501 of file Coupleable.C.

 {
   return adCoupledGradient(var_name, comp);
 }

◆ coupledGenericGradients() [1/3]

template<bool is_ad>

std::vector<const GenericVariableGradient<is_ad> *> Coupleable::coupledGenericGradients ( const std::string & var_name ) const

protected

Returns the gradients for all of a coupled variable's components for use in templated automatic differentiation.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

◆ coupledGenericGradients() [2/3]

template<>

std::vector<const GenericVariableGradient<true> *> Coupleable::coupledGenericGradients ( const std::string & var_name ) const

protected

Definition at line 2756 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &adCoupledGradient(var_name, comp); };
   return coupledVectorHelper<const GenericVariableGradient<true> *>(var_name, func);
 }

◆ coupledGenericGradients() [3/3]

template<>

std::vector<const GenericVariableGradient<false> *> Coupleable::coupledGenericGradients ( const std::string & var_name ) const

protected

Definition at line 2749 of file Coupleable.C.

 {
   return coupledGradients(var_name);
 }

◆ coupledGenericValue() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::coupledGenericValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns value of a coupled variable for use in templated automatic differentiation classes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a GenericVariableValue for the coupled variable

◆ coupledGenericValue() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::coupledGenericValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 500 of file Coupleable.C.

 {
   return coupledValue(var_name, comp);
 }

◆ coupledGenericValue() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::coupledGenericValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 507 of file Coupleable.C.

 {
   return adCoupledValue(var_name, comp);
 }

◆ coupledGenericValues() [1/3]

template<bool is_ad>

std::vector<const GenericVariableValue<is_ad> *> Coupleable::coupledGenericValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled variable's components for use in templated automatic differentiation classes.

Parameters

var_name Name of coupled variable

Returns: Vector of GenericVariableValue pointers for each component of var_name

◆ coupledGenericValues() [2/3]

template<>

std::vector<const GenericVariableValue<false> *> Coupleable::coupledGenericValues ( const std::string & var_name ) const

protected

Definition at line 2553 of file Coupleable.C.

 {
   return coupledValues(var_name);
 }

◆ coupledGenericValues() [3/3]

template<>

std::vector<const GenericVariableValue<true> *> Coupleable::coupledGenericValues ( const std::string & var_name ) const

protected

Definition at line 2560 of file Coupleable.C.

 {
   return adCoupledValues(var_name);
 }

◆ coupledGenericVectorValue() [1/3]

template<bool is_ad>

const GenericVectorVariableValue<is_ad>& Coupleable::coupledGenericVectorValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns value of a coupled vector variable for use in templated automatic differentiation classes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a GenericVariableVectorValue for the coupled variable

◆ coupledGenericVectorValue() [2/3]

template<>

const GenericVectorVariableValue<false>& Coupleable::coupledGenericVectorValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 514 of file Coupleable.C.

 {
   return coupledVectorValue(var_name, comp);
 }

◆ coupledGenericVectorValue() [3/3]

template<>

const GenericVectorVariableValue<true>& Coupleable::coupledGenericVectorValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 521 of file Coupleable.C.

 {
   return adCoupledVectorValue(var_name, comp);
 }

◆ coupledGradient()

const VariableGradient & Coupleable::coupledGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns gradient of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the gradient of the coupled variable

See also: Kernel::gradient

Definition at line 1543 of file Coupleable.C.

Referenced by coupledGradients(), and NodeFaceConstraint::coupledSecondaryGradient().

 {
   const auto * const var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
   return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
 }

◆ coupledGradientDot()

const VariableGradient & Coupleable::coupledGradientDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of the gradient of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the time derivative of the gradient of a coupled variable

Definition at line 1608 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::GradientDot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->gradSlnDot();
   return var->gradSlnNeighborDot();
 }

◆ coupledGradientDotDot()

const VariableGradient & Coupleable::coupledGradientDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of the gradient of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the time derivative of the gradient of a coupled variable

Definition at line 1624 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::GradientDot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->gradSlnDotDot();
   return var->gradSlnNeighborDotDot();
 }

◆ coupledGradientOld()

const VariableGradient & Coupleable::coupledGradientOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the old gradient of the coupled variable

See also: Kernel::gradientOld

Definition at line 1559 of file Coupleable.C.

Referenced by coupledGradientsOld(), and NodeFaceConstraint::coupledSecondaryGradientOld().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
   return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
 }

◆ coupledGradientOlder()

const VariableGradient & Coupleable::coupledGradientOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the older gradient of the coupled variable

See also: Kernel::gradientOlder

Definition at line 1575 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondaryGradientOlder().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->gradSlnOlder();
   return var->gradSlnOlderNeighbor();
 }

◆ coupledGradientPreviousNL()

const VariableGradient & Coupleable::coupledGradientPreviousNL	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns gradient of a coupled variable for previous Newton iterate.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableGradient containing the gradient of the coupled variable

Definition at line 1591 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   _c_fe_problem.needsPreviousNewtonIteration(true);
   if (!var)
   {
     _default_gradient.resize(_coupleable_max_qps);
     return _default_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->gradSlnPreviousNL();
   return var->gradSlnPreviousNLNeighbor();
 }

◆ coupledGradients()

std::vector< const VariableGradient * > Coupleable::coupledGradients ( const std::string & var_name ) const

protected

Returns the gradients for all of a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

Definition at line 2741 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledGradient(var_name, comp); };
   return coupledVectorHelper<const VariableGradient *>(var_name, func);
 }

◆ coupledGradientsOld()

std::vector< const VariableGradient * > Coupleable::coupledGradientsOld ( const std::string & var_name ) const

protected

Returns the old gradients for all of a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

Definition at line 2770 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledGradientOld(var_name, comp); };
   return coupledVectorHelper<const VariableGradient *>(var_name, func);
 }

◆ coupledIndices()

std::vector< unsigned int > Coupleable::coupledIndices ( const std::string & var_name ) const

protected

Returns the indices for a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of the indices for all components of the coupled variable var_name.

Definition at line 2507 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return coupled(var_name, comp); };
   return coupledVectorHelper<unsigned int>(var_name, func);
 }

◆ coupledMatrixTagValue() [1/2]

const VariableValue & Coupleable::coupledMatrixTagValue	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns value of a coupled variable for a given tag.

This couples the diag vector of matrix

Parameters

var_names	Name(s) of coupled variable(s)
tag	matrix tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 821 of file Coupleable.C.

Referenced by coupledMatrixTagValue(), and coupledMatrixTagValues().

 {
   const auto * var = getVarHelper<MooseVariableField<Real>>(var_names, index);
   if (!var)
     mooseError(var_names, ": invalid variable name for coupledMatrixTagValue");
   checkFuncType(var_names, VarType::Ignore, FuncAge::Curr);
 
   const_cast<Coupleable *>(this)->addFEVariableCoupleableMatrixTag(tag);
 
   if (_c_nodal)
     return var->nodalMatrixTagValue(tag);
   return var->matrixTagValue(tag);
 }

◆ coupledMatrixTagValue() [2/2]

const VariableValue & Coupleable::coupledMatrixTagValue	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 838 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.matrixTagExists(tagname))
     mooseError("Matrix tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getMatrixTagID(tagname);
   return coupledMatrixTagValue(var_names, tag, index);
 }

◆ coupledMatrixTagValues() [1/2]

std::vector< const VariableValue * > Coupleable::coupledMatrixTagValues	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns the diagonal matrix values for all the coupled variables desired for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	matrix tag ID

Returns: Vector of VariableValue pointers for each variable in var_name

Definition at line 2696 of file Coupleable.C.

Referenced by coupledMatrixTagValues().

 {
   auto func = [this, &var_names, &tag](unsigned int comp)
   { return &coupledMatrixTagValue(var_names, tag, comp); };
   return coupledVectorHelper<const VariableValue *>(var_names, func);
 }

◆ coupledMatrixTagValues() [2/2]

std::vector< const VariableValue * > Coupleable::coupledMatrixTagValues	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2704 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.matrixTagExists(tagname))
     mooseError("Matrix tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getMatrixTagID(tagname);
   return coupledMatrixTagValues(var_names, tag);
 }

◆ coupledName()

VariableName Coupleable::coupledName	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Names of the variable in the Coupleable interface.

Parameters

var_name	Name of the variable
comp	the component of the variable

Returns: name the variable has been coupled as. For constants, returns the constant

Definition at line 2514 of file Coupleable.C.

Referenced by coupledNames(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), and SpatialAverageBase::SpatialAverageBase().

 {
   if (getFieldVar(var_name, comp))
     return getFieldVar(var_name, comp)->name();
   // Detect if we are in the case where a constant was passed in lieu of a variable
   else if (isCoupledConstant(var_name))
     mooseError(_c_name,
                ": a variable name was queried but a constant was passed for parameter '",
                var_name,
                "Either pass a true variable or contact a developer to shield the call to "
                "'coupledName' with 'isCoupledConstant'");
   else
     mooseError(
         _c_name, ": Variable '", var_name, "' does not exist, yet its coupled name is requested");
 }

◆ coupledNames()

std::vector< VariableName > Coupleable::coupledNames ( const std::string & var_name ) const

protected

Names of the variables in the Coupleable interface.

Parameters

var_name Names of the variables

Returns: names the variables have been coupled as

Definition at line 2531 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return coupledName(var_name, comp); };
   return coupledVectorHelper<VariableName>(var_name, func);
 }

◆ coupledNodalDot()

template<typename T >

template const RealVectorValue & Coupleable::coupledNodalDot< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Nodal values of time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the nodal values of time derivative of the coupled variable

Definition at line 1995 of file Coupleable.C.

 {
   static const T zero = 0;
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
   if (!var)
     return zero;
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->nodalValueDot();
   mooseError("Neighbor version not implemented");
 }

◆ coupledNodalDotDot()

const VariableValue & Coupleable::coupledNodalDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Nodal values of second time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the nodal values of second time derivative of the coupled variable

Definition at line 2009 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->dofValuesDotDot();
   return var->dofValuesDotDotNeighbor();
 }

◆ coupledNodalDotDotOld()

const VariableValue & Coupleable::coupledNodalDotDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Nodal values of old second time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the nodal values of second time derivative of the coupled variable

Definition at line 2041 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return var->dofValuesDotDotOld();
   return var->dofValuesDotDotOldNeighbor();
 }

◆ coupledNodalDotOld()

const VariableValue & Coupleable::coupledNodalDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Nodal values of old time derivative of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the nodal values of time derivative of the coupled variable

Definition at line 2025 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return var->dofValuesDotOld();
   return var->dofValuesDotOldNeighbor();
 }

◆ coupledNodalValue()

template<typename T >

template const RealVectorValue & Coupleable::coupledNodalValue< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns nodal values of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 1919 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
   if (!var)
     return getDefaultNodalValue<T>(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!var->isNodal())
     mooseError(_c_name,
                ": Trying to get nodal values of variable '",
                var->name(),
                "', but it is not nodal.");
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->nodalValue() : var->nodalValueOld();
   return (_c_is_implicit) ? var->nodalValueNeighbor() : var->nodalValueOldNeighbor();
 }

◆ coupledNodalValueOld()

template<typename T >

template const RealVectorValue & Coupleable::coupledNodalValueOld< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns an old nodal value from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the old value of the coupled variable

Definition at line 1939 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
   if (!var)
     return getDefaultNodalValue<T>(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (!var->isNodal())
     mooseError(_c_name,
                ": Trying to get old nodal values of variable '",
                var->name(),
                "', but it is not nodal.");
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->nodalValueOld() : var->nodalValueOlder();
   return (_c_is_implicit) ? var->nodalValueOldNeighbor() : var->nodalValueOlderNeighbor();
 }

◆ coupledNodalValueOlder()

template<typename T >

template const RealVectorValue & Coupleable::coupledNodalValueOlder< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns an old nodal value from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the older value of the coupled variable

Definition at line 1959 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
   if (!var)
     return getDefaultNodalValue<T>(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!var->isNodal())
     mooseError(_c_name,
                ": Trying to get older nodal values of variable '",
                var->name(),
                "', but it is not nodal.");
 
   if (!_coupleable_neighbor)
     return var->nodalValueOlder();
   return var->nodalValueOlderNeighbor();
 }

◆ coupledNodalValuePreviousNL()

template<typename T >

template const RealVectorValue & Coupleable::coupledNodalValuePreviousNL< RealVectorValue >	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protected

Returns nodal values of a coupled variable for previous Newton iterate.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 1979 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableFE<T>>(var_name, comp);
   if (!var)
     return getDefaultNodalValue<T>(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   _c_fe_problem.needsPreviousNewtonIteration(true);
 
   if (!_coupleable_neighbor)
     return var->nodalValuePreviousNL();
   return var->nodalValuePreviousNLNeighbor();
 }

◆ coupledSecond()

const VariableSecond & Coupleable::coupledSecond	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns second spatial derivatives of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableSecond containing the second derivative of the coupled variable

See also: Kernel::second

Definition at line 1853 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondarySecond().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_second.resize(_coupleable_max_qps);
     return _default_second;
   }
   checkFuncType(var_name, VarType::Second, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->secondSln() : var->secondSlnOlder();
   return (_c_is_implicit) ? var->secondSlnNeighbor() : var->secondSlnOlderNeighbor();
 }

◆ coupledSecondOld()

const VariableSecond & Coupleable::coupledSecondOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old second spatial derivatives from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableSecond containing the old second derivative of the coupled variable

See also: Kernel::secondOld

Definition at line 1869 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_second.resize(_coupleable_max_qps);
     return _default_second;
   }
   checkFuncType(var_name, VarType::Second, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->secondSlnOld() : var->secondSlnOlder();
   return (_c_is_implicit) ? var->secondSlnOldNeighbor() : var->secondSlnOlderNeighbor();
 }

◆ coupledSecondOlder()

const VariableSecond & Coupleable::coupledSecondOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old second derivative from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableSecond containing the older second derivative of the coupled variable

See also: Kernel::secondOlder

Definition at line 1885 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
   {
     _default_second.resize(_coupleable_max_qps);
     return _default_second;
   }
   checkFuncType(var_name, VarType::Second, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->secondSlnOlder();
   return var->secondSlnOlderNeighbor();
 }

◆ coupledSecondPreviousNL()

const VariableSecond & Coupleable::coupledSecondPreviousNL	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns second derivative of a coupled variable for the previous Newton iterate.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableSecond containing the second derivative of the coupled variable

Definition at line 1901 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   _c_fe_problem.needsPreviousNewtonIteration(true);
   if (!var)
   {
     _default_second.resize(_coupleable_max_qps);
     return _default_second;
   }
   checkFuncType(var_name, VarType::Second, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->secondSlnPreviousNL();
   return var->secondSlnPreviousNLNeighbor();
 }

◆ coupledValue()

const VariableValue & Coupleable::coupledValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns value of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 527 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondaryValue(), coupledValues(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), and writableCoupledValue().

 {
   const auto * const var = getVarHelper<MooseVariableField<Real>>(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
     else
       return (_c_is_implicit) ? var->sln() : var->slnOld();
   }
   else
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
     else
       return (_c_is_implicit) ? var->slnNeighbor() : var->slnOldNeighbor();
   }
 }

◆ coupledValueLower()

const VariableValue & Coupleable::coupledValueLower	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns value of a coupled lower-dimensional variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 632 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (_coupleable_neighbor)
     mooseError(_c_name, ":coupledValueLower cannot be called in a coupleable neighbor object");
 
   if (_c_nodal)
     return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
   else
     return (_c_is_implicit) ? var->slnLower() : var->slnLowerOld();
 }

◆ coupledValueOld()

const VariableValue & Coupleable::coupledValueOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from previous time step of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the old value of the coupled variable

See also: Kernel::valueOld

Definition at line 1031 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondaryValueOld(), coupledValuesOld(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
     return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
   }
   else
   {
     if (_c_nodal)
       return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
     return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
   }
 }

◆ coupledValueOlder()

const VariableValue & Coupleable::coupledValueOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from two time steps previous of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the older value of the coupled variable

See also: Kernel::valueOlder

Definition at line 1053 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondaryValueOlder(), coupledValuesOlder(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesOlder();
     return var->slnOlder();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesOlderNeighbor();
     return var->slnOlderNeighbor();
   }
 }

◆ coupledValuePreviousNL()

const VariableValue & Coupleable::coupledValuePreviousNL	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns value of previous Newton iterate of a coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue containing the older value of the coupled variable

Definition at line 1075 of file Coupleable.C.

 {
   const auto * var = getVar(var_name, comp);
   if (!var)
     return *getDefaultValue(var_name, comp);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   _c_fe_problem.needsPreviousNewtonIteration(true);
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return var->dofValuesPreviousNL();
     return var->slnPreviousNL();
   }
   else
   {
     if (_c_nodal)
       return var->dofValuesPreviousNLNeighbor();
     return var->slnPreviousNLNeighbor();
   }
 }

◆ coupledValues()

std::vector< const VariableValue * > Coupleable::coupledValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled variable components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2538 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledValue(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledValuesOld()

std::vector< const VariableValue * > Coupleable::coupledValuesOld ( const std::string & var_name ) const

protected

Returns the old values for all of a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2719 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledValueOld(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledValuesOlder()

std::vector< const VariableValue * > Coupleable::coupledValuesOlder ( const std::string & var_name ) const

protected

Returns the older values for all of a coupled variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2726 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledValueOlder(var_name, comp); };
   return coupledVectorHelper<const VariableValue *>(var_name, func);
 }

◆ coupledVectorDot()

const VectorVariableValue & Coupleable::coupledVectorDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 1284 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_value_zero.resize(_coupleable_max_qps);
     return _default_vector_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->uDot();
   return var->uDotNeighbor();
 }

◆ coupledVectorDotDot()

const VectorVariableValue & Coupleable::coupledVectorDotDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 1300 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_value_zero.resize(_coupleable_max_qps);
     return _default_vector_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->uDotDot();
   return var->uDotDotNeighbor();
 }

◆ coupledVectorDotDotDu()

const VariableValue & Coupleable::coupledVectorDotDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Second time derivative of a coupled vector variable with respect to the coefficients.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VariableValue containing the time derivative of the coupled vector variable with respect to the coefficients

Definition at line 1364 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->duDotDotDu();
   return var->duDotDotDuNeighbor();
 }

◆ coupledVectorDotDotOld()

const VectorVariableValue & Coupleable::coupledVectorDotDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old second time derivative of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 1332 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_value_zero.resize(_coupleable_max_qps);
     return _default_vector_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return var->uDotDotOld();
   return var->uDotDotOldNeighbor();
 }

◆ coupledVectorDotDu()

const VariableValue & Coupleable::coupledVectorDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Time derivative of a coupled vector variable with respect to the coefficients.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VariableValue containing the time derivative of the coupled vector variable with respect to the coefficients

Definition at line 1348 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_value_zero.resize(_coupleable_max_qps, 0);
     return _default_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return var->duDotDu();
   return var->duDotDuNeighbor();
 }

◆ coupledVectorDotOld()

const VectorVariableValue & Coupleable::coupledVectorDotOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Old time derivative of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 1316 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_value_zero.resize(_coupleable_max_qps);
     return _default_vector_value_zero;
   }
   checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return var->uDotOld();
   return var->uDotOldNeighbor();
 }

◆ coupledVectorGradient()

const VectorVariableGradient & Coupleable::coupledVectorGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns gradient of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableGradient containing the gradient of the coupled vector variable

Definition at line 1640 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_gradient.resize(_coupleable_max_qps);
     return _default_vector_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
   return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
 }

◆ coupledVectorGradientOld()

const VectorVariableGradient & Coupleable::coupledVectorGradientOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from previous time step of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableGradient containing the old gradient of the coupled vector variable

Definition at line 1656 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_gradient.resize(_coupleable_max_qps);
     return _default_vector_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
   return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
 }

◆ coupledVectorGradientOlder()

const VectorVariableGradient & Coupleable::coupledVectorGradientOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old gradient from two time steps previous of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableGradient containing the older gradient of the coupled vector variable

Definition at line 1672 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
   {
     _default_vector_gradient.resize(_coupleable_max_qps);
     return _default_vector_gradient;
   }
   checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->gradSlnOlder();
   return var->gradSlnOlderNeighbor();
 }

◆ coupledVectorHelper()

template<typename T , typename Func >

std::vector<T> Coupleable::coupledVectorHelper	(	const std::string &	var_name,
		const Func &	func
	)		const

inlineprotected

Definition at line 1703 of file Coupleable.h.

   {
     const auto components = coupledComponents(var_name);
     std::vector<T> vals(components);
     for (MooseIndex(components) comp = 0; comp < components; ++comp)
       vals[comp] = func(comp);
     return vals;
   }

◆ coupledVectorTagArrayDofValue()

const ArrayVariableValue & Coupleable::coupledVectorTagArrayDofValue	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp = `0`
	)		const

protected

Returns evaluations of a tagged vector at the requested variable's degree of freedom indices.

Parameters

var_name	Name of coupled variable
tag_name	vector tag name

Returns: Reference to a ArrayVariableValue for the coupled variable

Definition at line 813 of file Coupleable.C.

 {
   return vectorTagDofValueHelper<RealEigenVector>(var_name, tag_name, comp);
 }

◆ coupledVectorTagArrayGradient() [1/2]

const ArrayVariableGradient & Coupleable::coupledVectorTagArrayGradient	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns gradient of a coupled array variable for a given tag.

Parameters

var_names	Name(s) of coupled array variable(s)
tag	vector tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a ArrayVariableGradient containing the gradient of the coupled array variable

See also: Kernel::gradient

Definition at line 719 of file Coupleable.C.

Referenced by coupledVectorTagArrayGradient(), and coupledVectorTagArrayGradients().

 {
   const auto * var = getArrayVar(var_names, index);
   if (!var)
     mooseError(var_names, ": invalid variable name for coupledVectorTagArrayGradient");
   checkFuncType(var_names, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_fe_problem.vectorTagExists(tag))
     mooseError("Attempting to couple to vector tag with ID ",
                tag,
                "in ",
                _c_name,
                ", but a vector tag with that ID does not exist");
 
   const_cast<Coupleable *>(this)->addFEVariableCoupleableVectorTag(tag);
 
   return var->vectorTagGradient(tag);
 }

◆ coupledVectorTagArrayGradient() [2/2]

const ArrayVariableGradient & Coupleable::coupledVectorTagArrayGradient	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 741 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagArrayGradient(var_names, tag, index);
 }

◆ coupledVectorTagArrayGradients() [1/2]

std::vector< const ArrayVariableGradient * > Coupleable::coupledVectorTagArrayGradients	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns gradients for all the coupled variables desired for a given tag.

Parameters

var_names	Name(s) of coupled array variable(s)
tag	vector tag ID

Returns: Vector of ArrayVariableGradient pointers for each variable in var_name

Definition at line 2650 of file Coupleable.C.

Referenced by coupledVectorTagArrayGradients().

 {
   auto func = [this, &var_names, &tag](unsigned int index)
   { return &coupledVectorTagArrayGradient(var_names, tag, index); };
   return coupledVectorHelper<const ArrayVariableGradient *>(var_names, func);
 }

◆ coupledVectorTagArrayGradients() [2/2]

std::vector< const ArrayVariableGradient * > Coupleable::coupledVectorTagArrayGradients	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2658 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagArrayGradients(var_names, tag);
 }

◆ coupledVectorTagArrayValue() [1/2]

const ArrayVariableValue & Coupleable::coupledVectorTagArrayValue	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns value of a coupled array variable for a given tag.

Parameters

var_names	Name(s) of coupled array variable(s)
tag	vector tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a VariableValue for the coupled array variable

See also: Kernel::_u

Definition at line 665 of file Coupleable.C.

Referenced by coupledVectorTagArrayValues().

 {
   return vectorTagValueHelper<RealEigenVector>(var_names, tag, index);
 }

◆ coupledVectorTagArrayValue() [2/2]

const ArrayVariableValue & Coupleable::coupledVectorTagArrayValue	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 673 of file Coupleable.C.

 {
   return vectorTagValueHelper<RealEigenVector>(var_names, tag_name, index);
 }

◆ coupledVectorTagArrayValues() [1/2]

std::vector< const ArrayVariableValue * > Coupleable::coupledVectorTagArrayValues	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns the values for all the coupled variables desired for a given tag.

Parameters

var_name	Name of array coupled variable
tag	vector tag ID

Returns: Vector of ArrayVariableValue pointers for each variable in var_names

Definition at line 2604 of file Coupleable.C.

Referenced by coupledVectorTagArrayValues().

 {
   auto func = [this, &var_names, &tag](unsigned int index)
   { return &coupledVectorTagArrayValue(var_names, tag, index); };
   return coupledVectorHelper<const ArrayVariableValue *>(var_names, func);
 }

◆ coupledVectorTagArrayValues() [2/2]

std::vector< const ArrayVariableValue * > Coupleable::coupledVectorTagArrayValues	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2612 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagArrayValues(var_names, tag);
 }

◆ coupledVectorTagDofValue() [1/2]

const VariableValue & Coupleable::coupledVectorTagDofValue	(	const std::string &	var_name,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns dof value of a coupled variable for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	vector tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a DofValue for the coupled variable

Definition at line 797 of file Coupleable.C.

Referenced by coupledVectorTagDofValues().

 {
   return vectorTagDofValueHelper<Real>(var_name, tag, comp);
 }

◆ coupledVectorTagDofValue() [2/2]

const VariableValue & Coupleable::coupledVectorTagDofValue	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 805 of file Coupleable.C.

 {
   return vectorTagDofValueHelper<Real>(var_name, tag_name, comp);
 }

◆ coupledVectorTagDofValues() [1/2]

std::vector< const VariableValue * > Coupleable::coupledVectorTagDofValues	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns the dof values for all the coupled variables desired for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	vector tag ID

Returns: Vector of VariableValue pointers for each variable in var_name

Definition at line 2673 of file Coupleable.C.

Referenced by coupledVectorTagDofValues().

 {
   auto func = [this, &var_names, &tag](unsigned int comp)
   { return &coupledVectorTagDofValue(var_names, tag, comp); };
   return coupledVectorHelper<const VariableValue *>(var_names, func);
 }

◆ coupledVectorTagDofValues() [2/2]

std::vector< const VariableValue * > Coupleable::coupledVectorTagDofValues	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2681 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagDofValues(var_names, tag);
 }

◆ coupledVectorTagGradient() [1/2]

const VariableGradient & Coupleable::coupledVectorTagGradient	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns gradient of a coupled variable for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	vector tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a VariableGradient containing the gradient of the coupled variable

See also: Kernel::gradient

Definition at line 681 of file Coupleable.C.

Referenced by coupledVectorTagGradient(), and coupledVectorTagGradients().

 {
   const auto * var = getVar(var_names, index);
   if (!var)
     mooseError(var_names, ": invalid variable name for coupledVectorTagGradient");
   checkFuncType(var_names, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_fe_problem.vectorTagExists(tag))
     mooseError("Attempting to couple to vector tag with ID ",
                tag,
                "in ",
                _c_name,
                ", but a vector tag with that ID does not exist");
 
   const_cast<Coupleable *>(this)->addFEVariableCoupleableVectorTag(tag);
 
   return var->vectorTagGradient(tag);
 }

◆ coupledVectorTagGradient() [2/2]

const VariableGradient & Coupleable::coupledVectorTagGradient	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 703 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagGradient(var_names, tag, index);
 }

◆ coupledVectorTagGradients() [1/2]

std::vector< const VariableGradient * > Coupleable::coupledVectorTagGradients	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns gradients for all the coupled variables desired for a given tag.

Parameters

var_names	Name(s) of coupled array variable(s)
tag	vector tag ID

Returns: Vector of VariableGradient pointers for each variables in var_name

Definition at line 2627 of file Coupleable.C.

Referenced by coupledVectorTagGradients().

 {
   auto func = [this, &var_names, &tag](unsigned int index)
   { return &coupledVectorTagGradient(var_names, tag, index); };
   return coupledVectorHelper<const VariableGradient *>(var_names, func);
 }

◆ coupledVectorTagGradients() [2/2]

std::vector< const VariableGradient * > Coupleable::coupledVectorTagGradients	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2635 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagGradients(var_names, tag);
 }

◆ coupledVectorTagValue() [1/2]

const VariableValue & Coupleable::coupledVectorTagValue	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

protectedvirtual

Returns value of a coupled variable for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	vector tag ID
index	Index of the desired variable in the vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 649 of file Coupleable.C.

Referenced by coupledVectorTagValues().

 {
   return vectorTagValueHelper<Real>(var_names, tag, index);
 }

◆ coupledVectorTagValue() [2/2]

const VariableValue & Coupleable::coupledVectorTagValue	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

protectedvirtual

Definition at line 657 of file Coupleable.C.

 {
   return vectorTagValueHelper<Real>(var_names, tag_name, index);
 }

◆ coupledVectorTagValues() [1/2]

std::vector< const VariableValue * > Coupleable::coupledVectorTagValues	(	const std::string &	var_names,
		TagID	tag
	)		const

protected

Returns the values for all the coupled variables desired for a given tag.

Parameters

var_names	Name(s) of coupled variable(s)
tag	vector tag ID

Returns: Vector of VariableValue pointers for each variable in var_names

Definition at line 2581 of file Coupleable.C.

Referenced by coupledVectorTagValues().

 {
   auto func = [this, &var_names, &tag](unsigned int comp)
   { return &coupledVectorTagValue(var_names, tag, comp); };
   return coupledVectorHelper<const VariableValue *>(var_names, func);
 }

◆ coupledVectorTagValues() [2/2]

std::vector< const VariableValue * > Coupleable::coupledVectorTagValues	(	const std::string &	var_names,
		const std::string &	tag_name
	)		const

protected

Definition at line 2589 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_name))
     mooseError("Tag name parameter '", tag_name, "' is invalid");
 
   TagName tagname = _c_parameters.get<TagName>(tag_name);
   if (!_c_fe_problem.vectorTagExists(tagname))
     mooseError("Tagged vector with tag name '", tagname, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tagname);
   return coupledVectorTagValues(var_names, tag);
 }

◆ coupledVectorValue()

const VectorVariableValue & Coupleable::coupledVectorValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns value of a coupled vector variable.

Parameters

var_name	Name of coupled vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a VectorVariableValue for the coupled vector variable

See also: VectorKernel::_u

Definition at line 854 of file Coupleable.C.

Referenced by coupledVectorValues().

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return _c_is_implicit ? var->nodalValueArray() : var->nodalValueOldArray();
     else
       return _c_is_implicit ? var->sln() : var->slnOld();
   }
   else
   {
     if (_c_nodal)
       // Since this is at a node, I don't feel like there should be any "neighbor" logic
       return _c_is_implicit ? var->nodalValueArray() : var->nodalValueOldArray();
     else
       return _c_is_implicit ? var->slnNeighbor() : var->slnOldNeighbor();
   }
 }

◆ coupledVectorValueOld()

const VectorVariableValue & Coupleable::coupledVectorValueOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from previous time step of a coupled vector variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableValue containing the old value of the coupled variable

See also: VectorKernel::_u_old

Definition at line 1098 of file Coupleable.C.

Referenced by coupledVectorValuesOld().

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (_c_nodal)
     return (_c_is_implicit) ? var->nodalValueOldArray() : var->nodalValueOlderArray();
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
   return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
 }

◆ coupledVectorValueOlder()

const VectorVariableValue & Coupleable::coupledVectorValueOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedvirtual

Returns an old value from two time steps previous of a coupled vector variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VectorVariableValue containing the older value of the coupled variable

See also: VectorKernel::_u_older

Definition at line 1113 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->slnOlder();
   return var->slnOlderNeighbor();
 }

◆ coupledVectorValues()

std::vector< const VectorVariableValue * > Coupleable::coupledVectorValues ( const std::string & var_name ) const

protected

Returns the values for all of a coupled vector variable's components.

Parameters

var_name Name of coupled variable

Returns: Vector of VectorVariableValue pointers for each component of var_name

Definition at line 2545 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp) { return &coupledVectorValue(var_name, comp); };
   return coupledVectorHelper<const VectorVariableValue *>(var_name, func);
 }

◆ coupledVectorValuesOld()

std::vector< const VectorVariableValue * > Coupleable::coupledVectorValuesOld ( const std::string & var_name ) const

protected

Returns the old values for all of a coupled vector variable's components.

Parameters

var_name Name of coupled vector variable

Returns: Vector of VectorVariableValue pointers for each component of var_name

Definition at line 2733 of file Coupleable.C.

 {
   auto func = [this, &var_name](unsigned int comp)
   { return &coupledVectorValueOld(var_name, comp); };
   return coupledVectorHelper<const VectorVariableValue *>(var_name, func);
 }

◆ genericZeroGradient() [1/3]

template<bool is_ad>

const GenericVariableGradient<is_ad>& Coupleable::genericZeroGradient ( )

protected

Returns zero gradient templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroGradient() [2/3]

template<>

const GenericVariableGradient<false>& Coupleable::genericZeroGradient ( )

protected

Definition at line 2466 of file Coupleable.C.

 {
   return _grad_zero;
 }

◆ genericZeroGradient() [3/3]

template<>

const GenericVariableGradient<true>& Coupleable::genericZeroGradient ( )

protected

Definition at line 2473 of file Coupleable.C.

 {
   return _ad_grad_zero;
 }

◆ genericZeroSecond() [1/3]

template<bool is_ad>

const GenericVariableSecond<is_ad>& Coupleable::genericZeroSecond ( )

protected

Returns zero second derivative templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroSecond() [2/3]

template<>

const GenericVariableSecond<false>& Coupleable::genericZeroSecond ( )

protected

Definition at line 2480 of file Coupleable.C.

 {
   return _second_zero;
 }

◆ genericZeroSecond() [3/3]

template<>

const GenericVariableSecond<true>& Coupleable::genericZeroSecond ( )

protected

Definition at line 2487 of file Coupleable.C.

 {
   return _ad_second_zero;
 }

◆ genericZeroValue() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::genericZeroValue ( )

protected

Returns zero value templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroValue() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::genericZeroValue ( )

protected

Definition at line 2452 of file Coupleable.C.

 {
   return _zero;
 }

◆ genericZeroValue() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::genericZeroValue ( )

protected

Definition at line 2459 of file Coupleable.C.

 {
   return _ad_zero;
 }

◆ getADDefaultCurl()

const ADVectorVariableCurl & Coupleable::getADDefaultCurl ( ) const

Helper method to return (and insert if necessary) the default curl value for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: Reference to a ADVectorVariableCurl containing zero entries for the default values

Definition at line 2423 of file Coupleable.C.

Referenced by adCoupledCurl().

 {
   _ad_default_curl.resize(_coupleable_max_qps);
   return _ad_default_curl;
 }

◆ getADDefaultGradient()

const ADVariableGradient & Coupleable::getADDefaultGradient ( ) const

Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default gradient

Returns: Reference to a ADVariableGradient containing zero entries for the default values

Definition at line 2402 of file Coupleable.C.

Referenced by adCoupledGradient(), and adCoupledGradientDot().

 {
   _ad_default_gradient.resize(_coupleable_max_qps);
   return _ad_default_gradient;
 }

◆ getADDefaultSecond()

const ADVariableSecond & Coupleable::getADDefaultSecond ( ) const

Helper method to return (and insert if necessary) the default second derivatives for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default second derivative

Returns: Reference to a ADVariableSecond containing zero entries for the default values

Definition at line 2416 of file Coupleable.C.

Referenced by adCoupledSecond().

 {
   _ad_default_second.resize(_coupleable_max_qps);
   return _ad_default_second;
 }

◆ getADDefaultValue()

const ADVariableValue * Coupleable::getADDefaultValue ( const std::string & var_name ) const

Helper method to return (and insert if necessary) the default value for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: VariableValue * a pointer to the associated VariableValue.

Definition at line 2371 of file Coupleable.C.

Referenced by adCoupledDofValues(), adCoupledDot(), adCoupledDotDot(), adCoupledLowerValue(), NeighborCoupleable::adCoupledNeighborValue(), and adCoupledValue().

 {
   auto default_value_it = _ad_default_value.find(var_name);
   if (default_value_it == _ad_default_value.end())
   {
     auto value = std::make_unique<ADVariableValue>(_coupleable_max_qps,
                                                    _c_parameters.defaultCoupledValue(var_name));
     default_value_it = _ad_default_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getADDefaultVectorGradient()

const ADVectorVariableGradient & Coupleable::getADDefaultVectorGradient ( ) const

Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled vector variable.

Parameters

var_name the name of the vector variable for which to retrieve a default gradient

Returns: Reference to a ADVectorVariableGradient containing zero entries for the default values

Definition at line 2409 of file Coupleable.C.

Referenced by adCoupledVectorGradient().

 {
   _ad_default_vector_gradient.resize(_coupleable_max_qps);
   return _ad_default_vector_gradient;
 }

◆ getADDefaultVectorValue()

const ADVectorVariableValue * Coupleable::getADDefaultVectorValue ( const std::string & var_name ) const

Helper method to return (and insert if necessary) the default vector value for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: VectorVariableValue * a pointer to the associated VectorVariableValue.

Definition at line 2385 of file Coupleable.C.

Referenced by adCoupledVectorDot(), NeighborCoupleable::adCoupledVectorNeighborValue(), and adCoupledVectorValue().

 {
   auto default_value_it = _ad_default_vector_value.find(var_name);
   if (default_value_it == _ad_default_vector_value.end())
   {
     RealVectorValue default_vec;
     for (unsigned int i = 0; i < _c_parameters.numberDefaultCoupledValues(var_name); ++i)
       default_vec(i) = _c_parameters.defaultCoupledValue(var_name, i);
     auto value = std::make_unique<ADVectorVariableValue>(_coupleable_max_qps, default_vec);
     default_value_it =
         _ad_default_vector_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getArrayVar() [1/2]

ArrayMooseVariable * Coupleable::getArrayVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protected

Extract pointer to a coupled array variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 336 of file Coupleable.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), ArrayVarReductionAux::ArrayVarReductionAux(), coupledArrayDofValues(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), coupledArrayGradientOlder(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), coupledArrayValue(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledVectorTagArrayGradient(), TagVectorArrayVariableAux::TagVectorArrayVariableAux(), and TagVectorArrayVariableValueAux::TagVectorArrayVariableValueAux().

 {
   return const_cast<ArrayMooseVariable *>(getVarHelper<ArrayMooseVariable>(var_name, comp));
 }

◆ getArrayVar() [2/2]

const ArrayMooseVariable * Coupleable::getArrayVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Extract pointer to a coupled array variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 359 of file Coupleable.C.

 {
   return getVarHelper<ArrayMooseVariable>(var_name, comp);
 }

◆ getCoupledArrayMooseVars()

const std::vector<ArrayMooseVariable *>& Coupleable::getCoupledArrayMooseVars ( ) const

inline

Get the list of array coupled variables.

Returns: The list of array coupled variables

Definition at line 108 of file Coupleable.h.

   {
     return _coupled_array_moose_vars;
   }

◆ getCoupledMooseVars()

const std::vector<MooseVariableFieldBase *>& Coupleable::getCoupledMooseVars ( ) const

inline

Get the list of all coupled variables.

Returns: The list of all coupled variables

Definition at line 81 of file Coupleable.h.

Referenced by AuxNodalScalarKernel::AuxNodalScalarKernel(), BuildArrayVariableAux::BuildArrayVariableAux(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), ElementIndicator::ElementIndicator(), InterfaceMaterial::InterfaceMaterial(), InternalSideIndicatorBase::InternalSideIndicatorBase(), Material::Material(), Moose::Kokkos::Material< KokkosGenericConstantMaterial >::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), and NodalScalarKernel::NodalScalarKernel().

   {
     return _coupled_moose_vars;
   }

◆ getCoupledStandardMooseVars()

const std::vector<MooseVariable *>& Coupleable::getCoupledStandardMooseVars ( ) const

inline

Get the list of standard coupled variables.

Returns: The list of standard coupled variables

Definition at line 90 of file Coupleable.h.

   {
     return _coupled_standard_moose_vars;
   }

◆ getCoupledVars()

const std::unordered_map<std::string, std::vector<MooseVariableFieldBase *> >& Coupleable::getCoupledVars ( ) const

inline

Get the list of coupled variables.

Returns: The list of coupled variables

Definition at line 72 of file Coupleable.h.

Referenced by InitialConditionBase::InitialConditionBase().

   {
     return _coupled_vars;
   }

◆ getCoupledVectorMooseVars()

const std::vector<VectorMooseVariable *>& Coupleable::getCoupledVectorMooseVars ( ) const

inline

Get the list of vector coupled variables.

Returns: The list of vector coupled variables

Definition at line 99 of file Coupleable.h.

   {
     return _coupled_vector_moose_vars;
   }

◆ getDefaultArrayValue()

const ArrayVariableValue * Coupleable::getDefaultArrayValue ( const std::string & var_name ) const

private

Helper method to return (and insert if necessary) the default value for an uncoupled array variable.

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: a pointer to the associated VectorVariableValue.

Definition at line 427 of file Coupleable.C.

Referenced by coupledArrayDofValues(), coupledArrayValue(), coupledArrayValueOld(), and coupledArrayValueOlder().

 {
   auto default_value_it = _default_array_value.find(var_name);
   if (default_value_it == _default_array_value.end())
   {
     auto value = std::make_unique<ArrayVariableValue>(_coupleable_max_qps);
     for (unsigned int qp = 0; qp < _coupleable_max_qps; ++qp)
     {
       auto n = _c_parameters.numberDefaultCoupledValues(var_name);
       (*value)[qp].resize(n);
       for (unsigned int i = 0; i < n; ++i)
         (*value)[qp](i) = _c_parameters.defaultCoupledValue(var_name, i);
     }
     default_value_it =
         _default_array_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getDefaultFunctor()

template<typename T >

const Moose::Functor<T>& Coupleable::getDefaultFunctor ( const std::string & var_name ) const

private

◆ getDefaultNodalValue() [1/3]

template<>

const RealVectorValue& Coupleable::getDefaultNodalValue	(	const std::string &	var_name,
		unsigned int
	)		const

private

Definition at line 457 of file Coupleable.C.

 {
   auto && default_variable_value = getDefaultVectorValue(var_name);
   return *default_variable_value->data();
 }

◆ getDefaultNodalValue() [2/3]

template<>

const RealEigenVector& Coupleable::getDefaultNodalValue	(	const std::string &	var_name,
		unsigned int
	)		const

private

Definition at line 465 of file Coupleable.C.

 {
   auto && default_variable_value = getDefaultArrayValue(var_name);
   return *default_variable_value->data();
 }

◆ getDefaultNodalValue() [3/3]

template<typename T >

const T & Coupleable::getDefaultNodalValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

private

Get nodal default value.

Definition at line 449 of file Coupleable.C.

 {
   auto && default_variable_value = getDefaultValue(var_name, comp);
   return *default_variable_value->data();
 }

◆ getDefaultValue()

const VariableValue * Coupleable::getDefaultValue	(	const std::string &	var_name,
		unsigned int	comp
	)		const

private

Helper method to return (and insert if necessary) the default value for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: a pointer to the associated VariableValue.

Definition at line 365 of file Coupleable.C.

Referenced by coupledDofValues(), coupledDofValuesOld(), coupledDofValuesOlder(), coupledValue(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), and getDefaultNodalValue().

 {
   // make sure we don't access values that were not provided
   checkComponent(_obj, comp, _c_parameters.numberDefaultCoupledValues(var_name), var_name);
 
   auto default_value_it = _default_value.find(var_name);
   if (default_value_it == _default_value.end())
   {
     _default_value[var_name].emplace_back(std::make_unique<VariableValue>(
         _coupleable_max_qps, _c_parameters.defaultCoupledValue(var_name, 0)));
     for (unsigned int j = 1; j < _c_parameters.numberDefaultCoupledValues(var_name); ++j)
       _default_value[var_name].emplace_back(std::make_unique<VariableValue>(
           _coupleable_max_qps, _c_parameters.defaultCoupledValue(var_name, j)));
     default_value_it = _default_value.find(var_name);
   }
 
   const auto & default_value_vec = default_value_it->second;
   const auto n_default_vals = default_value_vec.size();
   if (comp >= n_default_vals)
     mooseError("Requested comp ",
                comp,
                " is equal to or greater than the number of default values ",
                n_default_vals);
   return default_value_vec[comp].get();
 }

◆ getDefaultVectorValue()

const VectorVariableValue * Coupleable::getDefaultVectorValue ( const std::string & var_name ) const

private

Helper method to return (and insert if necessary) the default value for an uncoupled vector variable.

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: a pointer to the associated VectorVariableValue.

Definition at line 392 of file Coupleable.C.

Referenced by coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().

 {
   auto default_value_it = _default_vector_value.find(var_name);
   if (default_value_it == _default_vector_value.end())
   {
     auto value = std::make_unique<VectorVariableValue>(_coupleable_max_qps, 0);
     bool already_warned = false;
     for (unsigned int qp = 0; qp < _coupleable_max_qps; ++qp)
       for (const auto i : make_range(Moose::dim))
       {
         try
         {
           (*value)[qp](i) = _c_parameters.defaultCoupledValue(var_name, i);
         }
         catch (const std::out_of_range &)
         {
           if (!already_warned)
             mooseWarning(
                 "You supplied less than 3 arguments for the default vector value for variable ",
                 var_name,
                 ". Did you accidently leave something off? We are going to assign 0s, assuming "
                 "this "
                 "was intentional.");
           already_warned = true;
           (*value)[qp](i) = 0;
         }
       }
     default_value_it =
         _default_vector_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getFEVar()

const MooseVariableFieldBase * Coupleable::getFEVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Deprecated method.

Use getFieldVar instead Extract pointer to a base coupled field variable. Could be either a finite volume or finite element variable

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 298 of file Coupleable.C.

 {
   mooseDeprecated("Coupleable::getFEVar is deprecated. Please use Coupleable::getFieldVar instead. "
                   "Note that this method could potentially return a finite volume variable");
   return getFieldVar(var_name, comp);
 }

◆ getFEVariableCoupleableMatrixTags() [1/2]

std::set<TagID>& Coupleable::getFEVariableCoupleableMatrixTags ( )

inline

Definition at line 119 of file Coupleable.h.

119 { return _fe_coupleable_matrix_tags; }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1809

◆ getFEVariableCoupleableMatrixTags() [2/2]

const std::set<TagID>& Coupleable::getFEVariableCoupleableMatrixTags ( ) const

inline

Definition at line 126 of file Coupleable.h.

   {
     return _fe_coupleable_matrix_tags;
   }

◆ getFEVariableCoupleableVectorTags() [1/2]

std::set<TagID>& Coupleable::getFEVariableCoupleableVectorTags ( )

inline

Definition at line 117 of file Coupleable.h.

Referenced by ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateFEVariableCoupledVectorTagDependencyHelper().

117 { return _fe_coupleable_vector_tags; }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1807

◆ getFEVariableCoupleableVectorTags() [2/2]

const std::set<TagID>& Coupleable::getFEVariableCoupleableVectorTags ( ) const

inline

Definition at line 121 of file Coupleable.h.

   {
     return _fe_coupleable_vector_tags;
   }

◆ getFieldVar() [1/2]

const MooseVariableFieldBase * Coupleable::getFieldVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Definition at line 312 of file Coupleable.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), coupled(), coupledName(), getFEVar(), DomainUserObject::getInterfaceFieldVar(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), and InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor().

 {
   return getVarHelper<MooseVariableFieldBase>(var_name, comp);
 }

◆ getFieldVar() [2/2]

MooseVariableFieldBase * Coupleable::getFieldVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protected

Definition at line 306 of file Coupleable.C.

 {
   return getVarHelper<MooseVariableFieldBase>(var_name, comp);
 }

◆ getVar() [1/2]

MooseVariable * Coupleable::getVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protected

Extract pointer to a coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 318 of file Coupleable.C.

 {
   return const_cast<MooseVariable *>(getVarHelper<MooseVariable>(var_name, comp));
 }

◆ getVar() [2/2]

const MooseVariable * Coupleable::getVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Extract pointer to a coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 342 of file Coupleable.C.

 {
   return getVarHelper<MooseVariable>(var_name, comp);
 }

◆ getVarHelper() [1/2]

template<typename T >

const T * Coupleable::getVarHelper	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Helper that that be used to retrieve a variable of arbitrary type T.

Definition at line 1972 of file Coupleable.h.

 {
   return const_cast<Coupleable *>(this)->getVarHelper<T>(var_name, comp);
 }

◆ getVarHelper() [2/2]

template<typename T >

T * Coupleable::getVarHelper	(	const std::string &	var_name,
		unsigned int	comp
	)

protected

Helper that can be used to retrieve a variable of arbitrary type T.

Definition at line 1918 of file Coupleable.h.

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
   auto name_to_use = var_name;
 
   // First check for supplied name
   if (!checkVar(var_name, comp, 0))
   {
     // See if there is an associated deprecated name that the user may have used instead
     auto it = _new_to_deprecated_coupled_vars.find(var_name);
     if (it == _new_to_deprecated_coupled_vars.end())
       return nullptr;
     else
     {
       auto deprecated_name = it->second;
       if (checkVar(deprecated_name, comp, 0))
         name_to_use = deprecated_name;
       else
         return nullptr;
     }
   }
 
   auto coupled_vars_it = _coupled_vars.find(name_to_use);
 
   mooseAssert(coupled_vars_it != _coupled_vars.end(),
               "Trying to get a coupled var " << name_to_use << " that doesn't exist");
 
   if (auto coupled_var = dynamic_cast<T *>(coupled_vars_it->second[comp]))
     return coupled_var;
   else
   {
     for (auto & var : _coupled_standard_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a standard variable, try a "
                    "'coupled[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_vector_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a vector variable, try a "
                    "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_array_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is an array variable, try a "
                    "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_fv_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a finite volume variable, which the coupled[...] routine "
                    "used does not support. Try using the functor system routines instead.");
     mooseError(
         "Variable '", name_to_use, "' is of a different C++ type than you tried to fetch it as.");
   }
 }

◆ getVectorVar() [1/2]

VectorMooseVariable * Coupleable::getVectorVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protected

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 324 of file Coupleable.C.

Referenced by adCoupledCurl(), adCoupledVectorDot(), adCoupledVectorGradient(), adCoupledVectorValue(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), coupledDiv(), coupledDivOld(), coupledDivOlder(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().

 {
   auto * const var =
       const_cast<VectorMooseVariable *>(getVarHelper<VectorMooseVariable>(var_name, comp));
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getVectorVar() [2/2]

const VectorMooseVariable * Coupleable::getVectorVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protected

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 348 of file Coupleable.C.

 {
   const auto * const var = getVarHelper<VectorMooseVariable>(var_name, comp);
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getWritableCoupledVariables()

auto& Coupleable::getWritableCoupledVariables ( ) const

inline

returns a reference to the set of writable coupled variables

Definition at line 134 of file Coupleable.h.

Referenced by hasWritableCoupledVariables().

134 { return _writable_coupled_variables[_c_tid]; }

Coupleable::_c_tid

THREAD_ID _c_tid

Thread ID of the thread using this object.

Definition: Coupleable.h:1450

Coupleable::_writable_coupled_variables

std::vector< std::set< MooseWritableVariable * > > _writable_coupled_variables

keep a set of allocated writable variable references to make sure only one object can obtain them per...

Definition: Coupleable.h:1821

◆ hasWritableCoupledVariables()

bool Coupleable::hasWritableCoupledVariables ( ) const

inline

Checks whether the object has any writable coupled variables.

Definition at line 139 of file Coupleable.h.

139 { return !getWritableCoupledVariables().empty(); }

Coupleable::getWritableCoupledVariables

auto & getWritableCoupledVariables() const

returns a reference to the set of writable coupled variables

Definition: Coupleable.h:134

◆ isCoupled()

bool Coupleable::isCoupled	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedvirtual

Returns true if a variables has been coupled as name.

Parameters

var_name	The name the kernel wants to refer to the variable as.
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Returns: True if a coupled variable has the supplied name

Definition at line 159 of file Coupleable.C.

Referenced by adCoupledNodalValue(), checkVar(), coupledComponents(), and MatDiffusionBase< Real >::MatDiffusionBase().

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
 
   auto it = _coupled_vars.find(var_name);
   if (it != _coupled_vars.end())
     return (i < it->second.size());
   else
   {
     // Make sure the user originally requested this value in the InputParameter syntax
     if (!_c_parameters.hasCoupledValue(var_name))
       mooseError(_c_name,
                  ": The coupled variable \"",
                  var_name,
                  "\" was never added to this object's "
                  "InputParameters, please double-check your "
                  "spelling");
 
     return false;
   }
 }

◆ isCoupledConstant()

bool Coupleable::isCoupledConstant ( const std::string & var_name ) const

protectedvirtual

Returns true if a variable passed as a coupled value is really a constant.

Parameters

var_name The name the kernel wants to refer to the variable as.

Returns: True if the variable is actually a constant

Definition at line 182 of file Coupleable.C.

Referenced by coupledName(), and DerivativeFunctionMaterialBaseTempl< is_ad >::DerivativeFunctionMaterialBaseTempl().

 {
   return _c_parameters.hasDefaultCoupledValue(var_name);
 }

◆ kokkosCoupledDot()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledDotDu()

Moose::Kokkos::Scalar<const Real> Coupleable::kokkosCoupledDotDu	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledDots()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledDots ( const std::string & var_name )

◆ kokkosCoupledGradient()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradient	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledGradientOld()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradientOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledGradientOlder()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradientOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledGradients()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradients ( const std::string & var_name )

◆ kokkosCoupledGradientsOld()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradientsOld ( const std::string & var_name )

◆ kokkosCoupledGradientsOlder()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledGradientsOlder ( const std::string & var_name )

◆ kokkosCoupledNodalDot()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalDot	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledNodalDots()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalDots ( const std::string & var_name )

◆ kokkosCoupledNodalValue()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledNodalValueOld()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValueOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledNodalValueOlder()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValueOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledNodalValues()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValues ( const std::string & var_name )

◆ kokkosCoupledNodalValuesOld()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValuesOld ( const std::string & var_name )

◆ kokkosCoupledNodalValuesOlder()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledNodalValuesOlder ( const std::string & var_name )

◆ kokkosCoupledValue()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledValueOld()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValueOld	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledValueOlder()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValueOlder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledValues()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValues ( const std::string & var_name )

◆ kokkosCoupledValuesOld()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValuesOld ( const std::string & var_name )

◆ kokkosCoupledValuesOlder()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledValuesOlder ( const std::string & var_name )

◆ kokkosCoupledVectorTagGradient()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledVectorTagGradient	(	const std::string &	var_name,
		const std::string &	tag_param_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagGradientByName()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledVectorTagGradientByName	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagGradients()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledVectorTagGradients	(	const std::string &	var_name,
		const std::string &	tag_param_name
	)

◆ kokkosCoupledVectorTagGradientsByName()

Moose::Kokkos::VariableGradient Coupleable::kokkosCoupledVectorTagGradientsByName	(	const std::string &	var_name,
		const std::string &	tag_name
	)

◆ kokkosCoupledVectorTagNodalValue()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledVectorTagNodalValue	(	const std::string &	var_name,
		const std::string &	tag_param_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagNodalValueByName()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledVectorTagNodalValueByName	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagNodalValues()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledVectorTagNodalValues	(	const std::string &	var_name,
		const std::string &	tag_param_name
	)

◆ kokkosCoupledVectorTagNodalValuesByName()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosCoupledVectorTagNodalValuesByName	(	const std::string &	var_name,
		const std::string &	tag_name
	)

◆ kokkosCoupledVectorTagValue()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledVectorTagValue	(	const std::string &	var_name,
		const std::string &	tag_param_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagValueByName()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledVectorTagValueByName	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp = `0`
	)

◆ kokkosCoupledVectorTagValues()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledVectorTagValues	(	const std::string &	var_name,
		const std::string &	tag_param_name
	)

◆ kokkosCoupledVectorTagValuesByName()

Moose::Kokkos::VariableValue Coupleable::kokkosCoupledVectorTagValuesByName	(	const std::string &	var_name,
		const std::string &	tag_name
	)

◆ kokkosCoupledVectorTagVariable()

Moose::Kokkos::Variable Coupleable::kokkosCoupledVectorTagVariable	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp
	)

private

◆ kokkosCoupledVectorTagVariables()

Moose::Kokkos::Variable Coupleable::kokkosCoupledVectorTagVariables	(	const std::string &	var_name,
		const std::string &	tag_name
	)

private

◆ kokkosZeroGradient()

Moose::Kokkos::VariableGradient Coupleable::kokkosZeroGradient ( )

◆ kokkosZeroNodalValue()

Moose::Kokkos::VariableNodalValue Coupleable::kokkosZeroNodalValue ( )

◆ kokkosZeroValue()

Moose::Kokkos::VariableValue Coupleable::kokkosZeroValue ( )

◆ kokkosZeroVariable()

Moose::Kokkos::Variable Coupleable::kokkosZeroVariable ( )

private

◆ requestStates()

template<typename T >

void Coupleable::requestStates	(	const std::string &	var_name,
		const TagName &	tag_name,
		const unsigned int	comp
	)

private

Method that may request additional solution states from the variable's system depending on the value of tag_name.

E.g. if the tag name corresponds to old or older variable solution values, then we must request more states

Definition at line 578 of file Coupleable.C.

 {
   auto var =
       const_cast<MooseVariableField<T> *>(getVarHelper<MooseVariableField<T>>(var_name, comp));
   if (!var)
     mooseError(var_name, ": invalid variable name for tag coupling");
 
   auto & var_sys = var->sys();
   if (tag_name == Moose::OLD_SOLUTION_TAG)
     var_sys.needSolutionState(1);
   else if (tag_name == Moose::OLDER_SOLUTION_TAG)
     var_sys.needSolutionState(2);
 }

◆ validateExecutionerType()

void Coupleable::validateExecutionerType	(	const std::string &	name,
		const std::string &	fn_name
	)		const

protected

Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.

Parameters

name	the name of the variable
fn_name	The name of the function that called this method - used in the error message

Definition at line 2148 of file Coupleable.C.

 {
   if (!_c_fe_problem.isTransient())
     mooseError(_c_name,
                ": Calling \"",
                fn_name,
                "\" on variable \"",
                name,
                "\" when using a \"Steady\" executioner is not allowed. This value is available "
                "only in transient simulations.");
 }

◆ vectorTagDofValueHelper() [1/2]

template<typename T >

const OutputTools< T >::VariableValue & Coupleable::vectorTagDofValueHelper	(	const std::string &	var_name,
		TagID	tag,
		unsigned int	comp = `0`
	)		const

private

Generic helper method to get vector tag degree of freedom values based on tag ID.

Definition at line 758 of file Coupleable.C.

 {
   const auto * var = getVarHelper<MooseVariableField<T>>(var_name, comp);
   if (!var)
     mooseError(var_name, ": invalid variable name for coupledVectorTagDofValue");
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   const_cast<Coupleable *>(this)->addFEVariableCoupleableVectorTag(tag);
 
   return var->vectorTagDofValue(tag);
 }

◆ vectorTagDofValueHelper() [2/2]

template<typename T >

const OutputTools< T >::VariableValue & Coupleable::vectorTagDofValueHelper	(	const std::string &	var_name,
		const std::string &	tag_name,
		unsigned int	comp = `0`
	)		const

private

Generic helper method to get vector tag degree of freedom values based on tag name.

Definition at line 774 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_param_name))
     mooseError("Tag name parameter '", tag_param_name, "' is invalid");
 
   const TagName tag_name = MooseUtils::toUpper(_c_parameters.get<TagName>(tag_param_name));
 
   const bool older_state_tag = _older_state_tags.count(tag_name);
   if (older_state_tag)
     // We may need to add solution states and create vector tags
     const_cast<Coupleable *>(this)->requestStates<T>(var_name, tag_name, comp);
 
   if (!_c_fe_problem.vectorTagExists(tag_name))
     mooseError("Tagged vector with tag name '", tag_name, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tag_name);
 
   return vectorTagDofValueHelper<T>(var_name, tag, comp);
 }

◆ vectorTagValueHelper() [1/2]

template<typename T >

const OutputTools< T >::VariableValue & Coupleable::vectorTagValueHelper	(	const std::string &	var_names,
		TagID	tag,
		unsigned int	index = `0`
	)		const

private

Generic helper method to get vector tag values based on tag ID.

Definition at line 552 of file Coupleable.C.

 {
   const auto * const var = getVarHelper<MooseVariableField<T>>(var_names, index);
   if (!var)
     mooseError(var_names, ": invalid variable name for coupledVectorTagValue");
   checkFuncType(var_names, VarType::Ignore, FuncAge::Curr);
 
   if (!_c_fe_problem.vectorTagExists(tag))
     mooseError("Attempting to couple to vector tag with ID ",
                tag,
                "in ",
                _c_name,
                ", but a vector tag with that ID does not exist");
 
   const_cast<Coupleable *>(this)->addFEVariableCoupleableVectorTag(tag);
 
   if (_c_nodal)
     return var->nodalVectorTagValue(tag);
   else
     return var->vectorTagValue(tag);
 }

◆ vectorTagValueHelper() [2/2]

template<typename T >

const OutputTools< T >::VariableValue & Coupleable::vectorTagValueHelper	(	const std::string &	var_names,
		const std::string &	tag_name,
		unsigned int	index = `0`
	)		const

private

Generic helper method to get vector tag values based on tag name.

Definition at line 596 of file Coupleable.C.

 {
   if (!_c_parameters.isParamValid(tag_param_name))
     mooseError("Tag name parameter '", tag_param_name, "' is invalid");
 
   const TagName tag_name = MooseUtils::toUpper(_c_parameters.get<TagName>(tag_param_name));
 
   const bool older_state_tag = _older_state_tags.count(tag_name);
   if (older_state_tag)
     // We may need to add solution states and create vector tags
     const_cast<Coupleable *>(this)->requestStates<T>(var_names, tag_name, index);
 
   if (!_c_fe_problem.vectorTagExists(tag_name))
     mooseError("Tagged vector with tag name '", tag_name, "' does not exist");
 
   TagID tag = _c_fe_problem.getVectorTagID(tag_name);
   return vectorTagValueHelper<T>(var_names, tag, index);
 }

◆ writableCoupledValue()

VariableValue & Coupleable::writableCoupledValue	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

protectedvirtual

Returns a writable reference to a coupled variable for writing to multiple AuxVariables from a single AuxKernel or a UserObject.

Only one object can obtain a writable reference in a simulation.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::value

Definition at line 944 of file Coupleable.C.

 {
   mooseDeprecated("Coupleable::writableCoupledValue is deprecated, please use "
                   "Coupleable::writableVariable instead. ");
 
   // check if the variable exists
   auto * const var = getVar(var_name, comp);
   if (!var)
     mooseError(
         "Unable to create a writable reference for '", var_name, "', is it a constant expression?");
 
   // is the requested variable an AuxiliaryVariable?
   if (!_c_fe_problem.getAuxiliarySystem().hasVariable(var->name()))
     mooseError(
         "'", var->name(), "' must be an auxiliary variable in Coupleable::writableCoupledValue");
 
   // check that the variable type (elemental/nodal) is compatible with the object type
   const auto * aux = dynamic_cast<const AuxKernel *>(this);
 
   if (!aux)
     mooseError("writableCoupledValue() can only be called from AuxKernels, but '",
                _obj->name(),
                "' is not an AuxKernel.");
 
   if (!aux->isNodal() && var->isNodal())
     mooseError("The elemental AuxKernel '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
 
   // make sure only one object can access a variable
   checkWritableVar(var);
 
   return const_cast<VariableValue &>(coupledValue(var_name, comp));
 }

◆ writableVariable()

MooseWritableVariable & Coupleable::writableVariable	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)

protected

Returns a writable MooseVariable object for a nodal or elemental variable.

Use var.setNodalValue(val[, idx]) in both cases (!) to set the solution DOF values. Only one object can obtain a writable reference in a simulation. Note that the written values will not ba available in the same system loop! E.g. values written using this API by a nodal AuxKernel will not be updated for other nodal AuxKernels during the same iteration over all nodes.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns: Reference to a MooseWritableVariable for the coupled variable

See also: Kernel::value

Definition at line 908 of file Coupleable.C.

 {
   auto * var = getVarHelper<MooseWritableVariable>(var_name, comp);
 
   const auto * aux = dynamic_cast<const AuxKernel *>(this);
   const auto * euo = dynamic_cast<const ElementUserObject *>(this);
   const auto * nuo = dynamic_cast<const NodalUserObject *>(this);
   const auto * nfc = dynamic_cast<const NodeFaceConstraint *>(this);
   const auto * nec = dynamic_cast<const NodeElemConstraintBase *>(this);
 
   if (!aux && !euo && !nuo && !nfc && !nec)
     mooseError("writableVariable() can only be called from AuxKernels, ElementUserObjects, "
                "NodalUserObjects, NodeFaceConstraints, or NodeElemConstraints. '",
                _obj->name(),
                "' is none of those.");
 
   if (aux && !aux->isNodal() && var->isNodal())
     mooseError("The elemental AuxKernel '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
   if (euo && var->isNodal())
     mooseError("The ElementUserObject '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
 
   // make sure only one object can access a variable
   checkWritableVar(var);
 
   return *var;
 }

Member Data Documentation

◆ _ad_default_curl

MooseArray<ADRealVectorValue> Coupleable::_ad_default_curl

mutableprotected

This will always be zero because the default values for optionally coupled vector variables is always constant.

Definition at line 1492 of file Coupleable.h.

Referenced by getADDefaultCurl().

◆ _ad_default_gradient

MooseArray<ADRealVectorValue> Coupleable::_ad_default_gradient

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1480 of file Coupleable.h.

Referenced by getADDefaultGradient().

◆ _ad_default_second

MooseArray<ADRealTensorValue> Coupleable::_ad_default_second

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1489 of file Coupleable.h.

Referenced by getADDefaultSecond().

◆ _ad_default_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<ADReal> > > Coupleable::_ad_default_value

mutableprotected

Will hold the default value for optional coupled variables for automatic differentiation.

Definition at line 1457 of file Coupleable.h.

Referenced by getADDefaultValue().

◆ _ad_default_vector_gradient

MooseArray<ADRealTensorValue> Coupleable::_ad_default_vector_gradient

mutableprotected

This will always be zero because the default values for optionally coupled vector variables is always constant.

Definition at line 1483 of file Coupleable.h.

Referenced by getADDefaultVectorGradient().

◆ _ad_default_vector_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<ADRealVectorValue> > > Coupleable::_ad_default_vector_value

mutableprotected

Will hold the default value for optional vector coupled variables for automatic differentiation.

Definition at line 1468 of file Coupleable.h.

Referenced by getADDefaultVectorValue().

◆ _ad_grad_zero

const MooseArray<ADRealVectorValue>& Coupleable::_ad_grad_zero

protected

Definition at line 1501 of file Coupleable.h.

Referenced by adZeroGradient().

◆ _ad_second_zero

const MooseArray<ADRealTensorValue>& Coupleable::_ad_second_zero

protected

Definition at line 1508 of file Coupleable.h.

Referenced by adZeroSecond().

◆ _ad_zero

const MooseArray<ADReal>& Coupleable::_ad_zero

protected

Definition at line 1497 of file Coupleable.h.

Referenced by adZeroValue().

◆ _c_allow_element_to_nodal_coupling

const bool Coupleable::_c_allow_element_to_nodal_coupling

protected

Definition at line 1447 of file Coupleable.h.

Referenced by checkVar().

◆ _c_coupled_scalar_vars

std::unordered_map<std::string, std::vector<MooseVariableScalar *> > Coupleable::_c_coupled_scalar_vars

private

Scalar variables coupled into this object (for error checking)

Definition at line 1805 of file Coupleable.h.

Referenced by checkVar(), and Coupleable().

◆ _c_fe_problem

FEProblemBase& Coupleable::_c_fe_problem

protected

◆ _c_is_implicit

bool Coupleable::_c_is_implicit

protected

True if implicit value is required.

Definition at line 1444 of file Coupleable.h.

◆ _c_name

const std::string& Coupleable::_c_name

protected

The name of the object this interface is part of.

Definition at line 1409 of file Coupleable.h.

Referenced by checkFuncType(), checkVar(), coupledName(), coupledNodalValue(), coupledNodalValueOld(), coupledNodalValueOlder(), coupledValueLower(), coupledVectorTagArrayGradient(), coupledVectorTagGradient(), getVectorVar(), isCoupled(), validateExecutionerType(), and vectorTagValueHelper().

◆ _c_nodal

bool Coupleable::_c_nodal

protected

True if we provide coupling to nodal values.

Definition at line 1441 of file Coupleable.h.

Referenced by adCoupledDot(), adCoupledDotDot(), adCoupledLowerValue(), adCoupledNodalValue(), adCoupledValue(), adCoupledVectorDot(), adCoupledVectorValue(), checkFuncType(), checkVar(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledMatrixTagValue(), coupledValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorValue(), coupledVectorValueOld(), getVectorVar(), and vectorTagValueHelper().

◆ _c_parameters

const InputParameters& Coupleable::_c_parameters

protected

◆ _c_sys

const SystemBase* const Coupleable::_c_sys

protected

Pointer to the system object if the moose object this is an interface for has one.

Definition at line 1417 of file Coupleable.h.

Referenced by coupled().

◆ _c_tid

THREAD_ID Coupleable::_c_tid

protected

Thread ID of the thread using this object.

Definition at line 1450 of file Coupleable.h.

Referenced by checkWritableVar(), Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), and getWritableCoupledVariables().

◆ _c_type

const std::string& Coupleable::_c_type

protected

The type of the object this interface is part of.

Definition at line 1411 of file Coupleable.h.

◆ _coupleable_max_qps

unsigned int Coupleable::_coupleable_max_qps

private

Maximum qps for any element in this system.

Definition at line 1799 of file Coupleable.h.

Referenced by coupledArrayDotDu(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), coupledDiv(), coupledDivOld(), coupledDivOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledGradient(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), coupledGradientPreviousNL(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledSecond(), coupledSecondOld(), coupledSecondOlder(), coupledSecondPreviousNL(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), getADDefaultCurl(), getADDefaultGradient(), getADDefaultSecond(), getADDefaultValue(), getADDefaultVectorGradient(), getADDefaultVectorValue(), getDefaultArrayValue(), getDefaultValue(), and getDefaultVectorValue().

◆ _coupleable_neighbor

bool Coupleable::_coupleable_neighbor

protected

Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values.

Definition at line 1713 of file Coupleable.h.

Referenced by adCoupledCurl(), adCoupledDofValues(), adCoupledDot(), adCoupledDotDot(), adCoupledGradient(), adCoupledGradientDot(), adCoupledNodalValue(), adCoupledSecond(), adCoupledValue(), adCoupledVectorDot(), adCoupledVectorGradient(), adCoupledVectorValue(), coupledArrayDofValues(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), coupledArrayGradientOlder(), coupledArrayValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), coupledDiv(), coupledDivOld(), coupledDivOlder(), coupledDofValues(), coupledDofValuesOld(), coupledDofValuesOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledGradient(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), coupledGradientPreviousNL(), coupledNodalDot(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledNodalValue(), coupledNodalValueOld(), coupledNodalValueOlder(), coupledNodalValuePreviousNL(), coupledSecond(), coupledSecondOld(), coupledSecondOlder(), coupledSecondPreviousNL(), coupledValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().

◆ _coupled_array_moose_vars

std::vector<ArrayMooseVariable *> Coupleable::_coupled_array_moose_vars

protected

Vector of array coupled variables.

Definition at line 1432 of file Coupleable.h.

Referenced by Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), getCoupledArrayMooseVars(), and getVarHelper().

◆ _coupled_fv_moose_vars

std::vector<MooseVariableField<Real> *> Coupleable::_coupled_fv_moose_vars

protected

Vector of all finite volume coupled variables.

Definition at line 1435 of file Coupleable.h.

Referenced by Coupleable(), SideValueSampler::execute(), ElementValueSampler::execute(), getVarHelper(), and SideValueSampler::SideValueSampler().

◆ _coupled_moose_vars

std::vector<MooseVariableFieldBase *> Coupleable::_coupled_moose_vars

protected

Vector of all coupled variables.

Definition at line 1423 of file Coupleable.h.

Referenced by Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), ElementValueSampler::ElementValueSampler(), SideValueSampler::execute(), ElementValueSampler::execute(), PointVariableSamplerBase::execute(), getCoupledMooseVars(), PointVariableSamplerBase::initialize(), InterfaceUserObject::InterfaceUserObject(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), NodalValueSampler::NodalValueSampler(), PointVariableSamplerBase::PointVariableSamplerBase(), and SideValueSampler::SideValueSampler().

◆ _coupled_standard_moose_vars

std::vector<MooseVariable *> Coupleable::_coupled_standard_moose_vars

protected

Vector of standard coupled variables.

Definition at line 1426 of file Coupleable.h.

Referenced by Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), ElementValueSampler::execute(), NodalValueSampler::execute(), getCoupledStandardMooseVars(), and getVarHelper().

◆ _coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFieldBase *> > Coupleable::_coupled_vars

protected

Coupled vars whose values we provide.

Definition at line 1420 of file Coupleable.h.

Referenced by checkVar(), Coupleable(), coupledComponents(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), getCoupledVars(), getVarHelper(), and isCoupled().

◆ _coupled_vector_moose_vars

std::vector<VectorMooseVariable *> Coupleable::_coupled_vector_moose_vars

protected

Vector of vector coupled variables.

Definition at line 1429 of file Coupleable.h.

Referenced by Coupleable(), getCoupledVectorMooseVars(), and getVarHelper().

◆ _default_array_gradient

ArrayVariableGradient Coupleable::_default_array_gradient

protected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1538 of file Coupleable.h.

Referenced by coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), and coupledArrayGradientOlder().

◆ _default_array_value

std::unordered_map<std::string, std::unique_ptr<ArrayVariableValue> > Coupleable::_default_array_value

mutableprotected

Will hold the default value for optional array coupled variables.

Definition at line 1464 of file Coupleable.h.

Referenced by getDefaultArrayValue().

◆ _default_array_value_zero

ArrayVariableValue Coupleable::_default_array_value_zero

protected

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 1535 of file Coupleable.h.

Referenced by coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), and coupledArrayDotOld().

◆ _default_div

VectorVariableDivergence Coupleable::_default_div

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1529 of file Coupleable.h.

Referenced by coupledDiv(), coupledDivOld(), and coupledDivOlder().

◆ _default_gradient

VariableGradient Coupleable::_default_gradient

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1477 of file Coupleable.h.

Referenced by coupledGradient(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), and coupledGradientPreviousNL().

◆ _default_second

VariableSecond Coupleable::_default_second

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1486 of file Coupleable.h.

Referenced by coupledSecond(), coupledSecondOld(), coupledSecondOlder(), and coupledSecondPreviousNL().

◆ _default_value

std::unordered_map<std::string, std::vector<std::unique_ptr<VariableValue> > > Coupleable::_default_value

mutableprotected

Will hold the default value for optional coupled variables.

Definition at line 1454 of file Coupleable.h.

Referenced by getDefaultValue().

◆ _default_value_zero

VariableValue Coupleable::_default_value_zero

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 1474 of file Coupleable.h.

Referenced by coupledArrayDotDu(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledVectorDotDotDu(), and coupledVectorDotDu().

◆ _default_vector_curl

VectorVariableCurl Coupleable::_default_vector_curl

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1526 of file Coupleable.h.

Referenced by coupledCurl(), coupledCurlOld(), and coupledCurlOlder().

◆ _default_vector_gradient

VectorVariableGradient Coupleable::_default_vector_gradient

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 1523 of file Coupleable.h.

Referenced by coupledVectorGradient(), coupledVectorGradientOld(), and coupledVectorGradientOlder().

◆ _default_vector_value

std::unordered_map<std::string, std::unique_ptr<VectorVariableValue> > Coupleable::_default_vector_value

mutableprotected

Will hold the default value for optional vector coupled variables.

Definition at line 1461 of file Coupleable.h.

Referenced by getDefaultVectorValue().

◆ _default_vector_value_zero

VectorVariableValue Coupleable::_default_vector_value_zero

mutableprotected

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 1520 of file Coupleable.h.

Referenced by coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotOld(), and coupledVectorDotOld().

◆ _fe_coupleable_matrix_tags

std::set<TagID> Coupleable::_fe_coupleable_matrix_tags

private

Definition at line 1809 of file Coupleable.h.

Referenced by addFEVariableCoupleableMatrixTag(), and getFEVariableCoupleableMatrixTags().

◆ _fe_coupleable_vector_tags

std::set<TagID> Coupleable::_fe_coupleable_vector_tags

private

Definition at line 1807 of file Coupleable.h.

Referenced by addFEVariableCoupleableVectorTag(), and getFEVariableCoupleableVectorTags().

◆ _grad_phi_zero

const VariablePhiGradient& Coupleable::_grad_phi_zero

protected

Zero gradient of trial function.

Definition at line 1504 of file Coupleable.h.

◆ _grad_zero

const VariableGradient& Coupleable::_grad_zero

protected

Zero gradient of a variable.

Definition at line 1500 of file Coupleable.h.

◆ _is_fv

const bool Coupleable::_is_fv

private

Whether the MooseObject is a finite volume object.

Definition at line 1812 of file Coupleable.h.

Referenced by checkVar().

◆ _kokkos_default_value_zero

const Real Coupleable::_kokkos_default_value_zero = 0

private

kokkos-related variables and methods

Definition at line 1827 of file Coupleable.h.

◆ _new_to_deprecated_coupled_vars

const std::unordered_map<std::string, std::string>& Coupleable::_new_to_deprecated_coupled_vars

protected

map from new to deprecated variable names

Definition at line 1438 of file Coupleable.h.

Referenced by getVarHelper().

◆ _obj

const MooseObject* const Coupleable::_obj

private

Definition at line 1814 of file Coupleable.h.

Referenced by checkVar(), checkWritableVar(), Coupleable(), coupled(), getDefaultValue(), writableCoupledValue(), and writableVariable().

◆ _older_state_tags

const std::set<std::string> Coupleable::_older_state_tags

private

Initial value:

= {Moose::OLD_SOLUTION_TAG,

Moose::OLDER_SOLUTION_TAG}

vector tag names for which we need to request older solution states from the system

Definition at line 1817 of file Coupleable.h.

Referenced by vectorTagDofValueHelper(), and vectorTagValueHelper().

◆ _optional_var_index

std::unordered_map<std::string, std::vector<unsigned int> > Coupleable::_optional_var_index

private

Unique indices for optionally coupled vars that weren't provided.

Definition at line 1802 of file Coupleable.h.

Referenced by Coupleable(), and coupled().

◆ _phi_zero

const VariablePhiValue& Coupleable::_phi_zero

protected

Definition at line 1496 of file Coupleable.h.

◆ _second_phi_zero

const VariablePhiSecond& Coupleable::_second_phi_zero

protected

Zero second derivative of a test function.

Definition at line 1510 of file Coupleable.h.

◆ _second_zero

const VariableSecond& Coupleable::_second_zero

protected

Zero second derivative of a variable.

Definition at line 1507 of file Coupleable.h.

◆ _vector_curl_zero

const VectorVariableCurl& Coupleable::_vector_curl_zero

protected

Zero value of the curl of a vector variable.

Definition at line 1514 of file Coupleable.h.

◆ _vector_zero

const VectorVariableValue& Coupleable::_vector_zero

protected

Zero value of a vector variable.

Definition at line 1512 of file Coupleable.h.

◆ _writable_coupled_variables

std::vector<std::set<MooseWritableVariable *> > Coupleable::_writable_coupled_variables

private

keep a set of allocated writable variable references to make sure only one object can obtain them per thread

Definition at line 1821 of file Coupleable.h.

Referenced by checkWritableVar(), and getWritableCoupledVariables().

◆ _zero

const VariableValue& Coupleable::_zero

protected

Zero value of a variable.

Definition at line 1495 of file Coupleable.h.

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

include/interfaces/Coupleable.h
src/interfaces/Coupleable.C

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ FuncAge

◆ VarType

Constructor & Destructor Documentation

◆ Coupleable() [1/2]

◆ Coupleable() [2/2]

Member Function Documentation

◆ adCoupledCurl()

◆ adCoupledDofValues()

◆ adCoupledDot()

◆ adCoupledDotDot()

◆ adCoupledDots()

◆ adCoupledGradient()

◆ adCoupledGradientDot()

◆ adCoupledGradients()

◆ adCoupledLowerValue()

◆ adCoupledNodalValue()

◆ adCoupledSecond()

◆ adCoupledValue()

◆ adCoupledValues()

◆ adCoupledVectorDot()

◆ adCoupledVectorGradient()

◆ adCoupledVectorSecond()

◆ adCoupledVectorValue()

◆ adCoupledVectorValues()

◆ addFEVariableCoupleableMatrixTag()

◆ addFEVariableCoupleableVectorTag()

◆ adZeroGradient()

◆ adZeroSecond()

◆ adZeroValue()

◆ checkFuncType()

◆ checkVar()

◆ checkWritableVar()

◆ coupled()

◆ coupledAllDofValues()

◆ coupledAllDofValuesOld()

◆ coupledAllDofValuesOlder()

◆ coupledArrayDofValues()

◆ coupledArrayDot()

◆ coupledArrayDotDot()

◆ coupledArrayDotDotOld()

◆ coupledArrayDotDu()

◆ coupledArrayDotOld()

◆ coupledArrayGradient()

◆ coupledArrayGradientDot()

◆ coupledArrayGradientOld()

◆ coupledArrayGradientOlder()

◆ coupledArrayValue()

◆ coupledArrayValueOld()

◆ coupledArrayValueOlder()

◆ coupledArrayValues()

◆ coupledCallback()

◆ coupledComponents()

◆ coupledCurl()

◆ coupledCurlOld()

◆ coupledCurlOlder()

◆ coupledDiv()

◆ coupledDivOld()

◆ coupledDivOlder()

◆ coupledDofValues()

◆ coupledDofValuesOld()

◆ coupledDofValuesOlder()

◆ coupledDot()

◆ coupledDotDot()

◆ coupledDotDotDu()

◆ coupledDotDotOld()

◆ coupledDotDu()

◆ coupledDotOld()

◆ coupledDots()

◆ coupledGenericDofValue() [1/3]

◆ coupledGenericDofValue() [2/3]

◆ coupledGenericDofValue() [3/3]

◆ coupledGenericDot() [1/3]