#include <AuxNodalScalarKernel.h>

Inheritance diagram for AuxNodalScalarKernel:

Public Types
using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...

Public Member Functions
	AuxNodalScalarKernel (const InputParameters &parameters)

virtual void	compute () override
	Evaluate the kernel. More...

MooseVariableScalar &	variable ()
	The variable that this kernel operates on. More...

SubProblem &	subProblem ()

virtual const std::set< std::string > &	getRequestedItems () override
	Return a set containing the names of items requested by the object. More...

virtual const std::set< std::string > &	getSuppliedItems () override
	Return a set containing the names of items owned by the object. More...

virtual bool	isActive ()
	Use this to enable/disable the constraint. More...

virtual bool	enabled () const
	Return the enabled status of the object. More...

std::shared_ptr< MooseObject >	getSharedPtr ()
	Get another shared pointer to this object that has the same ownership group. More...

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with. More...

const std::string &	type () const
	Get the type of this class. More...

virtual const std::string &	name () const
	Get the name of the class. More...

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling. More...

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const
	Calls moose error with the message `msg`. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
	The unique parameter name of a valid parameter of this object for accessing parameter controls. More...

const InputParameters &	parameters () const
	Get the parameters of the object. More...

MooseObjectName	uniqueName () const
	The unique name for accessing input parameters of this object in the InputParameterWarehouse. More...

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

bool	isParamSetByUser (const std::string &nm) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type. More...

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
	Emits a documented error with object name and type. More...

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type. More...

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method. More...

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

const std::vector< MooseVariableScalar * > &	getCoupledMooseScalarVars ()
	Get the list of coupled scalar variables. More...

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

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

virtual void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. More...

virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...

virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...

virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...

virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...

virtual void	customSetup (const ExecFlagType &)
	Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain. More...

const ExecFlagEnum &	getExecuteOnEnum () const
	Return the execute on MultiMooseEnum for this object. More...

const Function &	getFunction (const std::string &name) const
	Get a function with a given name. More...

const Function &	getFunctionByName (const FunctionName &name) const
	Get a function with a given name. More...

bool	hasFunction (const std::string &param_name) const
	Determine if the function exists. More...

bool	hasFunctionByName (const FunctionName &name) const
	Determine if the function exists. More...

UserObjectName	getUserObjectName (const std::string &param_name) const

template<class T >
const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`. More...

template<class T >
const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name `object_name`. More...

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`. More...

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name `object_name`. More...

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
	Determine whether or not the Postprocessor is a default value. More...

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
	Determine if the Postprocessor data exists. More...

bool	hasPostprocessorByName (const PostprocessorName &name) const
	Determine if the Postprocessor data exists. More...

std::size_t	coupledPostprocessors (const std::string &param_name) const
	Returns number of Postprocessors coupled under parameter name. More...

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
	Get the name of a postprocessor. More...

bool	isImplicit ()

Moose::StateArg	determineState () const
	Create a functor state argument that corresponds to the implicit state of this object. More...

virtual void	meshChanged ()
	Called on this object when the mesh changes. 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 ()

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

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

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

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

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

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

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

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

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

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

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

const std::set< MooseVariableFieldBase * > &	getMooseVariableDependencies () const
	Retrieve the set of MooseVariableFieldBase that this object depends on. More...

template<typename DofObjectType >
std::set< MooseVariableFieldBase * >	checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase *> &vars_to_omit={})
	Check whether all of the variable dependencies have degree of freedom indices on the supplied degree of freedom object. More...

template<typename DofObjectType >
std::set< MooseVariableFieldBase * >	checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase *> &vars_to_check)
	Check whether all of the supplied variables have degree of freedom indices on the supplied degree of freedom object. More...

void	addMooseVariableDependency (MooseVariableFieldBase *var)
	Call this function to add the passed in MooseVariableFieldBase as a variable that this object depends on. More...

void	addMooseVariableDependency (const std::vector< MooseVariableFieldBase *> &vars)


bool	hasUserObject (const std::string &param_name) const

template<class T >
bool	hasUserObject (const std::string &param_name) const


bool	hasUserObjectByName (const UserObjectName &object_name) const

template<class T >
bool	hasUserObjectByName (const UserObjectName &object_name) const


const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
	doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values More...

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const


virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const
	Retrieve the value of the Postprocessor. More...

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

template<typename T >
static void	sort (typename std::vector< T > &vector)
	Given a vector, sort using the getRequested/SuppliedItems sets. More...

template<typename T >
static void	sortDFS (typename std::vector< T > &vector)
	Given a vector, sort using the depth-first search. More...

template<typename T , typename T2 >
static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
	A helper method for cyclic errors. More...

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Protected Member Functions
const VariableValue &	uOld () const
	Retrieves the old value of the variable that this AuxScalarKernel operates on. More...

virtual Real	computeValue ()=0
	Compute the value of this kernel. More...

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

unsigned int	coupledScalarComponents (const std::string &var_name) const
	Return the number of components to the coupled scalar variable. More...

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

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
	Returns the order for a scalar coupled variable by name. More...

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

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
	Returns AD value of a scalar coupled variable. More...

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

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

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

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
	Returns value of a scalar coupled variable. More...

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
	Returns value of a scalar coupled variable. More...

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
	Returns the old (previous time step) value of a scalar coupled variable. More...

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
	Returns the older (two time steps previous) value of a scalar coupled variable. More...

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
	Returns the time derivative of a scalar coupled variable. More...

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
	Returns the time derivative of a scalar coupled variable, including its dependence on the nonlinear degrees of freedom through automatic differentiation. More...

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
	Returns the second time derivative of a scalar coupled variable. More...

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
	Returns the old time derivative of a scalar coupled variable. More...

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
	Returns the old second time derivative of a scalar coupled variable. More...

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

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

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

virtual void	addUserObjectDependencyHelper (const UserObject &) const
	Helper for deriving classes to override to add dependencies when a UserObject is requested. More...

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const
	Helper for deriving classes to override to add dependencies when a Postprocessor is requested. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const
	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...

const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const
	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 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

Protected Attributes
std::vector< dof_id_type >	_node_ids
	List of node IDs. More...

SubProblem &	_subproblem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

MooseVariableScalar &	_var

MooseMesh &	_mesh

unsigned int	_i

const VariableValue &	_u

std::set< std::string >	_depend_vars
	Depend AuxKernels. More...

std::set< std::string >	_supplied_vars

const bool &	_enabled
	Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects. More...

MooseApp &	_app
	The MOOSE application this is associated with. More...

const std::string	_type
	The type of this class. More...

const std::string	_name
	The name of this class. More...

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const Parallel::Communicator &	_communicator

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid
	Thread ID of the thread using this object. More...

const Real &	_real_zero
	Scalar zero. More...

const VariableValue &	_scalar_zero
	Zero value of a scalar variable. More...

const Point &	_point_zero
	Zero point. More...

const ExecFlagEnum &	_execute_enum
	Execute settings for this object. More...

const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. More...

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit
	If the object is using implicit or explicit form. More...

Real &	_t
	Time. More...

const Real &	_t_old
	Old time. More...

int &	_t_step
	The number of the time step. More...

Real &	_dt
	Time step size. More...

Real &	_dt_old
	Size of the old time step. More...

bool	_is_transient

FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance. More...

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

std::vector< MooseLinearVariableFV< Real > * >	_coupled_standard_linear_fv_moose_vars
	Vector of standard linear finite volume coupled variables. More...

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

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

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

const bool	_c_allow_element_to_nodal_coupling

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const VariablePhiValue &	_phi_zero

const MooseArray< ADReal > &	_ad_zero

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

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

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

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

const MooseArray< ADRealTensorValue > &	_ad_second_zero

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

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

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

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

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

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

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

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

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

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

Detailed Description

Definition at line 20 of file AuxNodalScalarKernel.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ AuxNodalScalarKernel()

AuxNodalScalarKernel::AuxNodalScalarKernel ( const InputParameters & parameters )

Definition at line 21 of file AuxNodalScalarKernel.C.

   : AuxScalarKernel(parameters),
     Coupleable(this, true),
     MooseVariableDependencyInterface(this),
     _node_ids(getParam<std::vector<dof_id_type>>("nodes"))
 {
   // Fill in the MooseVariable dependencies
   const std::vector<MooseVariableFEBase *> & coupled_vars = getCoupledMooseVars();
   for (const auto & var : coupled_vars)
     addMooseVariableDependency(var);
 }

Member Function Documentation

◆ adCoupledCurl()

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

protectedinherited

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

Parameters

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

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

See also: Kernel::_curl_u

Definition at line 1758 of file Coupleable.C.

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

◆ adCoupledDofValues()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2101 of file Coupleable.C.

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

◆ adCoupledDot()

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

protectedinherited

Time derivative of a coupled variable for ad simulations.

Parameters

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

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

See also: Kernel::dot

Definition at line 2251 of file Coupleable.C.

Referenced by Coupleable::adCoupledDots().

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

◆ adCoupledDotDot()

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

protectedinherited

Second time derivative of a coupled variable for ad simulations.

Parameters

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

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

Definition at line 2274 of file Coupleable.C.

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

◆ adCoupledDots()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2754 of file Coupleable.C.

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

◆ adCoupledGradient()

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

protectedinherited

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

Parameters

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

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

See also: Kernel::gradient

Definition at line 2192 of file Coupleable.C.

Referenced by Coupleable::adCoupledGradients().

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

◆ adCoupledGradientDot()

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

protectedinherited

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

Parameters

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

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

Definition at line 2209 of file Coupleable.C.

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

◆ adCoupledGradients()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableGradient pointers for each component of var_name

Definition at line 2733 of file Coupleable.C.

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

◆ adCoupledLowerValue()

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

protectedinherited

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

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 2174 of file Coupleable.C.

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

◆ adCoupledNodalValue()

template<typename T >

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

protectedinherited

Returns AD nodal values of a coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 2132 of file Coupleable.C.

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

◆ adCoupledScalarDot()

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

protectedinherited

Returns the time derivative of a scalar coupled variable, including its dependence on the nonlinear degrees of freedom through automatic differentiation.

Parameters

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

Returns: Reference to the time derivative at quadrature points for the coupled variable, including automatic differentiation information

Definition at line 252 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "adCoupledScalarDot");
   return getScalarVar(var_name, comp)->adUDot();
 }

◆ adCoupledScalarValue()

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

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 135 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getADDefaultValue(var_name);
 
   auto var = getScalarVar(var_name, comp);
 
   if (_sc_is_implicit)
     return var->adSln();
   else
     mooseError("adCoupledValue for non-implicit calculations is not currently supported. Use "
                "coupledValue instead for non-implicit");
 }

◆ adCoupledSecond()

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

protectedinherited

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

Parameters

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

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

Definition at line 2226 of file Coupleable.C.

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

◆ adCoupledValue()

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

protectedinherited

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

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 2154 of file Coupleable.C.

Referenced by Coupleable::adCoupledValues().

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

◆ adCoupledValues()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableValue pointers for each component of var_name

Definition at line 2536 of file Coupleable.C.

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

◆ adCoupledVectorDot()

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

protectedinherited

Time derivative of a vector coupled variable for ad simulations.

Parameters

var_name	Name of vector coupled variable
comp	Component number

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

See also: Kernel::dot

Definition at line 2291 of file Coupleable.C.

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

◆ adCoupledVectorGradient()

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

protectedinherited

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

Parameters

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

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

See also: Kernel::gradient

Definition at line 2325 of file Coupleable.C.

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

◆ adCoupledVectorSecond()

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

protectedinherited

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

Parameters

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

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

◆ adCoupledVectorValue()

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

protectedinherited

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

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::value

Definition at line 2307 of file Coupleable.C.

Referenced by Coupleable::adCoupledVectorValues().

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

◆ adCoupledVectorValues()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of ADVariableValue pointers for each component of var_name

Definition at line 2543 of file Coupleable.C.

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

◆ addFEVariableCoupleableMatrixTag()

void Coupleable::addFEVariableCoupleableMatrixTag ( TagID tag )

inlineinherited

Definition at line 104 of file Coupleable.h.

Referenced by Coupleable::coupledMatrixTagValue().

104 { _fe_coupleable_matrix_tags.insert(tag); }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1801

◆ addFEVariableCoupleableVectorTag()

void Coupleable::addFEVariableCoupleableVectorTag ( TagID tag )

inlineinherited

Definition at line 102 of file Coupleable.h.

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

102 { _fe_coupleable_vector_tags.insert(tag); }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1799

