MaterialStdVectorRealGradientAux Class Reference

AuxKernel for outputting a std::vector material-property component to an AuxVariable. More...

#include <MaterialStdVectorRealGradientAux.h>

Inheritance diagram for MaterialStdVectorRealGradientAux:

Public Types
using	PropertyType = typename std::conditional< false, Moose::Functor< Moose::GenericType< std::vector< T >, is_ad > >, GenericMaterialProperty< std::vector< T >, is_ad > >::type
	Functors really only work for Real and RealVectorValue for now :(. More...
using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...
enum	TEST_TYPE { ALL, ANY }
	A flag changing the behavior of hasBoundary. More...

Public Member Functions
	MaterialStdVectorRealGradientAux (const InputParameters &parameters)
virtual void	compute ()
	Computes the value and stores it in the solution vector. More...
void	compute ()
void	compute ()
bool	isNodal () const
	Nodal or elemental kernel? More...
bool	isMortar ()
MooseVariableField< Real > &	variable ()
	Get a reference to a variable this kernel is action on. More...
const std::set< UserObjectName > &	getDependObjects () const
void	coupledCallback (const std::string &var_name, bool is_old) const override
	A call-back function provided by the derived object for actions before coupling a variable with functions such as coupledValue. More...
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...
const MaterialProperty< T > &	getMaterialProperty (const std::string &name)
	Override functions from MaterialPropertyInterface for error checking. More...
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" for the specified material_data. More...
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name)
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the generic property named "name" for the specified material_data at state state. More...
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
	Retrieve the old property deduced from the name name for the specified material_data. More...
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
	Retrieve the older property deduced from the name name for the specified material_data. More...
void	insert ()
	Insert the just computed values into the auxiliary solution vector. 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...
MooseVariableBase *	mooseVariableBase () const
	Get the variable that this object is using. More...
MooseVariableField< Real > &	mooseVariableField ()
	Return the MooseVariableField object that this interface acts on. More...
MooseVariableFE< Real > *	mooseVariable () const
	Return the MooseVariableFE object that this interface acts on. More...
MooseVariableFV< Real > *	mooseVariableFV () const
	Return the MooseVariableFV object that this interface acts on. More...
MooseLinearVariableFV< Real > *	mooseLinearVariableFV () const
	Return the MooseLinearVariableFV object that this interface acts on. More...
const std::vector< SubdomainName > &	blocks () const
	Return the block names for this object. More...
unsigned int	numBlocks () const
	Return the number of blocks for this object. More...
virtual const std::set< SubdomainID > &	blockIDs () const
	Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids. More...
unsigned int	blocksMaxDimension () const
	Return the largest mesh dimension of the elements in the blocks for this object. More...
bool	hasBlocks (const SubdomainName &name) const
	Test if the supplied block name is valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainName > &names) const
	Test if the supplied vector of block names are valid for this object. More...
bool	hasBlocks (const std::set< SubdomainName > &names) const
	Test if the supplied set of block names are valid for this object. More...
bool	hasBlocks (SubdomainID id) const
	Test if the supplied block ids are valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainID > &ids) const
	Test if the supplied vector block ids are valid for this object. More...
bool	hasBlocks (const std::set< SubdomainID > &ids) const
	Test if the supplied set of block ids are valid for this object. More...
bool	isBlockSubset (const std::set< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
bool	isBlockSubset (const std::vector< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
template<typename T , bool is_ad = false>
bool	hasBlockMaterialProperty (const std::string &prop_name)
	Check if a material property is valid for all blocks of this object. More...
const std::set< SubdomainID > &	meshBlockIDs () const
	Return all of the SubdomainIDs for the mesh. More...
virtual bool	blockRestricted () const
	Returns true if this object has been restricted to a block. More...
virtual void	checkVariable (const MooseVariableFieldBase &variable) const
	Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. More...
virtual const std::set< BoundaryID > &	boundaryIDs () const
	Return the boundary IDs for this object. More...
const std::vector< BoundaryName > &	boundaryNames () const
	Return the boundary names for this object. More...
unsigned int	numBoundaryIDs () const
	Return the number of boundaries for this object. More...
bool	hasBoundary (const BoundaryName &name) const
	Test if the supplied boundary name is valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryName > &names) const
	Test if the supplied vector of boundary names are valid for this object. More...
bool	hasBoundary (const BoundaryID &id) const
	Test if the supplied boundary ids are valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied vector boundary ids are valid for this object. More...
bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied set of boundary ids are valid for this object. More...
bool	isBoundarySubset (const std::set< BoundaryID > &ids) const
	Test if the class boundary ids are a subset of the supplied objects. More...
bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const
template<typename T , bool is_ad = false>
bool	hasBoundaryMaterialProperty (const std::string &prop_name) const
	Check if a material property is valid for all boundaries of this object. More...
virtual bool	boundaryRestricted () const
	Returns true if this object has been restricted to a boundary. More...
const std::set< BoundaryID > &	meshBoundaryIDs () const
	Returns the set of all boundary ids for the entire mesh. More...
virtual bool	checkVariableBoundaryIntegrity () const
	Whether integrity/coverage checking should be conducted for moose variables used in this object. More...
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...
virtual const VariableValue &	coupledValueByName (const std::string &var_name)
	Returns value of a coupled variable give the variable name. More...
virtual const ArrayVariableValue &	coupledArrayValueByName (const std::string &var_name)
	Returns value of a coupled array variable give the variable name. 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::vector< MooseVariableScalar * > &	getCoupledMooseScalarVars ()
	Get the list of coupled scalar variables. More...
const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const
const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const
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)
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	isImplicit ()
Moose::StateArg	determineState () const
	Create a functor state argument that corresponds to the implicit state of this object. More...
template<typename T >
const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)
	Retrieve the AD property named "name" for the specified material_data. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
	Retrieve the generic property named "name" without any deduction for the specified material_data for state state. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" without any deduction for the specified material_data. More...
template<typename T >
const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the AD property named "name" without any deduction for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the old property named name without any deduction for the specified material_data. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the older property named name without any deduction for the specified material_data. More...
template<typename T >
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()
	Return a constant zero anonymous material property. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)
template<typename T , typename... Ts>
const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)
	for backwards compatibility More...
std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
	Retrieve the block ids that the material property is defined. More...
std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
	Retrieve the block names that the material property is defined. More...
std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)
	Retrieve the boundary ids that the material property is defined. More...
std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)
	Retrieve the boundary namess that the material property is defined. More...
void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
	Check if block and boundary restrictions of a given material are compatible with the current material. More...
std::unordered_map< SubdomainID, std::vector< MaterialBase * > >	buildRequiredMaterials (bool allow_stateful=true)
	get a map of MaterialBase pointers for all material objects that this object depends on for each block More...
void	statefulPropertiesAllowed (bool)
	Derived classes can declare whether or not they work with stateful material properties. More...
bool	getMaterialPropertyCalled () const
	Returns true if getMaterialProperty() has been called, false otherwise. More...
virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const
	Retrieve the set of material properties that this object depends on. More...
virtual void	resolveOptionalProperties ()
	resolve all optional properties More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
	Retrieve the generic property named "prop_name" without any deduction for the specified material_data for state state. 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...
void	setRandomResetFrequency (ExecFlagType exec_flag)
	This interface should be called from a derived class to enable random number generation in this object. More...
unsigned long	getRandomLong () const
	Returns the next random number (long) from the generator tied to this object (elem/node). More...
Real	getRandomReal () const
	Returns the next random number (Real) from the generator tied to this object (elem/node). More...
unsigned int	getSeed (std::size_t id)
	Get the seed for the passed in elem/node id. More...
unsigned int	getMasterSeed () const
ExecFlagType	getResetOnTime () const
void	setRandomDataPointer (RandomData *random_data)
PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the PenetrationLocator associated with the two sides. More...
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the Quadrature PentrationLocator associated with the two sides. More...
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve the PentrationLocator associated with the two sides. More...
NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve a Quadrature NearestNodeLocator associated with the two sides. More...
bool	requiresGeometricSearch () const
	Whether any of this interface's methods have been called, e.g. More...
virtual void	meshChanged ()
	Called on this object when the mesh changes. More...
virtual unsigned int	getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
	Gets index of an element integer with a parameter of the object derived from this interface. More...
virtual unsigned int	getElementIDIndexByName (const std::string &id_name) const
	Return the accessing integer for an extra element integer with its name. More...
virtual const dof_id_type &	getElementID (const std::string &id_parameter_name, unsigned int comp=0) const
	Gets an element integer with a parameter of the object derived from this interface. More...
dof_id_type	getElementID (const Elem *elem, unsigned int elem_id_index) const
	Get an element integer for an element. More...
virtual const dof_id_type &	getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const
	Gets a neighbor element integer with a parameter of the object derived from this interface. More...
virtual const dof_id_type &	getElementIDByName (const std::string &id_name) const
	Gets an element integer with the element integer name. More...
virtual const dof_id_type &	getElementIDNeighborByName (const std::string &id_name) const
	Gets a neighbor element integer with the element integer name. More...
bool	hasElementID (const std::string &id_name) const
	Whether mesh has an element integer with a given name. More...
dof_id_type	maxElementID (unsigned int elem_id_index) const
	Return the maximum element ID for an element integer with its index. More...
dof_id_type	minElementID (unsigned int elem_id_index) const
	Return the minimum element ID for an element integer with its index. More...
bool	areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
	Whether two element integers are identical for all elements. More...
std::unordered_map< dof_id_type, std::set< dof_id_type > >	getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
	Get the mapping from IDs of one extra element integer to another given the two integer names. More...
std::set< dof_id_type >	getAllElemIDs (unsigned int elem_id_index) const
	Return all the unique element IDs for an element integer with its index on the entire domain. More...
std::set< dof_id_type >	getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const
	Return all the unique element IDs for an extra element integer with its index on a set of subdomains. More...
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
	Retrieve reference to material property or one of it's old or older values. More...
template<typename T >
const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)
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
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
	Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
template<typename T >
const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)
template<typename T , bool is_ad>
const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
template<typename T >
const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)
template<typename T >
const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)
MaterialBase &	getMaterial (const std::string &name)
	Return a MaterialBase reference - usable for computing directly. More...
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)
template<typename T >
bool	hasMaterialProperty (const std::string &name)
	Check if the material property exists. More...
template<typename T >
bool	hasMaterialPropertyByName (const std::string &name)
template<typename T >
bool	hasADMaterialProperty (const std::string &name)
template<typename T >
bool	hasADMaterialPropertyByName (const std::string &name)
template<typename T , bool is_ad>
bool	hasGenericMaterialProperty (const std::string &name)
	generic hasMaterialProperty helper More...
template<typename T , bool is_ad>
bool	hasGenericMaterialPropertyByName (const std::string &name)
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 ()
static bool	restricted (const std::set< BoundaryID > &ids)
	Helper for determining if the object is boundary restricted. More...
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...

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id
	The material property ID for a default (parsed from input) property. More...
static constexpr PropertyValue::id_type	zero_property_id = PropertyValue::invalid_property_id - 2
	The material property ID for a zero property. More...

Protected Types
typedef Moose::DOFType< Real >::type	OutputData

Protected Member Functions
virtual Real	getRealValue () override
	Returns material property values at quadrature points. More...
virtual Real	computeValue () override
	Compute and return the value of the aux variable. More...
virtual void	checkFullValue ()
	Perform a sanity check on the retrieved value (e.g. to check dynamic sizes) More...
virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) const override
	Time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) const override
	Time derivative of a coupled variable with respect to the coefficients. More...
virtual void	precalculateValue ()
	This callback is used for AuxKernelTempls that need to perform a per-element calculation. More...
const OutputTools< Real >::VariableValue &	uOld () const
	Retrieves the old value of the variable that this AuxKernel operates on. More...
const OutputTools< Real >::VariableValue &	uOlder () const
	Retrieves the older value of the variable that this AuxKernel operates on. More...
virtual const OutputTools< Real >::VariableValue &	value ()
	The value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on. More...
virtual const VariableValue &	dotDu ()
	The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
virtual const VariableValue &	dotDotDu ()
	The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
virtual const OutputTools< Real >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()
	The second derivative of the test function. More...
virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face. More...
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function. More...
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face. More...
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
	A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...
void	initializeBlockRestrictable (const MooseObject *moose_object)
	An initialization routine needed for dual constructors. More...
Moose::CoordinateSystemType	getBlockCoordSystem ()
	Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...
bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
	A helper method to avoid circular #include problems. 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...
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 &	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
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	checkMaterialProperty (const std::string &name, const unsigned int state)
	A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method. More...
void	markMatPropRequested (const std::string &)
	A proxy method for _mi_feproblem.markMatPropRequested(name) More...
MaterialPropertyName	getMaterialPropertyName (const std::string &name) const
void	checkExecutionStage ()
	Check and throw an error if the execution has progressed past the construction stage. More...
template<typename T , typename... Args>
T &	declareRestartableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it. More...
template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object. More...
template<typename T , typename... Args>
T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T , typename... Args>
T &	declareRecoverableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "recoverable" and initialize it. More...
template<typename T , typename... Args>
T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
	Declare a piece of data as "restartable". More...
template<typename T , typename... Args>
T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
	Declare a piece of data as "restartable". More...
std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix. More...
const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of a VectorPostprocessor. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of the VectorPostprocessor. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...
const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...
bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by parameter. More...
bool	hasVectorPostprocessor (const std::string &param_name) const
	Determine if the VectorPostprocessor exists by parameter. More...
bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by name. More...
bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
	Determine if the VectorPostprocessor exists by name. More...
const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const
	Get the name of a VectorPostprocessor associated with a parameter. More...
std::string	deduceFunctorName (const std::string &name) const
	Small helper to look up a functor name through the input parameter keys. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name)
	Retrieves a functor from the subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)
	Retrieves a functor from the subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)
	Retrieves a functor from the passed-in subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem. More...
bool	isFunctor (const std::string &name) const
	Checks the subproblem for the given functor. More...
bool	isFunctor (const std::string &name, const SubProblem &subproblem) const
	Checks the passed-in subproblem for the given functor. More...
Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
	Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections. More...
template<typename T >
void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
	Throws error if the functor does not support the requested side integration. More...
template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)
template<typename T >
const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)
bool	isVectorPostprocessorDistributed (const std::string &param_name) const
	Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED. More...
bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

Static Protected Member Functions
static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)
	Helper to look up a functor name through the input parameter keys. More...

Protected Attributes
unsigned int	_component
	component of the real gradient to be extracted More...
unsigned int	_index
	index of the vector element More...
const PropertyType &	_prop
	(Functor)Material property for this AuxKernel More...
const unsigned int	_selected_qp
	Evaluate at this quadrature point only. More...
Moose::GenericType< std::vector< T >, is_ad >	_full_value
	T Value evaluated from either the property or the functor. More...
const bool &	_check_boundary_restricted
	Whether or not to check for repeated element sides on the sideset to which the auxkernel is restricted (if boundary restricted and elemental). More...
SubProblem &	_subproblem
	Subproblem this kernel is part of. More...
SystemBase &	_sys
	System this kernel is part of. More...
SystemBase &	_nl_sys
AuxiliarySystem &	_aux_sys
THREAD_ID	_tid
	Thread ID. More...
MooseVariableField< Real > &	_var
	This is a regular kernel so we cast to a regular MooseVariable. More...
bool	_nodal
	Flag indicating if the AuxKernel is nodal. More...
const OutputTools< Real >::VariableValue &	_u
	Holds the solution at current quadrature points. More...
Assembly &	_assembly
	Assembly class. More...
bool	_bnd
	true if the kernel is boundary kernel, false if it is interior kernels More...
MooseMesh &	_mesh
	Mesh this kernel is active on. More...
const OutputTools< Real >::VariableTestValue &	_test
	Dimension of the problem being solved. More...
const MooseArray< Point > &	_q_point
	Active quadrature points. More...
const QBase *const &	_qrule
	Quadrature rule being used. More...
const MooseArray< Real > &	_JxW
	Transformed Jacobian weights. More...
const MooseArray< Real > &	_coord
const Elem *const &	_current_elem
	Current element (valid only for elemental kernels) More...
const unsigned int &	_current_side
	current side of the current element More...
const Real &	_current_elem_volume
	Volume of the current element. More...
const Real &	_current_side_volume
	Volume of the current side. More...
const Node *const &	_current_node
	Current node (valid only for nodal kernels) More...
const BoundaryID &	_current_boundary_id
	The current boundary ID. More...
NumericVector< Number > &	_solution
	reference to the solution vector of auxiliary system More...
const Elem *const &	_current_lower_d_elem
	The current lower dimensional element. More...
const bool	_coincident_lower_d_calc
	Whether we are computing for a lower dimensional variable using boundary restriction, e.g. More...
unsigned int	_qp
	Quadrature point index. More...
unsigned int	_n_local_dofs
	number of local dofs for elemental variables More...
DenseVector< OutputData >	_local_re
	for holding local load More...
DenseVector< OutputData >	_local_sol
	for holding local solution More...
DenseMatrix< Number >	_local_ke
	for holding local mass matrix More...
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
MooseVariableFE< Real > *	_variable
MooseVariableFV< Real > *	_fv_variable
MooseLinearVariableFV< Real > *	_linear_fv_variable
MooseVariableField< Real > *	_field_variable
Assembly *	_mvi_assembly
const MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object. More...
const ExecFlagEnum &	_execute_enum
	Execute settings for this object. More...
const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. 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...
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 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
const InputParameters &	_mi_params
	Parameters of the object with this interface. More...
const std::string	_mi_name
	The name of the object that this interface belongs to. More...
const MooseObjectName	_mi_moose_object_name
	The "complete" name of the object that this interface belongs for material property output. More...
FEProblemBase &	_mi_feproblem
	Reference to the FEProblemBase class. More...
SubProblem &	_mi_subproblem
	Reference to the subproblem. More...
const THREAD_ID	_mi_tid
	Current threaded it. More...
const Moose::MaterialDataType	_material_data_type
	The type of data. More...
MaterialData &	_material_data
	The material data class that stores properties. More...
bool	_stateful_allowed
	True by default. More...
bool	_get_material_property_called
	Initialized to false. More...
std::vector< std::unique_ptr< PropertyValue > >	_default_properties
	Storage vector for default properties. More...
std::unordered_set< unsigned int >	_material_property_dependencies
	The set of material properties (as given by their IDs) that this object depends on. More...
const MaterialPropertyName	_get_suffix
const bool	_use_interpolated_state
	Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction. More...
GeometricSearchData &	_geometric_search_data
bool	_requires_geometric_search
	Whether any of this interface's methods have been called, e.g. More...
MooseApp &	_restartable_app
	Reference to the application. More...
const std::string	_restartable_system_name
	The system name this object is in. More...
const THREAD_ID	_restartable_tid
	The thread ID for this object. More...
const bool	_restartable_read_only
	Flag for toggling read only status (see ReporterData) More...
FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance. More...

Static Protected Attributes
static const std::string	_interpolated_old = "_interpolated_old"
	name suffixes for interpolated old and older properties More...
static const std::string	_interpolated_older = "_interpolated_older"

Detailed Description

AuxKernel for outputting a std::vector material-property component to an AuxVariable.

Definition at line 18 of file MaterialStdVectorRealGradientAux.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.

OutputData

typedef Moose::DOFType<Real >::type AuxKernelTempl< Real >::OutputData

protectedinherited

Definition at line 235 of file AuxKernel.h.

PropertyType

using MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::PropertyType = typename std::conditional<false , Moose::Functor<Moose::GenericType<std::vector< T > , is_ad> >, GenericMaterialProperty<std::vector< T > , is_ad> >::type

inherited

Functors really only work for Real and RealVectorValue for now :(.

Definition at line 37 of file MaterialAuxBase.h.

Member Enumeration Documentation

TEST_TYPE

enum BoundaryRestrictable::TEST_TYPE

inherited

A flag changing the behavior of hasBoundary.

Enumerator
ALL
ANY

Definition at line 29 of file BoundaryRestrictable.h.

  {
    ALL,
    ANY
  };

Constructor & Destructor Documentation

MaterialStdVectorRealGradientAux()

MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux

(

const InputParameters &

parameters

)

Definition at line 26 of file MaterialStdVectorRealGradientAux.C.

  : MaterialStdVectorAuxBase<RealGradient>(parameters),
    _component(getParam<unsigned int>("component"))
{
  if (_component > LIBMESH_DIM)
    mooseError(
        "The component ", _component, " does not exist for ", LIBMESH_DIM, " dimensional problems");
}

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

{ _fe_coupleable_matrix_tags.insert(tag); }

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

{ _fe_coupleable_vector_tags.insert(tag); }

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::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());
  }

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;
}

areElemIDsIdentical()

bool ElementIDInterface::areElemIDsIdentical ( const std::string &  id_name1, const std::string &  id_name2  ) const

inlineinherited

Whether two element integers are identical for all elements.

Definition at line 103 of file ElementIDInterface.h.

  {
    return _id_mesh->areElemIDsIdentical(id_name1, id_name2);
  }

blockIDs()

const std::set< SubdomainID > & BlockRestrictable::blockIDs ( ) const

virtualinherited

Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids.

Returns

a set of SubdomainIDs that are valid for this object

Definition at line 194 of file BlockRestrictable.C.

Referenced by FunctorMaterial::addFunctorProperty(), DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), NodalPatchRecoveryAuxBase::blockRestrictElements(), ComboMarker::ComboMarker(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), BlockRestrictable::getBlockCoordSystem(), MaterialBase::getGenericZeroMaterialPropertyByName(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), IndicatorMarker::IndicatorMarker(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), FunctorExtremaPositions::initialize(), MooseVariableBase::MooseVariableBase(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), ProjectionAux::ProjectionAux(), MaterialBase::registerPropName(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

{
  if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return _blk_mesh->meshSubdomains();
  else
    return _blk_ids;
}

blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

Returns true if this object has been restricted to a block.

See also

MooseObject

Definition at line 182 of file BlockRestrictable.C.

Referenced by NodalPatchRecoveryAuxBase::blockRestrictElements(), BlockRestrictable::checkVariable(), SubdomainsDivision::divisionIndex(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), BlockRestrictable::initializeBlockRestrictable(), SolutionIC::initialSetup(), MooseVariableBase::MooseVariableBase(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

{
  return _blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end();
}

blocks()

const std::vector< SubdomainName > & BlockRestrictable::blocks ( ) const

inherited

Return the block names for this object.

Note, if the 'blocks' input parameter was not utilized this will return an empty vector.

Returns

vector of SubdomainNames that are valid for this object

Definition at line 188 of file BlockRestrictable.C.

Referenced by MaterialOutputAction::getParams(), SubdomainsDivision::initialize(), and SolutionIC::initialSetup().

{
  return _blocks;
}

blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

Return the largest mesh dimension of the elements in the blocks for this object.

Definition at line 371 of file BlockRestrictable.C.

{
  mooseAssert(_blk_dim != libMesh::invalid_uint, "Block restriction not initialized");
  return _blk_dim;
}

boundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::boundaryIDs ( ) const

virtualinherited

Return the boundary IDs for this object.

Returns

A set of all boundary ids for which the object is restricted

Definition at line 180 of file BoundaryRestrictable.C.

Referenced by MaterialBase::getGenericZeroMaterialPropertyByName(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), SidesetInfoVectorPostprocessor::initialize(), SideFVFluxBCIntegral::initialSetup(), InterfaceQpUserObjectBase::initialSetup(), and MaterialBase::registerPropName().

{
  return _bnd_ids;
}

boundaryNames()

const std::vector< BoundaryName > & BoundaryRestrictable::boundaryNames ( ) const

inherited

Return the boundary names for this object.

Returns

A set of all boundary names for which the object is restricted

Definition at line 186 of file BoundaryRestrictable.C.

Referenced by MaterialOutputAction::getParams(), NearestNodeDistanceAux::NearestNodeDistanceAux(), and NearestNodeValueAux::NearestNodeValueAux().

{
  return _boundary_names;
}

boundaryRestricted()

bool BoundaryRestrictable::boundaryRestricted ( ) const

virtualinherited

Returns true if this object has been restricted to a boundary.

See also

MooseObject

Definition at line 198 of file BoundaryRestrictable.C.

Referenced by Material::checkMaterialProperty(), MaterialOutputAction::getParams(), and DerivativeMaterialInterface< MortarScalarBase >::haveMaterialProperty().

{
  return BoundaryRestrictable::restricted(_bnd_ids);
}

buildRequiredMaterials()

std::unordered_map< SubdomainID, std::vector< MaterialBase * > > MaterialPropertyInterface::buildRequiredMaterials ( bool  allow_stateful = true )

inherited

get a map of MaterialBase pointers for all material objects that this object depends on for each block

Definition at line 209 of file MaterialPropertyInterface.C.

{
  std::unordered_map<SubdomainID, std::vector<MaterialBase *>> required_mats;
  const auto & mwh = _mi_feproblem.getMaterialWarehouse();
  for (const auto id : _mi_block_ids)
  {
    const auto & mats = mwh[_material_data_type].getActiveBlockObjects(id, _mi_tid);
    std::array<const MaterialPropertyInterface *, 1> consumers = {{this}};
    const auto block_required =
        MaterialBase::buildRequiredMaterials(consumers, mats, allow_stateful);
    required_mats[id].insert(
        required_mats[id].begin(), block_required.begin(), block_required.end());
  }
  return required_mats;
}

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);
}

checkBlockAndBoundaryCompatibility()

void MaterialPropertyInterface::checkBlockAndBoundaryCompatibility ( std::shared_ptr< MaterialBase >  discrete )

inherited

Check if block and boundary restrictions of a given material are compatible with the current material.

Error out otherwise.

Definition at line 151 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterialByName().

{
  // Check block compatibility
  if (!discrete->hasBlocks(_mi_block_ids))
  {
    std::ostringstream oss;
    oss << "Incompatible material and object blocks:";

    oss << "\n    " << paramErrorPrefix(discrete->parameters(), "block")
        << " material defined on blocks ";
    for (const auto & sbd_id : discrete->blockIDs())
      oss << sbd_id << ", ";

    oss << "\n    " << paramErrorPrefix(_mi_params, "block") << " object needs material on blocks ";
    for (const auto & block_id : _mi_block_ids)
      oss << block_id << ", ";

    mooseError(oss.str());
  }

  // Check boundary compatibility
  if (!discrete->hasBoundary(_mi_boundary_ids))
  {
    std::ostringstream oss;
    oss << "Incompatible material and object boundaries:";

    oss << "\n    " << paramErrorPrefix(discrete->parameters(), "boundary")
        << " material defined on boundaries ";
    for (const auto & bnd_id : discrete->boundaryIDs())
      oss << bnd_id << ", ";

    oss << "\n    " << paramErrorPrefix(_mi_params, "boundary")
        << " object needs material on boundaries ";
    for (const auto & bnd_id : _mi_boundary_ids)
      oss << bnd_id << ", ";

    mooseError(oss.str());
  }
}

checkExecutionStage()

void MaterialPropertyInterface::checkExecutionStage ( )

protectedinherited

Check and throw an error if the execution has progressed past the construction stage.

Definition at line 226 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName().

{
  if (_mi_feproblem.startedInitialSetup())
    mooseError("Material properties must be retrieved during object construction. This is a code "
               "problem.");
}

checkFullValue()

virtual void MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::checkFullValue ( )

inlineprotectedvirtualinherited

Perform a sanity check on the retrieved value (e.g. to check dynamic sizes)

Definition at line 43 of file MaterialAuxBase.h.

{}

checkFunctorSupportsSideIntegration()

template<typename T >

void FunctorInterface::checkFunctorSupportsSideIntegration ( const std::string &  name, bool  qp_integration  )

protectedinherited

Throws error if the functor does not support the requested side integration.

Parameters

