Interface for objects that needs coupling capabilities. More...
#include <Coupleable.h>
Public Member Functions | |
Coupleable (const MooseObject *moose_object, bool nodal, bool is_fv=false) | |
Constructing the object. 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... | |
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> | |
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... | |
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... | |
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... | |
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 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 > & | 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 |
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< MooseVariableFV< Real > * > | _coupled_standard_fv_moose_vars |
Vector of standard 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< DualReal > > > | _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... | |
const VariableValue & | _zero |
Zero value of a variable. More... | |
const VariablePhiValue & | _phi_zero |
const MooseArray< DualReal > & | _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... | |
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... | |
ArrayVariableCurl | _default_array_curl |
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 |
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... | |
Interface for objects that needs coupling capabilities.
Definition at line 44 of file Coupleable.h.
|
strongprivate |
Enumerator | |
---|---|
Curr | |
Old | |
Older |
Definition at line 1488 of file Coupleable.h.
|
strongprivate |
Enumerator | |
---|---|
Ignore | |
Gradient | |
Second | |
GradientDot | |
Dot |
Definition at line 1495 of file Coupleable.h.
Coupleable::Coupleable | ( | const MooseObject * | moose_object, |
bool | nodal, | ||
bool | is_fv = false |
||
) |
Constructing the object.
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 26 of file Coupleable.C.
|
protectedvirtual |
Returns DOF value of a coupled variable for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2000 of file Coupleable.C.
|
protected |
Time derivative of a coupled variable for ad simulations.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2150 of file Coupleable.C.
Referenced by adCoupledDots().
|
protected |
Second time derivative of a coupled variable for ad simulations.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2167 of file Coupleable.C.
|
protected |
Returns the time derivatives for all of a coupled variable's components for ad simulations.
var_name | Name of coupled variable |
var_name
Definition at line 2632 of file Coupleable.C.
|
protected |
Returns gradient of a coupled variable for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2091 of file Coupleable.C.
Referenced by adCoupledGradients().
|
protected |
Returns gradient of a coupled variable's time derivative for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2108 of file Coupleable.C.
|
protected |
Returns the gradients for all of a coupled variable's components for use in Automatic Differentiation.
var_name | Name of coupled variable |
var_name
Definition at line 2611 of file Coupleable.C.
|
protected |
Returns value of a coupled lower-dimensional variable for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2073 of file Coupleable.C.
|
protected |
Returns AD nodal values of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2031 of file Coupleable.C.
|
protected |
Returns second derivatives of a coupled variable for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2125 of file Coupleable.C.
|
protected |
Returns value of a coupled variable for use in Automatic Differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 2053 of file Coupleable.C.
Referenced by adCoupledValues().
|
protected |
Returns the values for all of a coupled variable's components for use in Automatic Differentiation.
var_name | Name of coupled variable |
var_name
Definition at line 2422 of file Coupleable.C.
|
protected |
Time derivative of a vector coupled variable for ad simulations.
var_name | Name of vector coupled variable |
comp | Component number |
Definition at line 2184 of file Coupleable.C.
|
protected |
Returns gradient of a coupled vector variable for use in Automatic Differentiation.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 2218 of file Coupleable.C.
|
protected |
Returns second derivatives of a coupled vector variable for use in Automatic Differentiation.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
|
protected |
Returns value of a coupled vector variable for use in Automatic Differentiation.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled variables |
Definition at line 2200 of file Coupleable.C.
Referenced by adCoupledVectorValues().
|
protected |
Returns the values for all of a coupled vector variable's components for use in Automatic Differentiation.
var_name | Name of coupled variable |
var_name
Definition at line 2429 of file Coupleable.C.
Definition at line 103 of file Coupleable.h.
Referenced by coupledMatrixTagValue().
Definition at line 101 of file Coupleable.h.
Referenced by coupledVectorTagArrayGradient(), coupledVectorTagGradient(), vectorTagDofValueHelper(), and vectorTagValueHelper().
|
protected |
method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects
Definition at line 2293 of file Coupleable.C.
|
protected |
Retrieve a zero second for automatic differentiation.
Definition at line 2300 of file Coupleable.C.
|
protected |
method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects
Definition at line 2286 of file Coupleable.C.
Definition at line 187 of file Coupleable.C.
Referenced by 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(), 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().
|
protected |
Check that the right kind of variable is being coupled in.
var_name | The name of the coupled variable |
Definition at line 204 of file Coupleable.C.
Referenced by getVarHelper().
|
protected |
Checks that the passed in variable is only accessed writable by one object in a given subdomain.
Definition at line 932 of file Coupleable.C.
Referenced by writableCoupledValue(), and writableVariable().
|
protectedvirtual |
Returns the index for a coupled variable by name.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Reimplemented in ShapeUserObject< ElementUserObject >, and ShapeUserObject< SideUserObject >.
Definition at line 437 of file Coupleable.C.
Referenced by coupledIndices(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), and KernelBase::KernelBase().
|
protected |
Returns DoFs in the current solution vector of all of a coupled variable's components for the local element.
var_name | Name of coupled variable |
Definition at line 1939 of file Coupleable.C.
|
protected |
Returns DoFs in the old solution vector of all of a coupled variable's components for the local element.
var_name | Name of coupled variable |
Definition at line 1959 of file Coupleable.C.
|
protected |
Returns DoFs in the older solution vector of all of a coupled variable's components for the local element.
var_name | Name of coupled variable |
Definition at line 1979 of file Coupleable.C.
|
protectedvirtual |
Returns DoFs in the current solution vector of a coupled array variable for the local element.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1987 of file Coupleable.C.
|
protectedvirtual |
Time derivative of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1314 of file Coupleable.C.
|
protectedvirtual |
Second time derivative of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1336 of file Coupleable.C.
|
protectedvirtual |
Old second time derivative of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1380 of file Coupleable.C.
|
protected |
Time derivative of a coupled array variable with respect to the coefficients.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1452 of file Coupleable.C.
|
protectedvirtual |
Old time derivative of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1358 of file Coupleable.C.
|
protectedvirtual |
Returns gradient of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1622 of file Coupleable.C.
|
protectedvirtual |
Retun a gradient of a coupled array variable's time derivative.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1661 of file Coupleable.C.
|
protectedvirtual |
Returns an old gradient from previous time step of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1635 of file Coupleable.C.
|
protectedvirtual |
Returns an old gradient from two time steps previous of a coupled array variable.
var_name | Name of coupled array variable |
comp | Component number for vector of coupled array variables |
Definition at line 1648 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled array variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 830 of file Coupleable.C.
Referenced by coupledArrayValues().
|
protectedvirtual |
Returns an old value from previous time step of a coupled array variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1074 of file Coupleable.C.
|
protectedvirtual |
Returns an old value from two time steps previous of a coupled array variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1096 of file Coupleable.C.
|
protected |
Returns the values for all of a coupled array variable's components.
var_name | Name of coupled array variable |
var_name
Definition at line 852 of file Coupleable.C.
|
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 134 of file Coupleable.h.
Referenced by checkFuncType().
|
protected |
Number of coupled components.
var_name | Name of the variable |
Definition at line 153 of file Coupleable.C.
Referenced by coupledVectorHelper(), KernelBase::KernelBase(), SpatialAverageBase::SpatialAverageBase(), and VariableValueVolumeHistogram::VariableValueVolumeHistogram().
|
protectedvirtual |
Returns curl of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1674 of file Coupleable.C.
|
protectedvirtual |
Returns an old curl from previous time step of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1690 of file Coupleable.C.
|
protectedvirtual |
Returns an old curl from two time steps previous of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1706 of file Coupleable.C.
|
protectedvirtual |
Returns DoFs in the current solution vector of a coupled variable for the local element.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1926 of file Coupleable.C.
Referenced by coupledAllDofValues().
|
protectedvirtual |
Returns DoFs in the old solution vector of a coupled variable for the local element.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1946 of file Coupleable.C.
Referenced by coupledAllDofValuesOld().
|
protectedvirtual |
Returns DoFs in the older solution vector of a coupled variable for the local element.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1966 of file Coupleable.C.
Referenced by coupledAllDofValuesOlder().
|
protectedvirtual |
Time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, and AuxKernelTempl< Real >.
Definition at line 1118 of file Coupleable.C.
Referenced by AuxKernelTempl< Real >::coupledDot(), and coupledDots().
|
protectedvirtual |
Second time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1143 of file Coupleable.C.
|
protectedvirtual |
Second time derivative of a coupled variable with respect to the coefficients.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1427 of file Coupleable.C.
|
protectedvirtual |
Old second time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1193 of file Coupleable.C.
|
protectedvirtual |
Time derivative of a coupled variable with respect to the coefficients.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, and AuxKernelTempl< Real >.
Definition at line 1402 of file Coupleable.C.
Referenced by AuxKernelTempl< Real >::coupledDotDu().
|
protectedvirtual |
Old time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1168 of file Coupleable.C.
|
protected |
Returns the time derivatives for all of a coupled variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2625 of file Coupleable.C.
|
protected |
Returns DOF value of a coupled variable for use in templated automatic differentiation classes.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
|
protected |
Definition at line 570 of file Coupleable.C.
|
protected |
Definition at line 577 of file Coupleable.C.
|
protected |
Returns gradient of a coupled variable for use in templated automatic differentiation.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
|
protected |
Definition at line 2350 of file Coupleable.C.
|
protected |
Definition at line 2357 of file Coupleable.C.
|
protected |
Returns the gradients for all of a coupled variable's components for use in templated automatic differentiation.
var_name | Name of coupled variable |
var_name
|
protected |
Definition at line 2597 of file Coupleable.C.
|
protected |
Definition at line 2604 of file Coupleable.C.
|
protected |
Returns value of a coupled variable for use in templated automatic differentiation classes.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
|
protected |
Definition at line 465 of file Coupleable.C.
|
protected |
Definition at line 472 of file Coupleable.C.
|
protected |
Returns the values for all of a coupled variable's components for use in templated automatic differentiation classes.
var_name | Name of coupled variable |
var_name
|
protected |
Definition at line 2409 of file Coupleable.C.
|
protected |
Definition at line 2416 of file Coupleable.C.
|
protectedvirtual |
Returns gradient of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1477 of file Coupleable.C.
Referenced by coupledGradients(), NodeElemConstraint::coupledSecondaryGradient(), and NodeFaceConstraint::coupledSecondaryGradient().
|
protectedvirtual |
Time derivative of the gradient of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1542 of file Coupleable.C.
|
protectedvirtual |
Second time derivative of the gradient of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1558 of file Coupleable.C.
|
protectedvirtual |
Returns an old gradient from previous time step of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1493 of file Coupleable.C.
Referenced by coupledGradientsOld(), NodeElemConstraint::coupledSecondaryGradientOld(), and NodeFaceConstraint::coupledSecondaryGradientOld().
|
protectedvirtual |
Returns an old gradient from two time steps previous of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1509 of file Coupleable.C.
Referenced by NodeElemConstraint::coupledSecondaryGradientOlder(), and NodeFaceConstraint::coupledSecondaryGradientOlder().
|
protectedvirtual |
Returns gradient of a coupled variable for previous Newton iterate.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1525 of file Coupleable.C.
|
protected |
Returns the gradients for all of a coupled variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2589 of file Coupleable.C.
|
protected |
Returns the old gradients for all of a coupled variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2618 of file Coupleable.C.
|
protected |
Returns the indices for a coupled variable's components.
var_name | Name of coupled variable |
var_name
. Definition at line 2363 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled variable for a given tag.
This couples the diag vector of matrix
var_names | Name(s) of coupled variable(s) |
tag | matrix tag ID |
index | Index of the desired variable in the vector of coupled variables |
Definition at line 772 of file Coupleable.C.
Referenced by coupledMatrixTagValue(), and coupledMatrixTagValues().
|
protectedvirtual |
Definition at line 789 of file Coupleable.C.
|
protected |
Returns the diagonal matrix values for all the coupled variables desired for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | matrix tag ID |
var_name
Definition at line 2552 of file Coupleable.C.
Referenced by coupledMatrixTagValues().
|
protected |
Definition at line 2560 of file Coupleable.C.
|
protected |
Names of the variable in the Coupleable interface.
var_name | Name of the variable |
comp | the component of the variable |
Definition at line 2370 of file Coupleable.C.
Referenced by coupledNames(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), and SpatialAverageBase::SpatialAverageBase().
|
protected |
Names of the variables in the Coupleable interface.
var_name | Names of the variables |
Definition at line 2387 of file Coupleable.C.
|
protected |
Nodal values of time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1864 of file Coupleable.C.
|
protectedvirtual |
Nodal values of second time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1878 of file Coupleable.C.
|
protectedvirtual |
Nodal values of old second time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1910 of file Coupleable.C.
|
protectedvirtual |
Nodal values of old time derivative of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1894 of file Coupleable.C.
|
protected |
Returns nodal values of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1788 of file Coupleable.C.
|
protected |
Returns an old nodal value from previous time step of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1808 of file Coupleable.C.
|
protected |
Returns an old nodal value from two time steps previous of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1828 of file Coupleable.C.
|
protected |
Returns nodal values of a coupled variable for previous Newton iterate.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1848 of file Coupleable.C.
|
protectedvirtual |
Returns second spatial derivatives of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1722 of file Coupleable.C.
Referenced by NodeElemConstraint::coupledSecondarySecond(), and NodeFaceConstraint::coupledSecondarySecond().
|
protectedvirtual |
Returns an old second spatial derivatives from previous time step of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1738 of file Coupleable.C.
|
protectedvirtual |
Returns an old second derivative from two time steps previous of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1754 of file Coupleable.C.
|
protectedvirtual |
Returns second derivative of a coupled variable for the previous Newton iterate.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1770 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 478 of file Coupleable.C.
Referenced by NodeElemConstraint::coupledSecondaryValue(), NodeFaceConstraint::coupledSecondaryValue(), coupledValues(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), and writableCoupledValue().
|
protectedvirtual |
Returns value of a coupled lower-dimensional variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 583 of file Coupleable.C.
|
protectedvirtual |
Returns an old value from previous time step of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 981 of file Coupleable.C.
Referenced by NodeElemConstraint::coupledSecondaryValueOld(), NodeFaceConstraint::coupledSecondaryValueOld(), coupledValuesOld(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().
|
protectedvirtual |
Returns an old value from two time steps previous of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1003 of file Coupleable.C.
Referenced by NodeElemConstraint::coupledSecondaryValueOlder(), NodeFaceConstraint::coupledSecondaryValueOlder(), coupledValuesOlder(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().
|
protectedvirtual |
Returns value of previous Newton iterate of a coupled variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1025 of file Coupleable.C.
|
protected |
Returns the values for all of a coupled variable components.
var_name | Name of coupled variable |
var_name
Definition at line 2394 of file Coupleable.C.
|
protected |
Returns the old values for all of a coupled variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2575 of file Coupleable.C.
|
protected |
Returns the older values for all of a coupled variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2582 of file Coupleable.C.
|
protectedvirtual |
Time derivative of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1218 of file Coupleable.C.
|
protectedvirtual |
Second time derivative of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1234 of file Coupleable.C.
|
protectedvirtual |
Second time derivative of a coupled vector variable with respect to the coefficients.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1298 of file Coupleable.C.
|
protectedvirtual |
Old second time derivative of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1266 of file Coupleable.C.
|
protectedvirtual |
Time derivative of a coupled vector variable with respect to the coefficients.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1282 of file Coupleable.C.
|
protectedvirtual |
Old time derivative of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1250 of file Coupleable.C.
|
protectedvirtual |
Returns gradient of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1574 of file Coupleable.C.
|
protectedvirtual |
Returns an old gradient from previous time step of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1590 of file Coupleable.C.
|
protectedvirtual |
Returns an old gradient from two time steps previous of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 1606 of file Coupleable.C.
|
inlineprotected |
Definition at line 1604 of file Coupleable.h.
|
protected |
Returns evaluations of a tagged vector at the requested variable's degree of freedom indices.
var_name | Name of coupled variable |
tag_name | vector tag name |
Definition at line 764 of file Coupleable.C.
|
protectedvirtual |
Returns gradient of a coupled array variable for a given tag.
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 |
Definition at line 670 of file Coupleable.C.
Referenced by coupledVectorTagArrayGradient(), and coupledVectorTagArrayGradients().
|
protectedvirtual |
Definition at line 692 of file Coupleable.C.
|
protected |
Returns gradients for all the coupled variables desired for a given tag.
var_names | Name(s) of coupled array variable(s) |
tag | vector tag ID |
var_name
Definition at line 2506 of file Coupleable.C.
Referenced by coupledVectorTagArrayGradients().
|
protected |
Definition at line 2514 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled array variable for a given tag.
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 |
Definition at line 616 of file Coupleable.C.
Referenced by coupledVectorTagArrayValues().
|
protectedvirtual |
Definition at line 624 of file Coupleable.C.
|
protected |
Returns the values for all the coupled variables desired for a given tag.
var_name | Name of array coupled variable |
tag | vector tag ID |
var_names
Definition at line 2460 of file Coupleable.C.
Referenced by coupledVectorTagArrayValues().
|
protected |
Definition at line 2468 of file Coupleable.C.
|
protectedvirtual |
Returns dof value of a coupled variable for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | vector tag ID |
index | Index of the desired variable in the vector of coupled variables |
Definition at line 748 of file Coupleable.C.
Referenced by coupledVectorTagDofValues().
|
protectedvirtual |
Definition at line 756 of file Coupleable.C.
|
protected |
Returns the dof values for all the coupled variables desired for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | vector tag ID |
var_name
Definition at line 2529 of file Coupleable.C.
Referenced by coupledVectorTagDofValues().
|
protected |
Definition at line 2537 of file Coupleable.C.
|
protectedvirtual |
Returns gradient of a coupled variable for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | vector tag ID |
index | Index of the desired variable in the vector of coupled variables |
Definition at line 632 of file Coupleable.C.
Referenced by coupledVectorTagGradient(), and coupledVectorTagGradients().
|
protectedvirtual |
Definition at line 654 of file Coupleable.C.
|
protected |
Returns gradients for all the coupled variables desired for a given tag.
var_names | Name(s) of coupled array variable(s) |
tag | vector tag ID |
var_name
Definition at line 2483 of file Coupleable.C.
Referenced by coupledVectorTagGradients().
|
protected |
Definition at line 2491 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled variable for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | vector tag ID |
index | Index of the desired variable in the vector of coupled variables |
Definition at line 600 of file Coupleable.C.
Referenced by coupledVectorTagValues().
|
protectedvirtual |
Definition at line 608 of file Coupleable.C.
|
protected |
Returns the values for all the coupled variables desired for a given tag.
var_names | Name(s) of coupled variable(s) |
tag | vector tag ID |
var_names
Definition at line 2437 of file Coupleable.C.
Referenced by coupledVectorTagValues().
|
protected |
Definition at line 2445 of file Coupleable.C.
|
protectedvirtual |
Returns value of a coupled vector variable.
var_name | Name of coupled vector variable |
comp | Component number for vector of coupled vector variables |
Definition at line 805 of file Coupleable.C.
Referenced by coupledVectorValues().
|
protectedvirtual |
Returns an old value from previous time step of a coupled vector variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1048 of file Coupleable.C.
|
protectedvirtual |
Returns an old value from two time steps previous of a coupled vector variable.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 1061 of file Coupleable.C.
|
protected |
Returns the values for all of a coupled vector variable's components.
var_name | Name of coupled variable |
var_name
Definition at line 2401 of file Coupleable.C.
|
protected |
Returns zero gradient templated with automatic differentiation boolean.
|
protected |
Definition at line 2322 of file Coupleable.C.
|
protected |
Definition at line 2329 of file Coupleable.C.
|
protected |
Returns zero second derivative templated with automatic differentiation boolean.
|
protected |
Definition at line 2336 of file Coupleable.C.
|
protected |
Definition at line 2343 of file Coupleable.C.
|
protected |
Returns zero value templated with automatic differentiation boolean.
|
protected |
Definition at line 2308 of file Coupleable.C.
|
protected |
Definition at line 2315 of file Coupleable.C.
const ADVariableGradient & Coupleable::getADDefaultGradient | ( | ) | const |
Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled variable.
var_name | the name of the variable for which to retrieve a default gradient |
Definition at line 2265 of file Coupleable.C.
Referenced by adCoupledGradient(), and adCoupledGradientDot().
const ADVariableSecond & Coupleable::getADDefaultSecond | ( | ) | const |
Helper method to return (and insert if necessary) the default second derivatives for Automatic Differentiation for an uncoupled variable.
var_name | the name of the variable for which to retrieve a default second derivative |
Definition at line 2279 of file Coupleable.C.
Referenced by adCoupledSecond().
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.
var_name | the name of the variable for which to retrieve a default value |
Definition at line 2234 of file Coupleable.C.
Referenced by adCoupledDofValues(), adCoupledDot(), adCoupledDotDot(), adCoupledLowerValue(), NeighborCoupleable::adCoupledNeighborValue(), and adCoupledValue().
const ADVectorVariableGradient & Coupleable::getADDefaultVectorGradient | ( | ) | const |
Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled vector variable.
var_name | the name of the vector variable for which to retrieve a default gradient |
Definition at line 2272 of file Coupleable.C.
Referenced by adCoupledVectorGradient().
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.
var_name | the name of the vector variable for which to retrieve a default value |
Definition at line 2248 of file Coupleable.C.
Referenced by adCoupledVectorDot(), NeighborCoupleable::adCoupledVectorNeighborValue(), and adCoupledVectorValue().
|
protected |
Extract pointer to a coupled array variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 301 of file Coupleable.C.
Referenced by ArrayParsedAux::ArrayParsedAux(), 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().
|
protected |
Extract pointer to a coupled array variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 324 of file Coupleable.C.
|
inline |
Get the list of array coupled variables.
Definition at line 96 of file Coupleable.h.
|
inline |
Get the list of all coupled variables.
Definition at line 69 of file Coupleable.h.
Referenced by AuxNodalScalarKernel::AuxNodalScalarKernel(), BuildArrayVariableAux::BuildArrayVariableAux(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), DomainUserObject::DomainUserObject(), ElementIndicator::ElementIndicator(), ElementUserObject::ElementUserObject(), InterfaceMaterial::InterfaceMaterial(), InterfaceUserObjectBase::InterfaceUserObjectBase(), InternalSideIndicator::InternalSideIndicator(), InternalSideUserObject::InternalSideUserObject(), Material::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalScalarKernel::NodalScalarKernel(), NodalUserObject::NodalUserObject(), and SideUserObject::SideUserObject().
|
inline |
Get the list of standard coupled variables.
Definition at line 78 of file Coupleable.h.
|
inline |
Get the list of coupled variables.
Definition at line 60 of file Coupleable.h.
Referenced by InitialConditionBase::InitialConditionBase().
|
inline |
Get the list of vector coupled variables.
Definition at line 87 of file Coupleable.h.
|
private |
Helper method to return (and insert if necessary) the default value for an uncoupled array variable.
var_name | the name of the vector variable for which to retrieve a default value |
Definition at line 392 of file Coupleable.C.
Referenced by coupledArrayDofValues(), coupledArrayValue(), coupledArrayValueOld(), and coupledArrayValueOlder().
|
private |
|
private |
Definition at line 422 of file Coupleable.C.
|
private |
Definition at line 430 of file Coupleable.C.
|
private |
Get nodal default value.
Definition at line 414 of file Coupleable.C.
|
private |
Helper method to return (and insert if necessary) the default value for an uncoupled variable.
var_name | the name of the variable for which to retrieve a default value |
Definition at line 330 of file Coupleable.C.
Referenced by coupledDofValues(), coupledDofValuesOld(), coupledDofValuesOlder(), coupledValue(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), and getDefaultNodalValue().
|
private |
Helper method to return (and insert if necessary) the default value for an uncoupled vector variable.
var_name | the name of the vector variable for which to retrieve a default value |
Definition at line 357 of file Coupleable.C.
Referenced by coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().
|
protected |
Deprecated method.
Use getFieldVar
instead Extract pointer to a base coupled field variable. Could be either a finite volume or finite element variable
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 263 of file Coupleable.C.
|
inline |
Definition at line 107 of file Coupleable.h.
|
inline |
Definition at line 114 of file Coupleable.h.
|
inline |
Definition at line 105 of file Coupleable.h.
Referenced by ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateFEVariableCoupledVectorTagDependencyHelper().
|
inline |
Definition at line 109 of file Coupleable.h.
|
protected |
Definition at line 277 of file Coupleable.C.
Referenced by ArrayParsedAux::ArrayParsedAux(), coupled(), coupledName(), getFEVar(), DomainUserObject::getInterfaceFieldVar(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), and ParsedAux::ParsedAux().
|
protected |
Definition at line 271 of file Coupleable.C.
|
protected |
Extract pointer to a coupled variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 283 of file Coupleable.C.
Referenced by coupledDofValuesOld(), coupledDofValuesOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), coupledGradientPreviousNL(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValueDot(), NeighborCoupleable::coupledNeighborValueDotDu(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledSecond(), coupledSecondOld(), coupledSecondOlder(), coupledSecondPreviousNL(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorTagGradient(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), and writableCoupledValue().
|
protected |
Extract pointer to a coupled variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 307 of file Coupleable.C.
|
protected |
Helper that that be used to retrieve a variable of arbitrary type T
.
Definition at line 1773 of file Coupleable.h.
|
protected |
Helper that can be used to retrieve a variable of arbitrary type T
.
Definition at line 1719 of file Coupleable.h.
|
protected |
Extract pointer to a coupled vector variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 289 of file Coupleable.C.
Referenced by adCoupledVectorDot(), adCoupledVectorGradient(), adCoupledVectorValue(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().
|
protected |
Extract pointer to a coupled vector variable.
var_name | Name of parameter desired |
comp | Component number of multiple coupled variables |
Definition at line 313 of file Coupleable.C.
|
inline |
returns a reference to the set of writable coupled variables
Definition at line 122 of file Coupleable.h.
Referenced by hasWritableCoupledVariables().
|
inline |
Checks whether the object has any writable coupled variables.
Definition at line 127 of file Coupleable.h.
|
protectedvirtual |
Returns true if a variables has been coupled as name.
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. |
Definition at line 124 of file Coupleable.C.
Referenced by adCoupledNodalValue(), checkVar(), coupledComponents(), and MatDiffusionBase< Real >::MatDiffusionBase().
|
protectedvirtual |
Returns true if a variable passed as a coupled value is really a constant.
var_name | The name the kernel wants to refer to the variable as. |
Definition at line 147 of file Coupleable.C.
Referenced by coupledName(), and DerivativeFunctionMaterialBaseTempl< is_ad >::DerivativeFunctionMaterialBaseTempl().
|
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 529 of file Coupleable.C.
|
protected |
Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.
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 2017 of file Coupleable.C.
Referenced by checkFuncType(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), NeighborCoupleable::coupledVectorNeighborGradientOld(), and NeighborCoupleable::coupledVectorNeighborGradientOlder().
|
private |
Generic helper method to get vector tag degree of freedom values based on tag ID.
Definition at line 709 of file Coupleable.C.
|
private |
Generic helper method to get vector tag degree of freedom values based on tag name.
Definition at line 725 of file Coupleable.C.
|
private |
Generic helper method to get vector tag values based on tag ID.
Definition at line 503 of file Coupleable.C.
|
private |
Generic helper method to get vector tag values based on tag name.
Definition at line 547 of file Coupleable.C.
|
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.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 894 of file Coupleable.C.
|
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.
var_name | Name of coupled variable |
comp | Component number for vector of coupled variables |
Definition at line 859 of file Coupleable.C.
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1384 of file Coupleable.h.
Referenced by getADDefaultGradient().
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1393 of file Coupleable.h.
Referenced by getADDefaultSecond().
|
mutableprotected |
Will hold the default value for optional coupled variables for automatic differentiation.
Definition at line 1361 of file Coupleable.h.
Referenced by getADDefaultValue().
|
mutableprotected |
This will always be zero because the default values for optionally coupled vector variables is always constant.
Definition at line 1387 of file Coupleable.h.
Referenced by getADDefaultVectorGradient().
|
mutableprotected |
Will hold the default value for optional vector coupled variables for automatic differentiation.
Definition at line 1372 of file Coupleable.h.
Referenced by getADDefaultVectorValue().
|
protected |
Definition at line 1402 of file Coupleable.h.
Referenced by adZeroGradient().
|
protected |
Definition at line 1409 of file Coupleable.h.
Referenced by adZeroSecond().
|
protected |
Definition at line 1398 of file Coupleable.h.
Referenced by adZeroValue().
|
protected |
Definition at line 1351 of file Coupleable.h.
Referenced by checkVar().
|
private |
Scalar variables coupled into this object (for error checking)
Definition at line 1698 of file Coupleable.h.
Referenced by checkVar(), and Coupleable().
|
protected |
Definition at line 1318 of file Coupleable.h.
Referenced by coupledGradientPreviousNL(), coupledMatrixTagValue(), coupledMatrixTagValues(), coupledNodalValuePreviousNL(), coupledSecondPreviousNL(), coupledValuePreviousNL(), coupledVectorTagArrayGradient(), coupledVectorTagArrayGradients(), coupledVectorTagArrayValues(), coupledVectorTagDofValues(), coupledVectorTagGradient(), coupledVectorTagGradients(), coupledVectorTagValues(), validateExecutionerType(), vectorTagDofValueHelper(), vectorTagValueHelper(), and writableCoupledValue().
|
protected |
True if implicit value is required.
Definition at line 1348 of file Coupleable.h.
Referenced by adCoupledDofValues(), adCoupledGradient(), adCoupledGradientDot(), adCoupledLowerValue(), NeighborCoupleable::adCoupledNeighborGradient(), NeighborCoupleable::adCoupledNeighborValue(), NeighborCoupleable::adCoupledNeighborValueDot(), adCoupledNodalValue(), adCoupledSecond(), adCoupledValue(), adCoupledVectorGradient(), NeighborCoupleable::adCoupledVectorNeighborValue(), adCoupledVectorValue(), checkFuncType(), coupledArrayDofValues(), coupledArrayGradient(), coupledArrayGradientOld(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), coupledArrayValue(), coupledArrayValueOld(), coupledCurl(), coupledCurlOld(), coupledDofValues(), coupledDofValuesOld(), coupledGradient(), coupledGradientOld(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradient(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValue(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), coupledNodalValue(), coupledNodalValueOld(), coupledSecond(), coupledSecondOld(), coupledValue(), coupledValueLower(), coupledValueOld(), coupledVectorGradient(), coupledVectorGradientOld(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), coupledVectorValue(), and coupledVectorValueOld().
|
protected |
The name of the object this interface is part of.
Definition at line 1313 of file Coupleable.h.
Referenced by checkFuncType(), checkVar(), coupledName(), coupledNodalValue(), coupledNodalValueOld(), coupledNodalValueOlder(), coupledValueLower(), coupledVectorTagArrayGradient(), coupledVectorTagGradient(), getVectorVar(), isCoupled(), validateExecutionerType(), and vectorTagValueHelper().
|
protected |
True if we provide coupling to nodal values.
Definition at line 1345 of file Coupleable.h.
Referenced by adCoupledDot(), adCoupledDotDot(), adCoupledLowerValue(), adCoupledNodalValue(), adCoupledValue(), adCoupledVectorDot(), adCoupledVectorValue(), checkFuncType(), checkVar(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayValue(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledMatrixTagValue(), coupledValue(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorValue(), getVectorVar(), and vectorTagValueHelper().
|
protected |
Definition at line 1310 of file Coupleable.h.
Referenced by checkVar(), Coupleable(), coupledComponents(), coupledMatrixTagValue(), coupledMatrixTagValues(), coupledVectorTagArrayGradient(), coupledVectorTagArrayGradients(), coupledVectorTagArrayValues(), coupledVectorTagDofValues(), coupledVectorTagGradient(), coupledVectorTagGradients(), coupledVectorTagValues(), getADDefaultValue(), getADDefaultVectorValue(), getDefaultArrayValue(), getDefaultValue(), getDefaultVectorValue(), getVarHelper(), isCoupled(), isCoupledConstant(), vectorTagDofValueHelper(), and vectorTagValueHelper().
|
protected |
Pointer to the system object if the moose object this is an interface for has one.
Definition at line 1321 of file Coupleable.h.
Referenced by coupled().
|
protected |
Thread ID of the thread using this object.
Definition at line 1354 of file Coupleable.h.
Referenced by checkWritableVar(), Coupleable(), and getWritableCoupledVariables().
|
protected |
The type of the object this interface is part of.
Definition at line 1315 of file Coupleable.h.
|
private |
Maximum qps for any element in this system.
Definition at line 1692 of file Coupleable.h.
Referenced by coupledArrayDotDu(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), 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(), getADDefaultGradient(), getADDefaultSecond(), getADDefaultValue(), getADDefaultVectorGradient(), getADDefaultVectorValue(), getDefaultArrayValue(), getDefaultValue(), and getDefaultVectorValue().
|
protected |
Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values.
Definition at line 1614 of file Coupleable.h.
Referenced by adCoupledDofValues(), adCoupledDot(), adCoupledDotDot(), adCoupledGradient(), adCoupledGradientDot(), adCoupledNodalValue(), adCoupledSecond(), adCoupledValue(), adCoupledVectorDot(), adCoupledVectorGradient(), adCoupledVectorValue(), coupledArrayDofValues(), coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), coupledArrayDotDu(), coupledArrayDotOld(), coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), coupledArrayGradientOlder(), coupledArrayValue(), coupledArrayValueOld(), coupledArrayValueOlder(), coupledCurl(), coupledCurlOld(), coupledCurlOlder(), 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(), coupledValueLower(), coupledValueOld(), coupledValueOlder(), coupledValuePreviousNL(), coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotDu(), coupledVectorDotDotOld(), coupledVectorDotDu(), coupledVectorDotOld(), coupledVectorGradient(), coupledVectorGradientOld(), coupledVectorGradientOlder(), coupledVectorValue(), coupledVectorValueOld(), and coupledVectorValueOlder().
|
protected |
Vector of array coupled variables.
Definition at line 1336 of file Coupleable.h.
Referenced by Coupleable(), getCoupledArrayMooseVars(), and getVarHelper().
|
protected |
Vector of all coupled variables.
Definition at line 1327 of file Coupleable.h.
Referenced by Coupleable(), 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().
|
protected |
Vector of standard finite volume coupled variables.
Definition at line 1339 of file Coupleable.h.
Referenced by Coupleable(), ElementValueSampler::execute(), and getVarHelper().
|
protected |
Vector of standard coupled variables.
Definition at line 1330 of file Coupleable.h.
Referenced by Coupleable(), NodalValueSampler::execute(), ElementValueSampler::execute(), getCoupledStandardMooseVars(), and getVarHelper().
|
protected |
Coupled vars whose values we provide.
Definition at line 1324 of file Coupleable.h.
Referenced by checkVar(), Coupleable(), coupledComponents(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), getCoupledVars(), getVarHelper(), and isCoupled().
|
protected |
Vector of vector coupled variables.
Definition at line 1333 of file Coupleable.h.
Referenced by Coupleable(), getCoupledVectorMooseVars(), and getVarHelper().
|
protected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1439 of file Coupleable.h.
|
protected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1436 of file Coupleable.h.
Referenced by coupledArrayGradient(), coupledArrayGradientDot(), coupledArrayGradientOld(), and coupledArrayGradientOlder().
|
mutableprotected |
Will hold the default value for optional array coupled variables.
Definition at line 1368 of file Coupleable.h.
Referenced by getDefaultArrayValue().
|
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 1433 of file Coupleable.h.
Referenced by coupledArrayDot(), coupledArrayDotDot(), coupledArrayDotDotOld(), and coupledArrayDotOld().
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1381 of file Coupleable.h.
Referenced by coupledGradient(), coupledGradientDot(), coupledGradientDotDot(), coupledGradientOld(), coupledGradientOlder(), and coupledGradientPreviousNL().
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1390 of file Coupleable.h.
Referenced by coupledSecond(), coupledSecondOld(), coupledSecondOlder(), and coupledSecondPreviousNL().
|
mutableprotected |
Will hold the default value for optional coupled variables.
Definition at line 1358 of file Coupleable.h.
Referenced by getDefaultValue().
|
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 1378 of file Coupleable.h.
Referenced by coupledArrayDotDu(), coupledDot(), coupledDotDot(), coupledDotDotDu(), coupledDotDotOld(), coupledDotDu(), coupledDotOld(), coupledNodalDotDot(), coupledNodalDotDotOld(), coupledNodalDotOld(), coupledVectorDotDotDu(), and coupledVectorDotDu().
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1427 of file Coupleable.h.
Referenced by coupledCurl(), coupledCurlOld(), and coupledCurlOlder().
|
mutableprotected |
This will always be zero because the default values for optionally coupled variables is always constant.
Definition at line 1424 of file Coupleable.h.
Referenced by coupledVectorGradient(), coupledVectorGradientOld(), and coupledVectorGradientOlder().
|
mutableprotected |
Will hold the default value for optional vector coupled variables.
Definition at line 1365 of file Coupleable.h.
Referenced by getDefaultVectorValue().
|
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 1421 of file Coupleable.h.
Referenced by coupledVectorDot(), coupledVectorDotDot(), coupledVectorDotDotOld(), and coupledVectorDotOld().
|
private |
Definition at line 1702 of file Coupleable.h.
Referenced by addFEVariableCoupleableMatrixTag(), and getFEVariableCoupleableMatrixTags().
|
private |
Definition at line 1700 of file Coupleable.h.
Referenced by addFEVariableCoupleableVectorTag(), and getFEVariableCoupleableVectorTags().
|
protected |
Zero gradient of trial function.
Definition at line 1405 of file Coupleable.h.
|
protected |
Zero gradient of a variable.
Definition at line 1401 of file Coupleable.h.
|
private |
Whether the MooseObject is a finite volume object.
Definition at line 1705 of file Coupleable.h.
Referenced by checkVar().
|
protected |
map from new to deprecated variable names
Definition at line 1342 of file Coupleable.h.
Referenced by getVarHelper().
|
private |
Definition at line 1707 of file Coupleable.h.
Referenced by checkVar(), checkWritableVar(), Coupleable(), coupled(), getDefaultValue(), writableCoupledValue(), and writableVariable().
|
private |
vector tag names for which we need to request older solution states from the system
Definition at line 1710 of file Coupleable.h.
Referenced by vectorTagDofValueHelper(), and vectorTagValueHelper().
|
private |
Unique indices for optionally coupled vars that weren't provided.
Definition at line 1695 of file Coupleable.h.
Referenced by Coupleable(), and coupled().
|
protected |
Definition at line 1397 of file Coupleable.h.
|
protected |
Zero second derivative of a test function.
Definition at line 1411 of file Coupleable.h.
|
protected |
Zero second derivative of a variable.
Definition at line 1408 of file Coupleable.h.
|
protected |
Zero value of the curl of a vector variable.
Definition at line 1415 of file Coupleable.h.
|
protected |
Zero value of a vector variable.
Definition at line 1413 of file Coupleable.h.
|
private |
keep a set of allocated writable variable references to make sure only one object can obtain them per thread
Definition at line 1714 of file Coupleable.h.
Referenced by checkWritableVar(), and getWritableCoupledVariables().
|
protected |
Zero value of a variable.
Definition at line 1396 of file Coupleable.h.