◆ addMooseVariableDependency() [1/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( MooseVariableFieldBase * var )

inlineinherited

Call this function to add the passed in MooseVariableFieldBase as a variable that this object depends on.

Definition at line 72 of file MooseVariableDependencyInterface.h.

Referenced by ADDGKernel::ADDGKernel(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), ArrayNodalBC::ArrayNodalBC(), AuxKernelTempl< Real >::AuxKernelTempl(), AuxNodalScalarKernel(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), DGKernel::DGKernel(), DiffusionLHDGAssemblyHelper::DiffusionLHDGAssemblyHelper(), DiracKernelTempl< T >::DiracKernelTempl(), ElemElemConstraint::ElemElemConstraint(), ElementIndicator::ElementIndicator(), ElementIntegralArrayVariablePostprocessor::ElementIntegralArrayVariablePostprocessor(), ElementIntegralVariablePostprocessor::ElementIntegralVariablePostprocessor(), ElementIntegralVariableUserObject::ElementIntegralVariableUserObject(), ElementVariablePostprocessor::ElementVariablePostprocessor(), FVBoundaryCondition::FVBoundaryCondition(), FVElementalKernel::FVElementalKernel(), FVInterfaceKernel::FVInterfaceKernel(), IntegratedBC::IntegratedBC(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceMaterial::InterfaceMaterial(), InternalSideIndicatorBase::InternalSideIndicatorBase(), InternalSideIndicatorTempl< ComputeValueType >::InternalSideIndicatorTempl(), InternalSideIntegralVariablePostprocessor::InternalSideIntegralVariablePostprocessor(), IPHDGAssemblyHelper::IPHDGAssemblyHelper(), Kernel::Kernel(), LinearFVBoundaryCondition::LinearFVBoundaryCondition(), LinearFVKernel::LinearFVKernel(), Marker::Marker(), Material::Material(), MortarConstraintBase::MortarConstraintBase(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalBC::NodalBC(), NodalConstraint::NodalConstraint(), NodalKernel::NodalKernel(), NodalScalarKernel::NodalScalarKernel(), NodeElemConstraintBase::NodeElemConstraintBase(), NodeFaceConstraint::NodeFaceConstraint(), PointVariableSamplerBase::PointVariableSamplerBase(), QuadraturePointMarker::QuadraturePointMarker(), SideIntegralVariablePostprocessor::SideIntegralVariablePostprocessor(), SideIntegralVariableUserObject::SideIntegralVariableUserObject(), SideVariablePostprocessor::SideVariablePostprocessor(), VectorIntegratedBC::VectorIntegratedBC(), VectorKernel::VectorKernel(), and VectorNodalBC::VectorNodalBC().

   {
     _moose_variable_dependencies.insert(var);
   }

◆ addMooseVariableDependency() [2/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( const std::vector< MooseVariableFieldBase *> & vars )

inlineinherited

Definition at line 76 of file MooseVariableDependencyInterface.h.

   {
     _moose_variable_dependencies.insert(vars.begin(), vars.end());
   }

◆ addPostprocessorDependencyHelper()

virtual void PostprocessorInterface::addPostprocessorDependencyHelper ( const PostprocessorName & ) const

inlineprotectedvirtualinherited

Helper for deriving classes to override to add dependencies when a Postprocessor is requested.

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

Definition at line 141 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal().

141 {}

◆ addUserObjectDependencyHelper()

virtual void UserObjectInterface::addUserObjectDependencyHelper ( const UserObject & ) const

inlineprotectedvirtualinherited

Helper for deriving classes to override to add dependencies when a UserObject is requested.

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

Definition at line 110 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBaseByName().

110 {}

◆ adZeroGradient()

const ADVariableGradient & Coupleable::adZeroGradient ( ) const

protectedinherited

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

Definition at line 2407 of file Coupleable.C.

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

◆ adZeroSecond()

const ADVariableSecond & Coupleable::adZeroSecond ( ) const

protectedinherited

Retrieve a zero second for automatic differentiation.

Definition at line 2414 of file Coupleable.C.

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

◆ adZeroValue()

const ADVariableValue & Coupleable::adZeroValue ( ) const

protectedinherited

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

Definition at line 2400 of file Coupleable.C.

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

◆ callMooseError()

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix
	)		const

inherited

Calls moose error with the message msg.

Will prefix the message with the subapp name if one exists.

If with_prefix, then add the prefix from errorPrefix() to the error.

Definition at line 33 of file MooseBase.C.

Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().

 {
   _app.getOutputWarehouse().mooseConsole();
   const std::string prefix = _app.isUltimateMaster() ? "" : _app.name();
   if (with_prefix)
     msg = errorPrefix("error") + msg;
   moose::internal::mooseErrorRaw(msg, prefix);
 }

◆ checkAllVariables()

template<typename DofObjectType >

std::set< MooseVariableFieldBase * > MooseVariableDependencyInterface::checkAllVariables	(	const DofObjectType &	dof_object,
		const std::set< MooseVariableFieldBase *> &	vars_to_omit = `{}`
	)

inherited

Check whether all of the variable dependencies have degree of freedom indices on the supplied degree of freedom object.

Parameters

dof_object	The degree of freedom object (an element or node) that we want to check for existence of variable degrees of freedom on
vars_to_omit	Variables that we can omit from checking

Returns: Any variables that do not have degrees of freedom on the supplied degree of freedom object

Definition at line 90 of file MooseVariableDependencyInterface.h.

 {
   if (vars_to_omit.empty())
     return checkVariables(dof_object, _moose_variable_dependencies);
 
   std::set<MooseVariableFieldBase *> vars_to_check;
   std::set_difference(_moose_variable_dependencies.begin(),
                       _moose_variable_dependencies.end(),
                       vars_to_omit.begin(),
                       vars_to_omit.end(),
                       std::inserter(vars_to_check, vars_to_check.begin()));
   return checkVariables(dof_object, vars_to_check);
 }

◆ checkVar()

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

protectedinherited

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

Parameters

var_name The name of the coupled variable

Definition at line 209 of file Coupleable.C.

Referenced by Coupleable::getVarHelper().

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

◆ checkVariables()

template<typename DofObjectType >

template std::set< MooseVariableFieldBase * > MooseVariableDependencyInterface::checkVariables	(	const DofObjectType &	dof_object,
		const std::set< MooseVariableFieldBase *> &	vars_to_check
	)

inherited

Check whether all of the supplied variables have degree of freedom indices on the supplied degree of freedom object.

Parameters

dof_object	The degree of freedom object (an element or node) that we want to check for existence of variable degrees of freedom on
vars_to_check	the variables to check

Returns: Any variables that do not have degrees of freedom on the supplied degree of freedom object

Definition at line 25 of file MooseVariableDependencyInterface.C.

Referenced by MooseVariableDependencyInterface::checkAllVariables().

 {
   std::set<MooseVariableFieldBase *> vars_without_indices;
   for (auto * const var : vars_to_check)
   {
     var->sys().dofMap().dof_indices(&dof_object, _dof_indices, var->number());
     if (_dof_indices.empty())
       vars_without_indices.insert(var);
   }
 
   return vars_without_indices;
 }

◆ checkWritableVar()

void Coupleable::checkWritableVar ( MooseWritableVariable * var )

protectedinherited

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

Definition at line 952 of file Coupleable.C.

Referenced by Coupleable::writableCoupledValue(), and Coupleable::writableVariable().

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

◆ compute()

void AuxNodalScalarKernel::compute ( )

overridevirtual

Evaluate the kernel.

Reimplemented from AuxScalarKernel.

Definition at line 34 of file AuxNodalScalarKernel.C.

 {
   _subproblem.reinitNodes(_node_ids, _tid); // compute variables at nodes
   AuxScalarKernel::compute();
 }

◆ computeValue()

virtual Real AuxScalarKernel::computeValue ( )

protectedpure virtualinherited

Compute the value of this kernel.

Each kernel must implement this.

Returns: The computed value

Implemented in SolutionScalarAux, FunctionScalarAux, QuotientScalarAux, ScalarTagMatrixAux, ScalarTagVectorAux, and ConstantScalarAux.

Referenced by AuxScalarKernel::compute().

◆ connectControllableParams()

void MooseBaseParameterInterface::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 33 of file MooseBaseParameterInterface.C.

 {
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = _factory.getValidParams(object_type).get<std::string>("_moose_base");
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
       primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ coupled()

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

protectedvirtualinherited

Returns the index for a coupled variable by name.

Parameters

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

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

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

Definition at line 442 of file Coupleable.C.

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

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

◆ coupledAllDofValues()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

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

Definition at line 2040 of file Coupleable.C.

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

◆ coupledAllDofValuesOld()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

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

Definition at line 2060 of file Coupleable.C.

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

◆ coupledAllDofValuesOlder()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

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

Definition at line 2080 of file Coupleable.C.

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

◆ coupledArrayDofValues()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2088 of file Coupleable.C.

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

◆ coupledArrayDot()

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

protectedvirtualinherited

Time derivative of a coupled array variable.

Parameters

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

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

Definition at line 1350 of file Coupleable.C.

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

◆ coupledArrayDotDot()

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

protectedvirtualinherited

Second time derivative of a coupled array variable.

Parameters

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

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

Definition at line 1372 of file Coupleable.C.

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

◆ coupledArrayDotDotOld()

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

protectedvirtualinherited

Old second time derivative of a coupled array variable.

Parameters

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

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

Definition at line 1416 of file Coupleable.C.

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

◆ coupledArrayDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 1488 of file Coupleable.C.

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

◆ coupledArrayDotOld()

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

protectedvirtualinherited

Old time derivative of a coupled array variable.

Parameters

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

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

Definition at line 1394 of file Coupleable.C.

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

◆ coupledArrayGradient()

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

protectedvirtualinherited

Returns gradient of a coupled array variable.

Parameters

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

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

Definition at line 1658 of file Coupleable.C.

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

◆ coupledArrayGradientDot()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1697 of file Coupleable.C.

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

◆ coupledArrayGradientOld()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1671 of file Coupleable.C.

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

◆ coupledArrayGradientOlder()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1684 of file Coupleable.C.

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

◆ coupledArrayValue()

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

protectedvirtualinherited

Returns value of a coupled array variable.

Parameters

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

Returns: Reference to a ArrayVariableValue for the coupled vector variable

See also: ArrayKernel::_u

Definition at line 849 of file Coupleable.C.

Referenced by Coupleable::coupledArrayValues().

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

◆ coupledArrayValueOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: ArrayKernel::_u_old

Definition at line 1096 of file Coupleable.C.

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

◆ coupledArrayValueOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: ArrayKernel::_u_older

Definition at line 1118 of file Coupleable.C.

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

◆ coupledArrayValues()

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

protectedinherited

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

Parameters

var_name Name of coupled array variable

Returns: Vector of ArrayVariableValue pointers for each component of var_name

Definition at line 871 of file Coupleable.C.

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

◆ coupledCallback()

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

inlineprotectedvirtualinherited

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 135 of file Coupleable.h.

Referenced by Coupleable::checkFuncType().

135 {}

◆ coupledComponents()

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

protectedinherited

Number of coupled components.

Parameters

var_name Name of the variable

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

Definition at line 158 of file Coupleable.C.

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

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

◆ coupledCurl()

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

protectedvirtualinherited

Returns curl of a coupled variable.

Parameters

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

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

See also: Kernel::_curl_u

Definition at line 1710 of file Coupleable.C.

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

◆ coupledCurlOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::_curl_u_old

Definition at line 1726 of file Coupleable.C.

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

◆ coupledCurlOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::_curl_u_older

Definition at line 1742 of file Coupleable.C.

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

◆ coupledDiv()

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

protectedvirtualinherited

Returns divergence of a coupled variable.

Parameters

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

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

See also: Kernel::_div_u

Definition at line 1775 of file Coupleable.C.

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

◆ coupledDivOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::_div_u_old

Definition at line 1791 of file Coupleable.C.

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

◆ coupledDivOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::_div_u_older

Definition at line 1807 of file Coupleable.C.

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

◆ coupledDofValues()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2027 of file Coupleable.C.

Referenced by Coupleable::coupledAllDofValues().

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

◆ coupledDofValuesOld()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2047 of file Coupleable.C.

Referenced by Coupleable::coupledAllDofValuesOld().

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

◆ coupledDofValuesOlder()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2067 of file Coupleable.C.

Referenced by Coupleable::coupledAllDofValuesOlder().

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

◆ coupledDot()

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

protectedvirtualinherited

Time derivative of a coupled variable.

Parameters

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

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

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

Definition at line 1140 of file Coupleable.C.

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

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

◆ coupledDotDot()

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

protectedvirtualinherited

Second time derivative of a coupled variable.

Parameters

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

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

Definition at line 1165 of file Coupleable.C.

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

◆ coupledDotDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1463 of file Coupleable.C.

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

◆ coupledDotDotOld()

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

protectedvirtualinherited

Old second time derivative of a coupled variable.

Parameters

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

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

Definition at line 1229 of file Coupleable.C.

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

◆ coupledDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

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

Definition at line 1438 of file Coupleable.C.

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

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

◆ coupledDotOld()

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

protectedvirtualinherited

Old time derivative of a coupled variable.

Parameters

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

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

Definition at line 1204 of file Coupleable.C.

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

◆ coupledDots()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2747 of file Coupleable.C.

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

◆ coupledGenericDofValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled variable

◆ coupledGenericDofValue() [2/3]

template<>

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

protectedinherited

Definition at line 589 of file Coupleable.C.

 {
   return coupledDofValues(var_name, comp);
 }

◆ coupledGenericDofValue() [3/3]

template<>

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

protectedinherited

Definition at line 596 of file Coupleable.C.

 {
   return adCoupledDofValues(var_name, comp);
 }

◆ coupledGenericDot() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

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

◆ coupledGenericDot() [2/3]

template<>

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

protectedinherited

Definition at line 2762 of file Coupleable.C.

 {
   return coupledDot(var_name, comp);
 }

◆ coupledGenericDot() [3/3]

template<>

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

protectedinherited

Definition at line 2769 of file Coupleable.C.

 {
   return adCoupledDot(var_name, comp);
 }

◆ coupledGenericDotDot() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

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

◆ coupledGenericDotDot() [2/3]

template<>

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

protectedinherited

Definition at line 1191 of file Coupleable.C.

 {
   return coupledDotDot(var_name, comp);
 }

◆ coupledGenericDotDot() [3/3]

template<>

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

protectedinherited

Definition at line 1198 of file Coupleable.C.

 {
   return adCoupledDotDot(var_name, comp);
 }

◆ coupledGenericGradient() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

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

See also: Kernel::gradient

◆ coupledGenericGradient() [2/3]

template<>

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

protectedinherited

Definition at line 2464 of file Coupleable.C.

 {
   return coupledGradient(var_name, comp);
 }

◆ coupledGenericGradient() [3/3]

template<>

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

protectedinherited

Definition at line 2471 of file Coupleable.C.

 {
   return adCoupledGradient(var_name, comp);
 }

◆ coupledGenericGradients() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

◆ coupledGenericGradients() [2/3]

template<>

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

protectedinherited

Definition at line 2719 of file Coupleable.C.

 {
   return coupledGradients(var_name);
 }

◆ coupledGenericGradients() [3/3]

template<>

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

protectedinherited

Definition at line 2726 of file Coupleable.C.

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

◆ coupledGenericScalarValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled scalar variable

◆ coupledGenericScalarValue() [2/3]

template<>

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

protectedinherited

Definition at line 152 of file ScalarCoupleable.C.

 {
   return coupledScalarValue(var_name, comp);
 }

◆ coupledGenericScalarValue() [3/3]

template<>

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

protectedinherited

Definition at line 160 of file ScalarCoupleable.C.

 {
   return adCoupledScalarValue(var_name, comp);
 }

◆ coupledGenericValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled variable

◆ coupledGenericValue() [2/3]

template<>

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

protectedinherited

Definition at line 470 of file Coupleable.C.

 {
   return coupledValue(var_name, comp);
 }

◆ coupledGenericValue() [3/3]

template<>

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

protectedinherited

Definition at line 477 of file Coupleable.C.

 {
   return adCoupledValue(var_name, comp);
 }

◆ coupledGenericValues() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of GenericVariableValue pointers for each component of var_name

◆ coupledGenericValues() [2/3]

template<>

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

protectedinherited

Definition at line 2523 of file Coupleable.C.

 {
   return coupledValues(var_name);
 }

◆ coupledGenericValues() [3/3]

template<>

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

protectedinherited

Definition at line 2530 of file Coupleable.C.

 {
   return adCoupledValues(var_name);
 }

◆ coupledGenericVectorValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableVectorValue for the coupled variable

◆ coupledGenericVectorValue() [2/3]

template<>

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

protectedinherited

Definition at line 484 of file Coupleable.C.

 {
   return coupledVectorValue(var_name, comp);
 }

◆ coupledGenericVectorValue() [3/3]

template<>

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

protectedinherited

Definition at line 491 of file Coupleable.C.

 {
   return adCoupledVectorValue(var_name, comp);
 }

◆ coupledGradient()

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

protectedvirtualinherited

Returns gradient of a coupled variable.

Parameters

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

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

See also: Kernel::gradient

Definition at line 1513 of file Coupleable.C.

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

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

◆ coupledGradientDot()

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

protectedvirtualinherited

Time derivative of the gradient of a coupled variable.

Parameters

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

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

Definition at line 1578 of file Coupleable.C.

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

◆ coupledGradientDotDot()

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

protectedvirtualinherited

Second time derivative of the gradient of a coupled variable.

Parameters

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

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

Definition at line 1594 of file Coupleable.C.

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

◆ coupledGradientOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::gradientOld

Definition at line 1529 of file Coupleable.C.

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

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

◆ coupledGradientOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::gradientOlder

Definition at line 1545 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondaryGradientOlder().

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

◆ coupledGradientPreviousNL()

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

protectedvirtualinherited

Returns gradient of a coupled variable for previous Newton iterate.

Parameters

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

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

Definition at line 1561 of file Coupleable.C.

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

◆ coupledGradients()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

Definition at line 2711 of file Coupleable.C.

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

◆ coupledGradientsOld()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableGradient pointers for each component of var_name

Definition at line 2740 of file Coupleable.C.

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

◆ coupledIndices()

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

protectedinherited

Returns the indices for a coupled variable's components.

Parameters

var_name Name of coupled variable

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

Definition at line 2477 of file Coupleable.C.

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

◆ coupledMatrixTagScalarValue()

const VariableValue & ScalarCoupleable::coupledMatrixTagScalarValue	(	const std::string &	var_name,
		TagID	tag,
		unsigned int	comp = `0`
	)		const

protectedinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
tag	Tag ID of coupled matrix;
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 202 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   _sc_coupleable_matrix_tags.insert(tag);
 
   return getScalarVar(var_name, comp)->matrixTagSln(tag);
 }

◆ coupledMatrixTagValue() [1/2]

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

protectedvirtualinherited

Returns value of a coupled variable for a given tag.

This couples the diag vector of matrix

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 791 of file Coupleable.C.

Referenced by Coupleable::coupledMatrixTagValue(), and Coupleable::coupledMatrixTagValues().

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

◆ coupledMatrixTagValue() [2/2]

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

protectedvirtualinherited

Definition at line 808 of file Coupleable.C.

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

◆ coupledMatrixTagValues() [1/2]

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

protectedinherited

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

Parameters

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

Returns: Vector of VariableValue pointers for each variable in var_name

Definition at line 2666 of file Coupleable.C.

Referenced by Coupleable::coupledMatrixTagValues().

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

◆ coupledMatrixTagValues() [2/2]

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

protectedinherited

Definition at line 2674 of file Coupleable.C.

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

◆ coupledName()

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

protectedinherited

Names of the variable in the Coupleable interface.

Parameters

var_name	Name of the variable
comp	the component of the variable

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

Definition at line 2484 of file Coupleable.C.

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

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

◆ coupledNames()

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

protectedinherited

Names of the variables in the Coupleable interface.

Parameters

var_name Names of the variables

Returns: names the variables have been coupled as

Definition at line 2501 of file Coupleable.C.

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

◆ coupledNodalDot()

template<typename T >

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

protectedinherited

Nodal values of time derivative of a coupled variable.

Parameters

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

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

Definition at line 1965 of file Coupleable.C.

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

◆ coupledNodalDotDot()

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

protectedvirtualinherited

Nodal values of second time derivative of a coupled variable.

Parameters

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

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

Definition at line 1979 of file Coupleable.C.

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

◆ coupledNodalDotDotOld()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 2011 of file Coupleable.C.

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

◆ coupledNodalDotOld()

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

protectedvirtualinherited

Nodal values of old time derivative of a coupled variable.

Parameters

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

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

Definition at line 1995 of file Coupleable.C.

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

◆ coupledNodalValue()

template<typename T >

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

protectedinherited

Returns nodal values of a coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 1889 of file Coupleable.C.

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

◆ coupledNodalValueOld()

template<typename T >

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

protectedinherited

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

Parameters

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

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

Definition at line 1909 of file Coupleable.C.

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

◆ coupledNodalValueOlder()

template<typename T >

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

protectedinherited

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

Parameters

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

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

Definition at line 1929 of file Coupleable.C.

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

◆ coupledNodalValuePreviousNL()

template<typename T >

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

protectedinherited

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

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 1949 of file Coupleable.C.

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

◆ coupledPostprocessors()

std::size_t PostprocessorInterface::coupledPostprocessors ( const std::string & param_name ) const

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

Returns: Number of coupled post-processors, 1 if it's a single

Definition at line 129 of file PostprocessorInterface.C.

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

 {
   checkParam(param_name);
 
   if (_ppi_params.isType<PostprocessorName>(param_name))
     return 1;
   return _ppi_params.get<std::vector<PostprocessorName>>(param_name).size();
 }

◆ coupledScalar()

unsigned int ScalarCoupleable::coupledScalar	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedinherited

Returns the index for a scalar coupled variable by name.

Parameters

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

Returns: Index of coupled variable

Definition at line 93 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

 {
   checkVar(var_name);
   return getScalarVar(var_name, comp)->number();
 }

◆ coupledScalarComponents()

unsigned int ScalarCoupleable::coupledScalarComponents ( const std::string & var_name ) const

protectedinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 353 of file ScalarCoupleable.C.

 {
   const auto var_name = _sc_parameters.checkForRename(var_name_in);
 
   const auto it = _coupled_scalar_vars.find(var_name);
   if (it != _coupled_scalar_vars.end())
     return it->second.size();
 
   mooseError(_sc_name, ": Trying to get a non-existent variable '", var_name, "'");
 }

◆ coupledScalarDot()

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

protectedinherited

Returns the time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 244 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDot");
   return getScalarVar(var_name, comp)->uDot();
 }

◆ coupledScalarDotDot()

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

protectedinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 260 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDot");
   return getScalarVar(var_name, comp)->uDotDot();
 }

◆ coupledScalarDotDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 292 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDotDu");
   return getScalarVar(var_name, comp)->duDotDotDu();
 }