[in]	name	Name of functor or functor parameter
[in]	qp_integration	True if performing qp integration, false if face info

Definition at line 236 of file FunctorInterface.h.

{
  const std::string functor_name = deduceFunctorName(name);
  const auto & functor = getFunctor<T>(name);
  if (qp_integration)
  {
    if (!functor.supportsElemSideQpArg())
      mooseError("Quadrature point integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
  else
  {
    if (!functor.supportsFaceArg())
      mooseError("Face info integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
}

checkMaterialProperty()

void MaterialPropertyInterface::checkMaterialProperty ( const std::string &  name, const unsigned int  state  )

protectedvirtualinherited

A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method.

Reimplemented in Material.

Definition at line 122 of file MaterialPropertyInterface.C.

Referenced by Material::checkMaterialProperty(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

{
  if (state == 0)
  {
    // If the material property is boundary restrictable, add to the list of materials to check
    if (_mi_boundary_restricted)
      for (const auto & bnd_id : _mi_boundary_ids)
        _mi_feproblem.storeBoundaryDelayedCheckMatProp(_mi_name, bnd_id, name);

    // The default is to assume block restrictions
    else
      for (const auto & blk_ids : _mi_block_ids)
        _mi_feproblem.storeSubdomainDelayedCheckMatProp(_mi_name, blk_ids, name);
  }
}

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;
}

checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableFieldBase &  variable ) const

virtualinherited

Helper for checking that the ids for this object are in agreement with the variables on the supplied variable.

Parameters

variable

The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 343 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

{
  // a variable defined on all internal sides does not need this check because
  // it can be coupled with other variables in DG kernels
  if (!_blk_mesh->interiorLowerDBlocks().empty() &&
      variable.activeOnSubdomains(_blk_mesh->interiorLowerDBlocks()))
    return;

  if (!isBlockSubset(variable.activeSubdomains()))
  {
    std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
    std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
    mooseError("The 'block' parameter of the object '",
               _blk_name,
               "' must be a subset of the 'block' parameter of the variable '",
               variable.name(),
               "':\n    Object '",
               _blk_name,
               "': ",
               obj_ids,
               "\n    Variable '",
               variable.name(),
               "': ",
               var_ids);
  }
}

checkVariableBoundaryIntegrity()

virtual bool BoundaryRestrictable::checkVariableBoundaryIntegrity ( ) const

inlinevirtualinherited

Whether integrity/coverage checking should be conducted for moose variables used in this object.

This should return true if variables are only evaluated locally, e.g. on the current node or element. This should return false if evaluation of this object entails non-local variable evaluations

Definition at line 179 of file BoundaryRestrictable.h.

{ 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() [1/3]

void AuxKernelTempl< Real >::compute ( )

virtualinherited

Computes the value and stores it in the solution vector.

Reimplemented in NodalPatchRecovery, ElementH1ErrorFunctionAux, ElementLpNormAux, and VolumeAux.

Definition at line 297 of file AuxKernel.C.

Referenced by NodalPatchRecovery::compute().

{
  precalculateValue();

  if (isNodal()) /* nodal variables */
  {
    mooseAssert(!_coincident_lower_d_calc,
                "Nodal evaluations are point evaluations. We don't have to concern ourselves with "
                "coincidence of lower-d blocks and higher-d faces because they share nodes");
    if (_var.isNodalDefined())
    {
      _qp = 0;
      ComputeValueType value = computeValue();
      // update variable data, which is referenced by other kernels, so the value is up-to-date
      _var.setNodalValue(value);
    }
  }
  else /* elemental variables */
  {
    _n_local_dofs = _coincident_lower_d_calc ? _var.dofIndicesLower().size() : _var.numberOfDofs();

    if (_coincident_lower_d_calc)
    {
      static const std::string lower_error = "Make sure that the lower-d variable lives on a "
                                             "lower-d block that is a superset of the boundary";
      if (!_current_lower_d_elem)
        mooseError("No lower-dimensional element. ", lower_error);
      if (!_n_local_dofs)
        mooseError("No degrees of freedom. ", lower_error);
    }

    if (_n_local_dofs == 1) /* p0 */
    {
      ComputeValueType value = 0;
      for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        value += _JxW[_qp] * _coord[_qp] * computeValue();
      value /= (_bnd ? _current_side_volume : _current_elem_volume);
      if (_var.isFV())
        setDofValueHelper(value);
      else
      {
        // update the variable data referenced by other kernels.
        // Note that this will update the values at the quadrature points too
        // (because this is an Elemental variable)
        if (_coincident_lower_d_calc)
        {
          _local_sol.resize(1);
          if constexpr (std::is_same<Real, ComputeValueType>::value)
            _local_sol(0) = value;
          else
            mooseAssert(false, "We should not enter the single dof branch with a vector variable");
          _var.setLowerDofValues(_local_sol);
        }
        else
          _var.setNodalValue(value);
      }
    }
    else /* high-order */
    {
      _local_re.resize(_n_local_dofs);
      _local_re.zero();
      _local_ke.resize(_n_local_dofs, _n_local_dofs);
      _local_ke.zero();

      const auto & test = _coincident_lower_d_calc ? _var.phiLower() : _test;

      // assemble the local mass matrix and the load
      for (unsigned int i = 0; i < test.size(); i++)
        for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        {
          ComputeValueType t = _JxW[_qp] * _coord[_qp] * test[i][_qp];
          _local_re(i) += t * computeValue();
          for (unsigned int j = 0; j < test.size(); j++)
            _local_ke(i, j) += t * test[j][_qp];
        }
      // mass matrix is always SPD but in case of boundary restricted, it will be rank deficient
      _local_sol.resize(_n_local_dofs);
      if (_bnd)
        _local_ke.svd_solve(_local_re, _local_sol);
      else
        _local_ke.cholesky_solve(_local_re, _local_sol);

      _coincident_lower_d_calc ? _var.setLowerDofValues(_local_sol) : _var.setDofValues(_local_sol);
    }
  }
}

compute() [2/3]

void AuxKernelTempl< RealEigenVector >::compute ( )

inherited

compute() [3/3]

void AuxKernelTempl< RealEigenVector >::compute ( )

inherited

Definition at line 386 of file AuxKernel.C.

{
  precalculateValue();

  if (isNodal()) /* nodal variables */
  {
    if (_var.isNodalDefined())
    {
      _qp = 0;
      RealEigenVector value = computeValue();
      // update variable data, which is referenced by other kernels, so the value is up-to-date
      _var.setNodalValue(value);
    }
  }
  else /* elemental variables */
  {
    _n_local_dofs = _var.numberOfDofs();
    if (_n_local_dofs == 1) /* p0 */
    {
      RealEigenVector value = RealEigenVector::Zero(_var.count());
      for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        value += _JxW[_qp] * _coord[_qp] * computeValue();
      value /= (_bnd ? _current_side_volume : _current_elem_volume);
      // update the variable data referenced by other kernels.
      // Note that this will update the values at the quadrature points too
      // (because this is an Elemental variable)
      _var.setNodalValue(value);
    }
    else /* high-order */
    {
      _local_re.resize(_n_local_dofs);
      for (unsigned int i = 0; i < _local_re.size(); ++i)
        _local_re(i) = RealEigenVector::Zero(_var.count());
      _local_ke.resize(_n_local_dofs, _n_local_dofs);
      _local_ke.zero();

      // assemble the local mass matrix and the load
      for (unsigned int i = 0; i < _test.size(); i++)
        for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        {
          Real t = _JxW[_qp] * _coord[_qp] * _test[i][_qp];
          _local_re(i) += t * computeValue();
          for (unsigned int j = 0; j < _test.size(); j++)
            _local_ke(i, j) += t * _test[j][_qp];
        }

      // mass matrix is always SPD
      _local_sol.resize(_n_local_dofs);
      for (unsigned int i = 0; i < _local_re.size(); ++i)
        _local_sol(i) = RealEigenVector::Zero(_var.count());
      DenseVector<Number> re(_n_local_dofs);
      DenseVector<Number> sol(_n_local_dofs);
      for (unsigned int i = 0; i < _var.count(); ++i)
      {
        for (unsigned int j = 0; j < _n_local_dofs; ++j)
          re(j) = _local_re(j)(i);

        if (_bnd)
          _local_ke.svd_solve(re, sol);
        else
          _local_ke.cholesky_solve(re, sol);

        for (unsigned int j = 0; j < _n_local_dofs; ++j)
          _local_sol(j)(i) = sol(j);
      }

      _var.setDofValues(_local_sol);
    }
  }
}

computeValue()

Real MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::computeValue ( )

overrideprotectedvirtualinherited

Compute and return the value of the aux variable.

Implements AuxKernelTempl< Real >.

Definition at line 124 of file MaterialAuxBase.h.

{
  // Functor Values
  if constexpr (is_functor)
  {
    if (this->isNodal())
    {
      const std::set<SubdomainID> sub_id_set = {_current_subdomain_id};
      const Moose::NodeArg node_arg{this->_current_node, &sub_id_set};
      const auto state = this->determineState();
      _full_value = _prop(node_arg, state);
    }
    else
    {
      const auto elem_arg = this->makeElemArg(this->_current_elem);
      const auto state = this->determineState();
      _full_value = _prop(elem_arg, state);
    }
  }
  // Material Properties
  else
  {
    if (_selected_qp != libMesh::invalid_uint)
    {
      if (_selected_qp >= this->_q_point.size())
      {
        Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
        this->paramError("selected_qp",
                         "Trying to evaluate qp ",
                         _selected_qp,
                         " but there are only ",
                         this->_q_point.size(),
                         " quadrature points in the element");
      }
      _full_value = _prop[_selected_qp];
    }
    else
      _full_value = _prop[this->_qp];
  }

  checkFullValue();
  return _factor * getRealValue() + _offset;
}

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();
  }
}

coupledArrayValueByName()

const ArrayVariableValue & CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName ( const std::string &  var_name )

virtualinherited

Returns value of a coupled array variable give the variable name.

Parameters

var_name

Name of coupled variable

Returns

Reference to a ArrayVariableValue for the coupled array variable

Definition at line 55 of file CoupleableMooseVariableDependencyIntermediateInterface.C.

{
  MooseVariableFieldBase * moose_var = &_c_fe_problem.getVariable(
      _c_tid, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
  _coupled_moose_vars.push_back(moose_var);
  ArrayMooseVariable * var = &_c_fe_problem.getArrayVariable(_c_tid, var_name);
  _coupled_array_moose_vars.push_back(var);

  addMooseVariableDependency(moose_var);

  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();
  }
}

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

void AuxKernelTempl< Real >::coupledCallback ( const std::string &  var_name, bool  is_old  ) const

overridevirtualinherited

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

Reimplemented from Coupleable.

Definition at line 233 of file AuxKernel.C.

{
  if (!is_old)
  {
    const auto & var_names = getParam<std::vector<VariableName>>(var_name);
    _depend_vars.insert(var_names.begin(), var_names.end());
  }
}

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 & AuxKernelTempl< Real >::coupledDot ( const std::string &  var_name, unsigned int  comp = 0  ) const

overrideprotectedvirtualinherited

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

Definition at line 244 of file AuxKernel.C.

{
  auto var = getVar(var_name, comp);
  if (var->kind() == Moose::VAR_AUXILIARY)
    mooseError(
        name(),
        ": Unable to couple time derivative of an auxiliary variable into the auxiliary system.");

  return Coupleable::coupledDot(var_name, comp);
}

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 & AuxKernelTempl< Real >::coupledDotDu ( const std::string &  var_name, unsigned int  comp = 0  ) const

overrideprotectedvirtualinherited

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

Definition at line 257 of file AuxKernel.C.

{
  auto var = getVar(var_name, comp);
  if (var->kind() == Moose::VAR_AUXILIARY)
    mooseError(
        name(),
        ": Unable to couple time derivative of an auxiliary variable into the auxiliary system.");

  return Coupleable::coupledDotDu(var_name, comp);
}

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();
  }
}

coupledValueByName()

const VariableValue & CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName ( const std::string &  var_name )

virtualinherited

Returns value of a coupled variable give the variable name.

Parameters

var_name

Name of coupled variable

Returns

Reference to a VariableValue for the coupled variable

Definition at line 27 of file CoupleableMooseVariableDependencyIntermediateInterface.C.

{
  MooseVariableFieldBase * moose_var = &_c_fe_problem.getVariable(
      _c_tid, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
  _coupled_moose_vars.push_back(moose_var);
  MooseVariable * var = &_c_fe_problem.getStandardVariable(_c_tid, var_name);
  _coupled_standard_moose_vars.push_back(var);

  addMooseVariableDependency(moose_var);

  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.

{}

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());
}

declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

Restartable::ManagedValue< T > Restartable::declareManagedRestartableDataWithContext ( const std::string &  data_name, void *  context, Args &&...  args  )

protectedinherited

Declares a piece of "managed" restartable data and initialize it.

Here, "managed" restartable data means that the caller can destruct this data upon destruction of the return value of this method. Therefore, this ManagedValue<T> wrapper should survive after the final calls to dataStore() for it. That is... at the very end.

This is needed for objects whose destruction ordering is important, and enables natural c++ destruction in reverse construction order of the object that declares it.

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 276 of file Restartable.h.

{
  auto & data_ptr =
      declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...);
  return Restartable::ManagedValue<T>(data_ptr);
}

declareRecoverableData()

template<typename T , typename... Args>

T & Restartable::declareRecoverableData ( const std::string &  data_name, Args &&...  args  )

protectedinherited

Declare a piece of data as "recoverable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 351 of file Restartable.h.

{
  const auto full_name = restartableName(data_name);

  registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);

  return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
}

declareRestartableData()

template<typename T , typename... Args>

T & Restartable::declareRestartableData ( const std::string &  data_name, Args &&...  args  )

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 269 of file Restartable.h.

{
  return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
}

declareRestartableDataWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithContext ( const std::string &  data_name, void *  context, Args &&...  args  )

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 294 of file Restartable.h.

{
  return declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...).set();
}

declareRestartableDataWithObjectName()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectName ( const std::string &  data_name, const std::string &  object_name, Args &&...  args  )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
args	Arguments to forward to the constructor of the data

Definition at line 323 of file Restartable.h.

{
  return declareRestartableDataWithObjectNameWithContext<T>(
      data_name, object_name, nullptr, std::forward<Args>(args)...);
}

declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectNameWithContext ( const std::string &  data_name, const std::string &  object_name, void *  context, Args &&...  args  )

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 333 of file Restartable.h.

{
  std::string old_name = _restartable_name;

  _restartable_name = object_name;

  T & value = declareRestartableDataWithContext<T>(data_name, context, std::forward<Args>(args)...);

  _restartable_name = old_name;

  return value;
}

deduceFunctorName() [1/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name, const InputParameters &  params  )

staticinherited

Helper to look up a functor name through the input parameter keys.

Parameters

name	The input parameter name that we are trying to deduce the functor name for
params	The input parameters object that we will be checking for parameters named name

Returns

The functor name

Definition at line 28 of file FunctorInterface.C.

Referenced by FunctorInterface::checkFunctorSupportsSideIntegration(), FunctorInterface::deduceFunctorName(), FunctorInterface::getFunctor(), and FunctorInterface::isFunctor().

{
  if (params.isParamValid(name))
  {
    if (params.have_parameter<MooseFunctorName>(name))
      return params.get<MooseFunctorName>(name);
    // variables, functor material properties, functions, and post-processors are also functors
    else if (params.have_parameter<MaterialPropertyName>(name))
      return params.get<MaterialPropertyName>(name);
    else if (params.have_parameter<VariableName>(name))
      return params.get<VariableName>(name);
    else if (params.have_parameter<std::vector<VariableName>>(name))
    {
      const auto & var_names = params.get<std::vector<VariableName>>(name);
      if (var_names.size() != 1)
        mooseError("We only support a single variable name for retrieving a functor");
      return var_names[0];
    }
    else if (params.have_parameter<NonlinearVariableName>(name))
      return params.get<NonlinearVariableName>(name);
    else if (params.have_parameter<FunctionName>(name))
      return params.get<FunctionName>(name);
    else if (params.have_parameter<PostprocessorName>(name))
      return params.get<PostprocessorName>(name);
    else
      mooseError("Invalid parameter type for retrieving a functor");
  }
  else
    return name;
}

deduceFunctorName() [2/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name ) const

protectedinherited

Small helper to look up a functor name through the input parameter keys.

Definition at line 60 of file FunctorInterface.C.

{
  return deduceFunctorName(name, _fi_params);
}

defaultADMaterialProperty()

template<typename T >

const ADMaterialProperty<T>* MaterialPropertyInterface::defaultADMaterialProperty ( const std::string &  name )

inlineprotectedinherited

Definition at line 521 of file MaterialPropertyInterface.h.

  {
    return defaultGenericMaterialProperty<T, true>(name);
  }

defaultGenericMaterialProperty()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > * MaterialPropertyInterface::defaultGenericMaterialProperty ( const std::string &  name )

protectedinherited

Returns

The default material property with the name name, if any.

"Default" properties are properties whose default values are set from within the name. That is, if we can cast name to a Real, and the prop type is a Real or RealVectorValue, we'll return said value.

Definition at line 618 of file MaterialPropertyInterface.h.

{
  if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
  {
    std::istringstream ss(name);
    Real real_value;

    // check if the string parsed cleanly into a Real number
    if (ss >> real_value && ss.eof())
    {
      using prop_type = GenericMaterialProperty<T, is_ad>;

      const auto nqp = Moose::constMaxQpsPerElem;
      auto & property =
          _default_properties.emplace_back(std::make_unique<prop_type>(default_property_id));
      auto & T_property = static_cast<prop_type &>(*property);

      T_property.resize(nqp);
      for (const auto qp : make_range(nqp))
        T_property[qp] = real_value;

      return &T_property;
    }
  }

  return nullptr;
}

defaultMaterialProperty()

template<typename T >

const MaterialProperty<T>* MaterialPropertyInterface::defaultMaterialProperty ( const std::string &  name )

inlineprotectedinherited

Definition at line 516 of file MaterialPropertyInterface.h.

  {
    return defaultGenericMaterialProperty<T, false>(name);
  }

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.

Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryGradientRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryGradientRHSContribution(), LinearFVDiffusion::computeBoundaryMatrixContribution(), LinearFVAnisotropicDiffusion::computeBoundaryMatrixContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), LinearFVAnisotropicDiffusion::computeFluxMatrixContribution(), LinearFVDiffusion::computeFluxMatrixContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), LinearFVReaction::computeMatrixContribution(), LayeredSideDiffusiveFluxAverage::computeQpIntegral(), SideIntegralFunctorUserObject::computeQpIntegral(), SideIntegralVariableUserObject::computeQpIntegral(), ElementIntegralFunctorUserObject::computeQpIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), ParsedMaterialHelper< is_ad >::computeQpProperties(), FVDiffusionInterface::computeQpResidual(), FVTwoVarContinuityConstraint::computeQpResidual(), FVOneVarDiffusionInterface::computeQpResidual(), FVMatAdvection::computeQpResidual(), FVAdvection::computeQpResidual(), FVFunctorTimeKernel::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVConstantScalarOutflowBC::computeQpResidual(), FVFunctorNeumannBC::computeQpResidual(), FVAnisotropicDiffusion::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVDivergence::computeQpResidual(), UserForcingFunctorNodalKernel::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FVDiffusion::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), DiffusionLHDGPrescribedGradientBC::computeResidual(), LinearFVSource::computeRightHandSideContribution(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), FunctorAux::computeValue(), ParsedAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), PositionsFunctorValueSampler::execute(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), FunctorPositions::initialize(), FunctorTimes::initialize(), FunctorExtremaPositions::initialize(), ParsedDownSelectionPositions::initialize(), IPHDGAssemblyHelper::lmDirichlet(), IPHDGAssemblyHelper::lmPrescribedFlux(), AdvectionIPHDGAssemblyHelper::scalarDirichlet(), DiffusionIPHDGAssemblyHelper::scalarDirichlet(), DiffusionLHDGAssemblyHelper::scalarDirichletResidual(), DiffusionLHDGAssemblyHelper::scalarVolumeResidual(), and DiffusionLHDGAssemblyHelper::vectorDirichletResidual().

{
  return _is_implicit ? Moose::currentState() : Moose::oldState();
}

dot()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 148 of file MooseVariableInterface.C.

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

dotDot()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 158 of file MooseVariableInterface.C.

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

dotDotDu()

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

protectedvirtualinherited

The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dotdot

Returns

The reference to be stored off and used later.

Definition at line 238 of file MooseVariableInterface.C.

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

dotDotOld()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 178 of file MooseVariableInterface.C.

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

dotDu()

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

protectedvirtualinherited

The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dot

Returns

The reference to be stored off and used later.

Definition at line 228 of file MooseVariableInterface.C.

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

dotOld()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 168 of file MooseVariableInterface.C.

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

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

{ return _enabled; }

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();
}

getADMaterialProperty() [1/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialProperty ( const std::string &  name )

inlineinherited

Definition at line 103 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, true>(name, 0);
  }

getADMaterialProperty() [2/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialProperty ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the AD property named "name" for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 362 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, true>(name, material_data, 0);
  }

getADMaterialPropertyByName() [1/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialPropertyByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 140 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, true>(name, 0);
  }

getADMaterialPropertyByName() [2/2]

template<typename T >

const ADMaterialProperty<T>& MaterialPropertyInterface::getADMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the AD property named "name" without any deduction for the specified material_data.

Definition at line 405 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, true>(name, material_data, 0);
  }

getAllElemIDs()

std::set<dof_id_type> ElementIDInterface::getAllElemIDs ( unsigned int  elem_id_index ) const

inlineinherited

Return all the unique element IDs for an element integer with its index on the entire domain.

Definition at line 120 of file ElementIDInterface.h.

  {
    return _id_mesh->getAllElemIDs(elem_id_index);
  }

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.

Referenced by ArrayParsedAux::ArrayParsedAux(), ArrayVarReductionAux::ArrayVarReductionAux(), Coupleable::coupledArrayDofValues(), Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotDu(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientDot(), Coupleable::coupledArrayGradientOld(), Coupleable::coupledArrayGradientOlder(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), Coupleable::coupledVectorTagArrayGradient(), TagVectorArrayVariableAux::TagVectorArrayVariableAux(), and TagVectorArrayVariableValueAux::TagVectorArrayVariableValueAux().

{
  return const_cast<ArrayMooseVariable *>(getVarHelper<ArrayMooseVariable>(var_name, comp));
}

getArrayVar() [2/2]

const ArrayMooseVariable * Coupleable::getArrayVar ( const std::string &  var_name, unsigned int  comp  ) const

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);
}

getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )

protectedinherited

Check if the blocks this object operates on all have the same coordinate system, and if so return it.

Definition at line 321 of file BlockRestrictable.C.

{
  if (!_blk_mesh)
    mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
  if (!_blk_feproblem)
    mooseError("No problem available in BlockRestrictable::checkCoordSystem()");

  const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();

  if (subdomains.empty())
    mooseError("No subdomains found in the problem.");

  // make sure all subdomains are using the same coordinate system
  auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
  for (auto subdomain : subdomains)
    if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
      mooseError("This object requires all subdomains to have the same coordinate system.");

  return coord_system;
}

getBlockMaterialProperty()

template<typename T >

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > MaterialPropertyInterface::getBlockMaterialProperty ( const MaterialPropertyName &  name )

inherited

Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file.

This function can be thought as the combination of getMaterialPropertyByName and getMaterialPropertyBlocks. It can be called after the action of all actions.

Parameters

name	The name of the material property to retrieve

Returns

Pointer to the material property with the name 'name' and the set of blocks where the property is valid

Definition at line 648 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  if (_mi_block_ids.empty())
    mooseError("getBlockMaterialProperty must be called by a block restrictable object");

  using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;

  if (!hasMaterialPropertyByName<T>(name))
    return pair_type(nullptr, {});

  // Call first so that the ID gets registered
  const auto & prop = _material_data.getProperty<T, false>(name, 0, _mi_moose_object);
  auto blocks = getMaterialPropertyBlocks(name);
  auto prop_blocks_pair = pair_type(&prop, std::move(blocks));

  _material_property_dependencies.insert(_material_data.getPropertyId(name));

  // Update consumed properties in MaterialPropertyDebugOutput
  addConsumedPropertyName(_mi_moose_object_name, name);

  return prop_blocks_pair;
}

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::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;
}

getDependObjects()

const std::set<UserObjectName>& AuxKernelTempl< Real >::getDependObjects ( ) const

inlineinherited

Definition at line 99 of file AuxKernel.h.

{ return _depend_uo; }

getElementID() [1/2]

const dof_id_type & ElementIDInterface::getElementID ( const std::string &  id_parameter_name, unsigned int  comp = 0  ) const

virtualinherited

Gets an element integer with a parameter of the object derived from this interface.

Parameters

id_parameter_name	Name of object parameter
comp	Component number for vector of integer names

Returns

Integer for the current element

Reimplemented in Material.

Definition at line 72 of file ElementIDInterface.C.

Referenced by Material::getElementID().

{
  auto id = getElementIDIndex(id_parameter_name, comp);

  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");

  auto tid = _obj_parameters.get<THREAD_ID>("_tid");

  auto & assembly = _subproblem.assembly(tid, 0);

  return assembly.extraElemID(id);
}

getElementID() [2/2]

dof_id_type ElementIDInterface::getElementID ( const Elem *  elem, unsigned int  elem_id_index  ) const

inlineinherited

Get an element integer for an element.

Definition at line 138 of file ElementIDInterface.h.

  {
    if (elem_id_index == elem->n_extra_integers())
      return elem->subdomain_id();

    return elem->get_extra_integer(elem_id_index);
  }

getElementIDByName()

const dof_id_type & ElementIDInterface::getElementIDByName ( const std::string &  id_name ) const

virtualinherited

Gets an element integer with the element integer name.

Parameters

id_name

Name of element integer

Returns

Integer for the current element

Reimplemented in Material.

Definition at line 101 of file ElementIDInterface.C.

Referenced by Material::getElementIDByName().

{
  auto id = getElementIDIndexByName(id_name);

  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");

  auto tid = _obj_parameters.get<THREAD_ID>("_tid");

  auto & assembly = _subproblem.assembly(tid, 0);

  return assembly.extraElemID(id);
}

getElementIDIndex()

unsigned int ElementIDInterface::getElementIDIndex ( const std::string &  id_parameter_name, unsigned int  comp = 0  ) const

virtualinherited

Gets index of an element integer with a parameter of the object derived from this interface.

Parameters

id_parameter_name	Name of object parameter
comp	Component number for vector of integer names

Returns

Index of the element integer

Definition at line 36 of file ElementIDInterface.C.

Referenced by ElementIDInterface::getElementID(), and ElementIDInterface::getElementIDNeighbor().

{
  auto & p = _obj_parameters.get<std::vector<ExtraElementIDName>>(id_parameter_name);
  if (comp >= p.size())
    mooseError(id_parameter_name, " does not have enough integer names");

  return getElementIDIndexByName(p[comp]);
}

getElementIDIndexByName()

unsigned int ElementIDInterface::getElementIDIndexByName ( const std::string &  id_name ) const

virtualinherited

Return the accessing integer for an extra element integer with its name.

Parameters

id_name

Name of element integer

Returns

Index of the element integer

Definition at line 47 of file ElementIDInterface.C.

Referenced by ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), ElementIDInterface::getElementIDByName(), ElementIDInterface::getElementIDIndex(), and ElementIDInterface::getElementIDNeighborByName().