◆ coupledScalarDotDotOld()

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

protectedinherited

Returns the old second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 276 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDotOld");
   return getScalarVar(var_name, comp)->uDotDotOld();
 }

◆ coupledScalarDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 284 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotDu");
   return getScalarVar(var_name, comp)->duDotDu();
 }

◆ coupledScalarDotOld()

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

protectedinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 268 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   validateExecutionerType(var_name, "coupledScalarDotOld");
   return getScalarVar(var_name, comp)->uDotOld();
 }

◆ coupledScalarOrder()

Order ScalarCoupleable::coupledScalarOrder	(	const std::string &	var_name,
		unsigned int	comp = `0`
	)		const

protectedinherited

Returns the order for a scalar coupled variable by name.

Parameters

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

Returns: Order of coupled variable

Definition at line 100 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return _sc_fe_problem.getMaxScalarOrder();
 
   return getScalarVar(var_name, comp)->order();
 }

◆ coupledScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 124 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   auto var = getScalarVar(var_name, comp);
   return _sc_is_implicit ? var->sln() : var->slnOld();
 }

◆ coupledScalarValueOld()

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

protectedinherited

Returns the old (previous time step) value of a scalar coupled variable.

Parameters

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

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 216 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   validateExecutionerType(var_name, "coupledScalarValueOld");
   auto var = getScalarVar(var_name, comp);
   return _sc_is_implicit ? var->slnOld() : var->slnOlder();
 }

◆ coupledScalarValueOlder()

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

protectedinherited

Returns the older (two time steps previous) value of a scalar coupled variable.

Parameters

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

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 228 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   validateExecutionerType(var_name, "coupledScalarValueOlder");
   auto var = getScalarVar(var_name, comp);
   if (_sc_is_implicit)
     return var->slnOlder();
   else
     mooseError("Older values not available for explicit schemes");
 }

◆ coupledSecond()

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

protectedvirtualinherited

Returns second spatial derivatives of a coupled variable.

Parameters

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

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

See also: Kernel::second

Definition at line 1823 of file Coupleable.C.

Referenced by NodeFaceConstraint::coupledSecondarySecond().

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

◆ coupledSecondOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::secondOld

Definition at line 1839 of file Coupleable.C.

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

◆ coupledSecondOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::secondOlder

Definition at line 1855 of file Coupleable.C.

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

◆ coupledSecondPreviousNL()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1871 of file Coupleable.C.

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

◆ coupledValue()

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

protectedvirtualinherited

Returns value of a coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 497 of file Coupleable.C.

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

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

◆ coupledValueLower()

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

protectedvirtualinherited

Returns value of a coupled lower-dimensional variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 602 of file Coupleable.C.

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

◆ coupledValueOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::valueOld

Definition at line 1001 of file Coupleable.C.

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

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

◆ coupledValueOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::valueOlder

Definition at line 1023 of file Coupleable.C.

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

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

◆ coupledValuePreviousNL()

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

protectedvirtualinherited

Returns value of previous Newton iterate of a coupled variable.

Parameters

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

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

Definition at line 1045 of file Coupleable.C.

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

◆ coupledValues()

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

protectedinherited

Returns the values for all of a coupled variable components.

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2508 of file Coupleable.C.

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

◆ coupledValuesOld()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2689 of file Coupleable.C.

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

◆ coupledValuesOlder()

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

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VariableValue pointers for each component of var_name

Definition at line 2696 of file Coupleable.C.

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

◆ coupledVectorDot()

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

protectedvirtualinherited

Time derivative of a coupled vector variable.

Parameters

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

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

Definition at line 1254 of file Coupleable.C.

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

◆ coupledVectorDotDot()

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

protectedvirtualinherited

Second time derivative of a coupled vector variable.

Parameters

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

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

Definition at line 1270 of file Coupleable.C.

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

◆ coupledVectorDotDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1334 of file Coupleable.C.

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

◆ coupledVectorDotDotOld()

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

protectedvirtualinherited

Old second time derivative of a coupled vector variable.

Parameters

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

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

Definition at line 1302 of file Coupleable.C.

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

◆ coupledVectorDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1318 of file Coupleable.C.

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

◆ coupledVectorDotOld()

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

protectedvirtualinherited

Old time derivative of a coupled vector variable.

Parameters

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

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

Definition at line 1286 of file Coupleable.C.

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

◆ coupledVectorGradient()

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

protectedvirtualinherited

Returns gradient of a coupled vector variable.

Parameters

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

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

Definition at line 1610 of file Coupleable.C.

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

◆ coupledVectorGradientOld()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1626 of file Coupleable.C.

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

◆ coupledVectorGradientOlder()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 1642 of file Coupleable.C.

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

◆ coupledVectorHelper()

template<typename T , typename Func >

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

inlineprotectedinherited

Definition at line 1695 of file Coupleable.h.

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

◆ coupledVectorTagArrayDofValue()

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

protectedinherited

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

Parameters

var_name	Name of coupled variable
tag_name	vector tag name

Returns: Reference to a ArrayVariableValue for the coupled variable

Definition at line 783 of file Coupleable.C.

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

◆ coupledVectorTagArrayGradient() [1/2]

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

protectedvirtualinherited

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

Parameters

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

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

See also: Kernel::gradient

Definition at line 689 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagArrayGradient(), and Coupleable::coupledVectorTagArrayGradients().

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

◆ coupledVectorTagArrayGradient() [2/2]

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

protectedvirtualinherited

Definition at line 711 of file Coupleable.C.

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

◆ coupledVectorTagArrayGradients() [1/2]

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

protectedinherited

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

Parameters

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

Returns: Vector of ArrayVariableGradient pointers for each variable in var_name

Definition at line 2620 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagArrayGradients().

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

◆ coupledVectorTagArrayGradients() [2/2]

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

protectedinherited

Definition at line 2628 of file Coupleable.C.

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

◆ coupledVectorTagArrayValue() [1/2]

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

protectedvirtualinherited

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

Parameters

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

Returns: Reference to a VariableValue for the coupled array variable

See also: Kernel::_u

Definition at line 635 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagArrayValues().

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

◆ coupledVectorTagArrayValue() [2/2]

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

protectedvirtualinherited

Definition at line 643 of file Coupleable.C.

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

◆ coupledVectorTagArrayValues() [1/2]

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

protectedinherited

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

Parameters