{
  if (!_id_mesh.get())
    mooseError("Mesh is not available for getting element integers");

  auto & mesh_base = _id_mesh->getMesh();

  if (id_name == "subdomain_id")
  {
    if (mesh_base.has_elem_integer(id_name))
      mooseError("MOOSE does not allow 'subdomain_id' element integer in a mesh. 'subdomain_id' is "
                 "reserved for element subdomain ID");
    return mesh_base.n_elem_integers();
  }

  if (!mesh_base.has_elem_integer(id_name))
    mooseError(
        "Mesh does not have an element integer names as ", id_name, " but required by ", _ei_name);

  auto id = mesh_base.get_elem_integer_index(id_name);

  return id;
}

getElementIDNeighbor()

const dof_id_type & ElementIDInterface::getElementIDNeighbor ( const std::string &  id_parameter_name, unsigned int  comp = 0  ) const

virtualinherited

Gets a neighbor element integer with a parameter of the object derived from this interface.

Parameters

id_parameter_name	Name of object parameter
comp	Component number for vector of integer names

Returns

Integer for the neighbor element

Reimplemented in Material.

Definition at line 86 of file ElementIDInterface.C.

Referenced by Material::getElementID(), and Material::getElementIDNeighbor().

{
  auto id = getElementIDIndex(id_parameter_name, comp);

  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");

  auto tid = _obj_parameters.get<THREAD_ID>("_tid");

  auto & assembly = _subproblem.assembly(tid, 0);

  return assembly.extraElemIDNeighbor(id);
}

getElementIDNeighborByName()

const dof_id_type & ElementIDInterface::getElementIDNeighborByName ( const std::string &  id_name ) const

virtualinherited

Gets a neighbor element integer with the element integer name.

Parameters

id_name

Name of element integer

Returns

Integer for the neighbor element

Reimplemented in Material.

Definition at line 115 of file ElementIDInterface.C.

Referenced by Material::getElementIDByName(), and Material::getElementIDNeighborByName().

{
  auto id = getElementIDIndexByName(id_name);

  auto & _subproblem = *_obj_parameters.getCheckedPointerParam<SubProblem *>("_subproblem");

  auto tid = _obj_parameters.get<THREAD_ID>("_tid");

  auto & assembly = _subproblem.assembly(tid, 0);

  return assembly.extraElemIDNeighbor(id);
}

getElemIDMapping()

std::unordered_map<dof_id_type, std::set<dof_id_type> > ElementIDInterface::getElemIDMapping ( const std::string &  id_name1, const std::string &  id_name2  ) const

inlineinherited

Get the mapping from IDs of one extra element integer to another given the two integer names.

Definition at line 112 of file ElementIDInterface.h.

  {
    return _id_mesh->getElemIDMapping(id_name1, id_name2);
  }

getElemIDsOnBlocks()

std::set<dof_id_type> ElementIDInterface::getElemIDsOnBlocks ( unsigned int  elem_id_index, const std::set< SubdomainID > &  blks  ) const

inlineinherited

Return all the unique element IDs for an extra element integer with its index on a set of subdomains.

Definition at line 129 of file ElementIDInterface.h.

  {
    return _id_mesh->getElemIDsOnBlocks(elem_id_index, blks);
  }

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(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), ElementReporter::shouldStore(), NodalReporter::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.

{ return _fe_coupleable_matrix_tags; }

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

{ return _fe_coupleable_vector_tags; }

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);
}

getFunctor() [1/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file

Returns

The functor

Definition at line 200 of file FunctorInterface.h.

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

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, _fi_tid);
}

getFunctor() [2/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, THREAD_ID  tid  )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
tid	The thread ID used to retrieve the functor from this interface's subproblem

Returns

The functor

Definition at line 192 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, tid);
}

getFunctor() [3/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem  )

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

The functor

Definition at line 185 of file FunctorInterface.h.

{
  return getFunctor<T>(name, subproblem, _fi_tid);
}

getFunctor() [4/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem, THREAD_ID  tid  )

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the subproblem

Returns

The functor

Definition at line 176 of file FunctorInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
  return getFunctorByName<T>(functor_name, subproblem, tid);
}

getGenericMaterialProperty() [1/3]

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& MaterialPropertyInterface::getGenericMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve reference to material property or one of it's old or older values.

The name required by this method is the name that is hard-coded into your source code as the input parameter key. If no input parameter is found this behaves like the getMaterialPropertyByName family as a fall back.

Parameters

name	The name of the parameter key of the material property to retrieve
state	The state (current = 0, old = 1, older = 2)

Returns

Reference to the desired material property

Definition at line 91 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, is_ad>(name, _material_data, state);
  }

getGenericMaterialProperty() [2/3]

const GenericMaterialProperty< T, is_ad > & AuxKernelTempl< Real >::getGenericMaterialProperty ( const std::string &  name )

inherited

Definition at line 289 of file AuxKernel.h.

{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");

  return MaterialPropertyInterface::getGenericMaterialProperty<T, is_ad>(name);
}

getGenericMaterialProperty() [3/3]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericMaterialProperty ( const std::string &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inherited

Retrieve the generic property named "name" for the specified material_data at state state.

Definition at line 786 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);

  return getPossiblyConstantGenericMaterialPropertyByName<T, is_ad>(
      prop_name, material_data, state);
}

getGenericMaterialPropertyByName() [1/2]

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& MaterialPropertyInterface::getGenericMaterialPropertyByName ( const MaterialPropertyName &  name, const unsigned int  state = 0  )

inlineinherited

Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file.

Parameters

name	The name of the material property to retrieve
state	The state (current = 0, old = 1, older = 2)

Returns

Reference to the material property with the name 'name'

Definition at line 129 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, is_ad>(name, _material_data, state);
  }

getGenericMaterialPropertyByName() [2/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data, const unsigned int  state  )

inherited

Retrieve the generic property named "name" without any deduction for the specified material_data for state state.

Definition at line 799 of file MaterialPropertyInterface.h.

{
  if (_use_interpolated_state)
  {
    if (state == 1)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_old, material_data, 0);
    if (state == 2)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_older, material_data, 0);
  }

  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  checkExecutionStage();
  checkMaterialProperty(name, state);

  // mark property as requested
  markMatPropRequested(name);

  // Update the boolean flag.
  _get_material_property_called = true;

  // Call first so that the ID gets registered
  auto & prop = material_data.getProperty<T, is_ad>(name, state, _mi_moose_object);

  // Does the material data used here matter?
  _material_property_dependencies.insert(material_data.getPropertyId(name));

  if (state == 0)
    addConsumedPropertyName(_mi_moose_object_name, name);

  return prop;
}

getGenericOptionalMaterialProperty()

template<typename T , bool is_ad>

const GenericOptionalMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericOptionalMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inherited

Optional material property getters state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 754 of file MaterialPropertyInterface.h.

{
  auto proxy = std::make_unique<OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>>(
      name, state);
  auto & optional_property = proxy->value();
  _optional_property_proxies.push_back(std::move(proxy));
  return optional_property;
}

getGenericZeroMaterialProperty() [1/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialProperty ( const std::string &  name )

inherited

Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material.

Definition at line 696 of file MaterialPropertyInterface.h.

{
  const auto prop_name = getMaterialPropertyName(name);
  return getGenericZeroMaterialPropertyByName<T, is_ad>(prop_name);
}

getGenericZeroMaterialProperty() [2/2]

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialProperty ( )

inherited

Return a constant zero anonymous material property.

Definition at line 715 of file MaterialPropertyInterface.h.

{
  // static zero property storage
  static GenericMaterialProperty<T, is_ad> zero(zero_property_id);

  // resize to accomodate maximum number of qpoints
  // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
  unsigned int nqp = getMaxQps();
  if (nqp > zero.size())
    zero.resize(nqp);

  // set values for all qpoints to zero
  for (unsigned int qp = 0; qp < nqp; ++qp)
    MathUtils::mooseSetToZero(zero[qp]);

  return zero;
}

getGenericZeroMaterialPropertyByName()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getGenericZeroMaterialPropertyByName ( const std::string &  prop_name )

inherited

Definition at line 704 of file MaterialPropertyInterface.h.

{
  // if found return the requested property
  if (hasGenericMaterialPropertyByName<T, is_ad>(prop_name))
    return getGenericMaterialPropertyByName<T, is_ad>(prop_name);

  return getGenericZeroMaterialProperty<T, is_ad>();
}

getMasterSeed()

unsigned int RandomInterface::getMasterSeed ( ) const

inlineinherited

Definition at line 66 of file RandomInterface.h.

{ return _master_seed; }

getMaterial()

MaterialBase & MaterialPropertyInterface::getMaterial ( const std::string &  name )

inherited

Return a MaterialBase reference - usable for computing directly.

Parameters

name	The name of the input parameter or explicit material name.
no_warn	If true, suppress warning about retrieving the material potentially during its calculation. If you don't know what this is/means, then you don't need it.

Definition at line 193 of file MaterialPropertyInterface.C.

{
  return getMaterialByName(_mi_params.get<MaterialName>(name));
}

getMaterialByName()

MaterialBase & MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn = false  )

inherited

Definition at line 199 of file MaterialPropertyInterface.C.

Referenced by ElementMaterialSampler::ElementMaterialSampler(), MaterialPropertyInterface::getMaterial(), and Material::getMaterialByName().

{
  std::shared_ptr<MaterialBase> discrete =
      _mi_feproblem.getMaterial(name, _material_data_type, _mi_tid, no_warn);

  checkBlockAndBoundaryCompatibility(discrete);
  return *discrete;
}

getMaterialProperty() [1/3]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 97 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, false>(name, state);
  }

getMaterialProperty() [2/3]

const MaterialProperty< T > & AuxKernelTempl< Real >::getMaterialProperty ( const std::string &  name )

inherited

Override functions from MaterialPropertyInterface for error checking.

Definition at line 272 of file AuxKernel.h.

{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");

  return MaterialPropertyInterface::getMaterialProperty<T>(name);
}

getMaterialProperty() [3/3]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialProperty ( const std::string &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inlineinherited

Retrieve the property named "name" for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 349 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialProperty<T, false>(name, material_data, state);
  }

getMaterialPropertyBlockNames()

std::vector< SubdomainName > MaterialPropertyInterface::getMaterialPropertyBlockNames ( const std::string &  name )

inherited

Retrieve the block names that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block names for the property

Definition at line 91 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBlockNames(name);
}

getMaterialPropertyBlocks()

std::set< SubdomainID > MaterialPropertyInterface::getMaterialPropertyBlocks ( const std::string &  name )

inherited

Retrieve the block ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block ids for the property

Definition at line 85 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty().

{
  return _mi_feproblem.getMaterialPropertyBlocks(name);
}

getMaterialPropertyBoundaryIDs()

std::set< BoundaryID > MaterialPropertyInterface::getMaterialPropertyBoundaryIDs ( const std::string &  name )

inherited

Retrieve the boundary ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary ids for the property

Definition at line 97 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryIDs(name);
}

getMaterialPropertyBoundaryNames()

std::vector< BoundaryName > MaterialPropertyInterface::getMaterialPropertyBoundaryNames ( const std::string &  name )

inherited

Retrieve the boundary namess that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary names for the property

Definition at line 103 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryNames(name);
}

getMaterialPropertyByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyByName ( const MaterialPropertyName &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 134 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, false>(name, state);
  }

getMaterialPropertyByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyByName ( const MaterialPropertyName &  name, MaterialData &  material_data, const unsigned int  state = 0  )

inlineinherited

Retrieve the property named "name" without any deduction for the specified material_data.

state is the property state; 0 = current, 1 = old, 2 = older, etc.

Definition at line 393 of file MaterialPropertyInterface.h.

  {
    return getGenericMaterialPropertyByName<T, false>(name, material_data, state);
  }

getMaterialPropertyCalled()

bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlineinherited

Returns true if getMaterialProperty() has been called, false otherwise.

Definition at line 320 of file MaterialPropertyInterface.h.

{ return _get_material_property_called; }

getMaterialPropertyName()

MaterialPropertyName MaterialPropertyInterface::getMaterialPropertyName ( const std::string &  name ) const

protectedinherited

Returns

The name of the material property associated with name name.

If name is the name of a material property parameter and the parameter is valid, this will return the value of said parameter. Otherwise, it will just return the name.

Definition at line 77 of file MaterialPropertyInterface.C.

Referenced by InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), MaterialPropertyInterface::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), MaterialPropertyInterface::getGenericZeroMaterialProperty(), MaterialPropertyInterface::hasADMaterialProperty(), and MaterialPropertyInterface::hasMaterialProperty().

{
  if (_mi_params.have_parameter<MaterialPropertyName>(name) && _mi_params.isParamValid(name))
    return _mi_params.get<MaterialPropertyName>(name);
  return name;
}

getMaterialPropertyOld() [1/2]

const MaterialProperty< T > & AuxKernelTempl< Real >::getMaterialPropertyOld ( const std::string &  name )

inherited

Definition at line 306 of file AuxKernel.h.

{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");

  return MaterialPropertyInterface::getMaterialPropertyOld<T>(name);
}

getMaterialPropertyOld() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOld ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the old property deduced from the name name for the specified material_data.

Definition at line 415 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, material_data, 1);
  }

getMaterialPropertyOldByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOldByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 145 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, 1);
  }

getMaterialPropertyOldByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOldByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the old property named name without any deduction for the specified material_data.

Definition at line 437 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, material_data, 1);
  }

getMaterialPropertyOlder() [1/2]

const MaterialProperty< T > & AuxKernelTempl< Real >::getMaterialPropertyOlder ( const std::string &  name )

inherited

Definition at line 323 of file AuxKernel.h.

{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");

  return MaterialPropertyInterface::getMaterialPropertyOlder<T>(name);
}

getMaterialPropertyOlder() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlder ( const std::string &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the older property deduced from the name name for the specified material_data.

Definition at line 426 of file MaterialPropertyInterface.h.

  {
    return getMaterialProperty<T>(name, material_data, 2);
  }

getMaterialPropertyOlderByName() [1/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlderByName ( const MaterialPropertyName &  name )

inlineinherited

Definition at line 150 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, 2);
  }

getMaterialPropertyOlderByName() [2/2]

template<typename T >

const MaterialProperty<T>& MaterialPropertyInterface::getMaterialPropertyOlderByName ( const MaterialPropertyName &  name, MaterialData &  material_data  )

inlineinherited

Retrieve the older property named name without any deduction for the specified material_data.

Definition at line 448 of file MaterialPropertyInterface.h.

  {
    return getMaterialPropertyByName<T>(name, material_data, 2);
  }

getMatPropDependencies()

virtual const std::unordered_set<unsigned int>& MaterialPropertyInterface::getMatPropDependencies ( ) const

inlinevirtualinherited

Retrieve the set of material properties that this object depends on.

Returns

The IDs corresponding to the material properties that MUST be reinited before evaluating this object

Reimplemented in Material, InterfaceMaterial, IPHDGKernel, and IPHDGBC.

Definition at line 328 of file MaterialPropertyInterface.h.

Referenced by IPHDGBC::getMatPropDependencies(), IPHDGKernel::getMatPropDependencies(), InterfaceMaterial::getMatPropDependencies(), Material::getMatPropDependencies(), NodalPatchRecovery::reinitPatch(), ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateMatPropDependencyHelper().

  {
    return _material_property_dependencies;
  }

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(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), 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(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

{ return _app; }

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;
  }

getNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getNearestNodeLocator ( const BoundaryName &  primary, const BoundaryName &  secondary  )

inherited

Retrieve the PentrationLocator associated with the two sides.

Definition at line 53 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getNearestNodeLocator(primary, secondary);
}

getOptionalADMaterialProperty()

template<typename T >

const OptionalADMaterialProperty<T>& MaterialPropertyInterface::getOptionalADMaterialProperty ( const std::string &  name )

inlineinherited

Definition at line 169 of file MaterialPropertyInterface.h.

  {
    return getGenericOptionalMaterialProperty<T, true>(name);
  }

getOptionalMaterialProperty()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialProperty ( const std::string &  name, const unsigned int  state = 0  )

inlineinherited

Definition at line 163 of file MaterialPropertyInterface.h.

  {
    return getGenericOptionalMaterialProperty<T, false>(name, state);
  }

getOptionalMaterialPropertyOld()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialPropertyOld ( const std::string &  name )

inlineinherited

Definition at line 175 of file MaterialPropertyInterface.h.

  {
    return getOptionalMaterialProperty<T>(name, 1);
  }

getOptionalMaterialPropertyOlder()

template<typename T >

const OptionalMaterialProperty<T>& MaterialPropertyInterface::getOptionalMaterialPropertyOlder ( const std::string &  name )

inlineinherited

Definition at line 180 of file MaterialPropertyInterface.h.

  {
    return getOptionalMaterialProperty<T>(name, 2);
  }

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.

Referenced by CreateDisplacedProblemAction::act(), AddPeriodicBCAction::act(), DiffusionPhysicsBase::addPostprocessors(), ADNodalKernel::ADNodalKernel(), ArrayParsedAux::ArrayParsedAux(), AddPeriodicBCAction::autoTranslationBoundaries(), BicubicSplineFunction::BicubicSplineFunction(), ComponentPhysicsInterface::ComponentPhysicsInterface(), FunctorAux::computeValue(), FEProblemBase::createTagSolutions(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), DebugResidualAux::DebugResidualAux(), AccumulateReporter::declareLateValues(), DerivativeParsedMaterialTempl< is_ad >::DerivativeParsedMaterialTempl(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), EigenKernel::EigenKernel(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ParsedSubdomainGeneratorBase::functionInitialize(), FVInterfaceKernel::FVInterfaceKernel(), BoundaryLayerSubdomainGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), BlockDeletionGenerator::generate(), BreakMeshByBlockGenerator::generate(), CoarsenBlockGenerator::generate(), GeneratedMeshGenerator::generate(), RefineBlockGenerator::generate(), RefineSidesetGenerator::generate(), MeshExtruderGenerator::generate(), GenericConstantRankTwoTensorTempl< is_ad >::GenericConstantRankTwoTensorTempl(), GenericConstantSymmetricRankTwoTensorTempl< is_ad >::GenericConstantSymmetricRankTwoTensorTempl(), MooseApp::getCheckpointDirectories(), DataFileInterface::getDataFileName(), ExecutorInterface::getExecutor(), GhostingUserObject::GhostingUserObject(), FixedPointIterationAdaptiveDT::init(), TimeSequenceStepper::init(), IterationAdaptiveDT::init(), AdvancedOutput::init(), AttribThread::initFrom(), AttribSysNum::initFrom(), AttribResidualObject::initFrom(), AttribDisplaced::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseMesh::MooseMesh(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MultiSystemSolveObject::MultiSystemSolveObject(), NEML2ModelExecutor::NEML2ModelExecutor(), NestedDivision::NestedDivision(), ConsoleUtils::outputExecutionInformation(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterialTempl< is_ad >::ParsedMaterialTempl(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedODEKernel::ParsedODEKernel(), ParsedPostprocessor::ParsedPostprocessor(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), PiecewiseConstantByBlockMaterialTempl< is_ad >::PiecewiseConstantByBlockMaterialTempl(), ReferenceResidualInterface::ReferenceResidualInterface(), RenameBlockGenerator::RenameBlockGenerator(), Moose::FV::setInterpolationMethod(), SetupMeshAction::setupMesh(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), UniqueExtraIDMeshGenerator::UniqueExtraIDMeshGenerator(), FunctorIC::value(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), and VectorOfPostprocessors::VectorOfPostprocessors().

{
  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);
}

getPenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getPenetrationLocator ( const BoundaryName &  primary, const BoundaryName &  secondary, Order  order  )

inherited

Retrieve the PenetrationLocator associated with the two sides.

Definition at line 35 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getPenetrationLocator(primary, secondary, order);
}

getPossiblyConstantGenericMaterialPropertyByName()

template<typename T , bool is_ad>

const GenericMaterialProperty< T, is_ad > & MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName ( const MaterialPropertyName &  prop_name, MaterialData &  material_data, const unsigned int  state  )

inherited

Retrieve the generic property named "prop_name" without any deduction for the specified material_data for state state.

This API allows the prop_name to be a constant, e.g. it allows the possibility that prop_name is not a name at all

Definition at line 766 of file MaterialPropertyInterface.h.

{
  // Check if it's just a constant
  if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
    return *default_property;

  if (state > 0 && !_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " State ",
               state,
               " property for \"",
               prop_name,
               "\" was requested.");

  return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
}

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);
}

getQuadratureNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getQuadratureNearestNodeLocator ( const BoundaryName &  primary, const BoundaryName &  secondary  )

inherited

Retrieve a Quadrature NearestNodeLocator associated with the two sides.

A "Quadrature" version means that it's going to find the nearest nodes to each quadrature point on this boundary

Definition at line 61 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadratureNearestNodeLocator(primary, secondary);
}

getQuadraturePenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getQuadraturePenetrationLocator ( const BoundaryName &  primary, const BoundaryName &  secondary, Order  order  )

inherited

Retrieve the Quadrature PentrationLocator associated with the two sides.

A "Quadrature" version means that it's going to find the penetration each quadrature point on this boundary

Definition at line 44 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadraturePenetrationLocator(primary, secondary, order);
}

getRandomLong()

unsigned long RandomInterface::getRandomLong ( ) const

inherited

Returns the next random number (long) from the generator tied to this object (elem/node).

Definition at line 69 of file RandomInterface.C.

{
  mooseAssert(_generator, "Random Generator is NULL, did you call setRandomResetFrequency()?");

  dof_id_type id;
  if (_is_nodal)
    id = _curr_node->id();
  else
    id = _curr_element->id();

  return _generator->randl(id);
}

getRandomReal()

Real RandomInterface::getRandomReal ( ) const

inherited

Returns the next random number (Real) from the generator tied to this object (elem/node).

Definition at line 83 of file RandomInterface.C.

{
  mooseAssert(_generator, "Random Generator is NULL, did you call setRandomResetFrequency()?");

  dof_id_type id;
  if (_is_nodal)
    id = _curr_node->id();
  else
    id = _curr_element->id();

  return _generator->rand(id);
}

getRealValue()

Real MaterialStdVectorRealGradientAux::getRealValue ( )

overrideprotectedvirtual

Returns material property values at quadrature points.

Implements MaterialAuxBaseTempl< std::vector< T >, is_ad >.

Definition at line 37 of file MaterialStdVectorRealGradientAux.C.

{
  return this->_full_value[_index](_component);
}

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 > & AuxKernelTempl< Real >::getRequestedItems ( )

overridevirtualinherited

Return a set containing the names of items requested by the object.

Implements DependencyResolverInterface.

Definition at line 194 of file AuxKernel.C.

{
  return _depend_vars;
}

getResetOnTime()

ExecFlagType RandomInterface::getResetOnTime ( ) const

inlineinherited

Definition at line 68 of file RandomInterface.h.

{ return _reset_on; }

getRestartableData()

template<typename T , typename... Args>

const T & Restartable::getRestartableData ( const std::string &  data_name ) const

protectedinherited

Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object.

Forwarded arguments are not allowed in this case because we assume that the object is restarted and we won't need different constructors to initialize it.

NOTE: This returns a const reference! Make sure you store it in a const reference!

Parameters

data_name

The name of the data (usually just use the same name as the member variable)

Definition at line 287 of file Restartable.h.

{
  return declareRestartableDataHelper<T>(data_name, nullptr).get();
}

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.

Referenced by ScalarCoupleable::adCoupledScalarDot(), ScalarCoupleable::adCoupledScalarValue(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalar(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), ScalarCoupleable::coupledVectorTagScalarValue(), and ParsedODEKernel::ParsedODEKernel().

{
  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;
  }

getScatterVectorPostprocessorValue()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValue ( const std::string &  param_name, const std::string &  vector_name  ) const

inherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

param_name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns

The reference to the current scatter value

Definition at line 106 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getScatterVectorPostprocessorValueByName(getVectorPostprocessorName(param_name),
                                                  vector_name);
}

getScatterVectorPostprocessorValueByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  ) const

inherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns

The reference to the current scatter value

Definition at line 115 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

{
  return getVectorPostprocessorContextByNameHelper(name, vector_name).getScatterValue();
}

getScatterVectorPostprocessorValueOld()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld ( const std::string &  param_name, const std::string &  vector_name  ) const

inherited

Return the old scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

param_name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns

The reference to the old scatter value

Definition at line 122 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getScatterVectorPostprocessorValueOldByName(getVectorPostprocessorName(param_name),
                                                     vector_name);
}

getScatterVectorPostprocessorValueOldByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOldByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  ) const

inherited

Return the old scatter value for the post processor.

This is only valid when you expect the vector to be of length "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns

The reference to the old scatter value

Definition at line 131 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

{
  return getVectorPostprocessorContextByNameHelper(name, vector_name).getScatterValueOld();
}

getSeed()

unsigned int RandomInterface::getSeed ( std::size_t  id )

inherited

Get the seed for the passed in elem/node id.

Parameters

id	- dof object id

Returns

current seed for this id

Definition at line 61 of file RandomInterface.C.

{
  mooseAssert(_random_data, "RandomData object is NULL!");

  return _random_data->getSeed(id);
}

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 > & AuxKernelTempl< Real >::getSuppliedItems ( )

overridevirtualinherited

Return a set containing the names of items owned by the object.

Implements DependencyResolverInterface.

Definition at line 201 of file AuxKernel.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.

Referenced by Coupleable::coupledDofValuesOld(), Coupleable::coupledDofValuesOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), Coupleable::coupledGradientPreviousNL(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValueDot(), NeighborCoupleable::coupledNeighborValueDotDu(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), Coupleable::coupledSecondPreviousNL(), Coupleable::coupledValueLower(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorTagGradient(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), NearestNodeValueAux::NearestNodeValueAux(), and Coupleable::writableCoupledValue().

{
  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.");
  }
}

getVectorPostprocessorName()

const VectorPostprocessorName & VectorPostprocessorInterface::getVectorPostprocessorName ( const std::string &  param_name ) const

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name

The name of the VectorPostprocessor parameter

Returns

The name of the given VectorPostprocessor

Definition at line 203 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue(), VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld(), VectorPostprocessorInterface::getVectorPostprocessorValue(), VectorPostprocessorInterface::getVectorPostprocessorValueOld(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::isVectorPostprocessorDistributed(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

{
  const auto & params = _vpi_moose_object.parameters();

  if (!params.isParamValid(param_name))
    _vpi_moose_object.mooseError(
        "When getting a VectorPostprocessor, failed to get a parameter with the name \"",
        param_name,
        "\".",
        "\n\nKnown parameters:\n",
        _vpi_moose_object.parameters());

  if (!params.isType<VectorPostprocessorName>(param_name))
    _vpi_moose_object.mooseError(
        "Supplied parameter with name \"",
        param_name,
        "\" of type \"",
        params.type(param_name),
        "\" is not an expected type for getting a VectorPostprocessor.\n\n",
        "The allowed type is \"VectorPostprocessorName\".");

  return params.get<VectorPostprocessorName>(param_name);
}

getVectorPostprocessorValue() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValue ( const std::string &  param_name, const std::string &  vector_name  ) const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of a VectorPostprocessor

Parameters

param_name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 36 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getVectorPostprocessorValueByName(getVectorPostprocessorName(param_name), vector_name);
}

getVectorPostprocessorValue() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValue ( const std::string &  param_name, const std::string &  vector_name, bool  needs_broadcast  ) const

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

param_name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 66 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getVectorPostprocessorValueByName(
      getVectorPostprocessorName(param_name), vector_name, needs_broadcast);
}

getVectorPostprocessorValueByName() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  ) const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of the VectorPostprocessor

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 44 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValue().

{
  return getVectorPostprocessorByNameHelper(name, vector_name, _broadcast_by_default, 0);
}

getVectorPostprocessorValueByName() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueByName ( const VectorPostprocessorName &  name, const std::string &  vector_name, bool  needs_broadcast  ) const

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 76 of file VectorPostprocessorInterface.C.

{
  return getVectorPostprocessorByNameHelper(
      name, vector_name, needs_broadcast || _broadcast_by_default, 0);
}

getVectorPostprocessorValueOld() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld ( const std::string &  param_name, const std::string &  vector_name  ) const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.

Returns

The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 51 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getVectorPostprocessorValueOldByName(getVectorPostprocessorName(param_name), vector_name);
}

getVectorPostprocessorValueOld() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld ( const std::string &  param_name, const std::string &  vector_name, bool  needs_broadcast  ) const

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns

The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 86 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessor(param_name, vector_name);
  return getVectorPostprocessorValueOldByName(
      getVectorPostprocessorName(param_name), vector_name, needs_broadcast);
}

getVectorPostprocessorValueOldByName() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  ) const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.

Returns

The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 59 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld().

{
  return getVectorPostprocessorByNameHelper(name, vector_name, _broadcast_by_default, 1);
}

getVectorPostprocessorValueOldByName() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName ( const VectorPostprocessorName &  name, const std::string &  vector_name, bool  needs_broadcast  ) const

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns

The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 96 of file VectorPostprocessorInterface.C.

{
  return getVectorPostprocessorByNameHelper(
      name, vector_name, needs_broadcast || _broadcast_by_default, 1);
}

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.

Referenced by Coupleable::adCoupledCurl(), Coupleable::adCoupledVectorDot(), Coupleable::adCoupledVectorGradient(), Coupleable::adCoupledVectorValue(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledCurlOlder(), Coupleable::coupledDiv(), Coupleable::coupledDivOld(), Coupleable::coupledDivOlder(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotDu(), Coupleable::coupledVectorDotDotOld(), Coupleable::coupledVectorDotDu(), Coupleable::coupledVectorDotOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), and Coupleable::coupledVectorValueOlder().

{
  auto * const var =
      const_cast<VectorMooseVariable *>(getVarHelper<VectorMooseVariable>(var_name, comp));

  if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
    mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");

  return var;
}

getVectorVar() [2/2]

const VectorMooseVariable * Coupleable::getVectorVar ( const std::string &  var_name, unsigned int  comp  ) const

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

{ return _writable_coupled_variables[_c_tid]; }

getZeroMaterialProperty()

template<typename T , typename... Ts>

const MaterialProperty<T>& MaterialPropertyInterface::getZeroMaterialProperty ( Ts...  args )

inlineinherited

for backwards compatibility

Definition at line 219 of file MaterialPropertyInterface.h.

  {
    return getGenericZeroMaterialProperty<T, false>(args...);
  }

gradient()

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

protectedvirtualinherited

The gradient of the variable this object is operating on.

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

Returns

The reference to be stored off and used later.

Definition at line 248 of file MooseVariableInterface.C.

Referenced by DiffusionFluxAux::computeValue().

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSln();
}

gradientOld()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 258 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSlnOld();
}

gradientOlder()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 268 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");

  return _variable->gradSlnOlder();
}

hasADMaterialProperty()

template<typename T >

bool MaterialPropertyInterface::hasADMaterialProperty ( const std::string &  name )

inherited

Definition at line 735 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasADMaterialPropertyByName<T>(prop_name);
}

hasADMaterialPropertyByName()

template<typename T >

bool MaterialPropertyInterface::hasADMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 744 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveADProperty<T>(name);
}

hasBlockMaterialProperty()

template<typename T , bool is_ad>

bool BlockRestrictable::hasBlockMaterialProperty ( const std::string &  prop_name )

inherited

Check if a material property is valid for all blocks of this object.

This method returns true if the supplied property name has been declared in a Material object on the block ids for this object.

Template Parameters

T	The type of material property

Parameters

prop_name

the name of the property to query

Returns

true if the property exists for all block ids of the object, otherwise false

See also

Material::hasBlockMaterialProperty

Definition at line 271 of file BlockRestrictable.h.

{
  mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
  return hasBlockMaterialPropertyHelper(prop_name) &&
         _blk_material_data->haveGenericProperty<T, is_ad>(prop_name);
}

hasBlockMaterialPropertyHelper()

bool BlockRestrictable::hasBlockMaterialPropertyHelper ( const std::string &  prop_name )

protectedvirtualinherited

A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.

It also avoid circular #include problems.

See also

hasBlockMaterialProperty

Definition at line 285 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

{

  // Reference to MaterialWarehouse for testing and retrieving block ids
  const MaterialWarehouse & warehouse = _blk_feproblem->getMaterialWarehouse();

  // Complete set of ids that this object is active
  const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();

  // Loop over each id for this object
  for (const auto & id : ids)
  {
    // Storage of material properties that have been DECLARED on this id
    std::set<std::string> declared_props;

    // If block materials exist, populated the set of properties that were declared
    if (warehouse.hasActiveBlockObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
      for (const auto & mat : mats)
      {
        const std::set<std::string> & mat_props = mat->getSuppliedItems();
        declared_props.insert(mat_props.begin(), mat_props.end());
      }
    }

    // If the supplied property is not in the list of properties on the current id, return false
    if (declared_props.find(prop_name) == declared_props.end())
      return false;
  }

  // If you get here the supplied property is defined on all blocks
  return true;
}

hasBlocks() [1/6]

bool BlockRestrictable::hasBlocks ( const SubdomainName &  name ) const

inherited

Test if the supplied block name is valid for this object.

Parameters

name	A SubdomainName to check

Returns

True if the given id is valid for this object

Definition at line 209 of file BlockRestrictable.C.

Referenced by LinearFVFluxKernel::addMatrixContribution(), DiracKernelBase::addPoint(), LinearFVFluxKernel::addRightHandSideContribution(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), DomainUserObject::checkVariable(), ComputeJacobianThread::compute(), ComboMarker::computeElementMarker(), GradientJumpIndicator::computeQpIntegral(), ProjectionAux::computeValue(), DomainUserObject::DomainUserObject(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MeshDivisionFunctorReductionVectorPostprocessor::hasBlocks(), BlockRestrictable::hasBlocks(), MooseVariableField< Real >::hasBlocks(), FVFluxKernel::hasFaceSide(), IndicatorMarker::IndicatorMarker(), NodePositions::initialize(), ParsedDownSelectionPositions::initialize(), UpdateErrorVectorsThread::onElement(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and BlockRestrictionDebugOutput::printBlockRestrictionMap().

{
  // Create a vector and utilize the getSubdomainIDs function, which
  // handles the ANY_BLOCK_ID (getSubdomainID does not)
  std::vector<SubdomainName> names(1);
  names[0] = name;
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [2/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainName > &  names ) const

inherited

Test if the supplied vector of block names are valid for this object.

Parameters

names

A vector of SubdomainNames to check

Returns

True if the given ids are valid for this object

Definition at line 219 of file BlockRestrictable.C.

{
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [3/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainName > &  names ) const

inherited

Test if the supplied set of block names are valid for this object.

Parameters

names

A set of SubdomainNames to check

Returns

True if the given ids are valid for this object

Definition at line 225 of file BlockRestrictable.C.

{
  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
}

hasBlocks() [4/6]

bool BlockRestrictable::hasBlocks ( SubdomainID  id ) const

inherited

Test if the supplied block ids are valid for this object.

Parameters

id	A SubdomainID to check

Returns

True if the given id is valid for this object

Definition at line 231 of file BlockRestrictable.C.

{
  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return true;
  else
    return _blk_ids.find(id) != _blk_ids.end();
}

hasBlocks() [5/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainID > &  ids ) const

inherited

Test if the supplied vector block ids are valid for this object.

Parameters

ids	A vector of SubdomainIDs ids to check

Returns

True if all of the given ids are found within the ids for this object

Definition at line 240 of file BlockRestrictable.C.

{
  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
  return hasBlocks(ids_set);
}

hasBlocks() [6/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainID > &  ids ) const

inherited

Test if the supplied set of block ids are valid for this object.

Parameters

ids	A std::set of SubdomainIDs to check

Returns

True if all of the given ids are found within the ids for this object

See also

isSubset

Definition at line 247 of file BlockRestrictable.C.

{
  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return true;
  else
    return std::includes(_blk_ids.begin(), _blk_ids.end(), ids.begin(), ids.end());
}

hasBoundary() [1/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryName &  name ) const

inherited

Test if the supplied boundary name is valid for this object.

Parameters

name	A BoundaryName to check

Returns

True if the given id is valid for this object

Definition at line 210 of file BoundaryRestrictable.C.

Referenced by AuxKernelTempl< Real >::AuxKernelTempl(), BoundaryRestrictable::hasBoundary(), and BoundaryRestrictable::hasBoundaryMaterialPropertyHelper().

{
  // Create a vector and utilize the getBoundaryIDs function, which
  // handles the ANY_BOUNDARY_ID (getBoundaryID does not)
  return hasBoundary(_bnd_mesh->getBoundaryIDs({name}));
}

hasBoundary() [2/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryName > &  names ) const

inherited

Test if the supplied vector of boundary names are valid for this object.

Parameters

names

A vector of BoundaryNames to check

Returns

True if the given ids are valid for this object

Definition at line 218 of file BoundaryRestrictable.C.

{
  return hasBoundary(_bnd_mesh->getBoundaryIDs(names));
}

hasBoundary() [3/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryID &  id ) const

inherited

Test if the supplied boundary ids are valid for this object.

Parameters

id	A BoundaryID to check

Returns

True if the given id is valid for this object

Definition at line 224 of file BoundaryRestrictable.C.

{
  if (_bnd_ids.empty() || _bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
    return true;
  else
    return _bnd_ids.find(id) != _bnd_ids.end();
}

hasBoundary() [4/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryID > &  ids, TEST_TYPE  type = ALL  ) const

inherited

Test if the supplied vector boundary ids are valid for this object.

Parameters

ids	A vector of BoundaryIDs ids to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

Returns

True if the all of the given ids are found within the ids for this object

Definition at line 233 of file BoundaryRestrictable.C.

{
  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
  return hasBoundary(ids_set, type);
}

hasBoundary() [5/5]

bool BoundaryRestrictable::hasBoundary ( const std::set< BoundaryID > &  ids, TEST_TYPE  type = ALL  ) const

inherited

Test if the supplied set of boundary ids are valid for this object.

Parameters

ids	A std::set of BoundaryIDs to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

Returns

True if the all of the given ids are found within the ids for this object

See also

isSubset

Definition at line 240 of file BoundaryRestrictable.C.

{
  // An empty input is assumed to be ANY_BOUNDARY_ID
  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
    return true;

  // All supplied IDs must match those of the object
  else if (type == ALL)
  {
    if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
      return true;
    else
      return std::includes(_bnd_ids.begin(), _bnd_ids.end(), ids.begin(), ids.end());
  }
  // Any of the supplied IDs must match those of the object
  else
  {
    // Loop through the supplied ids
    for (const auto & id : ids)
    {
      // Test the current supplied id
      bool test = hasBoundary(id);

      // If the id exists in the stored ids, then return true, otherwise
      if (test)
        return true;
    }
    return false;
  }
}

hasBoundaryMaterialProperty()

template<typename T , bool is_ad>

bool BoundaryRestrictable::hasBoundaryMaterialProperty ( const std::string &  prop_name ) const

inherited

Check if a material property is valid for all boundaries of this object.

This method returns true if the supplied property name has been declared in a Material object on the boundary ids for this object.

Template Parameters

T	The type of material property

Parameters

prop_name

the name of the property to query

Returns

true if the property exists for all boundary ids of the object, otherwise false

Definition at line 233 of file BoundaryRestrictable.h.

{
  // If you get here the supplied property is defined on all boundaries, but is still subject
  // existence in the MateialData class
  return hasBoundaryMaterialPropertyHelper(prop_name) &&
         _bnd_material_data.haveGenericProperty<T, is_ad>(prop_name);
}

hasBoundaryMaterialPropertyHelper()

bool BoundaryRestrictable::hasBoundaryMaterialPropertyHelper ( const std::string &  prop_name ) const

protectedinherited

A helper method to avoid circular #include problems.

See also

hasBoundaryMaterialProperty

Definition at line 301 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::hasBoundaryMaterialProperty().

{
  // Reference to MaterialWarehouse for testing and retrieving boundary ids
  const MaterialWarehouse & warehouse = _bnd_feproblem->getMaterialWarehouse();

  // Complete set of BoundaryIDs that this object is defined
  const std::set<BoundaryID> & ids =
      hasBoundary(Moose::ANY_BOUNDARY_ID) ? meshBoundaryIDs() : boundaryIDs();

  // Loop over each BoundaryID for this object
  for (const auto & id : ids)
  {
    // Storage of material properties that have been DECLARED on this BoundaryID
    std::set<std::string> declared_props;

    // If boundary materials exist, populated the set of properties that were declared
    if (warehouse.hasActiveBoundaryObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats =
          warehouse.getActiveBoundaryObjects(id);
      for (const auto & mat : mats)
      {
        const std::set<std::string> & mat_props = mat->getSuppliedItems();
        declared_props.insert(mat_props.begin(), mat_props.end());
      }
    }

    // If the supplied property is not in the list of properties on the current id, return false
    if (declared_props.find(prop_name) == declared_props.end())
      return false;
  }

  // If you get here the supplied property is defined on all boundaries
  return true;
}

hasElementID()

bool ElementIDInterface::hasElementID ( const std::string &  id_name ) const

inlineinherited

Whether mesh has an element integer with a given name.

Definition at line 82 of file ElementIDInterface.h.

{ return _id_mesh->hasElementID(id_name); }

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);
}

hasGenericMaterialProperty()

template<typename T , bool is_ad>

bool MaterialPropertyInterface::hasGenericMaterialProperty ( const std::string &  name )

inlineinherited

generic hasMaterialProperty helper

Definition at line 293 of file MaterialPropertyInterface.h.

  {
    if constexpr (is_ad)
      return hasADMaterialProperty<T>(name);
    else
      return hasMaterialProperty<T>(name);
  }

hasGenericMaterialPropertyByName()

template<typename T , bool is_ad>

bool MaterialPropertyInterface::hasGenericMaterialPropertyByName ( const std::string &  name )

inlineinherited

Definition at line 301 of file MaterialPropertyInterface.h.

  {
    if constexpr (is_ad)
      return hasADMaterialPropertyByName<T>(name);
    else
      return hasMaterialPropertyByName<T>(name);
  }

hasMaterialProperty()

template<typename T >

bool MaterialPropertyInterface::hasMaterialProperty ( const std::string &  name )

inherited

Check if the material property exists.

Parameters

name	the name of the property to query

Returns

true if the property exists, otherwise false

Definition at line 677 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasMaterialPropertyByName<T>(prop_name);
}

hasMaterialPropertyByName()

template<typename T >

bool MaterialPropertyInterface::hasMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 686 of file MaterialPropertyInterface.h.

{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveProperty<T>(name);
}

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));
}

hasVectorPostprocessor() [1/2]

bool VectorPostprocessorInterface::hasVectorPostprocessor ( const std::string &  param_name, const std::string &  vector_name  ) const

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The vector name within the VectorPostprocessor

Returns

True if the VectorPostprocessor data exists

See also

hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 138 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

{
  if (!vectorPostprocessorsAdded())
    _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessor() until all VectorPostprocessors "
                              "have been constructed.");

  return hasVectorPostprocessorByName(getVectorPostprocessorName(param_name), vector_name);
}

hasVectorPostprocessor() [2/2]

bool VectorPostprocessorInterface::hasVectorPostprocessor ( const std::string &  param_name ) const

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns

True if the VectorPostprocessor exists

Definition at line 168 of file VectorPostprocessorInterface.C.

{
  if (!vectorPostprocessorsAdded())
    _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessor() until all "
                              "VectorPostprocessors have been constructed.");

  return hasVectorPostprocessorByName(getVectorPostprocessorName(param_name));
}

hasVectorPostprocessorByName() [1/2]

bool VectorPostprocessorInterface::hasVectorPostprocessorByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  ) const

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

name	The name of the VectorPostprocessor
vector_name	The vector name within the VectorPostprocessor

Returns

True if the VectorPostprocessor data exists

See also

hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 149 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::hasVectorPostprocessor(), AdvancedOutput::initShowHideLists(), CSV::output(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName().

{
  if (!vectorPostprocessorsAdded())
    _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                              "VectorPostprocessors have been constructed.");

  const bool has_vpp = _vpi_feproblem.getReporterData().hasReporterValue<VectorPostprocessorValue>(
      VectorPostprocessorReporterName(name, vector_name));

  if (has_vpp)
    mooseAssert(_vpi_feproblem.hasUserObject(name) && dynamic_cast<const VectorPostprocessor *>(
                                                          &_vpi_feproblem.getUserObjectBase(name)),
                "Has reporter VectorPostprocessor Reporter value but not VectorPostprocessor UO");

  return has_vpp;
}

hasVectorPostprocessorByName() [2/2]

bool VectorPostprocessorInterface::hasVectorPostprocessorByName ( const VectorPostprocessorName &  name ) const

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns

True if the VectorPostprocessor exists

Definition at line 178 of file VectorPostprocessorInterface.C.

{
  if (!vectorPostprocessorsAdded())
    _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                              "VectorPostprocessors have been constructed.");

  return _vpi_feproblem.hasUserObject(name) &&
         dynamic_cast<const VectorPostprocessor *>(&_vpi_feproblem.getUserObjectBase(name));
}

hasWritableCoupledVariables()

bool Coupleable::hasWritableCoupledVariables ( ) const

inlineinherited

Checks whether the object has any writable coupled variables.

Definition at line 128 of file Coupleable.h.

{ return !getWritableCoupledVariables().empty(); }

initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject *  moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 74 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

{
  // If the mesh pointer is not defined, but FEProblemBase is, get it from there
  if (_blk_feproblem != NULL && _blk_mesh == NULL)
    _blk_mesh = &_blk_feproblem->mesh();

  // Check that the mesh pointer was defined, it is required for this class to operate
  if (_blk_mesh == NULL)
    mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
               "pointer to the MooseMesh via '_mesh'");

  // Populate the MaterialData pointer
  if (_blk_feproblem != NULL)
    _blk_material_data = &_blk_feproblem->getMaterialData(Moose::BLOCK_MATERIAL_DATA, _blk_tid);

  // The 'block' input is defined
  if (moose_object->isParamValid("block"))
  {
    // Extract the blocks from the input
    _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");

    // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
    if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
      _blk_ids.insert(Moose::ANY_BLOCK_ID);
    else
    {
      // Get the IDs from the supplied names
      _vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
      _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
    }
  }

  // When 'blocks' is not set and there is a "variable", use the blocks from the variable
  else if (moose_object->isParamValid("variable"))
  {
    std::string variable_name = moose_object->parameters().getMooseType("variable");
    if (!variable_name.empty())
      _blk_ids = _blk_feproblem
                     ->getVariable(_blk_tid,
                                   variable_name,
                                   Moose::VarKindType::VAR_ANY,
                                   Moose::VarFieldType::VAR_FIELD_ANY)
                     .activeSubdomains();
  }

  // Produce error if the object is not allowed to be both block and boundary restricted
  if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
    if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
      moose_object->paramError("block",
                               "Attempted to restrict the object '",
                               _blk_name,
                               "' to a block, but the object is already restricted by boundary");

  // If no blocks were defined above, specify that it is valid on all blocks
  if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
  {
    _blk_ids.insert(Moose::ANY_BLOCK_ID);
    _blocks = {"ANY_BLOCK_ID"};
  }

  // If this object is block restricted, check that defined blocks exist on the mesh
  if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
  {
    const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
    std::vector<SubdomainID> diff;

    std::set_difference(_blk_ids.begin(),
                        _blk_ids.end(),
                        valid_ids.begin(),
                        valid_ids.end(),
                        std::back_inserter(diff));

    if (!diff.empty())
    {
      std::ostringstream msg;
      auto sep = " ";
      msg << "the following blocks (ids) do not exist on the mesh:";
      for (const auto & id : diff)
      {
        if (_blk_name.size() > 0)
        {
          auto & name =
              _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
          if (std::to_string(id) != name)
            msg << sep << name << " (" << id << ")";
          else
            msg << sep << id;
        }
        else
          msg << sep << id;
        sep = ", ";
      }
      std::vector<SubdomainID> valid_ids_vec(valid_ids.begin(), valid_ids.end());
      auto valid_names = _blk_mesh->getSubdomainNames(valid_ids_vec);
      msg << "\nBlocks names (resp. ids) that do exist: " << Moose::stringify(valid_names) << " ("
          << Moose::stringify(valid_ids) << ")";
      moose_object->paramError("block", msg.str());
    }
  }

  // Get the mesh dimension for the blocks
  if (blockRestricted())
    _blk_dim = _blk_mesh->getBlocksMaxDimension(_blocks);
  else
    _blk_dim = _blk_mesh->dimension();
}

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, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, NEML2ModelExecutor, MultiAppTransfer, Convergence, 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().

{
}

insert()

void AuxKernelTempl< Real >::insert ( )

inherited

Insert the just computed values into the auxiliary solution vector.

Definition at line 287 of file AuxKernel.C.

{
  if (_coincident_lower_d_calc)
    _var.insertLower(_aux_sys.solution());
  else
    _var.insert(_aux_sys.solution());
}

isBlockSubset() [1/2]

bool BlockRestrictable::isBlockSubset ( const std::set< SubdomainID > &  ids ) const

inherited

Test if the class block ids are a subset of the supplied objects.

Parameters

ids	A std::set of Subdomains to check

Returns

True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)

See also

hasBlocks

Definition at line 256 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), BlockRestrictable::isBlockSubset(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), and ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux().

{
  // An empty input is assumed to be ANY_BLOCK_ID
  if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
    return true;

  if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
    return std::includes(ids.begin(),
                         ids.end(),
                         _blk_mesh->meshSubdomains().begin(),
                         _blk_mesh->meshSubdomains().end());
  else
    return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
}

isBlockSubset() [2/2]

bool BlockRestrictable::isBlockSubset ( const std::vector< SubdomainID > &  ids ) const

inherited

Test if the class block ids are a subset of the supplied objects.

Parameters

ids	A std::vector of Subdomains to check

Returns

True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)

See also

hasBlocks

Definition at line 272 of file BlockRestrictable.C.

{
  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
  return isBlockSubset(ids_set);
}

isBoundarySubset() [1/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::set< BoundaryID > &  ids ) const

inherited

Test if the class boundary ids are a subset of the supplied objects.

Parameters

ids	A std::set of boundaries to check

Returns

True if all of the boundary ids for this class are found within the given ids (opposite of hasBoundary)

See also

hasBoundary

Definition at line 272 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::isBoundarySubset().

{
  // An empty input is assumed to be ANY_BOUNDARY_ID
  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
    return true;

  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
    return std::includes(ids.begin(),
                         ids.end(),
                         _bnd_mesh->meshBoundaryIds().begin(),
                         _bnd_mesh->meshBoundaryIds().end());
  else
    return std::includes(ids.begin(), ids.end(), _bnd_ids.begin(), _bnd_ids.end());
}

isBoundarySubset() [2/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::vector< BoundaryID > &  ids ) const

inherited

Definition at line 288 of file BoundaryRestrictable.C.

{
  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
  return isBoundarySubset(ids_set);
}

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));
}

isFunctor() [1/2]

bool FunctorInterface::isFunctor ( const std::string &  name ) const

protectedinherited

Checks the subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file

Returns

Whether the subproblem has the specified functor

Definition at line 113 of file FunctorInterface.C.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return isFunctor(name, *_fi_subproblem);
}

isFunctor() [2/2]

bool FunctorInterface::isFunctor ( const std::string &  name, const SubProblem &  subproblem  ) const

protectedinherited

Checks the passed-in subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

Whether the subproblem has the specified functor

Definition at line 104 of file FunctorInterface.C.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);

  return subproblem.hasFunctor(functor_name, _fi_tid);
}

isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 38 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

{ return _is_implicit; }

isMortar()

bool AuxKernelTempl< Real >::isMortar ( )

inherited

Returns

whether this is a mortar auxiliary kernel

Definition at line 485 of file AuxKernel.C.

{
  return dynamic_cast<MortarNodalAuxKernelTempl<ComputeValueType> *>(this) != nullptr;
}

isNodal()

bool AuxKernelTempl< Real >::isNodal ( ) const

inlineinherited

Nodal or elemental kernel?

Returns

true if this is a nodal kernel, otherwise false

Definition at line 86 of file AuxKernel.h.

Referenced by ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), ProcessorIDAux::computeValue(), AdvectiveFluxAux::computeValue(), FunctorAux::computeValue(), ParsedAux::computeValue(), HardwareIDAux::computeValue(), MeshDivisionAux::computeValue(), NearestNodeValueAux::computeValue(), ProjectionAux::computeValue(), FunctionAux::computeValue(), SpatialUserObjectAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SolutionAux::computeValue(), ContainsPointAux::ContainsPointAux(), ElementIntegerAux::ElementIntegerAux(), ElementLengthAux::ElementLengthAux(), ElementQualityAux::ElementQualityAux(), ElementUOAux::ElementUOAux(), ExtraElementIDAux::ExtraElementIDAux(), ForcingFunctionAux::ForcingFunctionAux(), FunctorVectorElementalAuxTempl< is_ad >::FunctorVectorElementalAuxTempl(), VariableOldValueBounds::getBound(), BoundsBase::getDoFIndex(), GhostingFromUOAux::GhostingFromUOAux(), InterfaceValueUserObjectAux::InterfaceValueUserObjectAux(), NodalPatchRecovery::NodalPatchRecovery(), NodalPatchRecoveryAuxBase::NodalPatchRecoveryAuxBase(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), and TimeDerivativeAux::TimeDerivativeAux().

{ return _nodal; }

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

{ return _pars.isParamSetByUser(nm); }

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.