var_name	Name of array coupled variable
tag	vector tag ID

Returns: Vector of ArrayVariableValue pointers for each variable in var_names

Definition at line 2574 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagArrayValues().

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

◆ coupledVectorTagArrayValues() [2/2]

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

protectedinherited

Definition at line 2582 of file Coupleable.C.

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

◆ coupledVectorTagDofValue() [1/2]

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

protectedvirtualinherited

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

Parameters

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

Returns: Reference to a DofValue for the coupled variable

Definition at line 767 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagDofValues().

 {
   return vectorTagDofValueHelper<Real>(var_name, tag, comp);
 }

◆ coupledVectorTagDofValue() [2/2]

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

protectedvirtualinherited

Definition at line 775 of file Coupleable.C.

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

◆ coupledVectorTagDofValues() [1/2]

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

protectedinherited

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

Parameters

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

Returns: Vector of VariableValue pointers for each variable in var_name

Definition at line 2643 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagDofValues().

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

◆ coupledVectorTagDofValues() [2/2]

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

protectedinherited

Definition at line 2651 of file Coupleable.C.

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

◆ coupledVectorTagGradient() [1/2]

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

protectedvirtualinherited

Returns gradient of a coupled variable for a given tag.

Parameters

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

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

See also: Kernel::gradient

Definition at line 651 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagGradient(), and Coupleable::coupledVectorTagGradients().

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

◆ coupledVectorTagGradient() [2/2]

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

protectedvirtualinherited

Definition at line 673 of file Coupleable.C.

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

◆ coupledVectorTagGradients() [1/2]

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

protectedinherited

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

Parameters

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

Returns: Vector of VariableGradient pointers for each variables in var_name

Definition at line 2597 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagGradients().

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

◆ coupledVectorTagGradients() [2/2]

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

protectedinherited

Definition at line 2605 of file Coupleable.C.

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

◆ coupledVectorTagScalarValue()

const VariableValue & ScalarCoupleable::coupledVectorTagScalarValue	(	const std::string &	var_name,
		TagID	tag,
		unsigned int	comp = `0`
	)		const

protectedinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
tag	Tag ID of coupled vector ;
comp	Component number for vector of coupled variables

Returns: Reference to a VariableValue for the coupled variable

Definition at line 181 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   if (!_sc_fe_problem.vectorTagExists(tag))
     mooseError("Attempting to couple to vector tag scalar with ID ",
                tag,
                "in ",
                _sc_name,
                ", but a vector tag with that ID does not exist");
 
   _sc_coupleable_vector_tags.insert(tag);
 
   return getScalarVar(var_name, comp)->vectorTagSln(tag);
 }

◆ coupledVectorTagValue() [1/2]

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

protectedvirtualinherited

Returns value of a coupled variable for a given tag.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::_u

Definition at line 619 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagValues().

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

◆ coupledVectorTagValue() [2/2]

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

protectedvirtualinherited

Definition at line 627 of file Coupleable.C.

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

◆ coupledVectorTagValues() [1/2]

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

protectedinherited

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

Parameters

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

Returns: Vector of VariableValue pointers for each variable in var_names

Definition at line 2551 of file Coupleable.C.

Referenced by Coupleable::coupledVectorTagValues().

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

◆ coupledVectorTagValues() [2/2]

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

protectedinherited

Definition at line 2559 of file Coupleable.C.

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

◆ coupledVectorValue()

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

protectedvirtualinherited

Returns value of a coupled vector variable.

Parameters

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

Returns: Reference to a VectorVariableValue for the coupled vector variable

See also: VectorKernel::_u

Definition at line 824 of file Coupleable.C.

Referenced by Coupleable::coupledVectorValues().

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
   if (!_coupleable_neighbor)
   {
     if (_c_nodal)
       return _c_is_implicit ? var->nodalValueArray() : var->nodalValueOldArray();
     else
       return _c_is_implicit ? var->sln() : var->slnOld();
   }
   else
   {
     if (_c_nodal)
       // Since this is at a node, I don't feel like there should be any "neighbor" logic
       return _c_is_implicit ? var->nodalValueArray() : var->nodalValueOldArray();
     else
       return _c_is_implicit ? var->slnNeighbor() : var->slnOldNeighbor();
   }
 }

◆ coupledVectorValueOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: VectorKernel::_u_old

Definition at line 1068 of file Coupleable.C.

Referenced by Coupleable::coupledVectorValuesOld().

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   if (_c_nodal)
     return (_c_is_implicit) ? var->nodalValueOldArray() : var->nodalValueOlderArray();
   if (!_coupleable_neighbor)
     return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
   return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
 }

◆ coupledVectorValueOlder()

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

protectedvirtualinherited

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

Parameters

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

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

See also: VectorKernel::_u_older

Definition at line 1083 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
   if (!_coupleable_neighbor)
     return var->slnOlder();
   return var->slnOlderNeighbor();
 }

◆ coupledVectorValues()

std::vector< const VectorVariableValue * > Coupleable::coupledVectorValues ( const std::string & var_name ) const

protectedinherited

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

Parameters

var_name Name of coupled variable

Returns: Vector of VectorVariableValue pointers for each component of var_name

Definition at line 2515 of file Coupleable.C.

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

◆ coupledVectorValuesOld()

std::vector< const VectorVariableValue * > Coupleable::coupledVectorValuesOld ( const std::string & var_name ) const

protectedinherited

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

Parameters

var_name Name of coupled vector variable

Returns: Vector of VectorVariableValue pointers for each component of var_name

Definition at line 2703 of file Coupleable.C.

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

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ cyclicDependencyError()

template<typename T , typename T2 >

void DependencyResolverInterface::cyclicDependencyError	(	CyclicDependencyException< T2 > &	e,
		const std::string &	header
	)

staticinherited

A helper method for cyclic errors.

Definition at line 119 of file DependencyResolverInterface.h.

 {
   std::ostringstream oss;
 
   oss << header << ":\n";
   const auto cycle = e.getCyclicDependencies();
   std::vector<std::string> names(cycle.size());
   for (const auto i : index_range(cycle))
     names[i] = static_cast<T>(cycle[i])->name();
   oss << MooseUtils::join(names, " <- ");
   mooseError(oss.str());
 }

◆ determineState()

Moose::StateArg TransientInterface::determineState ( ) const

inlineinherited

Create a functor state argument that corresponds to the implicit state of this object.

If we are implicit then we will return the current state. If we are not, then we will return the old state

Definition at line 83 of file TransientInterface.h.

 {
   return _is_implicit ? Moose::currentState() : Moose::oldState();
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 40 of file MooseObject.h.

Referenced by EigenKernel::enabled().

40 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition: MooseObject.h:51

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & error_type ) const

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ genericZeroGradient() [1/3]

template<bool is_ad>

const GenericVariableGradient<is_ad>& Coupleable::genericZeroGradient ( )

protectedinherited

Returns zero gradient templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroGradient() [2/3]

template<>

const GenericVariableGradient<false>& Coupleable::genericZeroGradient ( )

protectedinherited

Definition at line 2436 of file Coupleable.C.

 {
   return _grad_zero;
 }

◆ genericZeroGradient() [3/3]

template<>

const GenericVariableGradient<true>& Coupleable::genericZeroGradient ( )

protectedinherited

Definition at line 2443 of file Coupleable.C.

 {
   return _ad_grad_zero;
 }

◆ genericZeroSecond() [1/3]

template<bool is_ad>

const GenericVariableSecond<is_ad>& Coupleable::genericZeroSecond ( )

protectedinherited

Returns zero second derivative templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroSecond() [2/3]

template<>

const GenericVariableSecond<false>& Coupleable::genericZeroSecond ( )

protectedinherited

Definition at line 2450 of file Coupleable.C.

 {
   return _second_zero;
 }

◆ genericZeroSecond() [3/3]

template<>

const GenericVariableSecond<true>& Coupleable::genericZeroSecond ( )

protectedinherited

Definition at line 2457 of file Coupleable.C.

 {
   return _ad_second_zero;
 }

◆ genericZeroValue() [1/3]

template<bool is_ad>

const GenericVariableValue<is_ad>& Coupleable::genericZeroValue ( )

protectedinherited

Returns zero value templated with automatic differentiation boolean.

Returns: Reference to a const GenericVariableValue

◆ genericZeroValue() [2/3]

template<>

const GenericVariableValue<false>& Coupleable::genericZeroValue ( )

protectedinherited

Definition at line 2422 of file Coupleable.C.

 {
   return _zero;
 }

◆ genericZeroValue() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::genericZeroValue ( )

protectedinherited

Definition at line 2429 of file Coupleable.C.

 {
   return _ad_zero;
 }

◆ getADDefaultCurl()

const ADVectorVariableCurl & Coupleable::getADDefaultCurl ( ) const

inherited

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

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: Reference to a ADVectorVariableCurl containing zero entries for the default values

Definition at line 2393 of file Coupleable.C.

Referenced by Coupleable::adCoupledCurl().

 {
   _ad_default_curl.resize(_coupleable_max_qps);
   return _ad_default_curl;
 }

◆ getADDefaultGradient()

const ADVariableGradient & Coupleable::getADDefaultGradient ( ) const

inherited

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

Parameters

var_name the name of the variable for which to retrieve a default gradient

Returns: Reference to a ADVariableGradient containing zero entries for the default values

Definition at line 2372 of file Coupleable.C.

Referenced by Coupleable::adCoupledGradient(), and Coupleable::adCoupledGradientDot().

 {
   _ad_default_gradient.resize(_coupleable_max_qps);
   return _ad_default_gradient;
 }

◆ getADDefaultSecond()

const ADVariableSecond & Coupleable::getADDefaultSecond ( ) const

inherited

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

Parameters

var_name the name of the variable for which to retrieve a default second derivative

Returns: Reference to a ADVariableSecond containing zero entries for the default values

Definition at line 2386 of file Coupleable.C.

Referenced by Coupleable::adCoupledSecond().

 {
   _ad_default_second.resize(_coupleable_max_qps);
   return _ad_default_second;
 }

◆ getADDefaultValue()

const ADVariableValue * Coupleable::getADDefaultValue ( const std::string & var_name ) const

inherited

Helper method to return (and insert if necessary) the default value for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: VariableValue * a pointer to the associated VariableValue.

Definition at line 2341 of file Coupleable.C.

Referenced by Coupleable::adCoupledDofValues(), Coupleable::adCoupledDot(), Coupleable::adCoupledDotDot(), Coupleable::adCoupledLowerValue(), NeighborCoupleable::adCoupledNeighborValue(), and Coupleable::adCoupledValue().

 {
   auto default_value_it = _ad_default_value.find(var_name);
   if (default_value_it == _ad_default_value.end())
   {
     auto value = std::make_unique<ADVariableValue>(_coupleable_max_qps,
                                                    _c_parameters.defaultCoupledValue(var_name));
     default_value_it = _ad_default_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getADDefaultVectorGradient()

const ADVectorVariableGradient & Coupleable::getADDefaultVectorGradient ( ) const

inherited

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

Parameters

var_name the name of the vector variable for which to retrieve a default gradient

Returns: Reference to a ADVectorVariableGradient containing zero entries for the default values

Definition at line 2379 of file Coupleable.C.

Referenced by Coupleable::adCoupledVectorGradient().

 {
   _ad_default_vector_gradient.resize(_coupleable_max_qps);
   return _ad_default_vector_gradient;
 }

◆ getADDefaultVectorValue()

const ADVectorVariableValue * Coupleable::getADDefaultVectorValue ( const std::string & var_name ) const

inherited

Helper method to return (and insert if necessary) the default vector value for Automatic Differentiation for an uncoupled variable.

Parameters

var_name the name of the vector variable for which to retrieve a default value

Returns: VectorVariableValue * a pointer to the associated VectorVariableValue.

Definition at line 2355 of file Coupleable.C.

Referenced by Coupleable::adCoupledVectorDot(), NeighborCoupleable::adCoupledVectorNeighborValue(), and Coupleable::adCoupledVectorValue().

 {
   auto default_value_it = _ad_default_vector_value.find(var_name);
   if (default_value_it == _ad_default_vector_value.end())
   {
     RealVectorValue default_vec;
     for (unsigned int i = 0; i < _c_parameters.numberDefaultCoupledValues(var_name); ++i)
       default_vec(i) = _c_parameters.defaultCoupledValue(var_name, i);
     auto value = std::make_unique<ADVectorVariableValue>(_coupleable_max_qps, default_vec);
     default_value_it =
         _ad_default_vector_value.insert(std::make_pair(var_name, std::move(value))).first;
   }
 
   return default_value_it->second.get();
 }

◆ getArrayVar() [1/2]

ArrayMooseVariable * Coupleable::getArrayVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protectedinherited

Extract pointer to a coupled array variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 306 of file Coupleable.C.

 {
   return const_cast<ArrayMooseVariable *>(getVarHelper<ArrayMooseVariable>(var_name, comp));
 }

◆ getArrayVar() [2/2]

const ArrayMooseVariable * Coupleable::getArrayVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a coupled array variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 329 of file Coupleable.C.

 {
   return getVarHelper<ArrayMooseVariable>(var_name, comp);
 }

◆ getCheckedPointerParam()

template<typename T >

T MooseBaseParameterInterface::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 286 of file MooseBaseParameterInterface.h.

 {
   return parameters().getCheckedPointerParam<T>(name, error_string);
 }

◆ getCoupledArrayMooseVars()

const std::vector<ArrayMooseVariable *>& Coupleable::getCoupledArrayMooseVars ( ) const

inlineinherited

Get the list of array coupled variables.

Returns: The list of array coupled variables

Definition at line 97 of file Coupleable.h.

   {
     return _coupled_array_moose_vars;
   }

◆ getCoupledMooseScalarVars()

const std::vector<MooseVariableScalar *>& ScalarCoupleable::getCoupledMooseScalarVars ( )

inlineinherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 45 of file ScalarCoupleable.h.

Referenced by AuxScalarKernel::AuxScalarKernel(), MortarScalarBase::computeJacobian(), and ScalarInitialCondition::ScalarInitialCondition().

   {
     return _coupled_moose_scalar_vars;
   }

◆ getCoupledMooseVars()

const std::vector<MooseVariableFieldBase *>& Coupleable::getCoupledMooseVars ( ) const

inlineinherited

Get the list of all coupled variables.

Returns: The list of all coupled variables

Definition at line 70 of file Coupleable.h.

Referenced by AuxNodalScalarKernel(), BuildArrayVariableAux::BuildArrayVariableAux(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), ElementIndicator::ElementIndicator(), InterfaceMaterial::InterfaceMaterial(), InternalSideIndicatorBase::InternalSideIndicatorBase(), Material::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), and NodalScalarKernel::NodalScalarKernel().

   {
     return _coupled_moose_vars;
   }

◆ getCoupledStandardMooseVars()

const std::vector<MooseVariable *>& Coupleable::getCoupledStandardMooseVars ( ) const

inlineinherited

Get the list of standard coupled variables.

Returns: The list of standard coupled variables

Definition at line 79 of file Coupleable.h.

   {
     return _coupled_standard_moose_vars;
   }

◆ getCoupledVars()

const std::unordered_map<std::string, std::vector<MooseVariableFieldBase *> >& Coupleable::getCoupledVars ( ) const

inlineinherited

Get the list of coupled variables.

Returns: The list of coupled variables

Definition at line 61 of file Coupleable.h.

Referenced by InitialConditionBase::InitialConditionBase().

   {
     return _coupled_vars;
   }

◆ getCoupledVectorMooseVars()

const std::vector<VectorMooseVariable *>& Coupleable::getCoupledVectorMooseVars ( ) const

inlineinherited

Get the list of vector coupled variables.

Returns: The list of vector coupled variables

Definition at line 88 of file Coupleable.h.

   {
     return _coupled_vector_moose_vars;
   }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), Control::Control(), EigenExecutionerBase::init(), MultiAppConservativeTransfer::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getFEVar()

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