Referenced by HierarchicalGridPartitioner::_do_partition(), GridPartitioner::_do_partition(), CopyNodalVarsAction::act(), SetupMeshAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), AddVariableAction::act(), CommonOutputAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AddPeriodicBCAction::AddPeriodicBCAction(), DiffusionPhysicsBase::addPostprocessors(), AdvectiveFluxAux::AdvectiveFluxAux(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayVarReductionAux::ArrayVarReductionAux(), AddPeriodicBCAction::autoTranslationBoundaries(), BicubicSplineFunction::BicubicSplineFunction(), BlockDeletionGenerator::BlockDeletionGenerator(), TimedSubdomainModifier::buildFromFile(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromJSON(), ParsedChainControl::buildFunction(), GeneratedMesh::buildMesh(), MooseMesh::buildTypedMesh(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), SampledOutput::cloneMesh(), CombinerGenerator::CombinerGenerator(), FunctorAux::computeValue(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), CopyMeshPartitioner::CopyMeshPartitioner(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), CutMeshByLevelSetGeneratorBase::CutMeshByLevelSetGeneratorBase(), ConstantReporter::declareConstantReporterValues(), DGKernelBase::DGKernelBase(), DiffusionFluxAux::DiffusionFluxAux(), DomainUserObject::DomainUserObject(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), Eigenvalue::Eigenvalue(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), PIDTransientControl::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), Exodus::Exodus(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FileOutput::FileOutput(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), FunctionDT::FunctionDT(), FunctionValuePostprocessor::FunctionValuePostprocessor(), FVInterfaceKernel::FVInterfaceKernel(), FVMassMatrix::FVMassMatrix(), AddMetaDataGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), SubdomainPerElementGenerator::generate(), BlockDeletionGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), MeshExtruderGenerator::generate(), ParsedExtraElementIDGenerator::generate(), XYZDelaunayGenerator::generate(), XYDelaunayGenerator::generate(), XYMeshLineCutter::generate(), SubdomainBoundingBoxGenerator::generate(), DistributedRectilinearMeshGenerator::generate(), PropertyReadFile::getFileNames(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBaseParameterInterface::getRenamedParam(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), Terminator::handleMessage(), HFEMDirichletBC::HFEMDirichletBC(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), Eigenvalue::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), MultiAppCloneReporterTransfer::initialSetup(), SolutionIC::initialSetup(), MultiAppVariableValueSampleTransfer::initialSetup(), PiecewiseTabularBase::initialSetup(), ParsedConvergence::initialSetup(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), Console::initialSetup(), MooseParsedVectorFunction::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), SampledOutput::initSample(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MassMatrix::MassMatrix(), MatCoupledForce::MatCoupledForce(), MatDiffusionBase< Real >::MatDiffusionBase(), MeshGeneratorComponent::MeshGeneratorComponent(), MooseMesh::MooseMesh(), MoosePreconditioner::MoosePreconditioner(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MooseVariableFV< Real >::MooseVariableFV(), MortarConstraintBase::MortarConstraintBase(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppCloneReporterTransfer::MultiAppCloneReporterTransfer(), MultiAppGeneralFieldNearestLocationTransfer::MultiAppGeneralFieldNearestLocationTransfer(), MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiSystemSolveObject::MultiSystemSolveObject(), NodeSetsGeneratorBase::NodeSetsGeneratorBase(), EigenExecutionerBase::normalizeSolution(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ParsedCurveGenerator::ParsedCurveGenerator(), PetscOutput::PetscOutput(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PIDTransientControl::PIDTransientControl(), PiecewiseTabularBase::PiecewiseTabularBase(), PlaneIDMeshGenerator::PlaneIDMeshGenerator(), MooseMesh::prepare(), MooseBaseParameterInterface::queryParam(), MultiApp::readCommandLineArguments(), SolutionUserObjectBase::readExodusII(), ReferenceResidualInterface::ReferenceResidualInterface(), RenameBlockGenerator::RenameBlockGenerator(), ReporterPointSource::ReporterPointSource(), PhysicsBase::reportPotentiallyMissedParameters(), ParsedSubdomainMeshGenerator::setBlockName(), MooseMesh::setCoordSystem(), FileOutput::setFileBase(), FileOutput::setFileBaseInternal(), Split::setup(), SideSetsGeneratorBase::setup(), SetupMeshAction::setupMesh(), SideDiffusiveFluxIntegralTempl< is_ad, Real >::SideDiffusiveFluxIntegralTempl(), SideSetsGeneratorBase::SideSetsGeneratorBase(), SolutionUserObjectBase::SolutionUserObjectBase(), FEProblemSolve::solve(), WebServerControl::startServer(), Terminator::Terminator(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), MultiAppDofCopyTransfer::transfer(), TransformGenerator::TransformGenerator(), FunctorIC::value(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), WebServerControl::WebServerControl(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

{ return _pars.isParamValid(name); }

isVectorPostprocessorDistributed()

bool VectorPostprocessorInterface::isVectorPostprocessorDistributed ( const std::string &  param_name ) const

inherited

Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED.

Definition at line 190 of file VectorPostprocessorInterface.C.

{
  return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
}

isVectorPostprocessorDistributedByName()

bool VectorPostprocessorInterface::isVectorPostprocessorDistributedByName ( const VectorPostprocessorName &  name ) const

inherited

Definition at line 196 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

{
  return _vpi_feproblem.getVectorPostprocessorObjectByName(name).isDistributed();
}

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

{
}

makeElemArg()

Moose::ElemArg FunctorInterface::makeElemArg ( const Elem *  elem, bool  correct_skewnewss = false  ) const

protectedinherited

Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.

Definition at line 120 of file FunctorInterface.C.

Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVReaction::computeMatrixContribution(), LinearFVTimeDerivative::computeMatrixContribution(), FVFunctorTimeKernel::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), LinearFVSource::computeRightHandSideContribution(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), FunctorTimes::initialize(), and LinearFVTimeDerivative::setCurrentElemInfo().

{
  return {elem, correct_skewness};
}

markMatPropRequested()

void MaterialPropertyInterface::markMatPropRequested ( const std::string &  name )

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 139 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName().

{
  _mi_feproblem.markMatPropRequested(name);
}

maxElementID()

dof_id_type ElementIDInterface::maxElementID ( unsigned int  elem_id_index ) const

inlineinherited

Return the maximum element ID for an element integer with its index.

Definition at line 87 of file ElementIDInterface.h.

  {
    return _id_mesh->maxElementID(elem_id_index);
  }

meshBlockIDs()

const std::set< SubdomainID > & BlockRestrictable::meshBlockIDs ( ) const

inherited

Return all of the SubdomainIDs for the mesh.

Returns

A set of all subdomians for the entire mesh

Definition at line 279 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and SolutionIC::initialSetup().

{
  return _blk_mesh->meshSubdomains();
}

meshBoundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::meshBoundaryIDs ( ) const

inherited

Returns the set of all boundary ids for the entire mesh.

Returns

A const reference the the boundary ids for the entire mesh

Definition at line 295 of file BoundaryRestrictable.C.

Referenced by BoundaryRestrictable::hasBoundaryMaterialPropertyHelper().

{
  return _bnd_mesh->getBoundaryIDs();
}

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

{}

minElementID()

dof_id_type ElementIDInterface::minElementID ( unsigned int  elem_id_index ) const

inlineinherited

Return the minimum element ID for an element integer with its index.

Definition at line 95 of file ElementIDInterface.h.

  {
    return _id_mesh->minElementID(elem_id_index);
  }

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(), and UserForcingFunction::UserForcingFunction().

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

Referenced by CopyMeshPartitioner::_do_partition(), HierarchicalGridPartitioner::_do_partition(), GridPartitioner::_do_partition(), PetscExternalPartitioner::_do_partition(), MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), AddVectorPostprocessorAction::act(), AddICAction::act(), AutoCheckpointAction::act(), CheckFVBCAction::act(), CreateExecutionerAction::act(), AddBoundsVectorsAction::act(), InitProblemAction::act(), SetupMeshCompleteAction::act(), AddMeshGeneratorAction::act(), CheckIntegrityAction::act(), AddFVICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SplitMeshAction::act(), AdaptivityAction::act(), ChainControlSetupAction::act(), DeprecatedBlockAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), AddTimeStepperAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), MaterialOutputAction::act(), AddMFEMSubMeshAction::act(), CommonOutputAction::act(), AddPeriodicBCAction::act(), Action::Action(), FEProblemBase::adaptMesh(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), MooseVariableFV< Real >::adCurlSln(), MooseVariableFV< Real >::adCurlSlnNeighbor(), AddActionComponentAction::AddActionComponentAction(), MFEMProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DiffusionCG::addBoundaryConditionsFromComponents(), PhysicsComponentInterface::addBoundaryConditionsFromComponents(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), DistributedRectilinearMeshGenerator::addElement(), FEProblemBase::addFunction(), SubProblem::addFunctor(), FEProblemBase::addFVInitialCondition(), ADDGKernel::ADDGKernel(), FEProblemBase::addHDGKernel(), FEProblemBase::addInitialCondition(), PhysicsComponentInterface::addInitialConditionsFromComponents(), FEProblemBase::addInterfaceKernel(), MFEMProblem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), MFEMProblem::addMaterial(), MeshGenerator::addMeshSubgenerator(), MFEMProblem::addMFEMFESpaceFromMOOSEVariable(), FEProblemBase::addOutput(), SubProblem::addPiecewiseByBlockLambdaFunctor(), DiracKernelBase::addPoint(), DistributedRectilinearMeshGenerator::addPoint(), DiracKernelBase::addPointWithValidId(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), MooseMesh::addQuadratureNode(), Action::addRelationshipManager(), FEProblemBase::addReporter(), FEProblemBase::addScalarKernel(), AddVariableAction::addVariable(), FEProblemBase::addVectorPostprocessor(), SubProblem::addVectorTag(), MooseLinearVariableFV< Real >::adError(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), MooseVariableScalar::adUDot(), Output::advancedExecuteOn(), AdvectiveFluxAux::AdvectiveFluxAux(), MooseVariableBase::allDofIndices(), NEML2ModelExecutor::applyPredictor(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayConstantIC::ArrayConstantIC(), ArrayDGKernel::ArrayDGKernel(), ArrayDiffusion::ArrayDiffusion(), ArrayFunctionIC::ArrayFunctionIC(), ArrayReaction::ArrayReaction(), ArrayTimeDerivative::ArrayTimeDerivative(), AddPeriodicBCAction::autoTranslationBoundaries(), AuxKernelTempl< Real >::AuxKernelTempl(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), BicubicSplineFunction::BicubicSplineFunction(), BlockDeletionGenerator::BlockDeletionGenerator(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), MultiApp::buildComm(), DistributedRectilinearMeshGenerator::buildCube(), TimedSubdomainModifier::buildFromFile(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromJSON(), TimedSubdomainModifier::buildFromParameters(), PiecewiseTabularBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), MooseMesh::buildLowerDMesh(), TiledMesh::buildMesh(), GeneratedMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), ImageMeshGenerator::buildMesh3D(), ImageMesh::buildMesh3D(), MooseMesh::buildRefinementMap(), MaterialBase::buildRequiredMaterials(), MooseMesh::buildSideList(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), PhysicsBase::checkBlockRestrictionIdentical(), ComponentBoundaryConditionInterface::checkBoundaryConditionsAllRequested(), SubProblem::checkBoundaryMatProps(), PhysicsBase::checkComponentType(), IterationCountConvergence::checkConvergence(), MooseMesh::checkCoordinateSystems(), DiffusionLHDGAssemblyHelper::checkCoupling(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), FEProblemBase::checkDuplicatePostprocessorVariableNames(), DefaultConvergenceBase::checkDuplicateSetSharedExecutionerParams(), MooseMesh::checkDuplicateSubdomainNames(), FEProblemBase::checkExceptionAndStopSolve(), NEML2ModelExecutor::checkExecutionStage(), MaterialBase::checkExecutionStage(), MeshGenerator::checkGetMesh(), ReporterTransferInterface::checkHasReporterValue(), FEProblemBase::checkICRestartError(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), Eigenvalue::checkIntegrity(), ExplicitTimeIntegrator::checkLinearConvergence(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), PostprocessorInterface::checkParam(), FEProblemBase::checkProblemIntegrity(), Sampler::checkReinitStatus(), MultiAppGeneralFieldNearestLocationTransfer::checkRestrictionsForSource(), MultiAppPostprocessorToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppScalarToAuxScalarTransfer::checkSiblingsTransferSupported(), MultiAppPostprocessorTransfer::checkSiblingsTransferSupported(), MultiAppReporterTransfer::checkSiblingsTransferSupported(), MultiAppMFEMCopyTransfer::checkSiblingsTransferSupported(), MultiAppCopyTransfer::checkSiblingsTransferSupported(), MultiAppTransfer::checkSiblingsTransferSupported(), MaterialBase::checkStatefulSanity(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), FEProblemBase::checkUserObjects(), Moose::PetscSupport::checkUserProvidedPetscOption(), DomainUserObject::checkVariable(), MultiAppTransfer::checkVariable(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), LibmeshPartitioner::clone(), MooseMesh::clone(), CombinerGenerator::CombinerGenerator(), ComparisonPostprocessor::comparisonIsTrue(), MooseVariableFieldBase::componentName(), CompositeFunction::CompositeFunction(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), FEProblemBase::computeBounds(), VariableCondensationPreconditioner::computeDInverseDiag(), CompositionDT::computeDT(), ArrayDGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighResidual(), InternalSideIntegralPostprocessor::computeFaceInfoIntegral(), SideIntegralPostprocessor::computeFaceInfoIntegral(), MooseVariableFieldBase::computeFaceValues(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), MooseMesh::computeFiniteVolumeCoords(), HistogramVectorPostprocessor::computeHistogram(), ArrayKernel::computeJacobian(), ArrayIntegratedBC::computeJacobian(), FVFluxKernel::computeJacobian(), NodalConstraint::computeJacobian(), FEProblemBase::computeJacobianTags(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), EigenProblem::computeMatricesTags(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), ArrayKernel::computeOffDiagJacobian(), ArrayIntegratedBC::computeOffDiagJacobian(), FVElementalKernel::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), DGLowerDKernel::computeOffDiagLowerDJacobian(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), MaterialBase::computeProperties(), SideFVFluxBCIntegral::computeQpIntegral(), ScalarKernel::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), NodalEqualValueConstraint::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), NodeElemConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), ScalarKernel::computeQpResidual(), MassMatrix::computeQpResidual(), HDGKernel::computeQpResidual(), DiffusionLHDGDirichletBC::computeQpResidual(), NodalEqualValueConstraint::computeQpResidual(), DiffusionLHDGPrescribedGradientBC::computeQpResidual(), IPHDGBC::computeQpResidual(), KernelValue::computeQpResidual(), TorchScriptMaterial::computeQpValues(), InterfaceQpValueUserObject::computeRealValue(), ArrayKernel::computeResidual(), ArrayIntegratedBC::computeResidual(), FVFluxBC::computeResidual(), FVFluxKernel::computeResidual(), NodalConstraint::computeResidual(), FVFluxKernel::computeResidualAndJacobian(), ResidualObject::computeResidualAndJacobian(), FEProblemBase::computeResidualAndJacobian(), HDGKernel::computeResidualAndJacobianOnSide(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualTags(), FEProblemBase::computeResidualType(), KernelScalarBase::computeScalarOffDiagJacobian(), ADKernelScalarBase::computeScalarQpResidual(), ADMortarScalarBase::computeScalarQpResidual(), MortarScalarBase::computeScalarQpResidual(), KernelScalarBase::computeScalarQpResidual(), TimeStepper::computeStep(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), ActuallyExplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CentralDifference::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), MultiAppGeometricInterpolationTransfer::computeTransformation(), BuildArrayVariableAux::computeValue(), TagVectorArrayVariableAux::computeValue(), NearestNodeValueAux::computeValue(), ProjectionAux::computeValue(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), ConditionalEnableControl::ConditionalEnableControl(), TimeStepper::constrainStep(), LibtorchNeuralNetControl::controlNeuralNet(), ParsedConvergence::convertRealToBool(), CopyMeshPartitioner::CopyMeshPartitioner(), CoupledForceNodalKernel::CoupledForceNodalKernel(), MultiApp::createApp(), AddVariableAction::createInitialConditionAction(), Function::curl(), MooseVariableFV< Real >::curlPhi(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), SidesetInfoVectorPostprocessor::dataHelper(), DebugResidualAux::DebugResidualAux(), ReporterTransferInterface::declareClone(), MeshGenerator::declareMeshProperty(), ReporterTransferInterface::declareVectorClone(), FunctorRelationshipManager::delete_remote_elements(), MooseMesh::deleteRemoteElements(), BicubicSplineFunction::derivative(), DerivativeSumMaterialTempl< is_ad >::DerivativeSumMaterialTempl(), MooseMesh::detectPairedSidesets(), FEProblemBase::determineSolverSystem(), DGKernel::DGKernel(), MeshDiagnosticsGenerator::diagnosticsLog(), DistributedPositions::DistributedPositions(), Function::div(), FunctorBinnedValuesDivision::divisionIndex(), MooseVariableFV< Real >::divPhi(), FunctorRelationshipManager::dofmap_reinit(), EigenProblem::doFreeNonlinearPowerIterations(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementIntegerAux::ElementIntegerAux(), ElementMaterialSampler::ElementMaterialSampler(), ElementQualityAux::ElementQualityAux(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), ElementUOAux::ElementUOAux(), ExtraIDIntegralVectorPostprocessor::elementValue(), DistributedRectilinearMeshGenerator::elemId(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), EigenKernel::enabled(), MooseMesh::errorIfDistributedMesh(), MultiAppTransfer::errorIfObjectExecutesOnTransferInSourceApp(), SideIntegralPostprocessor::errorNoFaceInfo(), SideIntegralFunctorPostprocessorTempl< false >::errorNoFaceInfo(), SolutionUserObjectBase::evalMeshFunction(), SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), FixedPointSolve::examineFixedPointConvergence(), MultiAppGeneralFieldTransfer::examineReceivedValueConflicts(), RealToBoolChainControl::execute(), RestartableDataReporter::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), NodalValueSampler::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppPostprocessorTransfer::execute(), ElementQualityChecker::execute(), PositionsFunctorValueSampler::execute(), GreaterThanLessThanPostprocessor::execute(), PointValue::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppMFEMCopyTransfer::execute(), MultiAppCopyTransfer::execute(), WebServerControl::execute(), InterfaceQpUserObjectBase::execute(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), LeastSquaresFit::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFitHistory::execute(), TimeExtremeValue::execute(), Eigenvalue::execute(), DomainUserObject::execute(), FEProblemBase::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus::Exodus(), ExplicitSSPRungeKutta::ExplicitSSPRungeKutta(), MultiAppGeneralFieldTransfer::extractOutgoingPoints(), NEML2ModelExecutor::extractOutputs(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemSolve::FEProblemSolve(), FileOutput::FileOutput(), NEML2ModelExecutor::fillInputs(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), NearestPointAverage::finalize(), NearestPointIntegralVariablePostprocessor::finalize(), Transfer::find_sys(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), FVMassMatrix::FVMassMatrix(), FVMatAdvection::FVMatAdvection(), FVScalarLagrangeMultiplierInterface::FVScalarLagrangeMultiplierInterface(), GapValueAux::GapValueAux(), WorkBalance::gather(), ElementOrderConversionGenerator::generate(), BlockToMeshConverterGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MoveNodeGenerator::generate(), PlaneIDMeshGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), SideSetsFromNormalsGenerator::generate(), SmoothMeshGenerator::generate(), SubdomainPerElementGenerator::generate(), TiledMeshGenerator::generate(), MeshDiagnosticsGenerator::generate(), BreakMeshByBlockGenerator::generate(), CoarsenBlockGenerator::generate(), FlipSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), MeshRepairGenerator::generate(), SideSetsFromPointsGenerator::generate(), CombinerGenerator::generate(), AllSideSetsByNormalsGenerator::generate(), MeshExtruderGenerator::generate(), AdvancedExtruderGenerator::generate(), MeshCollectionGenerator::generate(), ParsedGenerateNodeset::generate(), SideSetsFromBoundingBoxGenerator::generate(), StackGenerator::generate(), StitchedMeshGenerator::generate(), XYZDelaunayGenerator::generate(), CutMeshByLevelSetGeneratorBase::generate(), SpiralAnnularMeshGenerator::generate(), XYDelaunayGenerator::generate(), XYMeshLineCutter::generate(), PatternedMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), DistributedRectilinearMeshGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), MeshGenerator::generateData(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), MeshGenerator::generateInternal(), CircularBoundaryCorrectionGenerator::generateRadialCorrectionFactor(), RandomICBase::generateRandom(), GenericConstantMaterialTempl< is_ad >::GenericConstantMaterialTempl(), GenericConstantVectorMaterialTempl< is_ad >::GenericConstantVectorMaterialTempl(), GenericFunctionMaterialTempl< is_ad >::GenericFunctionMaterialTempl(), GenericFunctionVectorMaterialTempl< is_ad >::GenericFunctionVectorMaterialTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), DisplacedProblem::getActualFieldVariable(), FEProblemBase::getActualFieldVariable(), DisplacedProblem::getArrayVariable(), FEProblemBase::getArrayVariable(), MooseMesh::getAxisymmetricRadialCoord(), MFEMFESpace::getBasis(), NEML2BatchIndexGenerator::getBatchIndex(), MooseMesh::getBlockConnectedBlocks(), VariableOldValueBounds::getBound(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), ChainControl::getChainControlDataByName(), MooseMesh::getCoarseningMap(), MultiApp::getCommandLineArgs(), MooseVariableBase::getContinuity(), Control::getControllableParameterByName(), FEProblemBase::getConvergence(), MooseMesh::getCoordSystem(), PhysicsBase::getCoupledPhysics(), PropertyReadFile::getData(), DataFileInterface::getDataFilePath(), TransfiniteMeshGenerator::getDiscreteEdge(), FEProblemBase::getDistribution(), MooseVariableBase::getDofIndices(), VariableCondensationPreconditioner::getDofToCondense(), TransfiniteMeshGenerator::getEdge(), GhostingUserObject::getElementalValue(), ElementUOProvider::getElementalValueLong(), ElementUOProvider::getElementalValueReal(), PropertyReadFile::getElementData(), MooseMesh::getElementIDIndex(), Material::getElementIDNeighbor(), Material::getElementIDNeighborByName(), MooseMesh::getElemIDMapping(), MooseMesh::getElemIDsOnBlocks(), MultiAppFieldTransfer::getEquationSystem(), MultiApp::getExecutioner(), MFEMVectorFESpace::getFECName(), MultiAppTransfer::getFromMultiApp(), MultiAppTransfer::getFromMultiAppInfo(), FEProblemBase::getFunction(), SubProblem::getFunctor(), FEProblemBase::getFVMatsAndDependencies(), MooseMesh::getGeneralAxisymmetricCoordAxis(), DistributedRectilinearMeshGenerator::getGhostNeighbors(), DistributedRectilinearMeshGenerator::getIndices(), FEProblemBase::getLinearConvergenceNames(), SolutionUserObjectBase::getLocalVarIndex(), Material::getMaterialByName(), FEProblemBase::getMaterialData(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMeshDivision(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), AnnularMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MultiAppTransfer::getMultiApp(), FEProblemBase::getMultiAppFixedPointConvergenceName(), DistributedRectilinearMeshGenerator::getNeighbors(), Times::getNextTime(), MooseMesh::getNodeBlockIds(), PropertyReadFile::getNodeData(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearConvergenceNames(), EigenProblem::getNonlinearEigenSystem(), FEProblemBase::getNonlinearSystem(), NEML2ModelExecutor::getOutput(), NEML2ModelExecutor::getOutputDerivative(), NEML2ModelExecutor::getOutputParameterDerivative(), MooseMesh::getPairedBoundaryMapping(), MaterialOutputAction::getParams(), ImageMeshGenerator::GetPixelInfo(), ImageMesh::GetPixelInfo(), PlaneIDMeshGenerator::getPlaneID(), Positions::getPosition(), Positions::getPositions(), FEProblemBase::getPositionsObject(), Positions::getPositionsVector2D(), Positions::getPositionsVector3D(), Positions::getPositionsVector4D(), PostprocessorInterface::getPostprocessorValueByNameInternal(), Times::getPreviousTime(), ComponentMaterialPropertyInterface::getPropertyValue(), InterfaceQpUserObjectBase::getQpValue(), MooseMesh::getRefinementMap(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), FEProblemBase::getSampler(), WebServerControl::getScalarJSONValue(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), MooseObject::getSharedPtr(), InterfaceQpUserObjectBase::getSideAverageValue(), PhysicsBase::getSolverSystem(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), TimedSubdomainModifier::getSubdomainIDAndCheck(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), Times::getTimeAtIndex(), FEProblemBase::getTimeFromStateArg(), TransientBase::getTimeIntegratorNames(), Times::getTimes(), MultiAppTransfer::getToMultiApp(), MultiAppTransfer::getToMultiAppInfo(), MooseMesh::getUniqueCoordSystem(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectName(), NumRelationshipManagers::getValue(), VectorPostprocessorComponent::getValue(), Residual::getValue(), SideAverageValue::getValue(), JSONFileReader::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), JSONFileReader::getVector(), VectorPostprocessorInterface::getVectorPostprocessorName(), SubProblem::getVectorTag(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), GhostingFromUOAux::GhostingFromUOAux(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), Function::gradient(), FEProblemBase::handleException(), Terminator::handleMessage(), MooseVariableBase::hasDoFsOnNodes(), PostprocessorInterface::hasPostprocessor(), PostprocessorInterface::hasPostprocessorByName(), ReporterInterface::hasReporterValue(), ReporterInterface::hasReporterValueByName(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::hasVectorPostprocessorByName(), HDGKernel::HDGKernel(), TransientBase::incrementStepOrReject(), FixedPointIterationAdaptiveDT::init(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), ExplicitTimeIntegrator::init(), EigenExecutionerBase::init(), TransientBase::init(), FEProblem::init(), AddAuxVariableAction::init(), IterationAdaptiveDT::init(), Eigenvalue::init(), AddVariableAction::init(), MooseMesh::init(), Sampler::init(), FEProblemBase::init(), MultiApp::init(), FEProblemBase::initialAdaptMesh(), NestedDivision::initialize(), ReporterPositions::initialize(), DistributedPositions::initialize(), TransformedPositions::initialize(), ElementGroupCentroidPositions::initialize(), FunctorPositions::initialize(), ReporterTimes::initialize(), FunctorTimes::initialize(), ParsedDownSelectionPositions::initialize(), ParsedConvergence::initializeConstantSymbol(), PhysicsBase::initializePhysics(), SteffensenSolve::initialSetup(), MultiAppCloneReporterTransfer::initialSetup(), SolutionIC::initialSetup(), PiecewiseLinearBase::initialSetup(), ChainControlDataPostprocessor::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), FullSolveMultiApp::initialSetup(), PiecewiseLinear::initialSetup(), CoarsenedPiecewiseLinear::initialSetup(), LinearFVDiffusion::initialSetup(), LinearFVAnisotropicDiffusion::initialSetup(), MultiAppDofCopyTransfer::initialSetup(), SolutionScalarAux::initialSetup(), LinearFVAdvection::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), SolutionAux::initialSetup(), ExplicitTimeIntegrator::initialSetup(), ReferenceResidualConvergence::initialSetup(), NodalVariableValue::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), Exodus::initialSetup(), CSV::initialSetup(), MooseParsedFunction::initialSetup(), SolutionUserObjectBase::initialSetup(), FEProblemBase::initialSetup(), SubProblem::initialSetup(), AdvancedOutput::initOutputList(), MFEMProblem::initProblemOperator(), AdvancedOutput::initShowHideLists(), Function::integral(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceTimeKernel::InterfaceTimeKernel(), InternalSideIndicatorBase::InternalSideIndicatorBase(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), Sampler::isAdaptiveSamplingCompleted(), MooseMesh::isBoundaryFullyExternalToSubdomains(), MooseVariableBase::isNodal(), IterationAdaptiveDT::IterationAdaptiveDT(), IterationCountConvergence::IterationCountConvergence(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), MultiAppGeneralFieldTransfer::locatePointReceivers(), LowerBoundNodalKernel::LowerBoundNodalKernel(), MooseLinearVariableFV< Real >::lowerDError(), PNGOutput::makePNG(), ReporterPointMarker::markerSetup(), SubProblem::markFamilyPRefinement(), MassMatrix::MassMatrix(), Material::Material(), MaterialRealTensorValueAuxTempl< is_ad >::MaterialRealTensorValueAuxTempl(), MaterialRealVectorValueAuxTempl< T, is_ad, is_functor >::MaterialRealVectorValueAuxTempl(), MaterialStdVectorRealGradientAux(), Distribution::median(), FunctorRelationshipManager::mesh_reinit(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshRepairGenerator::MeshRepairGenerator(), SetupMeshAction::modifyParamsForUseSplit(), MeshMetaDataInterface::mooseErrorInternal(), MooseLinearVariableFV< Real >::MooseLinearVariableFV(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), UserObjectInterface::mooseObjectError(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MooseVariableConstMonomial::MooseVariableConstMonomial(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), FEProblemBase::needsPreviousNewtonIteration(), NewmarkBeta::NewmarkBeta(), NodalConstraint::NodalConstraint(), MooseVariableFV< Real >::nodalDofIndex(), MooseVariableFV< Real >::nodalDofIndexNeighbor(), MooseLinearVariableFV< Real >::nodalError(), MooseVariableFV< Real >::nodalMatrixTagValue(), NodalPatchRecoveryBase::nodalPatchRecovery(), NodalPatchRecoveryAuxBase::NodalPatchRecoveryAuxBase(), NodalScalarKernel::NodalScalarKernel(), MooseVariableFV< Real >::nodalValueArray(), MooseVariableFV< Real >::nodalValueOldArray(), MooseVariableFV< Real >::nodalValueOlderArray(), NodalVariableValue::NodalVariableValue(), MooseVariableFV< Real >::nodalVectorTagValue(), DistributedRectilinearMeshGenerator::nodeId(), MooseVariableFV< Real >::numberOfDofsNeighbor(), NumDOFs::NumDOFs(), NumFailedTimeSteps::NumFailedTimeSteps(), DistributedRectilinearMeshGenerator::numNeighbors(), NumNonlinearIterations::NumNonlinearIterations(), NumVars::NumVars(), Output::onInterval(), FunctorRelationshipManager::operator()(), RelationshipManager::operator==(), ActionComponent::outerSurfaceArea(), ActionComponent::outerSurfaceBoundaries(), XDA::output(), SolutionHistory::output(), Exodus::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputReporters(), AdvancedOutput::outputScalarVariables(), Exodus::outputSetup(), AdvancedOutput::outputSystemInformation(), Console::outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), DistributedRectilinearMeshGenerator::paritionSquarely(), PiecewiseBilinear::parse(), ParsedConvergence::ParsedConvergence(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedODEKernel::ParsedODEKernel(), MultiAppConservativeTransfer::performAdjustment(), ExplicitTimeIntegrator::performExplicitSolve(), PetscExternalPartitioner::PetscExternalPartitioner(), MooseVariableFV< Real >::phiLowerSize(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PIDTransientControl::PIDTransientControl(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), PiecewiseTabularBase::PiecewiseTabularBase(), CutMeshByLevelSetGeneratorBase::pointPairLevelSetInterception(), SolutionUserObjectBase::pointValueGradientWrapper(), SolutionUserObjectBase::pointValueWrapper(), ReporterInterface::possiblyCheckHasReporter(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), EigenProblem::postScaleEigenVector(), VariableCondensationPreconditioner::preallocateCondensedJacobian(), ADKernelValueTempl< T >::precomputeQpJacobian(), Predictor::Predictor(), TransientBase::preExecute(), MooseMesh::prepare(), MooseMesh::prepared(), FixedPointSolve::printFixedPointConvergenceReason(), PseudoTimestep::PseudoTimestep(), MultiApp::readCommandLineArguments(), PropertyReadFile::readData(), SolutionUserObjectBase::readExodusII(), SolutionUserObjectBase::readXda(), CoarsenBlockGenerator::recursiveCoarsen(), FunctorRelationshipManager::redistribute(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Sampler::reinit(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), PhysicsBase::reportPotentiallyMissedParameters(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), PiecewiseMultiInterpolation::sample(), ScalarComponentIC::ScalarComponentIC(), MortarScalarBase::scalarVariable(), DistributedRectilinearMeshGenerator::scaleNodalPositions(), BicubicSplineFunction::secondDerivative(), MooseVariableFV< Real >::secondPhi(), MooseVariableFV< Real >::secondPhiFace(), MooseVariableFV< Real >::secondPhiFaceNeighbor(), MooseVariableFV< Real >::secondPhiNeighbor(), FunctorRelationshipManager::set_mesh(), MooseVariableBase::setActiveTags(), DistributedRectilinearMeshGenerator::setBoundaryNames(), MooseMesh::setCoordSystem(), FEProblemBase::setCoupling(), PiecewiseBase::setData(), FileOutput::setFileBaseInternal(), MooseMesh::setGeneralAxisymmetricCoordAxes(), FEProblemSolve::setInnerSolve(), MeshGenerator::setMeshProperty(), FVPointValueConstraint::setMyElem(), FEProblemBase::setNonlocalCouplingMatrix(), Sampler::setNumberOfCols(), Sampler::setNumberOfRandomSeeds(), Sampler::setNumberOfRows(), Exodus::setOutputDimensionInExodusWriter(), AddPeriodicBCAction::setPeriodicVars(), MFEMSolverBase::setPreconditioner(), MultiAppGeneralFieldTransfer::setSolutionVectorValues(), Split::setup(), TransientMultiApp::setupApp(), SetupMeshAction::setupMesh(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), TimePeriodBase::setupTimes(), IntegratedBCBase::shouldApply(), PhysicsBase::shouldCreateIC(), PhysicsBase::shouldCreateTimeDerivative(), PhysicsBase::shouldCreateVariable(), SideAdvectiveFluxIntegralTempl< is_ad >::SideAdvectiveFluxIntegralTempl(), SideDiffusiveFluxIntegralTempl< is_ad, Real >::SideDiffusiveFluxIntegralTempl(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), SolutionUserObjectBase::SolutionUserObjectBase(), TimeIntegrator::solve(), FEProblemBase::solverSysNum(), FullSolveMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), UserObject::spatialPoints(), NearestPointAverage::spatialValue(), NearestPointIntegralVariablePostprocessor::spatialValue(), MeshDivisionFunctorReductionVectorPostprocessor::spatialValue(), UserObject::spatialValue(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), WebServerControl::startServer(), StitchedMesh::StitchedMesh(), WebServerControl::stringifyJSONType(), MultiAppGeometricInterpolationTransfer::subdomainIDsNode(), Constraint::subdomainSetup(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), MaterialBase::subdomainSetup(), FEProblemBase::swapBackMaterialsNeighbor(), DisplacedProblem::systemBaseLinear(), Console::systemInfoFlags(), FEProblemBase::systemNumForVariable(), TerminateChainControl::terminate(), Terminator::Terminator(), CutMeshByLevelSetGeneratorBase::tet4ElemCutter(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), Function::timeDerivative(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeExtremeValue::TimeExtremeValue(), Function::timeIntegral(), MooseLinearVariableFV< Real >::timeIntegratorError(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriodBase::TimePeriodBase(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppDofCopyTransfer::transfer(), MultiAppMFEMCopyTransfer::transfer(), MultiAppShapeEvaluationTransfer::transferVariable(), TransformedPositions::TransformedPositions(), FEProblemBase::trustUserCouplingMatrix(), MooseVariableScalar::uDot(), MooseVariableScalar::uDotDot(), MooseVariableScalar::uDotDotOld(), FEProblemBase::uDotDotOldRequested(), MooseVariableScalar::uDotOld(), FEProblemBase::uDotOldRequested(), Positions::unrollMultiDPositions(), ScalarKernelBase::uOld(), AuxScalarKernel::uOld(), Checkpoint::updateCheckpointFiles(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObjectBase::updateExodusBracketingTimeIndices(), FEProblemBase::updateMaxQps(), MFEMHypreAMS::updateSolver(), MFEMHypreADS::updateSolver(), MFEMCGSolver::updateSolver(), MFEMOperatorJacobiSmoother::updateSolver(), MFEMHypreBoomerAMG::updateSolver(), MFEMHypreFGMRES::updateSolver(), MFEMGMRESSolver::updateSolver(), MFEMHyprePCG::updateSolver(), MFEMHypreGMRES::updateSolver(), MFEMSuperLU::updateSolver(), UpperBoundNodalKernel::UpperBoundNodalKernel(), NearestPointAverage::userObjectValue(), NearestPointIntegralVariablePostprocessor::userObjectValue(), BoundingBoxIC::value(), PiecewiseConstantFromCSV::value(), IntegralPreservingFunctionIC::value(), Axisymmetric2D3DSolutionFunction::value(), Function::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), PhysicsBase::variableExists(), MultiAppTransfer::variableIntegrityCheck(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), AddVariableAction::variableType(), VariableValueVolumeHistogram::VariableValueVolumeHistogram(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), VectorNodalBC::VectorNodalBC(), SubProblem::vectorTagName(), SubProblem::vectorTagType(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), Function::vectorValue(), SubProblem::verifyVectorTags(), ActionComponent::volume(), VTKOutput::VTKOutput(), WebServerControl::WebServerControl(), DOFMapOutput::writeStreamToFile(), and Console::writeStreamToFile().

  {
    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(), 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(), and SymmetryTransformGenerator::SymmetryTransformGenerator().

  {
    moose::internal::mooseInfoStream(
        _console, _moose_base.errorPrefix("information"), std::forward<Args>(args)...);
  }

mooseLinearVariableFV()

MooseLinearVariableFV< Real > * MooseVariableInterface< Real >::mooseLinearVariableFV ( ) const

inherited

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 68 of file MooseVariableInterface.C.

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

mooseVariable()

MooseVariableFE< Real > * MooseVariableInterface< Real >::mooseVariable ( ) const

inherited

Return the MooseVariableFE object that this interface acts on.

Definition at line 78 of file MooseVariableInterface.C.

Referenced by ADDGKernel::ADDGKernel(), DGKernel::DGKernel(), IntegratedBC::IntegratedBC(), Kernel::Kernel(), and NodalBC::NodalBC().

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

mooseVariableBase()

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

inlineinherited

Get the variable that this object is using.

Returns

The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

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

{ return _var; };

mooseVariableField()

MooseVariableField< Real > & MooseVariableInterface< Real >::mooseVariableField ( )

inherited

Return the MooseVariableField object that this interface acts on.

Definition at line 354 of file MooseVariableInterface.C.

Referenced by ElementIndicator::ElementIndicator(), ElementIntegralVariablePostprocessor::ElementIntegralVariablePostprocessor(), ElementIntegralVariableUserObject::ElementIntegralVariableUserObject(), ElementVariablePostprocessor::ElementVariablePostprocessor(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InternalSideIntegralVariablePostprocessor::InternalSideIntegralVariablePostprocessor(), PointVariableSamplerBase::PointVariableSamplerBase(), QuadraturePointMarker::QuadraturePointMarker(), SideIntegralVariablePostprocessor::SideIntegralVariablePostprocessor(), SideIntegralVariableUserObject::SideIntegralVariableUserObject(), and SideVariablePostprocessor::SideVariablePostprocessor().

{
  return *_field_variable;
}

mooseVariableFV()

MooseVariableFV< Real > * MooseVariableInterface< Real >::mooseVariableFV ( ) const

inherited

Return the MooseVariableFV object that this interface acts on.

Definition at line 57 of file MooseVariableInterface.C.

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

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(), CylindricalGridDivision::initialize(), SphericalGridDivision::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.

Referenced by AddElementalFieldAction::act(), CopyNodalVarsAction::act(), AdaptivityAction::act(), AddTimeStepperAction::act(), DeprecatedBlockAction::act(), SetupTimeIntegratorAction::act(), AddActionComponentAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), FEProblemBase::addAnyRedistributers(), Executioner::addAttributeReporter(), MFEMProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), MFEMProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), PhysicsComponentInterface::addComponent(), FEProblemBase::addConstraint(), FEProblemBase::addConvergence(), FEProblemBase::addDamper(), Registry::addDataFilePath(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), MooseApp::addExecutor(), MooseApp::addExecutorParams(), MFEMProblem::addFESpace(), MFEMProblem::addFunction(), FEProblemBase::addFunction(), SubProblem::addFunctor(), MFEMProblem::addFunctorMaterial(), FEProblemBase::addFunctorMaterial(), FunctorMaterial::addFunctorProperty(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblemBase::addFVBC(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVInterfaceKernel(), FEProblemBase::addFVKernel(), ADDGKernel::ADDGKernel(), FEProblemBase::addHDGKernel(), FEProblemBase::addIndicator(), MFEMProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), MFEMProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addLinearFVBC(), FEProblemBase::addLinearFVKernel(), FEProblemBase::addMarker(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), ComponentMaterialPropertyInterface::addMaterials(), FEProblemBase::addMeshDivision(), MooseApp::addMeshGenerator(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), MFEMProblem::addMFEMPreconditioner(), MFEMProblem::addMFEMSolver(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObject(), ComponentPhysicsInterface::addPhysics(), SubProblem::addPiecewiseByBlockLambdaFunctor(), MFEMProblem::addPostprocessor(), FEProblemBase::addPostprocessor(), InitialConditionBase::addPostprocessorDependencyHelper(), UserObject::addPostprocessorDependencyHelper(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), MFEMProblem::addTransfer(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), InitialConditionBase::addUserObjectDependencyHelper(), UserObject::addUserObjectDependencyHelper(), AuxKernelTempl< Real >::addUserObjectDependencyHelper(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), UserObject::addVectorPostprocessorDependencyHelper(), Output::advancedExecuteOn(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MooseApp::appBinaryName(), MooseApp::appendMeshGenerator(), Registry::appNameFromAppPath(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayDGKernel::ArrayDGKernel(), PhysicsBase::assignBlocks(), AStableDirk4::AStableDirk4(), AuxKernelTempl< Real >::AuxKernelTempl(), Function::average(), MultiApp::backup(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), MFEMFESpace::buildFEC(), PiecewiseTabularBase::buildFromFile(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), MooseBase::callMooseError(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::checkComponentType(), DefaultNonlinearConvergence::checkConvergence(), ParsedConvergence::checkConvergence(), FEProblemBase::checkDependMaterialsHelper(), ReporterTransferInterface::checkHasReporterValue(), FEProblemBase::checkICRestartError(), Material::checkMaterialProperty(), MooseApp::checkMetaDataIntegrity(), Damper::checkMinDamping(), Checkpoint::checkpointInfo(), Coupleable::checkWritableVar(), CompositeFunction::CompositeFunction(), MaterialBase::computeProperties(), FEProblemBase::computeUserObjectByName(), VectorPostprocessorVisualizationAux::computeValue(), MooseBaseParameterInterface::connectControllableParams(), ConstantPostprocessor::ConstantPostprocessor(), CommonOutputAction::create(), MultiApp::createApp(), MooseApp::createExecutors(), MeshGeneratorSystem::createMeshGeneratorOrder(), MooseApp::createRecoverablePerfGraph(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), MaterialBase::declareADProperty(), MeshGenerator::declareMeshesForSubByName(), MeshGenerator::declareNullMeshName(), MaterialBase::declareProperty(), DOFMapOutput::demangle(), DerivativeSumMaterialTempl< is_ad >::DerivativeSumMaterialTempl(), Registry::determineDataFilePath(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DomainUserObject::DomainUserObject(), DumpObjectsProblem::dumpObjectHelper(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementMaterialSampler::ElementMaterialSampler(), ElementValueSampler::ElementValueSampler(), EigenKernel::enabled(), MooseMesh::errorIfDistributedMesh(), MooseBase::errorPrefix(), SolutionUserObjectBase::evalMeshFunction(), SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), RestartableDataReporter::execute(), PointValue::execute(), MultiAppNearestNodeTransfer::execute(), WebServerControl::execute(), MultiAppGeneralFieldTransfer::execute(), ActionWarehouse::executeActionsWithAction(), Exodus::Exodus(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), MultiApp::fillPositions(), PointSamplerBase::finalize(), ChainControl::fullControlDataName(), FunctionDT::FunctionDT(), FunctionIC::functionName(), FVFunctionIC::functionName(), FunctorPositions::FunctorPositions(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVOneVarDiffusionInterface::FVOneVarDiffusionInterface(), MooseServer::gatherDocumentSymbols(), BoundaryDeletionGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), BreakMeshByBlockGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), ParsedExtraElementIDGenerator::generate(), StitchedMeshGenerator::generate(), XYDelaunayGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MeshGenerator::generateInternal(), InterfaceMaterial::getADMaterialProperty(), Material::getADMaterialProperty(), MultiAppTransfer::getAppInfo(), MultiApp::getBoundingBox(), MooseApp::getCheckpointDirectories(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), FEProblemBase::getConvergence(), Registry::getDataFilePath(), UserObject::getDependObjects(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), ElementUOProvider::getElementalValueLong(), ElementUOProvider::getElementalValueReal(), MultiApp::getExecutioner(), MooseApp::getExecutor(), FEProblemBase::getExecutor(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SubProblem::getFunctor(), NodalPatchRecovery::getGenericMaterialProperty(), InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), AuxKernelTempl< Real >::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialPropertyByName(), Material::getGenericOptionalMaterialProperty(), MaterialBase::getGenericZeroMaterialProperty(), MFEMProblem::getGridFunction(), SolutionUserObjectBase::getLocalVarIndex(), Marker::getMarkerValue(), Material::getMaterial(), FEProblemBase::getMaterial(), Material::getMaterialByName(), NodalPatchRecovery::getMaterialProperty(), InterfaceMaterial::getMaterialProperty(), Material::getMaterialProperty(), AuxKernelTempl< Real >::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), NodalPatchRecovery::getMaterialPropertyOld(), InterfaceMaterial::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), AuxKernelTempl< Real >::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOlder(), InterfaceMaterial::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), AuxKernelTempl< Real >::getMaterialPropertyOlder(), MFEMGeneralUserObject::getMatrixCoefficient(), MeshGenerator::getMesh(), FEProblemBase::getMeshDivision(), MeshGenerator::getMeshesByName(), MooseApp::getMeshGenerator(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), ActionWarehouse::getMooseAppName(), MultiAppTransfer::getMultiApp(), InterfaceMaterial::getNeighborADMaterialProperty(), InterfaceMaterial::getNeighborMaterialProperty(), InterfaceMaterial::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), MooseServer::getObjectParameters(), Material::getOptionalADMaterialProperty(), Material::getOptionalMaterialProperty(), Material::getOptionalMaterialPropertyOld(), Material::getOptionalMaterialPropertyOlder(), OutputWarehouse::getOutput(), MooseApp::getParam(), FEProblemBase::getPositionsObject(), FEProblemBase::getPostprocessorValueByName(), ComponentMaterialPropertyInterface::getPropertyValue(), ReporterData::getReporterInfo(), MooseApp::getRestartableDataMap(), MooseApp::getRestartableDataMapName(), MooseApp::getRestartableMetaData(), FEProblemBase::getSampler(), MFEMGeneralUserObject::getScalarCoefficient(), TransientBase::getTimeStepperName(), ProjectedStatefulMaterialStorageAction::getTypeEnum(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), MFEMGeneralUserObject::getVectorCoefficient(), Terminator::handleMessage(), Control::hasControllableParameterByName(), FEProblemBase::hasConvergence(), FEProblemBase::hasFunction(), SubProblem::hasFunctor(), SubProblem::hasFunctorWithType(), MooseApp::hasMeshGenerator(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasPostprocessorValueByName(), MooseApp::hasRelationshipManager(), MooseApp::hasRestartableDataMap(), MooseApp::hasRestartableMetaData(), FEProblemBase::hasUserObject(), IterationAdaptiveDT::init(), AddVariableAction::init(), AdvancedOutput::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), NestedDivision::initialize(), TransformedPositions::initialize(), JSONOutput::initialSetup(), SideFVFluxBCIntegral::initialSetup(), SolutionScalarAux::initialSetup(), MultiAppProjectionTransfer::initialSetup(), NodalVariableValue::initialSetup(), Console::initialSetup(), SolutionUserObjectBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MeshGenerator::isChildMeshGenerator(), MeshGenerator::isNullMeshName(), MooseApp::isParamValid(), MeshGenerator::isParentMeshGenerator(), LinearCombinationFunction::LinearCombinationFunction(), FEProblemBase::logAdd(), Marker::Marker(), MaterialBase::markMatPropRequested(), MatDiffusionBase< Real >::MatDiffusionBase(), Material::Material(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshGenerator::meshPropertyPrefix(), MooseApp::MooseApp(), OutputWarehouse::mooseConsole(), MooseVariableInterface< Real >::MooseVariableInterface(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalPatchRecoveryAuxBase::NodalPatchRecoveryAuxBase(), NodalValueSampler::NodalValueSampler(), Registry::objData(), MeshGenerator::Comparator::operator()(), ProgressOutput::output(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), ConsoleUtils::outputExecutionInformation(), MaterialOutputAction::outputHelper(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), TableOutput::outputReporter(), AdvancedOutput::outputReporters(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedCurveGenerator::ParsedCurveGenerator(), MooseServer::parseDocumentForDiagnostics(), ParsedODEKernel::ParsedODEKernel(), ComponentPhysicsInterface::physicsExists(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), MooseApp::possiblyLoadRestartableMetaData(), PhysicsBase::prefix(), MooseMesh::prepare(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), PerfGraphLivePrint::printStats(), MultiApp::readCommandLineArguments(), Receiver::Receiver(), Executor::Result::record(), AppFactory::reg(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), MooseApp::registerRestartableDataMapName(), MooseApp::registerRestartableNameWithFilter(), GlobalParamsAction::remove(), MaterialBase::resetQpProperties(), MultiApp::restore(), ScalarComponentIC::ScalarComponentIC(), MultiApp::setAppOutputFileBase(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), GlobalParamsAction::setDoubleIndexParam(), OutputWarehouse::setFileNumbers(), GlobalParamsAction::setParam(), FEProblemBase::setPostprocessorValueByName(), FEProblemBase::setResidualObjectParamsAndLog(), GlobalParamsAction::setScalarParam(), MooseMesh::setSubdomainName(), GlobalParamsAction::setTripleIndexParam(), NodeSetsGeneratorBase::setup(), Split::setup(), SideSetsGeneratorBase::setup(), TransientMultiApp::setupApp(), GlobalParamsAction::setVectorParam(), FullSolveMultiApp::showStatusMessage(), SideSetExtruderGenerator::SideSetExtruderGenerator(), TransientMultiApp::solveStep(), UserObject::spatialValue(), WebServerControl::startServer(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), MaterialBase::storeBoundaryZeroMatProp(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), MaterialBase::storeSubdomainZeroMatProp(), SubProblem::storeSubdomainZeroMatProp(), MaterialBase::subdomainSetup(), TaggingInterface::TaggingInterface(), VectorPostprocessorVisualizationAux::timestepSetup(), to_json(), MultiAppDofCopyTransfer::transfer(), TransientMultiApp::TransientMultiApp(), MooseServer::traverseParseTreeAndFillSymbols(), MooseBase::typeAndName(), MooseBaseParameterInterface::uniqueParameterName(), FVFluxBC::uOnGhost(), FVFluxBC::uOnUSub(), UserObject::UserObject(), UserObjectInterface::userObjectName(), ParsedAux::validateGenericVectorNames(), PhysicsBase::variableExists(), MultiAppTransfer::variableIntegrityCheck(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), Convergence::verboseOutput(), AdvancedOutput::wantOutput(), Coupleable::writableCoupledValue(), Coupleable::writableVariable(), Console::write(), and MooseApp::writeRestartableMetaData().

{ return _name; }

numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns

The number of subdomains

Definition at line 203 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::initialize(), and QuadraturePointsPositions::initialize().

{
  return (unsigned int)_blk_ids.size();
}

numBoundaryIDs()

unsigned int BoundaryRestrictable::numBoundaryIDs ( ) const

inherited

Return the number of boundaries for this object.

Returns

The number of boundary ids

Definition at line 192 of file BoundaryRestrictable.C.

Referenced by SidesetInfoVectorPostprocessor::initialize().

{
  return (unsigned int)_bnd_ids.size();
}

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.

Referenced by HierarchicalGridPartitioner::_do_partition(), AutoCheckpointAction::act(), SetupDebugAction::act(), CommonOutputAction::act(), AddPeriodicBCAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEKernels(), DiffusionFV::addFVKernels(), NEML2ModelExecutor::addGatheredParameter(), NEML2ModelExecutor::addGatheredVariable(), ADDGKernel::ADDGKernel(), CylinderComponent::addMeshGenerators(), AddPeriodicBCAction::AddPeriodicBCAction(), ReporterPointSource::addPoints(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ADNodalKernel::ADNodalKernel(), ADPenaltyPeriodicSegmentalConstraint::ADPenaltyPeriodicSegmentalConstraint(), ADPeriodicSegmentalConstraint::ADPeriodicSegmentalConstraint(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), AdvectiveFluxAux::AdvectiveFluxAux(), ADVectorFunctionDirichletBC::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), ArrayBodyForce::ArrayBodyForce(), ArrayDGKernel::ArrayDGKernel(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayDirichletBC::ArrayDirichletBC(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), ArrayParsedAux::ArrayParsedAux(), ArrayPenaltyDirichletBC::ArrayPenaltyDirichletBC(), ArrayVacuumBC::ArrayVacuumBC(), ArrayVarReductionAux::ArrayVarReductionAux(), ParsedSubdomainIDsGenerator::assignElemSubdomainID(), AuxKernelTempl< Real >::AuxKernelTempl(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), BlockDeletionGenerator::BlockDeletionGenerator(), BlockWeightedPartitioner::BlockWeightedPartitioner(), BoundsBase::BoundsBase(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BuildArrayVariableAux::BuildArrayVariableAux(), PiecewiseTabularBase::buildFromFile(), MFEMMesh::buildMesh(), CartesianGridDivision::CartesianGridDivision(), checkComponent(), MeshGenerator::checkGetMesh(), ComponentInitialConditionInterface::checkInitialConditionsAllRequested(), BatchMeshGeneratorAction::checkInputParameterType(), PhysicsBase::checkIntegrityEarly(), PostprocessorInterface::checkParam(), FEProblemBase::checkProblemIntegrity(), MultiAppReporterTransfer::checkSiblingsTransferSupported(), Coupleable::checkVar(), MultiAppTransfer::checkVariable(), CircularBoundaryCorrectionGenerator::CircularBoundaryCorrectionGenerator(), CircularBoundaryCorrectionGenerator::circularCenterCalculator(), MultiAppGeneralFieldTransfer::closestToPosition(), CoarsenBlockGenerator::CoarsenBlockGenerator(), CombinerGenerator::CombinerGenerator(), ComponentInitialConditionInterface::ComponentInitialConditionInterface(), ComponentMaterialPropertyInterface::ComponentMaterialPropertyInterface(), CompositionDT::CompositionDT(), FunctorAux::computeValue(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), ContainsPointAux::ContainsPointAux(), CopyValueAux::CopyValueAux(), Coupleable::Coupleable(), CoupledForceTempl< is_ad >::CoupledForceTempl(), CoupledValueFunctionMaterialTempl< is_ad >::CoupledValueFunctionMaterialTempl(), MultiApp::createApp(), MeshGeneratorSystem::createMeshGenerator(), CylindricalGridDivision::CylindricalGridDivision(), ConstantReporter::declareConstantReporterValues(), AccumulateReporter::declareLateValues(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DGLowerDKernel::DGLowerDKernel(), DiffusionFluxAux::DiffusionFluxAux(), DomainUserObject::DomainUserObject(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementLengthAux::ElementLengthAux(), ElementLpNormAux::ElementLpNormAux(), ExtraIDIntegralVectorPostprocessor::elementValue(), ElementValueSampler::ElementValueSampler(), ElementVectorL2Error::ElementVectorL2Error(), EqualValueEmbeddedConstraintTempl< is_ad >::EqualValueEmbeddedConstraintTempl(), ReporterPointSource::errorCheck(), ExamplePatchMeshGenerator::ExamplePatchMeshGenerator(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), ExtraElementIDAux::ExtraElementIDAux(), ExtraElementIntegerDivision::ExtraElementIntegerDivision(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::FileMeshGenerator(), FillBetweenCurvesGenerator::FillBetweenCurvesGenerator(), FillBetweenSidesetsGenerator::FillBetweenSidesetsGenerator(), ReporterPointSource::fillPoint(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), InternalSideIndicatorBase::finalize(), ForcingFunctionAux::ForcingFunctionAux(), FullSolveMultiApp::FullSolveMultiApp(), FunctionArrayAux::FunctionArrayAux(), FunctionValuePostprocessor::FunctionValuePostprocessor(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorAux::FunctorAux(), FunctorBinnedValuesDivision::FunctorBinnedValuesDivision(), FunctorCoordinatesFunctionAux::FunctorCoordinatesFunctionAux(), FunctorElementalGradientAuxTempl< is_ad >::FunctorElementalGradientAuxTempl(), FunctorExtremaPositions::FunctorExtremaPositions(), FunctorIC::FunctorIC(), FunctorPositions::FunctorPositions(), FunctorVectorElementalAuxTempl< is_ad >::FunctorVectorElementalAuxTempl(), FVAdvection::FVAdvection(), FVFluxBC::FVFluxBC(), FVInterfaceKernel::FVInterfaceKernel(), FVOneVarDiffusionInterface::FVOneVarDiffusionInterface(), FVTwoVarContinuityConstraint::FVTwoVarContinuityConstraint(), BoundaryDeletionGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), ExtraNodesetGenerator::generate(), ElementsToTetrahedronsConverter::generate(), AddMetaDataGenerator::generate(), BlockToMeshConverterGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenSidesetsGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), PlaneIDMeshGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), BlockDeletionGenerator::generate(), BreakMeshByBlockGenerator::generate(), CoarsenBlockGenerator::generate(), FlipSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), RefineBlockGenerator::generate(), RefineSidesetGenerator::generate(), AdvancedExtruderGenerator::generate(), BreakMeshByElementGenerator::generate(), CircularBoundaryCorrectionGenerator::generate(), CombinerGenerator::generate(), MeshCollectionGenerator::generate(), MeshExtruderGenerator::generate(), ParsedCurveGenerator::generate(), ParsedExtraElementIDGenerator::generate(), StackGenerator::generate(), StitchedMeshGenerator::generate(), XYZDelaunayGenerator::generate(), CutMeshByLevelSetGeneratorBase::generate(), XYDelaunayGenerator::generate(), XYMeshLineCutter::generate(), PatternedMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), GeneratedMeshGenerator::GeneratedMeshGenerator(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), PropertyReadFile::getBlockData(), ComponentBoundaryConditionInterface::getBoundaryCondition(), MultiApp::getCommandLineArgs(), PropertyReadFile::getData(), PropertyReadFile::getFileNames(), Sampler::getGlobalSamples(), ComponentInitialConditionInterface::getInitialCondition(), NEML2Action::getInputParameterMapping(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), Sampler::getLocalSamples(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), Sampler::getNextLocalRow(), FEProblemSolve::getParamFromNonlinearSystemVectorParam(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectName(), HFEMDirichletBC::HFEMDirichletBC(), AddVariableAction::init(), MultiApp::init(), DistributedPositions::initialize(), BlockWeightedPartitioner::initialize(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), PhysicsBase::initializePhysics(), JSONOutput::initialSetup(), MultiAppCloneReporterTransfer::initialSetup(), SolutionIC::initialSetup(), SideFVFluxBCIntegral::initialSetup(), ElementSubdomainModifierBase::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MultiAppDofCopyTransfer::initialSetup(), HistogramVectorPostprocessor::initialSetup(), ReferenceResidualConvergence::initialSetup(), PiecewiseConstantFromCSV::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), SampledOutput::initSample(), AddMetaDataGenerator::inputChecker(), IntegratedBC::IntegratedBC(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceValueUserObjectAux::InterfaceValueUserObjectAux(), InternalSideIndicatorBase::InternalSideIndicatorBase(), InterpolatedStatefulMaterialTempl< T >::InterpolatedStatefulMaterialTempl(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), MultiApp::keepSolutionDuringRestore(), Kernel::Kernel(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), LinearCombinationFunction::LinearCombinationFunction(), LowerDIntegratedBC::LowerDIntegratedBC(), PNGOutput::makeMeshFunc(), MatCoupledForce::MatCoupledForce(), MaterialADConverterTempl< T >::MaterialADConverterTempl(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), MatrixSymmetryCheck::MatrixSymmetryCheck(), PatternedMeshGenerator::mergeSubdomainNameMaps(), MeshCollectionGenerator::MeshCollectionGenerator(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MeshDivisionAux::MeshDivisionAux(), MeshGenerator::MeshGenerator(), MeshGeneratorComponent::MeshGeneratorComponent(), MFEMGenericFunctorMaterial::MFEMGenericFunctorMaterial(), MFEMGenericFunctorVectorMaterial::MFEMGenericFunctorVectorMaterial(), MooseLinearVariableFV< Real >::MooseLinearVariableFV(), UserObjectInterface::mooseObjectError(), MoosePreconditioner::MoosePreconditioner(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MortarConstraintBase::MortarConstraintBase(), MortarNodalAuxKernelTempl< ComputeValueType >::MortarNodalAuxKernelTempl(), MultiApp::moveApp(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppCloneReporterTransfer::MultiAppCloneReporterTransfer(), MultiAppGeneralFieldNearestLocationTransfer::MultiAppGeneralFieldNearestLocationTransfer(), MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppGeometricInterpolationTransfer::MultiAppGeometricInterpolationTransfer(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorToAuxScalarTransfer::MultiAppPostprocessorToAuxScalarTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppProjectionTransfer::MultiAppProjectionTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppScalarToAuxScalarTransfer::MultiAppScalarToAuxScalarTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiAppVectorPostprocessorTransfer::MultiAppVectorPostprocessorTransfer(), MultiSystemSolveObject::MultiSystemSolveObject(), NearestNodeValueAux::NearestNodeValueAux(), NEML2Action::NEML2Action(), NestedDivision::NestedDivision(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), NodalValueSampler::NodalValueSampler(), Output::Output(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), ParsedPostprocessor::ParsedPostprocessor(), PatternedMeshGenerator::PatternedMeshGenerator(), PenaltyPeriodicSegmentalConstraint::PenaltyPeriodicSegmentalConstraint(), PeriodicSegmentalConstraint::PeriodicSegmentalConstraint(), PIDTransientControl::PIDTransientControl(), PlaneDeletionGenerator::PlaneDeletionGenerator(), PlaneIDMeshGenerator::PlaneIDMeshGenerator(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), PolyLineMeshGenerator::PolyLineMeshGenerator(), ReporterInterface::possiblyCheckHasReporter(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor(), LibmeshPartitioner::prepareBlocksForSubdomainPartitioner(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), ProjectionAux::ProjectionAux(), PropertyReadFile::PropertyReadFile(), RandomIC::RandomIC(), MultiApp::readCommandLineArguments(), PropertyReadFile::readData(), SolutionUserObjectBase::readXda(), ReferenceResidualConvergence::ReferenceResidualConvergence(), RefineBlockGenerator::RefineBlockGenerator(), RefineSidesetGenerator::RefineSidesetGenerator(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), ReporterPointSource::ReporterPointSource(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), FEProblemBase::setLinearConvergenceNames(), FEProblemBase::setNonlinearConvergenceNames(), MooseMesh::setPartitioner(), NodeSetsGeneratorBase::setup(), SideSetsGeneratorBase::setup(), NEML2Action::setupDerivativeMappings(), NEML2Action::setupParameterDerivativeMappings(), TimeSequenceStepperBase::setupSequence(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SingleRankPartitioner::SingleRankPartitioner(), SphericalGridDivision::SphericalGridDivision(), SymmetryTransformGenerator::SymmetryTransformGenerator(), Terminator::Terminator(), TimeDerivativeAux::TimeDerivativeAux(), Transfer::Transfer(), TransformGenerator::TransformGenerator(), TransientMultiApp::TransientMultiApp(), ParsedCurveGenerator::tSectionSpaceDefiner(), UniqueExtraIDMeshGenerator::UniqueExtraIDMeshGenerator(), UserObject::UserObject(), Checkpoint::validateExecuteOn(), ParsedAux::validateGenericVectorNames(), ParsedMaterialBase::validateVectorNames(), FunctorIC::value(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), VectorFunctionIC::VectorFunctionIC(), VolumeAux::VolumeAux(), WebServerControl::WebServerControl(), XYDelaunayGenerator::XYDelaunayGenerator(), XYMeshLineCutter::XYMeshLineCutter(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

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

Referenced by SetupDebugAction::act(), AddActionComponentAction::act(), CommonOutputAction::act(), Action::Action(), FEProblemBase::addAnyRedistributers(), MFEMProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), MFEMProblem::addAuxVariable(), DisplacedProblem::addAuxVariable(), MFEMProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addConvergence(), FEProblemBase::addDamper(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), FEProblemBase::addDefaultMultiAppFixedPointConvergence(), ReferenceResidualProblem::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::addDefaultNonlinearConvergence(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), MFEMProblem::addFESpace(), MFEMProblem::addFunction(), FEProblemBase::addFunction(), MFEMProblem::addFunctorMaterial(), FEProblemBase::addFunctorMaterial(), FEProblemBase::addFVBC(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVInterfaceKernel(), FEProblemBase::addFVKernel(), MFEMProblem::addGridFunction(), FEProblemBase::addHDGKernel(), FEProblemBase::addIndicator(), MFEMProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DiffusionPhysicsBase::addInitialConditions(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), MFEMProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addLinearFVBC(), FEProblemBase::addLinearFVKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMeshDivision(), MFEMProblem::addMFEMFESpaceFromMOOSEVariable(), MFEMProblem::addMFEMPreconditioner(), MFEMProblem::addMFEMSolver(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObject(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addOutput(), MFEMProblem::addPostprocessor(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addScalarKernel(), MFEMProblem::addSubMesh(), FEProblemBase::addTimeIntegrator(), MFEMProblem::addTransfer(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), MFEMProblem::addVariable(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), AdvancedOutput::AdvancedOutput(), ADVectorFunctionDirichletBC::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), Action::associateWithParameter(), AuxKernelTempl< Real >::AuxKernelTempl(), AuxScalarKernel::AuxScalarKernel(), BoundsBase::BoundsBase(), MooseMesh::buildTypedMesh(), PostprocessorInterface::checkParam(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), SampledOutput::cloneMesh(), LibtorchNeuralNetControl::conditionalParameterError(), Console::Console(), CommonOutputAction::create(), MultiApp::createApp(), Postprocessor::declareValue(), DumpObjectsProblem::deduceNecessaryParameters(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), ElementMaterialSampler::ElementMaterialSampler(), ExamplePatchMeshGenerator::ExamplePatchMeshGenerator(), Executor::Executor(), Exodus::Exodus(), FEProblem::FEProblem(), FEProblemBase::FEProblemBase(), FixedPointSolve::FixedPointSolve(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GapValueAux::GapValueAux(), ParsedSubdomainGeneratorBase::generate(), MooseBaseParameterInterface::getCheckedPointerParam(), ActionWarehouse::getCurrentActionName(), ExecutorInterface::getExecutor(), Material::getMaterial(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), UserObjectInterface::getUserObjectName(), VectorPostprocessorInterface::getVectorPostprocessorName(), GhostingUserObject::GhostingUserObject(), AttribSystem::initFrom(), AttribDisplaced::initFrom(), BlockRestrictable::initializeBlockRestrictable(), FullSolveMultiApp::initialSetup(), FEProblemBase::initNullSpaceVectors(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), isValid(), IterationAdaptiveDT::IterationAdaptiveDT(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MFEMCGSolver::MFEMCGSolver(), MFEMGMRESSolver::MFEMGMRESSolver(), MFEMHypreADS::MFEMHypreADS(), MFEMHypreAMS::MFEMHypreAMS(), MFEMHypreBoomerAMG::MFEMHypreBoomerAMG(), MFEMHypreFGMRES::MFEMHypreFGMRES(), MFEMHypreGMRES::MFEMHypreGMRES(), MFEMHyprePCG::MFEMHyprePCG(), MFEMOperatorJacobiSmoother::MFEMOperatorJacobiSmoother(), MFEMSuperLU::MFEMSuperLU(), MooseObject::MooseObject(), UserObjectInterface::mooseObjectError(), MooseVariableInterface< Real >::MooseVariableInterface(), MultiApp::MultiApp(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NodeFaceConstraint::NodeFaceConstraint(), OverlayMeshGenerator::OverlayMeshGenerator(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), NEML2Action::printSummary(), ProjectedStatefulMaterialStorageAction::processProperty(), PropertyReadFile::PropertyReadFile(), PseudoTimestep::PseudoTimestep(), RandomIC::RandomIC(), ReferenceResidualConvergence::ReferenceResidualConvergence(), InputParameterWarehouse::removeInputParameters(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), FEProblemBase::setResidualObjectParamsAndLog(), SideSetsGeneratorBase::setup(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), Moose::PetscSupport::storePetscOptions(), DumpObjectsProblem::stringifyParameters(), TaggingInterface::TaggingInterface(), Transfer::Transfer(), TransientBase::TransientBase(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), VectorFunctionIC::VectorFunctionIC(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

{ return _pars; }

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(), 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)...));
}

precalculateValue()

virtual void AuxKernelTempl< Real >::precalculateValue ( )

inlineprotectedvirtualinherited

This callback is used for AuxKernelTempls that need to perform a per-element calculation.

Reimplemented in GhostingFromUOAux.

Definition at line 137 of file AuxKernel.h.

Referenced by ElementLpNormAux::compute(), and ElementH1ErrorFunctionAux::compute().

{}

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;
}

requiresGeometricSearch()

bool GeometricSearchInterface::requiresGeometricSearch ( ) const

inlineinherited

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 65 of file GeometricSearchInterface.h.

{ return _requires_geometric_search; }

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

{
}

resolveOptionalProperties()

void MaterialPropertyInterface::resolveOptionalProperties ( )

virtualinherited

resolve all optional properties

Reimplemented in Material.

Definition at line 234 of file MaterialPropertyInterface.C.

{
  for (auto & proxy : _optional_property_proxies)
    proxy->resolve(*this);
}

restartableName()

std::string Restartable::restartableName ( const std::string &  data_name ) const

protectedinherited

Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

This should only be used in this interface and in testing.

Definition at line 66 of file Restartable.C.

Referenced by Restartable::declareRecoverableData(), and Restartable::declareRestartableDataHelper().

{
  return _restartable_system_name + "/" + _restartable_name + "/" + data_name;
}

restricted()

bool BoundaryRestrictable::restricted ( const std::set< BoundaryID > &  ids )

staticinherited

Helper for determining if the object is boundary restricted.

This is needed for the MaterialPropertyInterface.

Definition at line 204 of file BoundaryRestrictable.C.

Referenced by moose::internal::boundaryRestricted(), and BoundaryRestrictable::boundaryRestricted().

{
  return ids.find(Moose::ANY_BOUNDARY_ID) == ids.end();
}

second()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 278 of file MooseVariableInterface.C.

Referenced by ProjectionAux::elemOnNodeVariableIsDefinedOn().

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSln();
}

secondOld()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 288 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSlnOld();
}

secondOlder()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 298 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondSlnOlder();
}

secondPhi()

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

protectedvirtualinherited

The second derivative of the trial function.

Returns

The reference to be stored off and used later.

Definition at line 328 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");

  return _mvi_assembly->secondPhi(*_variable);
}

secondPhiFace()

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

protectedvirtualinherited

The second derivative of the trial function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the trial function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 341 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");

  return _mvi_assembly->secondPhiFace(*_variable);
}

secondTest()

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

protectedvirtualinherited

The second derivative of the test function.

Returns

The reference to be stored off and used later.

Definition at line 308 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondPhi();
}

secondTestFace()

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

protectedvirtualinherited

The second derivative of the test function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the test function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 318 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");

  return _variable->secondPhiFace();
}

setRandomDataPointer()

void RandomInterface::setRandomDataPointer ( RandomData *  random_data )

inherited

Definition at line 54 of file RandomInterface.C.

Referenced by FEProblemBase::registerRandomInterface().

{
  _random_data = random_data;
  _generator = &_random_data->getGenerator();
}

setRandomResetFrequency()

void RandomInterface::setRandomResetFrequency ( ExecFlagType  exec_flag )

inherited

This interface should be called from a derived class to enable random number generation in this object.

Definition at line 47 of file RandomInterface.C.

{
  _reset_on = exec_flag;
  _ri_problem.registerRandomInterface(*this, _ri_name);
}

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;
}

statefulPropertiesAllowed()

void MaterialPropertyInterface::statefulPropertiesAllowed ( bool  stateful_allowed )

inherited

Derived classes can declare whether or not they work with stateful material properties.

See, for example, DiracKernel. By default, they are allowed.

Definition at line 145 of file MaterialPropertyInterface.C.

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

{
  _stateful_allowed = stateful_allowed;
}

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.

{
}

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

{
}

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.

Referenced by CreateProblemDefaultAction::act(), SetupDebugAction::act(), MaterialDerivativeTestAction::act(), MaterialOutputAction::act(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addConvergence(), FEProblemBase::addDistribution(), MooseApp::addExecutor(), MooseApp::addExecutorParams(), MFEMProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addMeshDivision(), MooseApp::addMeshGenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addObject(), MFEMProblem::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addTimeIntegrator(), MooseServer::addValuesToList(), DisplacedProblem::addVectorTag(), SubProblem::addVectorTag(), FEProblemBase::advanceMultiApps(), MooseApp::appendMeshGenerator(), AuxKernelTempl< Real >::AuxKernelTempl(), FEProblemBase::backupMultiApps(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), BoundaryPreservedMarker::BoundaryPreservedMarker(), DistributedRectilinearMeshGenerator::buildCube(), MooseMesh::buildHRefinementAndCoarseningMaps(), MooseMesh::buildLowerDMesh(), MooseMesh::buildPRefinementAndCoarseningMaps(), PhysicsBase::checkComponentType(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), ADDGKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), ADDGKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), LowerDIntegratedBC::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDJacobian(), DGLowerDKernel::computeLowerDJacobian(), ArrayDGLowerDKernel::computeLowerDJacobian(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayHFEMDirichletBC::computeLowerDQpJacobian(), ArrayHFEMDiffusion::computeLowerDQpJacobian(), HFEMDirichletBC::computeLowerDQpJacobian(), HFEMDiffusion::computeLowerDQpJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), HFEMDirichletBC::computeLowerDQpOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), FEProblemBase::computeMultiAppsDT(), ADDGKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGLowerDKernel::computeOffDiagLowerDJacobian(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), DGConvection::computeQpJacobian(), ScalarKernel::computeQpJacobian(), InterfaceDiffusion::computeQpJacobian(), ArrayDGDiffusion::computeQpJacobian(), InterfaceReaction::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), HFEMTestJump::computeQpOffDiagJacobian(), HFEMTrialJump::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), HFEMDiffusion::computeQpResidual(), ArrayHFEMDiffusion::computeQpResidual(), DGConvection::computeQpResidual(), ScalarKernel::computeQpResidual(), InterfaceDiffusion::computeQpResidual(), ArrayDGDiffusion::computeQpResidual(), ADMatInterfaceReaction::computeQpResidual(), InterfaceReaction::computeQpResidual(), ADDGAdvection::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), ADDGDiffusion::computeQpResidual(), HFEMTestJump::computeQpResidual(), HFEMTrialJump::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), FEProblemBase::computeSystems(), FEProblemBase::computeUserObjectByName(), FEProblemBase::computeUserObjects(), FEProblemBase::computeUserObjectsInternal(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), MooseApp::createRecoverablePerfGraph(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), MooseBase::errorPrefix(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), WebServerControl::execute(), SteadyBase::execute(), ActionWarehouse::executeActionsWithAction(), FEProblemBase::finishMultiAppStep(), FVScalarLagrangeMultiplierInterface::FVScalarLagrangeMultiplierInterface(), MooseServer::gatherDocumentReferencesLocations(), LowerDBlockFromSidesetGenerator::generate(), SubdomainPerElementGenerator::generate(), PatternedMeshGenerator::generate(), MeshGenerator::generateInternal(), MultiAppTransfer::getAppInfo(), TransfiniteMeshGenerator::getEdge(), ElementGenerator::getElemType(), MooseServer::getInputLookupDefinitionNodes(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), MaterialOutputAction::getParams(), ReporterData::getReporterInfo(), FEProblemBase::getTransfers(), DisplacedProblem::getVectorTags(), SubProblem::getVectorTags(), CommonOutputAction::hasConsole(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), FunctorPositions::initialize(), FunctorTimes::initialize(), MultiAppConservativeTransfer::initialSetup(), LinearFVDiffusion::initialSetup(), LinearFVAnisotropicDiffusion::initialSetup(), LinearFVAdvection::initialSetup(), ArrayDGDiffusion::initQpResidual(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), FEProblemBase::logAdd(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), MFEMProblem::mesh(), MooseApp::MooseApp(), MooseObject::MooseObject(), MultiAppMFEMCopyTransfer::MultiAppMFEMCopyTransfer(), DisplacedProblem::numVectorTags(), SubProblem::numVectorTags(), Console::output(), AdvancedOutput::output(), ConsoleUtils::outputExecutionInformation(), SampledOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), MooseServer::parseDocumentForDiagnostics(), MooseMesh::prepare(), ProjectedStatefulMaterialStorageAction::processProperty(), MooseApp::recursivelyCreateExecutors(), SolutionInvalidInterface::registerInvalidSolutionInternal(), FEProblemBase::restoreMultiApps(), MeshRepairGenerator::separateSubdomainsByElementType(), FEProblemBase::setCoupling(), MooseApp::setupOptions(), WebServerControl::startServer(), MooseBase::typeAndName(), ScalarKernelBase::uOld(), AuxScalarKernel::uOld(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), UserObjectInterface::userObjectType(), and AdvancedOutput::wantOutput().

{ return _type; }

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 OutputTools< Real >::VariableValue & AuxKernelTempl< Real >::uOld ( ) const

protectedinherited

Retrieves the old value of the variable that this AuxKernel operates on.

Store this as a reference in the constructor.

Definition at line 459 of file AuxKernel.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 _nodal ? _var.nodalValueOldArray() : _var.slnOld();
}

uOlder()

const OutputTools< Real >::VariableValue & AuxKernelTempl< Real >::uOlder ( ) const

protectedinherited

Retrieves the older value of the variable that this AuxKernel operates on.

Store this as a reference in the constructor.

Definition at line 472 of file AuxKernel.C.

{
  if (_sys.solutionStatesInitialized())
    mooseError("The solution states have already been initialized when calling ",
               type(),
               "::uOlder().\n\n",
               "Make sure to call uOlder() within the object constructor.");

  return _nodal ? _var.nodalValueOlderArray() : _var.slnOlder();
}

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.

Referenced by Coupleable::checkFuncType(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), NeighborCoupleable::coupledVectorNeighborGradientOld(), and NeighborCoupleable::coupledVectorNeighborGradientOlder().

{
  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 MaterialStdVectorRealGradientAux::validParams ( )

static

Definition at line 15 of file MaterialStdVectorRealGradientAux.C.

{
  InputParameters params = MaterialStdVectorAuxBase<>::validParams();
  params.addClassDescription("Extracts a component of a material's std::vector<RealGradient> to an "
                             "aux variable.  If the std::vector is not of sufficient size then "
                             "zero is returned");
  params.addParam<unsigned int>(
      "component", 0, "The gradient component to be extracted for this kernel");
  return params;
}

value()

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

protectedvirtualinherited

The value of the variable this object is operating on.

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

Returns

The reference to be stored off and used later.

Definition at line 88 of file MooseVariableInterface.C.

Referenced by KernelGrad::computeJacobian(), KernelValue::computeJacobian(), NodalConstraint::computeJacobian(), ConvectiveFluxBC::computeQpResidual(), SinDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), KernelGrad::computeResidual(), KernelValue::computeResidual(), MeshDivisionAux::computeValue(), ElementUOAux::computeValue(), and LineValueSampler::getValue().

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

valueOld()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 108 of file MooseVariableInterface.C.

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

valueOlder()

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

protectedvirtualinherited

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

Returns

The reference to be stored off and used later.

Definition at line 128 of file MooseVariableInterface.C.

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

variable()

MooseVariableField<Real >& AuxKernelTempl< Real >::variable ( )

inlineinherited

Get a reference to a variable this kernel is action on.

Returns

reference to a variable this kernel is action on

Definition at line 97 of file AuxKernel.h.

{ return _var; }

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& AuxKernelTempl< Real >::_assembly

protectedinherited

Assembly class.

Definition at line 183 of file AuxKernel.h.

_aux_sys

AuxiliarySystem& AuxKernelTempl< Real >::_aux_sys

protectedinherited

Definition at line 168 of file AuxKernel.h.

Referenced by BoundsBase::BoundsBase().

_blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 214 of file BlockRestrictable.h.

Referenced by BlockRestrictable::hasBlockMaterialProperty(), and BlockRestrictable::initializeBlockRestrictable().

_bnd

bool AuxKernelTempl< Real >::_bnd

protectedinherited

true if the kernel is boundary kernel, false if it is interior kernels

Definition at line 186 of file AuxKernel.h.

Referenced by VolumeAux::computeValue().

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

Referenced by FunctorAux::computeValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), Coupleable::coupledGradientPreviousNL(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledMatrixTagValues(), Coupleable::coupledNodalValuePreviousNL(), Coupleable::coupledSecondPreviousNL(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorTagArrayGradient(), Coupleable::coupledVectorTagArrayGradients(), Coupleable::coupledVectorTagArrayValues(), Coupleable::coupledVectorTagDofValues(), Coupleable::coupledVectorTagGradient(), Coupleable::coupledVectorTagGradients(), Coupleable::coupledVectorTagValues(), BoundsBase::initialSetup(), Coupleable::validateExecutionerType(), Coupleable::vectorTagDofValueHelper(), Coupleable::vectorTagValueHelper(), and Coupleable::writableCoupledValue().

_c_is_implicit

bool Coupleable::_c_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 1436 of file Coupleable.h.

Referenced by Coupleable::adCoupledCurl(), Coupleable::adCoupledDofValues(), Coupleable::adCoupledGradient(), Coupleable::adCoupledGradientDot(), Coupleable::adCoupledLowerValue(), NeighborCoupleable::adCoupledNeighborGradient(), NeighborCoupleable::adCoupledNeighborValue(), NeighborCoupleable::adCoupledNeighborValueDot(), Coupleable::adCoupledNodalValue(), Coupleable::adCoupledSecond(), Coupleable::adCoupledValue(), Coupleable::adCoupledVectorGradient(), NeighborCoupleable::adCoupledVectorNeighborValue(), Coupleable::adCoupledVectorValue(), Coupleable::checkFuncType(), Coupleable::coupledArrayDofValues(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), Coupleable::coupledArrayValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), Coupleable::coupledArrayValueOld(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledDiv(), Coupleable::coupledDivOld(), Coupleable::coupledDofValues(), Coupleable::coupledDofValuesOld(), Coupleable::coupledGradient(), Coupleable::coupledGradientOld(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradient(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValue(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), Coupleable::coupledValueLower(), Coupleable::coupledValueOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), Coupleable::coupledVectorValue(), and Coupleable::coupledVectorValueOld().

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

Referenced by Coupleable::adCoupledDot(), Coupleable::adCoupledDotDot(), Coupleable::adCoupledLowerValue(), Coupleable::adCoupledNodalValue(), Coupleable::adCoupledValue(), Coupleable::adCoupledVectorDot(), Coupleable::adCoupledVectorValue(), Coupleable::checkFuncType(), Coupleable::checkVar(), Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotDu(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledArrayValueByName(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledValue(), CoupleableMooseVariableDependencyIntermediateInterface::coupledValueByName(), Coupleable::coupledValueLower(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), Coupleable::getVectorVar(), and Coupleable::vectorTagValueHelper().

_c_parameters

const InputParameters& Coupleable::_c_parameters

protectedinherited

Definition at line 1395 of file Coupleable.h.

Referenced by Coupleable::checkVar(), Coupleable::Coupleable(), Coupleable::coupledComponents(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledMatrixTagValues(), Coupleable::coupledVectorTagArrayGradient(), Coupleable::coupledVectorTagArrayGradients(), Coupleable::coupledVectorTagArrayValues(), Coupleable::coupledVectorTagDofValues(), Coupleable::coupledVectorTagGradient(), Coupleable::coupledVectorTagGradients(), Coupleable::coupledVectorTagValues(), Coupleable::getADDefaultValue(), Coupleable::getADDefaultVectorValue(), Coupleable::getDefaultArrayValue(), Coupleable::getDefaultValue(), Coupleable::getDefaultVectorValue(), Coupleable::getVarHelper(), Coupleable::isCoupled(), Coupleable::isCoupledConstant(), Coupleable::vectorTagDofValueHelper(), and Coupleable::vectorTagValueHelper().

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

_check_boundary_restricted

const bool& AuxKernelTempl< Real >::_check_boundary_restricted

protectedinherited

Whether or not to check for repeated element sides on the sideset to which the auxkernel is restricted (if boundary restricted and elemental).

Setting this to false will allow an element with more than one face on the boundary to which it is restricted allow contribution to the element's value(s). This flag allows auxkernels that evaluate boundary-restricted elemental auxvariables to have more than one element face on the boundary of interest.

Definition at line 161 of file AuxKernel.h.

_coincident_lower_d_calc

const bool AuxKernelTempl< Real >::_coincident_lower_d_calc

protectedinherited

Whether we are computing for a lower dimensional variable using boundary restriction, e.g.

a variable whose block restriction is coincident with a higher-dimensional boundary face

Definition at line 227 of file AuxKernel.h.

_component

unsigned int MaterialStdVectorRealGradientAux::_component

protected

component of the real gradient to be extracted

Definition at line 29 of file MaterialStdVectorRealGradientAux.h.

Referenced by getRealValue(), and MaterialStdVectorRealGradientAux().

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

Referenced by IterationAdaptiveDT::acceptStep(), MeshOnlyAction::act(), SetupDebugAction::act(), MaterialOutputAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), PerfGraph::addToExecutionList(), SimplePredictor::apply(), SystemBase::applyScalingFactors(), MultiApp::backup(), FEProblemBase::backupMultiApps(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), MeshDiagnosticsGenerator::checkElementOverlap(), MeshDiagnosticsGenerator::checkElementTypes(), MeshDiagnosticsGenerator::checkElementVolumes(), FEProblemBase::checkExceptionAndStopSolve(), SolverSystem::checkInvalidSolution(), MeshDiagnosticsGenerator::checkLocalJacobians(), MeshDiagnosticsGenerator::checkNonConformalMesh(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkNonPlanarSides(), FEProblemBase::checkProblemIntegrity(), ReferenceResidualConvergence::checkRelativeConvergence(), MeshDiagnosticsGenerator::checkSidesetsOrientation(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), IterationAdaptiveDT::computeAdaptiveDT(), TransientBase::computeConstrainedDT(), DefaultMultiAppFixedPointConvergence::computeCustomConvergencePostprocessor(), NonlinearSystemBase::computeDamping(), FixedPointIterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInitialDT(), IterationAdaptiveDT::computeInterpolationDT(), LinearSystem::computeLinearSystemTags(), FEProblemBase::computeLinearSystemTags(), NonlinearSystemBase::computeScaling(), Problem::console(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MFEMSteady::execute(), MessageFromInput::execute(), SteadyBase::execute(), Eigenvalue::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), MeshGeneratorSystem::executeMeshGenerators(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MeshRepairGenerator::fixOverlappingNodes(), CoarsenBlockGenerator::generate(), MeshGenerator::generateInternal(), VariableCondensationPreconditioner::getDofToCondense(), InversePowerMethod::init(), NonlinearEigen::init(), FEProblemBase::initialAdaptMesh(), DefaultMultiAppFixedPointConvergence::initialize(), EigenExecutionerBase::inversePowerIteration(), FEProblemBase::joinAndFinalize(), TransientBase::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::logAdd(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), MooseBaseErrorInterface::mooseWarningNonPrefixed(), ReferenceResidualConvergence::nonlinearConvergenceSetup(), ReporterDebugOutput::output(), PerfGraphOutput::output(), SolutionInvalidityOutput::output(), MaterialPropertyDebugOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), PseudoTimestep::outputPseudoTimestep(), Console::outputReporters(), DefaultMultiAppFixedPointConvergence::outputResidualNorm(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), SolutionInvalidity::printDebug(), EigenExecutionerBase::printEigenvalue(), SecantSolve::printFixedPointConvergenceHistory(), SteffensenSolve::printFixedPointConvergenceHistory(), PicardSolve::printFixedPointConvergenceHistory(), FixedPointSolve::printFixedPointConvergenceReason(), PerfGraphLivePrint::printLiveMessage(), MaterialPropertyDebugOutput::printMaterialMap(), PerfGraphLivePrint::printStats(), NEML2Action::printSummary(), AutomaticMortarGeneration::projectPrimaryNodesSinglePair(), AutomaticMortarGeneration::projectSecondaryNodesSinglePair(), CoarsenBlockGenerator::recursiveCoarsen(), SolutionTimeAdaptiveDT::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), FEProblemBase::restoreSolutions(), NonlinearSystemBase::setInitialSolution(), MooseApp::setupOptions(), Checkpoint::shouldOutput(), SubProblem::showFunctorRequestors(), SubProblem::showFunctors(), FullSolveMultiApp::showStatusMessage(), FEProblemSolve::solve(), FixedPointSolve::solve(), EigenProblem::solve(), NonlinearSystem::solve(), LinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), FixedPointSolve::solveStep(), PerfGraphLivePrint::start(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), TransientBase::takeStep(), TerminateChainControl::terminate(), Convergence::verboseOutput(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

_coord

const MooseArray<Real>& AuxKernelTempl< Real >::_coord

protectedinherited

Definition at line 201 of file AuxKernel.h.

Referenced by ElementLpNormAux::compute(), and ElementH1ErrorFunctionAux::compute().

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

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

_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(), and Coupleable::getVarHelper().

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

_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_boundary_id

const BoundaryID& AuxKernelTempl< Real >::_current_boundary_id

protectedinherited

The current boundary ID.

Definition at line 217 of file AuxKernel.h.

_current_elem

const Elem* const& AuxKernelTempl< Real >::_current_elem

protectedinherited

Current element (valid only for elemental kernels)

Definition at line 204 of file AuxKernel.h.

Referenced by ProcessorIDAux::computeValue(), GapValueAux::computeValue(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), DebugResidualAux::computeValue(), HardwareIDAux::computeValue(), FunctorAux::computeValue(), ParsedAux::computeValue(), ElementQualityAux::computeValue(), MeshDivisionAux::computeValue(), NearestNodeDistanceAux::computeValue(), NearestNodeValueAux::computeValue(), ElementUOAux::computeValue(), ElementLengthAux::computeValue(), InterfaceValueUserObjectAux::computeValue(), SpatialUserObjectAux::computeValue(), ContainsPointAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SolutionAux::computeValue(), PenetrationAux::computeValue(), BoundsBase::getDoFIndex(), and GhostingFromUOAux::precalculateValue().

_current_elem_volume

const Real& AuxKernelTempl< Real >::_current_elem_volume

protectedinherited

Volume of the current element.

Definition at line 209 of file AuxKernel.h.

Referenced by VolumeAux::computeValue().

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

_current_lower_d_elem

const Elem* const& AuxKernelTempl< Real >::_current_lower_d_elem

protectedinherited

The current lower dimensional element.

Definition at line 223 of file AuxKernel.h.

_current_node

const Node* const& AuxKernelTempl< Real >::_current_node

protectedinherited

Current node (valid only for nodal kernels)

Definition at line 214 of file AuxKernel.h.

Referenced by NodalPatchRecovery::compute(), ProcessorIDAux::computeValue(), GapValueAux::computeValue(), DebugResidualAux::computeValue(), AdvectiveFluxAux::computeValue(), ParsedAux::computeValue(), FunctorAux::computeValue(), HardwareIDAux::computeValue(), MeshDivisionAux::computeValue(), NearestNodeDistanceAux::computeValue(), NearestNodeValueAux::computeValue(), ProjectionAux::computeValue(), NodalPatchRecoveryAuxBase::computeValue(), FunctionAux::computeValue(), SpatialUserObjectAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SolutionAux::computeValue(), PenetrationAux::computeValue(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), VariableOldValueBounds::getBound(), BoundsBase::getDoFIndex(), NodalPatchRecoveryAux::nodalPatchRecovery(), and ProjectedMaterialPropertyNodalPatchRecoveryAux::nodalPatchRecovery().

_current_side

const unsigned int& AuxKernelTempl< Real >::_current_side

protectedinherited

current side of the current element

Definition at line 206 of file AuxKernel.h.

Referenced by GapValueAux::computeValue(), AdvectiveFluxAux::computeValue(), NearestNodeDistanceAux::computeValue(), InterfaceValueUserObjectAux::computeValue(), and PenetrationAux::computeValue().

_current_side_volume

const Real& AuxKernelTempl< Real >::_current_side_volume

protectedinherited

Volume of the current side.

Definition at line 211 of file AuxKernel.h.

Referenced by VolumeAux::computeValue().

_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_properties

std::vector<std::unique_ptr<PropertyValue> > MaterialPropertyInterface::_default_properties

protectedinherited

Storage vector for default properties.

Definition at line 546 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

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

_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(), CreateExecutionerAction::act(), PartitionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::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().

_field_variable

MooseVariableField<Real >* MooseVariableInterface< Real >::_field_variable

protectedinherited

Definition at line 230 of file MooseVariableInterface.h.

Referenced by SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), and SideIntegralVariablePostprocessor::hasFaceSide().

_full_value

Moose::GenericType<std::vector< T > , is_ad> MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::_full_value

protectedinherited

T Value evaluated from either the property or the functor.

Definition at line 55 of file MaterialAuxBase.h.

Referenced by getRealValue().

_fv_variable

MooseVariableFV<Real >* MooseVariableInterface< Real >::_fv_variable

protectedinherited

Definition at line 228 of file MooseVariableInterface.h.

Referenced by InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), LayeredSideDiffusiveFluxAverage::computeQpIntegral(), SideIntegralVariableUserObject::computeQpIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), and InternalSideIntegralVariablePostprocessor::hasFaceSide().

_geometric_search_data

GeometricSearchData& GeometricSearchInterface::_geometric_search_data

protectedinherited

Definition at line 68 of file GeometricSearchInterface.h.

Referenced by GeometricSearchInterface::getNearestNodeLocator(), GeometricSearchInterface::getPenetrationLocator(), GeometricSearchInterface::getQuadratureNearestNodeLocator(), and GeometricSearchInterface::getQuadraturePenetrationLocator().

_get_material_property_called

bool MaterialPropertyInterface::_get_material_property_called

protectedinherited

Initialized to false.

Gets set to true when getMaterialProperty() is called. Clients of this class can inquire whether getMaterialProperty() has been called by calling getMaterialPropertyCalled().

Definition at line 543 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getMaterialPropertyCalled().

_get_suffix

const MaterialPropertyName MaterialPropertyInterface::_get_suffix

protectedinherited

Definition at line 551 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), Material::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::hasADMaterialPropertyByName(), and MaterialPropertyInterface::hasMaterialPropertyByName().

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

_index

template<typename T, bool is_ad>

unsigned int MaterialStdVectorAuxBaseTempl< T, is_ad >::_index

protectedinherited

index of the vector element

Definition at line 28 of file MaterialStdVectorAuxBase.h.

Referenced by getRealValue().

_interpolated_old

const std::string MaterialPropertyInterface::_interpolated_old = "_interpolated_old"

staticprotectedinherited

name suffixes for interpolated old and older properties

Definition at line 557 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

_interpolated_older

const std::string MaterialPropertyInterface::_interpolated_older = "_interpolated_older"

staticprotectedinherited

Definition at line 558 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

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

_JxW

const MooseArray<Real>& AuxKernelTempl< Real >::_JxW

protectedinherited

Transformed Jacobian weights.

Definition at line 200 of file AuxKernel.h.

Referenced by ElementLpNormAux::compute(), and ElementH1ErrorFunctionAux::compute().

_linear_fv_variable

MooseLinearVariableFV<Real >* MooseVariableInterface< Real >::_linear_fv_variable

protectedinherited

Definition at line 229 of file MooseVariableInterface.h.

_local_ke

DenseMatrix<Number> AuxKernelTempl< Real >::_local_ke

protectedinherited

for holding local mass matrix

Definition at line 242 of file AuxKernel.h.

_local_re

DenseVector<OutputData> AuxKernelTempl< Real >::_local_re

protectedinherited

for holding local load

Definition at line 238 of file AuxKernel.h.

_local_sol

DenseVector<OutputData> AuxKernelTempl< Real >::_local_sol

protectedinherited

for holding local solution

Definition at line 240 of file AuxKernel.h.

_material_data

MaterialData& MaterialPropertyInterface::_material_data

protectedinherited

The material data class that stores properties.

Definition at line 481 of file MaterialPropertyInterface.h.

Referenced by Material::computeProperties(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::hasADMaterialPropertyByName(), MaterialPropertyInterface::hasMaterialPropertyByName(), InterfaceMaterial::materialData(), and Material::materialData().

_material_data_type

const Moose::MaterialDataType MaterialPropertyInterface::_material_data_type

protectedinherited

The type of data.

Definition at line 478 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), and MaterialPropertyInterface::getMaterialByName().

_material_property_dependencies

std::unordered_set<unsigned int> MaterialPropertyInterface::_material_property_dependencies

protectedinherited

The set of material properties (as given by their IDs) that this object depends on.

Definition at line 549 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getMatPropDependencies().

_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& AuxKernelTempl< Real >::_mesh

protectedinherited

Mesh this kernel is active on.

Definition at line 188 of file AuxKernel.h.

Referenced by NodalPatchRecoveryAuxBase::blockRestrictElements(), NodalPatchRecovery::compute(), GapValueAux::computeValue(), NearestNodeDistanceAux::computeValue(), ProjectionAux::computeValue(), NodalPatchRecoveryAuxBase::computeValue(), PenetrationAux::computeValue(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), NodalPatchRecovery::NodalPatchRecovery(), and ProjectionAux::ProjectionAux().

_mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 469 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::addConsumedPropertyName(), MaterialPropertyInterface::buildRequiredMaterials(), MaterialPropertyInterface::checkExecutionStage(), MaterialPropertyInterface::checkMaterialProperty(), Material::getMaterialByName(), MaterialPropertyInterface::getMaterialByName(), MaterialPropertyInterface::getMaterialPropertyBlockNames(), MaterialPropertyInterface::getMaterialPropertyBlocks(), MaterialPropertyInterface::getMaterialPropertyBoundaryIDs(), MaterialPropertyInterface::getMaterialPropertyBoundaryNames(), MaterialPropertyInterface::getMaxQps(), and MaterialPropertyInterface::markMatPropRequested().

_mi_moose_object_name

const MooseObjectName MaterialPropertyInterface::_mi_moose_object_name

protectedinherited

The "complete" name of the object that this interface belongs for material property output.

Definition at line 466 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

_mi_name

const std::string MaterialPropertyInterface::_mi_name

protectedinherited

The name of the object that this interface belongs to.

Definition at line 463 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkMaterialProperty().

_mi_params

const InputParameters& MaterialPropertyInterface::_mi_params

protectedinherited

Parameters of the object with this interface.

Definition at line 460 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), MaterialPropertyInterface::getMaterial(), MaterialPropertyInterface::getMaterialDataType(), and MaterialPropertyInterface::getMaterialPropertyName().

_mi_subproblem

SubProblem& MaterialPropertyInterface::_mi_subproblem

protectedinherited

Reference to the subproblem.

Definition at line 472 of file MaterialPropertyInterface.h.

_mi_tid

const THREAD_ID MaterialPropertyInterface::_mi_tid

protectedinherited

Current threaded it.

Definition at line 475 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), and MaterialPropertyInterface::getMaterialByName().

_mvi_assembly

Assembly* MooseVariableInterface< Real >::_mvi_assembly

protectedinherited

Definition at line 233 of file MooseVariableInterface.h.

_n_local_dofs

unsigned int AuxKernelTempl< Real >::_n_local_dofs

protectedinherited

number of local dofs for elemental variables

Definition at line 233 of file AuxKernel.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(), AddPostprocessorAction::act(), PartitionerAction::act(), AddMeshGeneratorAction::act(), AddDamperAction::act(), AddInterfaceKernelAction::act(), AddFVInterfaceKernelAction::act(), AddMaterialAction::act(), AddVectorPostprocessorAction::act(), AddNodalKernelAction::act(), AddScalarKernelAction::act(), AddTransferAction::act(), AddDiracKernelAction::act(), AddFunctorMaterialAction::act(), AddUserObjectAction::act(), AddFVInitialConditionAction::act(), AddKernelAction::act(), AddDGKernelAction::act(), ReadExecutorParamsAction::act(), AddMarkerAction::act(), AddMultiAppAction::act(), AddIndicatorAction::act(), AddInitialConditionAction::act(), AddPositionsAction::act(), AddReporterAction::act(), AddTimesAction::act(), AddFieldSplitAction::act(), AddFVKernelAction::act(), AddFVBCAction::act(), AddConvergenceAction::act(), AddMeshDivisionAction::act(), AddHDGKernelAction::act(), AddTimeStepperAction::act(), AddDistributionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddFunctionAction::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(), FillBetweenSidesetsGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenCurvesGenerator::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().

_nl_sys

SystemBase& AuxKernelTempl< Real >::_nl_sys

protectedinherited

Definition at line 167 of file AuxKernel.h.

Referenced by DebugResidualAux::computeValue(), NearestNodeValueAux::computeValue(), and BoundsBase::getDoFIndex().

_nodal

bool AuxKernelTempl< Real >::_nodal

protectedinherited

Flag indicating if the AuxKernel is nodal.

Definition at line 177 of file AuxKernel.h.

Referenced by GapValueAux::computeValue(), DebugResidualAux::computeValue(), NearestNodeDistanceAux::computeValue(), VectorVariableComponentAux::computeValue(), PenetrationAux::computeValue(), and DebugResidualAux::DebugResidualAux().

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

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBaseParameterInterface::connectControllableParams(), Console::Console(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MaterialBase::getGenericZeroMaterialProperty(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBaseParameterInterface::getParam(), MooseBaseParameterInterface::getRenamedParam(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBaseParameterInterface::isParamSetByUser(), MooseBaseParameterInterface::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBaseParameterInterface::MooseBaseParameterInterface(), MooseBaseParameterInterface::paramErrorMsg(), GlobalParamsAction::parameters(), MooseBaseParameterInterface::parameters(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseBaseParameterInterface::uniqueName(), and MooseBaseParameterInterface::uniqueParameterName().

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

_prop

const PropertyType& MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::_prop

protectedinherited

(Functor)Material property for this AuxKernel

Definition at line 49 of file MaterialAuxBase.h.

_q_point

const MooseArray<Point>& AuxKernelTempl< Real >::_q_point

protectedinherited

Active quadrature points.

Definition at line 196 of file AuxKernel.h.

Referenced by NodalPatchRecovery::compute(), TimeDerivativeAux::computeValue(), ForcingFunctionAux::computeValue(), SecondTimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), FunctorAux::computeValue(), ParsedAux::computeValue(), FunctionAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), and ElementH1ErrorFunctionAux::computeValue().

_qp

unsigned int AuxKernelTempl< Real >::_qp

protectedinherited

Quadrature point index.

Definition at line 230 of file AuxKernel.h.

Referenced by ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), ArrayVarReductionAux::computeValue(), ArrayVariableComponent::computeValue(), GapValueAux::computeValue(), ForcingFunctionAux::computeValue(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), CopyValueAux::computeValue(), ParsedAux::computeValue(), DiffusionFluxAux::computeValue(), FunctorAux::computeValue(), VectorMagnitudeAux::computeValue(), TagMatrixAux::computeValue(), NearestNodeDistanceAux::computeValue(), NormalizationAux::computeValue(), TagVectorAux::computeValue(), VariableTimeIntegrationAux::computeValue(), QuotientAux::computeValue(), VectorVariableMagnitudeAux::computeValue(), ProjectionAux::computeValue(), InterfaceValueUserObjectAux::computeValue(), VectorVariableComponentAux::computeValue(), VariableGradientComponent::computeValue(), FunctionAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), ElementLpNormAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), PenetrationAux::computeValue(), and VariableTimeIntegrationAux::getIntegralValue().

_qrule

const QBase* const& AuxKernelTempl< Real >::_qrule

protectedinherited

Quadrature rule being used.

Definition at line 198 of file AuxKernel.h.

Referenced by ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), TimeDerivativeAux::computeValue(), SecondTimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), FunctorAux::computeValue(), ParsedAux::computeValue(), and FunctorCoordinatesFunctionAux::computeValue().

_real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 238 of file ScalarCoupleable.h.

_requires_geometric_search

bool GeometricSearchInterface::_requires_geometric_search

protectedinherited

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 72 of file GeometricSearchInterface.h.

Referenced by GeometricSearchInterface::getNearestNodeLocator(), GeometricSearchInterface::getPenetrationLocator(), GeometricSearchInterface::getQuadratureNearestNodeLocator(), GeometricSearchInterface::getQuadraturePenetrationLocator(), and GeometricSearchInterface::requiresGeometricSearch().

_restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 227 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp(), and Restartable::registerRestartableNameWithFilterOnApp().

_restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 236 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

_restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 230 of file Restartable.h.

Referenced by Restartable::restartableName().

_restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 233 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

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

_selected_qp

const unsigned int MaterialAuxBaseTempl< std::vector< T > , is_ad, false , Real >::_selected_qp

protectedinherited

Evaluate at this quadrature point only.

Definition at line 52 of file MaterialAuxBase.h.

_solution

NumericVector<Number>& AuxKernelTempl< Real >::_solution

protectedinherited

reference to the solution vector of auxiliary system

Definition at line 220 of file AuxKernel.h.

Referenced by NodalPatchRecovery::compute().

_stateful_allowed

bool MaterialPropertyInterface::_stateful_allowed