protectedinherited

Deprecated method.

Use getFieldVar instead Extract pointer to a base coupled field variable. Could be either a finite volume or finite element variable

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 268 of file Coupleable.C.

 {
   mooseDeprecated("Coupleable::getFEVar is deprecated. Please use Coupleable::getFieldVar instead. "
                   "Note that this method could potentially return a finite volume variable");
   return getFieldVar(var_name, comp);
 }

◆ getFEVariableCoupleableMatrixTags() [1/2]

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

inlineinherited

Definition at line 108 of file Coupleable.h.

108 { return _fe_coupleable_matrix_tags; }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1801

◆ getFEVariableCoupleableMatrixTags() [2/2]

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

inlineinherited

Definition at line 115 of file Coupleable.h.

   {
     return _fe_coupleable_matrix_tags;
   }

◆ getFEVariableCoupleableVectorTags() [1/2]

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

inlineinherited

Definition at line 106 of file Coupleable.h.

Referenced by ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateFEVariableCoupledVectorTagDependencyHelper().

106 { return _fe_coupleable_vector_tags; }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1799

◆ getFEVariableCoupleableVectorTags() [2/2]

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

inlineinherited

Definition at line 110 of file Coupleable.h.

   {
     return _fe_coupleable_vector_tags;
   }

◆ getFieldVar() [1/2]

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

protectedinherited

Definition at line 282 of file Coupleable.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), Coupleable::coupled(), Coupleable::coupledName(), Coupleable::getFEVar(), DomainUserObject::getInterfaceFieldVar(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), and InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor().

 {
   return getVarHelper<MooseVariableFieldBase>(var_name, comp);
 }

◆ getFieldVar() [2/2]

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

protectedinherited

Definition at line 276 of file Coupleable.C.

 {
   return getVarHelper<MooseVariableFieldBase>(var_name, comp);
 }

◆ getFunction()

const Function & FunctionInterface::getFunction ( const std::string & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the parameter key of the function to retrieve

Returns: The function with name associated with the parameter 'name'

Definition at line 30 of file FunctionInterface.C.

Referenced by FunctionDT::FunctionDT(), and Output::Output().

 {
   return _fni_feproblem.getFunction(_fni_params.get<FunctionName>(name), _fni_tid);
 }

◆ getFunctionByName()

const Function & FunctionInterface::getFunctionByName ( const FunctionName & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 36 of file FunctionInterface.C.

Referenced by ArrayBodyForce::ArrayBodyForce(), ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionArrayAux::FunctionArrayAux(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterialTempl< is_ad >::GenericFunctionMaterialTempl(), GenericFunctionRankTwoTensorTempl< is_ad >::GenericFunctionRankTwoTensorTempl(), GenericFunctionVectorMaterialTempl< is_ad >::GenericFunctionVectorMaterialTempl(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

 {
   return _fni_feproblem.getFunction(name, _fni_tid);
 }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ getMooseVariableDependencies()

const std::set<MooseVariableFieldBase *>& MooseVariableDependencyInterface::getMooseVariableDependencies ( ) const

inlineinherited

Retrieve the set of MooseVariableFieldBase that this object depends on.

Returns: The MooseVariableFieldBase that MUST be reinited before evaluating this object

Definition at line 35 of file MooseVariableDependencyInterface.h.

Referenced by ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateVariableDependencyHelper().

   {
     return _moose_variable_dependencies;
   }

◆ getParam() [1/2]

template<typename T >

const T & MooseBaseParameterInterface::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 215 of file MooseBaseParameterInterface.h.

 {
   return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0), &_moose_base);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 279 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getPostprocessorName()

const PostprocessorName & PostprocessorInterface::getPostprocessorName	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Get the name of a postprocessor.

This can only be used if the postprocessor parameter does not have a default value set (see isDefaultPostprocessorValue()), in which case the "name" is actually the default value.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: The name of the given Postprocessor

Definition at line 185 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return getPostprocessorNameInternal(param_name, index, /* allow_default_value = */ false);
 }

◆ getPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValue	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values

Parameters

param_name	The name of the Postprocessor parameter (see below)
index	The index of the Postprocessor

Returns: A reference to the desired value

The name required by this method is the name that is hard-coded into your source code. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 36 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel(), FunctionValuePostprocessor::FunctionValuePostprocessor(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), and ParsedPostprocessor::ParsedPostprocessor().

 {
   return getPostprocessorValueInternal(param_name, index, /* t_index = */ 0);
 }

◆ getPostprocessorValueByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueByName ( const PostprocessorName & name ) const

virtualinherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns: A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 57 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel(), PIDTransientControl::execute(), IterationAdaptiveDT::IterationAdaptiveDT(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), ParsedODEKernel::ParsedODEKernel(), SecantSolve::savePostprocessorValues(), SteffensenSolve::savePostprocessorValues(), PicardSolve::savePostprocessorValues(), WebServerControl::startServer(), Terminator::Terminator(), SecantSolve::transformPostprocessors(), SteffensenSolve::transformPostprocessors(), PicardSolve::transformPostprocessors(), and VectorOfPostprocessors::VectorOfPostprocessors().

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 0);
 }

◆ getPostprocessorValueOld()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOld	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Definition at line 43 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueInternal(param_name, index, /* t_index = */ 1);
 }

◆ getPostprocessorValueOldByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOldByName ( const PostprocessorName & name ) const

inherited

Definition at line 63 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 1);
 }

◆ getPostprocessorValueOlder()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlder	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Definition at line 50 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueInternal(param_name, index, /* t_index = */ 2);
 }

◆ getPostprocessorValueOlderByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlderByName ( const PostprocessorName & name ) const

inherited

Definition at line 69 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 2);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 229 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getRequestedItems()

const std::set< std::string > & AuxScalarKernel::getRequestedItems ( )

overridevirtualinherited

Return a set containing the names of items requested by the object.

Implements DependencyResolverInterface.

Definition at line 89 of file AuxScalarKernel.C.

 {
   return _depend_vars;
 }

◆ getScalarVar()

const MooseVariableScalar * ScalarCoupleable::getScalarVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 321 of file ScalarCoupleable.C.

 {
   const auto var_name = _sc_parameters.checkForRename(var_name_in);
 
   const auto it = _coupled_scalar_vars.find(var_name);
   if (it != _coupled_scalar_vars.end())
   {
     const auto & entry = it->second;
     if (comp < entry.size())
       return entry[comp];
     else
       mooseError(_sc_name, ": Trying to get a non-existent component of variable '", var_name, "'");
   }
   else
     mooseError(_sc_name, ": Trying to get a non-existent variable '", var_name, "'");
 }

◆ getScalarVariableCoupleableMatrixTags()

const std::set<TagID>& ScalarCoupleable::getScalarVariableCoupleableMatrixTags ( ) const

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_matrix_tags;
   }

◆ getScalarVariableCoupleableVectorTags()

const std::set<TagID>& ScalarCoupleable::getScalarVariableCoupleableVectorTags ( ) const

inlineinherited

Definition at line 50 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_vector_tags;
   }

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 68 of file MooseObject.C.

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 81 of file MooseObject.C.

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSuppliedItems()

const std::set< std::string > & AuxScalarKernel::getSuppliedItems ( )

overridevirtualinherited

Return a set containing the names of items owned by the object.

Implements DependencyResolverInterface.

Definition at line 95 of file AuxScalarKernel.C.

 {
   return _supplied_vars;
 }

◆ getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 169 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBase(param_name, is_dependency), param_name);
 }

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 86 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObject().

 {
   const auto object_name = getUserObjectName(param_name);
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.paramError(
         param_name, "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   return getUserObjectBaseByName(object_name, is_dependency);
 }

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 98 of file UserObjectInterface.C.

Referenced by UserObject::getDependObjects(), UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectByName().

 {
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.mooseError(
         "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   const auto & uo_base_tid0 = _uoi_feproblem.getUserObjectBase(object_name, /* tid = */ 0);
   if (is_dependency)
     addUserObjectDependencyHelper(uo_base_tid0);
 
   const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectBase(object_name, tid);
 }

◆ getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 176 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBaseByName(object_name, is_dependency));
 }

◆ getUserObjectName()

UserObjectName UserObjectInterface::getUserObjectName ( const std::string & param_name ) const

inherited

Returns: The name of the user object associated with the parameter param_name

Definition at line 35 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObjectBase(), and UserObjectInterface::hasUserObject().

 {
   const auto & params = _uoi_moose_object.parameters();
 
   if (!params.isParamValid(param_name))
     _uoi_moose_object.mooseError("Failed to get a parameter with the name \"",
                                  param_name,
                                  "\" when getting a UserObjectName.",
                                  "\n\nKnown parameters:\n",
                                  _uoi_moose_object.parameters());
 
   // Other interfaces will use this interface (PostprocessorInterface, VectorPostprocessorInterface)
   // to grab UOs with a specialized name, so we need to check them all
   UserObjectName name;
   if (params.isType<UserObjectName>(param_name))
     name = params.get<UserObjectName>(param_name);
   else if (params.isType<PostprocessorName>(param_name))
     name = params.get<PostprocessorName>(param_name);
   else if (params.isType<VectorPostprocessorName>(param_name))
     name = params.get<VectorPostprocessorName>(param_name);
   else if (params.isType<std::string>(param_name))
     name = params.get<std::string>(param_name);
   else
     _uoi_moose_object.paramError(
         param_name,
         "Parameter of type \"",
         params.type(param_name),
         "\" is not an expected type for getting the name of a UserObject.");
 
   return name;
 }

◆ getVar() [1/2]

MooseVariable * Coupleable::getVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protectedinherited

Extract pointer to a coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 288 of file Coupleable.C.

 {
   return const_cast<MooseVariable *>(getVarHelper<MooseVariable>(var_name, comp));
 }

◆ getVar() [2/2]

const MooseVariable * Coupleable::getVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 312 of file Coupleable.C.

 {
   return getVarHelper<MooseVariable>(var_name, comp);
 }

◆ getVarHelper() [1/2]

template<typename T >

const T * Coupleable::getVarHelper	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Helper that that be used to retrieve a variable of arbitrary type T.

Definition at line 1872 of file Coupleable.h.

 {
   return const_cast<Coupleable *>(this)->getVarHelper<T>(var_name, comp);
 }

◆ getVarHelper() [2/2]

template<typename T >

T * Coupleable::getVarHelper	(	const std::string &	var_name,
		unsigned int	comp
	)

protectedinherited

Helper that can be used to retrieve a variable of arbitrary type T.

Definition at line 1818 of file Coupleable.h.

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
   auto name_to_use = var_name;
 
   // First check for supplied name
   if (!checkVar(var_name, comp, 0))
   {
     // See if there is an associated deprecated name that the user may have used instead
     auto it = _new_to_deprecated_coupled_vars.find(var_name);
     if (it == _new_to_deprecated_coupled_vars.end())
       return nullptr;
     else
     {
       auto deprecated_name = it->second;
       if (checkVar(deprecated_name, comp, 0))
         name_to_use = deprecated_name;
       else
         return nullptr;
     }
   }
 
   auto coupled_vars_it = _coupled_vars.find(name_to_use);
 
   mooseAssert(coupled_vars_it != _coupled_vars.end(),
               "Trying to get a coupled var " << name_to_use << " that doesn't exist");
 
   if (auto coupled_var = dynamic_cast<T *>(coupled_vars_it->second[comp]))
     return coupled_var;
   else
   {
     for (auto & var : _coupled_standard_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a standard variable, try a "
                    "'coupled[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_vector_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a vector variable, try a "
                    "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_array_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is an array variable, try a "
                    "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_standard_fv_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a finite volume variable, which the coupled[...] routine "
                    "used does not support. Try using the functor system routines instead.");
     mooseError(
         "Variable '", name_to_use, "' is of a different C++ type than you tried to fetch it as.");
   }
 }

◆ getVectorVar() [1/2]

VectorMooseVariable * Coupleable::getVectorVar	(	const std::string &	var_name,
		unsigned int	comp
	)