protectedinherited

True by default.

If false, this class throws an error if any of the stateful material properties interfaces are used.

Definition at line 536 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName(), and MaterialPropertyInterface::statefulPropertiesAllowed().

_subproblem

SubProblem& AuxKernelTempl< Real >::_subproblem

protectedinherited

Subproblem this kernel is part of.

Definition at line 164 of file AuxKernel.h.

Referenced by NearestNodeValueAux::NearestNodeValueAux(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), and TimeDerivativeAux::TimeDerivativeAux().

_sys

SystemBase& AuxKernelTempl< Real >::_sys

protectedinherited

System this kernel is part of.

Definition at line 166 of file AuxKernel.h.

_t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 61 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), AnalyticalIndicator::computeQpIntegral(), FunctionElementIntegral::computeQpIntegral(), ElementL2Error::computeQpIntegral(), ElementHCurlSemiError::computeQpIntegral(), ElementHDivSemiError::computeQpIntegral(), ElementL1Error::computeQpIntegral(), FunctionElementIntegralUserObject::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), FunctionDiffusion::computeQpJacobian(), VectorFunctionReaction::computeQpJacobian(), ArrayBodyForce::computeQpResidual(), FunctionDiffusion::computeQpResidual(), ConvectiveFluxBC::computeQpResidual(), ADVectorFunctionNeumannBC::computeQpResidual(), FunctionGradientNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), ADFunctionNeumannBC::computeQpResidual(), FVFunctionNeumannBC::computeQpResidual(), FunctionNeumannBC::computeQpResidual(), VectorCurlPenaltyDirichletBC::computeQpResidual(), VectorFunctionReaction::computeQpResidual(), VectorDivPenaltyDirichletBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), VectorPenaltyDirichletBC::computeQpResidual(), FVBodyForce::computeQpResidual(), ADConservativeAdvectionBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), SinDirichletBC::computeQpResidual(), ADFunctionPenaltyDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), ADVectorFunctionDirichletBC::computeQpValue(), ADFunctionDirichletBC::computeQpValue(), FunctionDirichletBC::computeQpValue(), TimedSubdomainModifier::computeSubdomainID(), FunctionArrayAux::computeValue(), ForcingFunctionAux::computeValue(), ArrayParsedAux::computeValue(), ParsedAux::computeValue(), ParsedVectorAux::computeValue(), FunctionScalarAux::computeValue(), VectorFunctionAux::computeValue(), FunctionAux::computeValue(), SolutionScalarAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), ConditionalFunctionEnableControl::conditionMet(), TimesEnableControl::conditionMet(), TimePeriod::conditionMet(), PIDChainControl::execute(), LineFunctionSampler::execute(), NodalL2Error::execute(), IterationInfo::execute(), SmootherChainControl::execute(), GetFunctionValueChainControl::execute(), BoolFunctionControl::execute(), ParsedChainControl::execute(), PIDTransientControl::execute(), RealFunctionControl::execute(), LeastSquaresFitHistory::execute(), TimeExtremeValue::execute(), UserForcingFunction::f(), ParsedPostprocessor::finalize(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), ParsedDownSelectionPositions::initialize(), ActivateElementsByPath::isElementActivated(), SolutionUserObject::solutionSampleTime(), SolutionUserObjectBase::updateExodusTimeInterpolation(), and ParsedConvergence::updateFunctionSymbolValues().