protectedinherited

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 294 of file Coupleable.C.

 {
   auto * const var =
       const_cast<VectorMooseVariable *>(getVarHelper<VectorMooseVariable>(var_name, comp));
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getVectorVar() [2/2]

const VectorMooseVariable * Coupleable::getVectorVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 318 of file Coupleable.C.

 {
   const auto * const var = getVarHelper<VectorMooseVariable>(var_name, comp);
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getWritableCoupledVariables()

auto& Coupleable::getWritableCoupledVariables ( ) const

inlineinherited

returns a reference to the set of writable coupled variables

Definition at line 123 of file Coupleable.h.

Referenced by Coupleable::hasWritableCoupledVariables().

123 { return _writable_coupled_variables[_c_tid]; }

Coupleable::_c_tid

THREAD_ID _c_tid

Thread ID of the thread using this object.

Definition: Coupleable.h:1442

Coupleable::_writable_coupled_variables

std::vector< std::set< MooseWritableVariable * > > _writable_coupled_variables

keep a set of allocated writable variable references to make sure only one object can obtain them per...

Definition: Coupleable.h:1813

◆ hasFunction()

bool FunctionInterface::hasFunction ( const std::string & param_name ) const

inherited

Determine if the function exists.

Parameters

param_name	The name of the function parameter
index	The index of the function

Returns: True if the function exists

Definition at line 42 of file FunctionInterface.C.

 {
   return hasFunctionByName(_fni_params.get<FunctionName>(param_name));
 }

◆ hasFunctionByName()

bool FunctionInterface::hasFunctionByName ( const FunctionName & name ) const

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 48 of file FunctionInterface.C.

Referenced by FunctionInterface::hasFunction().

 {
   return _fni_feproblem.hasFunction(name, _fni_tid);
 }

◆ hasPostprocessor()

bool PostprocessorInterface::hasPostprocessor	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Determine if the Postprocessor data exists.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessorByName getPostprocessorValue

Definition at line 107 of file PostprocessorInterface.C.

 {
   if (!postprocessorsAdded())
     _ppi_moose_object.mooseError(
         "Cannot call hasPostprocessor() until all Postprocessors have been constructed.");
 
   return hasPostprocessorByName(getPostprocessorNameInternal(param_name, index));
 }

◆ hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName & name ) const

inherited

Determine if the Postprocessor data exists.

Parameters

name	The name of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessor getPostprocessorValueByName

Definition at line 118 of file PostprocessorInterface.C.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), AdvancedOutput::initShowHideLists(), TableOutput::outputReporters(), Exodus::outputReporters(), and WebServerControl::startServer().

 {
   if (!postprocessorsAdded())
     _ppi_moose_object.mooseError(
         "Cannot call hasPostprocessorByName() until all Postprocessors have been constructed.");
 
   return _ppi_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(
       PostprocessorReporterName(name));
 }

◆ hasUserObject() [1/2]

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Returns: Whether or not a UserObject exists with the name given by the parameter param_name.

Definition at line 68 of file UserObjectInterface.C.

 {
   return hasUserObjectByName(getUserObjectName(param_name));
 }

◆ hasUserObject() [2/2]

template<class T >

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Definition at line 184 of file UserObjectInterface.h.

 {
   return hasUserObjectByName<T>(getUserObjectName(param_name));
 }

◆ hasUserObjectByName() [1/2]

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 74 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::hasUserObject(), and UserObjectInterface::hasUserObjectByName().

 {
   return _uoi_feproblem.hasUserObject(object_name);
 }

◆ hasUserObjectByName() [2/2]

template<class T >

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 191 of file UserObjectInterface.h.

 {
   if (!hasUserObjectByName(object_name))
     return false;
   return dynamic_cast<const T *>(&getUserObjectFromFEProblem(object_name));
 }

◆ hasWritableCoupledVariables()

bool Coupleable::hasWritableCoupledVariables ( ) const

inlineinherited

Checks whether the object has any writable coupled variables.

Definition at line 128 of file Coupleable.h.

128 { return !getWritableCoupledVariables().empty(); }

Coupleable::getWritableCoupledVariables

auto & getWritableCoupledVariables() const

returns a reference to the set of writable coupled variables

Definition: Coupleable.h:123

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

Gets called at the beginning of the simulation before this object is asked to do its job.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, SolutionUserObjectBase, AdvancedOutput, MooseVariableBase, ParsedMaterialHelper< is_ad >, MultiApp, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseParsedFunction, MooseParsedGradFunction, DerivativeFunctionMaterialBaseTempl< is_ad >, Transfer, ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >, MatDiffusionBase< T >, MatDiffusionBase< Real >, CSV, Exodus, SampledOutput, Convergence, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, NEML2ModelExecutor, MultiAppTransfer, RadialAverage, MooseParsedVectorFunction, ImageFunction, Console, PiecewiseConstantFromCSV, Nemesis, NodalVariableValue, ReferenceResidualConvergence, DiffusionLHDGKernel, MortarNodalAuxKernelTempl< ComputeValueType >, LibtorchArtificialNeuralNetParameters, TimePeriod, TransientMultiApp, ElementalVariableValue, GhostingUserObject, InterfaceQpUserObjectBase, SolutionAux, BoundsBase, DiffusionLHDGPrescribedGradientBC, MultiAppProjectionTransfer, HistogramVectorPostprocessor, SolutionScalarAux, DiffusionLHDGDirichletBC, ParsedConvergence, LinearFVAdvection, LinearFVAnisotropicDiffusion, LinearFVDiffusion, MultiAppPositions, MultiAppDofCopyTransfer, MultiAppGeneralFieldNearestLocationTransfer, CoarsenedPiecewiseLinear, PiecewiseTabularBase, MatReaction, SideIntegralMaterialPropertyTempl< is_ad >, SideIntegralPostprocessor, MultiAppVariableValueSamplePostprocessorTransfer, NodalPatchRecoveryMaterialProperty, ProjectedStatefulMaterialAuxTempl< T, is_ad >, PiecewiseLinear, ElementSubdomainModifierBase, FullSolveMultiApp, SideFVFluxBCIntegral, MultiAppFieldTransfer, MultiAppVariableValueSampleTransfer, DefaultConvergenceBase, PiecewiseLinearBase, ChainControlDataPostprocessor, MultiAppConservativeTransfer, MultiAppCloneReporterTransfer, MultiAppReporterTransfer, DerivativeSumMaterialTempl< is_ad >, and JSONOutput.

Definition at line 41 of file SetupInterface.C.

Referenced by SideIntegralPostprocessor::initialSetup(), ElementalVariableValue::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), and Positions::meshChanged().

42 {

43 }

◆ isActive()

bool AuxScalarKernel::isActive ( )

virtualinherited

Use this to enable/disable the constraint.

Returns: true if the constrain is active

Definition at line 101 of file AuxScalarKernel.C.

 {
   return true;
 }

◆ isCoupled()

bool Coupleable::isCoupled	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedvirtualinherited

Returns true if a variables has been coupled as name.

Parameters

var_name	The name the kernel wants to refer to the variable as.
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Returns: True if a coupled variable has the supplied name

Definition at line 129 of file Coupleable.C.

Referenced by Coupleable::adCoupledNodalValue(), Coupleable::checkVar(), Coupleable::coupledComponents(), and MatDiffusionBase< Real >::MatDiffusionBase().

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
 
   auto it = _coupled_vars.find(var_name);
   if (it != _coupled_vars.end())
     return (i < it->second.size());
   else
   {
     // Make sure the user originally requested this value in the InputParameter syntax
     if (!_c_parameters.hasCoupledValue(var_name))
       mooseError(_c_name,
                  ": The coupled variable \"",
                  var_name,
                  "\" was never added to this object's "
                  "InputParameters, please double-check your "
                  "spelling");
 
     return false;
   }
 }

◆ isCoupledConstant()

bool Coupleable::isCoupledConstant ( const std::string & var_name ) const

protectedvirtualinherited

Returns true if a variable passed as a coupled value is really a constant.

Parameters

var_name The name the kernel wants to refer to the variable as.

Returns: True if the variable is actually a constant

Definition at line 152 of file Coupleable.C.

Referenced by Coupleable::coupledName(), and DerivativeFunctionMaterialBaseTempl< is_ad >::DerivativeFunctionMaterialBaseTempl().

 {
   return _c_parameters.hasDefaultCoupledValue(var_name);
 }

◆ isCoupledScalar()

bool ScalarCoupleable::isCoupledScalar	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedinherited

Returns true if a variables has been coupled_as name.

Parameters

var_name	The of the coupled variable
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Definition at line 70 of file ScalarCoupleable.C.

Referenced by ScalarCoupleable::adCoupledScalarValue(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

 {
   const auto var_name = _sc_parameters.checkForRename(var_name_in);
 
   auto it = _coupled_scalar_vars.find(var_name);
   if (it != _coupled_scalar_vars.end())
     return (i < it->second.size());
   else
   {
     // Make sure the user originally requested this value in the InputParameter syntax
     if (!_sc_parameters.hasCoupledValue(var_name))
       mooseError(_sc_name,
                  ": The coupled scalar variable \"",
                  var_name,
                  "\" was never added to this object's "
                  "InputParameters, please double-check "
                  "your spelling");
 
     return false;
   }
 }

◆ isDefaultPostprocessorValue()

bool PostprocessorInterface::isDefaultPostprocessorValue	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Determine whether or not the Postprocessor is a default value.

A default value is when the value is either the value set by addParam, or is a user-set value in input instead of a name to a postprocessor.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the postprocessor

Returns: True if the Postprocessor is a default value, false if the Postprocessor is the name of a Postprocessor

Definition at line 75 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return isDefaultPostprocessorValueByName(getPostprocessorNameInternal(param_name, index));
 }

◆ isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 38 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

38 { return _is_implicit; }

TransientInterface::_is_implicit

bool _is_implicit

If the object is using implicit or explicit form.

Definition: TransientInterface.h:58

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 128 of file MooseBaseParameterInterface.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseBaseParameterInterface::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MFEMSolverBase::setPreconditioner(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

128 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

bool isParamSetByUser(const std::string &name) const

Method returns true if the parameter was set by the user.

Definition: InputParameters.C:1178

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

◆ isParamValid()

bool MooseBaseParameterInterface::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 122 of file MooseBaseParameterInterface.h.

122 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:390

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, DiffusionLHDGKernel, IPHDGKernel, EqualValueEmbeddedConstraintTempl< is_ad >, ADKernelTempl< T >, IPHDGBC, DiffusionLHDGPrescribedGradientBC, and DiffusionLHDGDirichletBC.

Definition at line 51 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().

52 {

53 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableDataFV< OutputType >, DiracKernelBase, Positions, Console, MeshDivision, Exodus, SampledOutput, RadialAverage, Nemesis, NEML2ModelExecutor, GhostingUserObject, FVPointValueConstraint, ExplicitTimeIntegrator, NEML2BatchIndexGenerator, MultiAppVariableValueSamplePostprocessorTransfer, MoveNodesToGeometryModifierBase, ElementSubdomainModifierBase, SidesetInfoVectorPostprocessor, NearestNodeNumberUO, and EqualValueBoundaryConstraint.

Definition at line 30 of file MeshChangedInterface.h.

Referenced by MooseVariableFV< Real >::meshChanged(), and MooseVariableFE< Real >::meshChanged().

30 {}

◆ mooseDeprecated()

template<typename... Args>

void MooseBaseErrorInterface::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, _moose_base.errorPrefix("deprecation"), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

void MooseBaseErrorInterface::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

void MooseBaseErrorInterface::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 98 of file MooseBaseErrorInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

   {
     moose::internal::mooseInfoStream(
         _console, _moose_base.errorPrefix("information"), std::forward<Args>(args)...);
   }

◆ mooseWarning()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchedMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), SphericalGridDivision::initialize(), CylindricalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CartesianGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     moose::internal::mooseWarningStream(
         _console, _moose_base.errorPrefix("warning"), std::forward<Args>(args)...);
   }

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 85 of file MooseBaseErrorInterface.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

◆ name()

virtual const std::string& MooseBase::name ( ) const

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 255 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 272 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(paramErrorMsg(param, std::forward<Args>(args)...));
 }

◆ paramWarning()

template<typename... Args>

void MooseBaseParameterInterface::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 265 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

 {
   mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
 }

◆ queryParam()

template<typename T >

const T * MooseBaseParameterInterface::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 222 of file MooseBaseParameterInterface.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, NodeFaceConstraint, Positions, and Times.

Definition at line 56 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().

57 {

58 }

◆ sort()

template<typename T >

void DependencyResolverInterface::sort ( typename std::vector< T > & vector )

staticinherited

Given a vector, sort using the getRequested/SuppliedItems sets.

Definition at line 64 of file DependencyResolverInterface.h.

Referenced by TheWarehouse::prepare().

 {
   sortDFS(vector);
 }

◆ sortDFS()

template<typename T >

void DependencyResolverInterface::sortDFS ( typename std::vector< T > & vector )

staticinherited

Given a vector, sort using the depth-first search.

Class that represents the dependency as a graph

Definition at line 71 of file DependencyResolverInterface.h.

Referenced by DependencyResolverInterface::sort().

 {
   if (vector.size() <= 1)
     return;
 
   DependencyResolver<T> graph;
 
   // Map of suppliers: what is supplied -> by what object
   std::multimap<std::string, T> suppliers_map;
   for (auto & v : vector)
   {
     // Whether or not this object supplies something, we will always
     // add it as a node because we want to make sure that it gets returned
     graph.addNode(v);
 
     for (const auto & supplied_item : v->getSuppliedItems())
       suppliers_map.emplace(supplied_item, v);
   }
 
   // build the dependency graph
   for (auto & v : vector)
     for (const auto & requested_item : v->getRequestedItems())
     {
       const auto & [begin_it, end_it] = suppliers_map.equal_range(requested_item);
       for (const auto & [supplier_name, supplier_object] : as_range(begin_it, end_it))
       {
         libmesh_ignore(supplier_name);
 
         // We allow an object to have a circular dependency within itself; e.g. we choose to
         // trust a developer knows what they are doing within a single object
         if (supplier_object != v)
           graph.addEdge(supplier_object, v);
       }
     }
 
   const auto & sorted = graph.dfs();
 
   // The set here gets unique objects, as it's valid to pass in duplicates
   mooseAssert(sorted.size() == std::set<T>(vector.begin(), vector.end()).size(), "Size mismatch");
 
   vector = sorted;
 }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in MaterialBase, Material, GeneralUserObject, NodalUserObject, Constraint, and ThreadedGeneralUserObject.

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ subProblem()