_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(), ChangeOverTimePostprocessor::finalize(), and ChangeOverFixedPointPostprocessor::finalize().

_test

const OutputTools<Real >::VariableTestValue& AuxKernelTempl< Real >::_test

protectedinherited

Dimension of the problem being solved.

Holds the the test functions

Definition at line 193 of file AuxKernel.h.

_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 AuxKernelTempl< Real >::_tid

protectedinherited

Thread ID.

Definition at line 171 of file AuxKernel.h.

Referenced by BoundsBase::BoundsBase(), NodalPatchRecovery::compute(), NodalPatchRecovery::reinitPatch(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), and TimeDerivativeAux::TimeDerivativeAux().

_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(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

_u

const OutputTools<Real >::VariableValue& AuxKernelTempl< Real >::_u

protectedinherited

Holds the solution at current quadrature points.

Definition at line 180 of file AuxKernel.h.

_use_interpolated_state

const bool MaterialPropertyInterface::_use_interpolated_state

protectedinherited

Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction.

Definition at line 554 of file MaterialPropertyInterface.h.

Referenced by Material::getGenericMaterialPropertyByName(), and MaterialPropertyInterface::getGenericMaterialPropertyByName().

_var

MooseVariableField<Real >& AuxKernelTempl< Real >::_var

protectedinherited

This is a regular kernel so we cast to a regular MooseVariable.

Definition at line 174 of file AuxKernel.h.

Referenced by AdvectiveFluxAux::AdvectiveFluxAux(), VolumeAux::compute(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), ProjectionAux::computeValue(), CopyValueAux::CopyValueAux(), DebugResidualAux::DebugResidualAux(), FunctorCoordinatesFunctionAux::FunctorCoordinatesFunctionAux(), MeshDivisionAux::MeshDivisionAux(), NodalPatchRecovery::NodalPatchRecovery(), ProjectionAux::ProjectionAux(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), TagMatrixAux::TagMatrixAux(), TagVectorAux::TagVectorAux(), and TimeDerivativeAux::TimeDerivativeAux().

_variable

MooseVariableFE<Real >* MooseVariableInterface< Real >::_variable

protectedinherited

Definition at line 227 of file MooseVariableInterface.h.

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

default_property_id

constexpr PropertyValue::id_type MaterialPropertyInterface::default_property_id

staticinherited

Initial value:

=
      PropertyValue::invalid_property_id - 1

The material property ID for a default (parsed from input) property.

Definition at line 75 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

zero_property_id

constexpr PropertyValue::id_type MaterialPropertyInterface::zero_property_id = PropertyValue::invalid_property_id - 2

staticinherited

The material property ID for a zero property.

Definition at line 78 of file MaterialPropertyInterface.h.

Referenced by MaterialBase::getGenericZeroMaterialProperty(), and MaterialPropertyInterface::getGenericZeroMaterialProperty().

---

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

• include/auxkernels/MaterialStdVectorRealGradientAux.h
• src/auxkernels/MaterialStdVectorRealGradientAux.C