SubProblem& AuxScalarKernel::subProblem ( )

inlineinherited

Definition at line 57 of file AuxScalarKernel.h.

57 { return _subproblem; }

AuxScalarKernel::_subproblem

SubProblem & _subproblem

Definition: AuxScalarKernel.h:77

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

Gets called at the beginning of the timestep before this object is asked to do its job.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObjectBase, Console, VectorPostprocessorVisualizationAux, EqualValueEmbeddedConstraintTempl< is_ad >, NumNonlinearIterations, VectorMemoryUsage, JSONOutput, and MemoryUsage.

Definition at line 46 of file SetupInterface.C.

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().

47 {

48 }

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

The unique name for accessing input parameters of this object in the InputParameterWarehouse.

Definition at line 67 of file MooseBaseParameterInterface.h.

Referenced by MooseBaseParameterInterface::connectControllableParams(), and Action::uniqueActionName().

   {
     return MooseObjectName(_pars.get<std::string>("_unique_name"));
   }

◆ uniqueParameterName()

MooseObjectParameterName MooseBaseParameterInterface::uniqueParameterName ( const std::string & parameter_name ) const

inlineinherited

The unique parameter name of a valid parameter of this object for accessing parameter controls.

Definition at line 52 of file MooseBaseParameterInterface.h.

   {
     return MooseObjectParameterName(
         _pars.get<std::string>("_moose_base"), _moose_base.name(), parameter_name);
   }

◆ uOld()

const VariableValue & AuxScalarKernel::uOld ( ) const

protectedinherited

Retrieves the old value of the variable that this AuxScalarKernel operates on.

Store this as a reference in the constructor.

Definition at line 107 of file AuxScalarKernel.C.

 {
   if (_sys.solutionStatesInitialized())
     mooseError("The solution states have already been initialized when calling ",
                type(),
                "::uOld().\n\n",
                "Make sure to call uOld() within the object constructor.");
 
   return _var.slnOld();
 }

◆ validateExecutionerType()

void Coupleable::validateExecutionerType	(	const std::string &	name,
		const std::string &	fn_name
	)		const

protectedinherited

Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.

Parameters

name	the name of the variable
fn_name	The name of the function that called this method - used in the error message

Definition at line 2118 of file Coupleable.C.

 {
   if (!_c_fe_problem.isTransient())
     mooseError(_c_name,
                ": Calling \"",
                fn_name,
                "\" on variable \"",
                name,
                "\" when using a \"Steady\" executioner is not allowed. This value is available "
                "only in transient simulations.");
 }

◆ validParams()

InputParameters AuxNodalScalarKernel::validParams ( )

static

Definition at line 14 of file AuxNodalScalarKernel.C.

 {
   InputParameters params = AuxScalarKernel::validParams();
   params.addRequiredParam<std::vector<dof_id_type>>("nodes", "Node ids");
   return params;
 }

◆ variable()

MooseVariableScalar& AuxScalarKernel::variable ( )

inlineinherited

The variable that this kernel operates on.

Definition at line 55 of file AuxScalarKernel.h.

55 { return _var; }

AuxScalarKernel::_var

MooseVariableScalar & _var

Definition: AuxScalarKernel.h:83

◆ writableCoupledValue()

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

protectedvirtualinherited

Returns a writable reference to a coupled variable for writing to multiple AuxVariables from a single AuxKernel or a UserObject.

Only one object can obtain a writable reference in a simulation.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

See also: Kernel::value

Definition at line 914 of file Coupleable.C.

 {
   mooseDeprecated("Coupleable::writableCoupledValue is deprecated, please use "
                   "Coupleable::writableVariable instead. ");
 
   // check if the variable exists
   auto * const var = getVar(var_name, comp);
   if (!var)
     mooseError(
         "Unable to create a writable reference for '", var_name, "', is it a constant expression?");
 
   // is the requested variable an AuxiliaryVariable?
   if (!_c_fe_problem.getAuxiliarySystem().hasVariable(var->name()))
     mooseError(
         "'", var->name(), "' must be an auxiliary variable in Coupleable::writableCoupledValue");
 
   // check that the variable type (elemental/nodal) is compatible with the object type
   const auto * aux = dynamic_cast<const AuxKernel *>(this);
 
   if (!aux)
     mooseError("writableCoupledValue() can only be called from AuxKernels, but '",
                _obj->name(),
                "' is not an AuxKernel.");
 
   if (!aux->isNodal() && var->isNodal())
     mooseError("The elemental AuxKernel '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
 
   // make sure only one object can access a variable
   checkWritableVar(var);
 
   return const_cast<VariableValue &>(coupledValue(var_name, comp));
 }

◆ writableVariable()

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

protectedinherited

Returns a writable MooseVariable object for a nodal or elemental variable.

Use var.setNodalValue(val[, idx]) in both cases (!) to set the solution DOF values. Only one object can obtain a writable reference in a simulation. Note that the written values will not ba available in the same system loop! E.g. values written using this API by a nodal AuxKernel will not be updated for other nodal AuxKernels during the same iteration over all nodes.

Parameters

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

Returns: Reference to a MooseWritableVariable for the coupled variable

See also: Kernel::value

Definition at line 878 of file Coupleable.C.

 {
   auto * var = getVarHelper<MooseWritableVariable>(var_name, comp);
 
   const auto * aux = dynamic_cast<const AuxKernel *>(this);
   const auto * euo = dynamic_cast<const ElementUserObject *>(this);
   const auto * nuo = dynamic_cast<const NodalUserObject *>(this);
   const auto * nfc = dynamic_cast<const NodeFaceConstraint *>(this);
   const auto * nec = dynamic_cast<const NodeElemConstraintBase *>(this);
 
   if (!aux && !euo && !nuo && !nfc && !nec)
     mooseError("writableVariable() can only be called from AuxKernels, ElementUserObjects, "
                "NodalUserObjects, NodeFaceConstraints, or NodeElemConstraints. '",
                _obj->name(),
                "' is none of those.");
 
   if (aux && !aux->isNodal() && var->isNodal())
     mooseError("The elemental AuxKernel '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
   if (euo && var->isNodal())
     mooseError("The ElementUserObject '",
                _obj->name(),
                "' cannot obtain a writable reference to the nodal variable '",
                var->name(),
                "'.");
 
   // make sure only one object can access a variable
   checkWritableVar(var);
 
   return *var;
 }

Member Data Documentation

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

Definition at line 179 of file MooseBaseParameterInterface.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _ad_default_curl

MooseArray<ADRealVectorValue> Coupleable::_ad_default_curl

mutableprotectedinherited

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

Definition at line 1484 of file Coupleable.h.

Referenced by Coupleable::getADDefaultCurl().

◆ _ad_default_gradient

MooseArray<ADRealVectorValue> Coupleable::_ad_default_gradient

mutableprotectedinherited

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

Definition at line 1472 of file Coupleable.h.

Referenced by Coupleable::getADDefaultGradient().

◆ _ad_default_second

MooseArray<ADRealTensorValue> Coupleable::_ad_default_second

mutableprotectedinherited

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

Definition at line 1481 of file Coupleable.h.

Referenced by Coupleable::getADDefaultSecond().

◆ _ad_default_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<ADReal> > > Coupleable::_ad_default_value

mutableprotectedinherited

Will hold the default value for optional coupled variables for automatic differentiation.

Definition at line 1449 of file Coupleable.h.

Referenced by Coupleable::getADDefaultValue().

◆ _ad_default_vector_gradient

MooseArray<ADRealTensorValue> Coupleable::_ad_default_vector_gradient

mutableprotectedinherited

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

Definition at line 1475 of file Coupleable.h.

Referenced by Coupleable::getADDefaultVectorGradient().

◆ _ad_default_vector_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<ADRealVectorValue> > > Coupleable::_ad_default_vector_value

mutableprotectedinherited

Will hold the default value for optional vector coupled variables for automatic differentiation.

Definition at line 1460 of file Coupleable.h.

Referenced by Coupleable::getADDefaultVectorValue().

◆ _ad_grad_zero

const MooseArray<ADRealVectorValue>& Coupleable::_ad_grad_zero

protectedinherited

Definition at line 1493 of file Coupleable.h.

Referenced by Coupleable::adZeroGradient().

◆ _ad_second_zero

const MooseArray<ADRealTensorValue>& Coupleable::_ad_second_zero

protectedinherited

Definition at line 1500 of file Coupleable.h.

Referenced by Coupleable::adZeroSecond().

◆ _ad_zero

const MooseArray<ADReal>& Coupleable::_ad_zero

protectedinherited

Definition at line 1489 of file Coupleable.h.

Referenced by Coupleable::adZeroValue().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _assembly

Assembly& AuxScalarKernel::_assembly

protectedinherited

Definition at line 82 of file AuxScalarKernel.h.

◆ _c_allow_element_to_nodal_coupling

const bool Coupleable::_c_allow_element_to_nodal_coupling

protectedinherited

Definition at line 1439 of file Coupleable.h.

Referenced by Coupleable::checkVar().

◆ _c_fe_problem

FEProblemBase& Coupleable::_c_fe_problem

protectedinherited

Definition at line 1403 of file Coupleable.h.

◆ _c_is_implicit

bool Coupleable::_c_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 1436 of file Coupleable.h.

◆ _c_name

const std::string& Coupleable::_c_name

protectedinherited

The name of the object this interface is part of.

Definition at line 1398 of file Coupleable.h.

Referenced by Coupleable::checkFuncType(), Coupleable::checkVar(), Coupleable::coupledName(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledNodalValueOlder(), Coupleable::coupledValueLower(), Coupleable::coupledVectorTagArrayGradient(), Coupleable::coupledVectorTagGradient(), Coupleable::getVectorVar(), Coupleable::isCoupled(), Coupleable::validateExecutionerType(), and Coupleable::vectorTagValueHelper().

◆ _c_nodal

bool Coupleable::_c_nodal

protectedinherited

True if we provide coupling to nodal values.

Definition at line 1433 of file Coupleable.h.

◆ _c_parameters

const InputParameters& Coupleable::_c_parameters

protectedinherited

Definition at line 1395 of file Coupleable.h.

◆ _c_sys

const SystemBase* const Coupleable::_c_sys

protectedinherited

Pointer to the system object if the moose object this is an interface for has one.

Definition at line 1406 of file Coupleable.h.

Referenced by Coupleable::coupled().

◆ _c_tid

THREAD_ID Coupleable::_c_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 1442 of file Coupleable.h.

Referenced by Coupleable::checkWritableVar(), Coupleable::Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), and Coupleable::getWritableCoupledVariables().

◆ _c_type

const std::string& Coupleable::_c_type

protectedinherited

The type of the object this interface is part of.

Definition at line 1400 of file Coupleable.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _coupleable_neighbor

bool Coupleable::_coupleable_neighbor

protectedinherited

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

Definition at line 1705 of file Coupleable.h.

◆ _coupled_array_moose_vars

std::vector<ArrayMooseVariable *> Coupleable::_coupled_array_moose_vars

protectedinherited

Vector of array coupled variables.

Definition at line 1421 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), Coupleable::getCoupledArrayMooseVars(), and Coupleable::getVarHelper().

◆ _coupled_moose_vars

std::vector<MooseVariableFieldBase *> Coupleable::_coupled_moose_vars

protectedinherited

Vector of all coupled variables.

Definition at line 1412 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), ElementValueSampler::ElementValueSampler(), SideValueSampler::execute(), ElementValueSampler::execute(), PointVariableSamplerBase::execute(), Coupleable::getCoupledMooseVars(), PointVariableSamplerBase::initialize(), InterfaceUserObject::InterfaceUserObject(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), NodalValueSampler::NodalValueSampler(), PointVariableSamplerBase::PointVariableSamplerBase(), and SideValueSampler::SideValueSampler().

◆ _coupled_standard_fv_moose_vars

std::vector<MooseVariableFV<Real> *> Coupleable::_coupled_standard_fv_moose_vars

protectedinherited

Vector of standard finite volume coupled variables.

Definition at line 1424 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), ElementValueSampler::execute(), Coupleable::getVarHelper(), and SideValueSampler::SideValueSampler().

◆ _coupled_standard_linear_fv_moose_vars

std::vector<MooseLinearVariableFV<Real> *> Coupleable::_coupled_standard_linear_fv_moose_vars

protectedinherited

Vector of standard linear finite volume coupled variables.

Definition at line 1427 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), and SideValueSampler::SideValueSampler().

◆ _coupled_standard_moose_vars

std::vector<MooseVariable *> Coupleable::_coupled_standard_moose_vars

protectedinherited

Vector of standard coupled variables.

Definition at line 1415 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), NodalValueSampler::execute(), ElementValueSampler::execute(), Coupleable::getCoupledStandardMooseVars(), and Coupleable::getVarHelper().

◆ _coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFieldBase *> > Coupleable::_coupled_vars

protectedinherited

Coupled vars whose values we provide.

Definition at line 1409 of file Coupleable.h.

Referenced by Coupleable::checkVar(), Coupleable::Coupleable(), Coupleable::coupledComponents(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), Coupleable::getCoupledVars(), Coupleable::getVarHelper(), and Coupleable::isCoupled().

◆ _coupled_vector_moose_vars

std::vector<VectorMooseVariable *> Coupleable::_coupled_vector_moose_vars

protectedinherited

Vector of vector coupled variables.

Definition at line 1418 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getCoupledVectorMooseVars(), and Coupleable::getVarHelper().

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 78 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _default_array_gradient

ArrayVariableGradient Coupleable::_default_array_gradient

protectedinherited

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

Definition at line 1530 of file Coupleable.h.

Referenced by Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientDot(), Coupleable::coupledArrayGradientOld(), and Coupleable::coupledArrayGradientOlder().

◆ _default_array_value

std::unordered_map<std::string, std::unique_ptr<ArrayVariableValue> > Coupleable::_default_array_value

mutableprotectedinherited

Will hold the default value for optional array coupled variables.

Definition at line 1456 of file Coupleable.h.

Referenced by Coupleable::getDefaultArrayValue().

◆ _default_array_value_zero

ArrayVariableValue Coupleable::_default_array_value_zero

protectedinherited

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 1527 of file Coupleable.h.

Referenced by Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), and Coupleable::coupledArrayDotOld().

◆ _default_div

VectorVariableDivergence Coupleable::_default_div

mutableprotectedinherited

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

Definition at line 1521 of file Coupleable.h.

Referenced by Coupleable::coupledDiv(), Coupleable::coupledDivOld(), and Coupleable::coupledDivOlder().

◆ _default_gradient

VariableGradient Coupleable::_default_gradient

mutableprotectedinherited

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

Definition at line 1469 of file Coupleable.h.

Referenced by Coupleable::coupledGradient(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), and Coupleable::coupledGradientPreviousNL().

◆ _default_second

VariableSecond Coupleable::_default_second

mutableprotectedinherited

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

Definition at line 1478 of file Coupleable.h.

Referenced by Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), and Coupleable::coupledSecondPreviousNL().

◆ _default_value

std::unordered_map<std::string, std::vector<std::unique_ptr<VariableValue> > > Coupleable::_default_value

mutableprotectedinherited

Will hold the default value for optional coupled variables.

Definition at line 1446 of file Coupleable.h.

Referenced by Coupleable::getDefaultValue().

◆ _default_value_zero

VariableValue Coupleable::_default_value_zero

mutableprotectedinherited

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 1466 of file Coupleable.h.

Referenced by Coupleable::coupledArrayDotDu(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledVectorDotDotDu(), and Coupleable::coupledVectorDotDu().

◆ _default_vector_curl

VectorVariableCurl Coupleable::_default_vector_curl

mutableprotectedinherited

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

Definition at line 1518 of file Coupleable.h.

Referenced by Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), and Coupleable::coupledCurlOlder().

◆ _default_vector_gradient

VectorVariableGradient Coupleable::_default_vector_gradient

mutableprotectedinherited

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

Definition at line 1515 of file Coupleable.h.

Referenced by Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), and Coupleable::coupledVectorGradientOlder().

◆ _default_vector_value

std::unordered_map<std::string, std::unique_ptr<VectorVariableValue> > Coupleable::_default_vector_value

mutableprotectedinherited

Will hold the default value for optional vector coupled variables.

Definition at line 1453 of file Coupleable.h.

Referenced by Coupleable::getDefaultVectorValue().

◆ _default_vector_value_zero

VectorVariableValue Coupleable::_default_vector_value_zero

mutableprotectedinherited

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 1512 of file Coupleable.h.

Referenced by Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotOld(), and Coupleable::coupledVectorDotOld().

◆ _depend_vars

std::set<std::string> AuxScalarKernel::_depend_vars

protectedinherited

Depend AuxKernels.

Definition at line 91 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::AuxScalarKernel(), and AuxScalarKernel::getRequestedItems().

◆ _dt

Real& TransientInterface::_dt

protectedinherited

Time step size.

Definition at line 70 of file TransientInterface.h.

Referenced by InterfaceQpValueUserObject::computeRealValue(), ForcingFunctionAux::computeValue(), TimeIntegratedPostprocessor::execute(), PIDTransientControl::execute(), VariableTimeIntegrationAux::getIntegralValue(), and PIDChainControl::updateValues().

◆ _dt_old

Real& TransientInterface::_dt_old

protectedinherited

Size of the old time step.

Definition at line 73 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition at line 51 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

Referenced by ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), SetupInterface::getExecuteOnEnum(), JSONOutput::outputReporters(), XMLOutput::outputVectorPostprocessors(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 176 of file MooseBaseParameterInterface.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), MooseBaseParameterInterface::connectControllableParams(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _grad_phi_zero

const VariablePhiGradient& Coupleable::_grad_phi_zero

protectedinherited

Zero gradient of trial function.

Definition at line 1496 of file Coupleable.h.

◆ _grad_zero

const VariableGradient& Coupleable::_grad_zero

protectedinherited

Zero gradient of a variable.

Definition at line 1492 of file Coupleable.h.

◆ _i

unsigned int AuxScalarKernel::_i

protectedinherited

Definition at line 86 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::compute(), and FunctionScalarAux::computeValue().

◆ _is_implicit

bool TransientInterface::_is_implicit

protectedinherited

If the object is using implicit or explicit form.

This does NOT mean time scheme, but which values are going to be used in the object - either from current time or old time. Note that even explicit schemes have implicit form (it is the time derivative "kernel")

Definition at line 58 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), Kernel::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), TransientInterface::determineState(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and TransientInterface::isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient

protectedinherited

Definition at line 76 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 34 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& AuxScalarKernel::_mesh

protectedinherited

Definition at line 84 of file AuxScalarKernel.h.

◆ _name

const std::string MooseBase::_name

protectedinherited

The name of this class.

Definition at line 90 of file MooseBase.h.

Referenced by AddBCAction::act(), AddConstraintAction::act(), PartitionerAction::act(), AddFVInterfaceKernelAction::act(), AddUserObjectAction::act(), AddFVInitialConditionAction::act(), AddMaterialAction::act(), AddKernelAction::act(), AddDGKernelAction::act(), AddMeshGeneratorAction::act(), AddVectorPostprocessorAction::act(), ReadExecutorParamsAction::act(), AddMarkerAction::act(), AddNodalKernelAction::act(), AddMultiAppAction::act(), AddIndicatorAction::act(), AddPostprocessorAction::act(), AddDamperAction::act(), AddScalarKernelAction::act(), AddInitialConditionAction::act(), AddTransferAction::act(), AddInterfaceKernelAction::act(), AddDiracKernelAction::act(), AddFunctorMaterialAction::act(), AddPositionsAction::act(), AddReporterAction::act(), AddTimesAction::act(), AddFieldSplitAction::act(), AddFVKernelAction::act(), AddFVBCAction::act(), AddMeshDivisionAction::act(), AddHDGKernelAction::act(), AddTimeStepperAction::act(), AddDistributionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddFunctionAction::act(), AddConvergenceAction::act(), AddOutputAction::act(), AddLinearFVBCAction::act(), AddLinearFVKernelAction::act(), AddCorrectorAction::act(), AddMeshModifiersAction::act(), AddSamplerAction::act(), AddControlAction::act(), AddMFEMSolverAction::act(), AddMFEMPreconditionerAction::act(), AddMFEMSubMeshAction::act(), AddMFEMFESpaceAction::act(), AddPeriodicBCAction::act(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CombinerGenerator::CombinerGenerator(), Executor::Executor(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::name(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), and AddVariableAction::varName().

◆ _new_to_deprecated_coupled_vars

const std::unordered_map<std::string, std::string>& Coupleable::_new_to_deprecated_coupled_vars

protectedinherited

map from new to deprecated variable names

Definition at line 1430 of file Coupleable.h.

Referenced by Coupleable::getVarHelper().

◆ _node_ids

std::vector<dof_id_type> AuxNodalScalarKernel::_node_ids

protected

List of node IDs.

Definition at line 33 of file AuxNodalScalarKernel.h.

Referenced by compute().

◆ _pars

const InputParameters& MooseBaseParameterInterface::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 173 of file MooseBaseParameterInterface.h.

◆ _phi_zero

const VariablePhiValue& Coupleable::_phi_zero

protectedinherited

Definition at line 1488 of file Coupleable.h.

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 244 of file ScalarCoupleable.h.

Referenced by FunctionDT::computeDT(), FunctionScalarAux::computeValue(), and FunctionScalarIC::value().

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 238 of file ScalarCoupleable.h.

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 232 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledVectorTagScalarValue(), ScalarCoupleable::getADDefaultValue(), ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_tid

const THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 235 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 241 of file ScalarCoupleable.h.

◆ _second_phi_zero

const VariablePhiSecond& Coupleable::_second_phi_zero

protectedinherited

Zero second derivative of a test function.

Definition at line 1502 of file Coupleable.h.

◆ _second_zero

const VariableSecond& Coupleable::_second_zero

protectedinherited

Zero second derivative of a variable.

Definition at line 1499 of file Coupleable.h.

◆ _subproblem

SubProblem& AuxScalarKernel::_subproblem

protectedinherited

Definition at line 77 of file AuxScalarKernel.h.

Referenced by compute(), and AuxScalarKernel::subProblem().

◆ _supplied_vars

std::set<std::string> AuxScalarKernel::_supplied_vars

protectedinherited

Definition at line 92 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::AuxScalarKernel(), and AuxScalarKernel::getSuppliedItems().

◆ _sys

SystemBase& AuxScalarKernel::_sys

protectedinherited

Definition at line 78 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::uOld().

◆ _t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 61 of file TransientInterface.h.

◆ _t_old

const Real& TransientInterface::_t_old

protectedinherited

Old time.

Definition at line 64 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), and TimedSubdomainModifier::computeSubdomainID().

◆ _t_step

int& TransientInterface::_t_step

protectedinherited

The number of the time step.

Definition at line 67 of file TransientInterface.h.

Referenced by AccumulateReporter::execute(), IterationInfo::execute(), PIDTransientControl::execute(), LeastSquaresFitHistory::execute(), ChangeOverFixedPointPostprocessor::finalize(), and ChangeOverTimePostprocessor::finalize().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protectedinherited

Definition at line 50 of file TransientInterface.h.

Referenced by Function::evaluate(), Function::evaluateDotHelper(), Function::evaluateGradientHelper(), Function::evaluateHelper(), PiecewiseConstantFromCSV::initialSetup(), and PiecewiseConstantFromCSV::PiecewiseConstantFromCSV().

◆ _ti_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 48 of file TransientInterface.h.

◆ _tid

THREAD_ID AuxScalarKernel::_tid

protectedinherited

Definition at line 80 of file AuxScalarKernel.h.

Referenced by compute().

◆ _type

const std::string MooseBase::_type

protectedinherited

The type of this class.

Definition at line 87 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenSidesetsGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _u

const VariableValue& AuxScalarKernel::_u

protectedinherited

Definition at line 88 of file AuxScalarKernel.h.

◆ _var

MooseVariableScalar& AuxScalarKernel::_var

protectedinherited

Definition at line 83 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::compute(), FunctionScalarAux::FunctionScalarAux(), AuxScalarKernel::uOld(), and AuxScalarKernel::variable().

◆ _vector_curl_zero

const VectorVariableCurl& Coupleable::_vector_curl_zero

protectedinherited

Zero value of the curl of a vector variable.

Definition at line 1506 of file Coupleable.h.

◆ _vector_zero

const VectorVariableValue& Coupleable::_vector_zero

protectedinherited

Zero value of a vector variable.

Definition at line 1504 of file Coupleable.h.

◆ _zero

const VariableValue& Coupleable::_zero

protectedinherited

Zero value of a variable.

Definition at line 1487 of file Coupleable.h.

The documentation for this class was generated from the following files:

include/auxscalarkernels/AuxNodalScalarKernel.h
src/auxscalarkernels/AuxNodalScalarKernel.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ AuxNodalScalarKernel()

Member Function Documentation

◆ adCoupledCurl()

◆ adCoupledDofValues()

◆ adCoupledDot()

◆ adCoupledDotDot()

◆ adCoupledDots()

◆ adCoupledGradient()

◆ adCoupledGradientDot()

◆ adCoupledGradients()

◆ adCoupledLowerValue()

◆ adCoupledNodalValue()

◆ adCoupledScalarDot()

◆ adCoupledScalarValue()

◆ adCoupledSecond()

◆ adCoupledValue()

◆ adCoupledValues()

◆ adCoupledVectorDot()

◆ adCoupledVectorGradient()

◆ adCoupledVectorSecond()

◆ adCoupledVectorValue()

◆ adCoupledVectorValues()

◆ addFEVariableCoupleableMatrixTag()

◆ addFEVariableCoupleableVectorTag()

◆ addMooseVariableDependency() [1/2]

◆ addMooseVariableDependency() [2/2]

◆ addPostprocessorDependencyHelper()

◆ addUserObjectDependencyHelper()

◆ adZeroGradient()

◆ adZeroSecond()

◆ adZeroValue()

◆ callMooseError()

◆ checkAllVariables()

◆ checkVar()

◆ checkVariables()

◆ checkWritableVar()

◆ compute()

◆ computeValue()

◆ connectControllableParams()

◆ coupled()

◆ coupledAllDofValues()

◆ coupledAllDofValuesOld()

◆ coupledAllDofValuesOlder()

◆ coupledArrayDofValues()

◆ coupledArrayDot()

◆ coupledArrayDotDot()

◆ coupledArrayDotDotOld()

◆ coupledArrayDotDu()

◆ coupledArrayDotOld()

◆ coupledArrayGradient()

◆ coupledArrayGradientDot()

◆ coupledArrayGradientOld()

◆ coupledArrayGradientOlder()

◆ coupledArrayValue()

◆ coupledArrayValueOld()

◆ coupledArrayValueOlder()

◆ coupledArrayValues()

◆ coupledCallback()

◆ coupledComponents()

◆ coupledCurl()

◆ coupledCurlOld()

◆ coupledCurlOlder()

◆ coupledDiv()

◆ coupledDivOld()

◆ coupledDivOlder()

◆ coupledDofValues()

◆ coupledDofValuesOld()

◆ coupledDofValuesOlder()

◆ coupledDot()

◆ coupledDotDot()