IC that calls vectorValue method of a Function object. More...

#include <VectorFunctionIC.h>

Inheritance diagram for VectorFunctionIC:

Public Types
typedef OutputTools< T >::OutputShape	ValueType

typedef OutputTools< T >::OutputGradient	GradientType

typedef OutputTools< T >::OutputShapeGradient	GradientShapeType

typedef OutputTools< T >::OutputData	DataType

typedef FEGenericBase< ValueType >	FEBaseType

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
	VectorFunctionIC (const InputParameters &parameters)

virtual RealVectorValue	value (const Point &p) override
	The value of the variable at a point. More...

virtual MooseVariableFEBase &	variable () override
	retrieves the MOOSE variable that this initial condition acts upon More...

virtual void	compute () override
	Workhorse method for projecting the initial conditions for block initial conditions. More...

virtual void	computeNodal (const Point &p) override
	Workhorse method for projecting the initial conditions for boundary restricted initial conditions. More...

virtual GradientType	gradient (const Point &)
	The gradient of the variable at a point. More...

T	gradientComponent (GradientType grad, unsigned int i)

template<>
RealVectorValue	gradientComponent (GradientType grad, unsigned int i)

template<>
RealEigenVector	gradientComponent (GradientType grad, unsigned int i)

void	setCZeroVertices ()
	set the temporary solution vector for node projections of C0 variables More...

template<>
void	setCZeroVertices ()

void	setHermiteVertices ()
	set the temporary solution vector for node projections of Hermite variables More...

template<>
void	setHermiteVertices ()

void	setOtherCOneVertices ()
	set the temporary solution vector for node projections of non-Hermitian C1 variables More...

template<>
void	setOtherCOneVertices ()

Real	dotHelper (const RealGradient &op1, const RealGradient &op2)
	Helps perform multiplication of GradientTypes: a normal dot product for vectors and a contraction for tensors. More...

Real	dotHelper (const RealTensor &op1, const RealTensor &op2)

RealEigenVector	dotHelper (const RealVectorArrayValue &op1, const RealGradient &op2)

void	choleskySolve (bool is_volume)
	Perform the cholesky solves for edge, side, and interior projections. More...

template<>
void	choleskySolve (bool is_volume)

void	choleskyAssembly (bool is_volume)
	Assemble a small local system for cholesky solve. More...

const std::set< UserObjectName > &	getDependObjects () const
	getter method for dependent user objects More...

virtual void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. 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...

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 &	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
	Returns the path of a data file for a given FileName type parameter, searching (in the following order) More...

std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const
	Returns the path of a data file for a given relative file path. 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 (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...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 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 , 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 MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

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

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)


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)


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

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


bool	hasUserObjectByName (const UserObjectName &object_name) const

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


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

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

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


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

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<bool is_ad>
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
	A helper method to avoid circular #include problems. 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...


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)

Protected Attributes
const Function *const	_function
	Optional vectorValue function. More...

const Function &	_function_x
	Optional component function value. More...

const Function &	_function_y

const Function &	_function_z

FEProblemBase &	_fe_problem

THREAD_ID	_tid

Real &	_t
	Time. More...

MooseVariableField< T > &	_var
	The variable that this initial condition is acting upon. More...

MooseVariableFE< T > *	_fe_var

Assembly &	_assembly
	the finite element/volume assembly object More...

const Moose::CoordinateSystemType &	_coord_sys
	The coordinate system type for this problem, references the value in Assembly. More...

const Elem *const &	_current_elem
	The current element we are on will retrieving values at specific points in the domain. More...

const Real &	_current_elem_volume
	the volume of the current element More...

const Node *	_current_node
	The current node if the point we are evaluating at also happens to be a node. More...

unsigned int	_qp
	The current quadrature point, contains the "nth" node number when visiting nodes. More...

DenseMatrix< Real >	_Ke
	Matrix storage member. More...

DenseVector< DataType >	_Fe
	Linear b vector. More...

DenseVector< DataType >	_Ue
	Linear solution vector. More...

const FEType &	_fe_type
	The finite element type for the IC variable. More...

FEContinuity	_cont
	The type of continuity, e.g. C0, C1. More...

std::vector< dof_id_type >	_dof_indices
	The global DOF indices. More...

std::vector< unsigned int >	_side_dofs
	Side/edge DOF indices. More...

unsigned int	_n_qp
	The number of quadrature points for a given element. More...

unsigned int	_n_nodes
	The number of nodes for a given element. More...

std::vector< char >	_dof_is_fixed
	Whether the degree of freedom is fixed (true/false) More...

std::vector< int >	_free_dof
	Stores the ids of the free dofs. More...

dof_id_type	_free_dofs
	The number of free dofs. More...

dof_id_type	_current_dof
	The current dof being operated on. More...

dof_id_type	_nc
	number of dofs per node per variable More...

const std::vector< std::vector< ValueType > > *	_phi
	pointers to shape functions More...

const std::vector< std::vector< GradientShapeType > > *	_dphi
	pointers to shape function gradients More...

const std::vector< Real > *	_JxW
	pointers to the Jacobian * quadrature weights for current element More...

const std::vector< Point > *	_xyz_values
	pointers to the xyz coordinates of the quadrature points for the current element More...

unsigned int	_n
	node counter More...

unsigned int	_dim
	the mesh dimension More...

SystemBase &	_sys
	The system object. More...

const bool	_ignore_uo_dependency
	If set, UOs retrieved by this IC will not be executed before this IC. 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

const MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object. 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< DualReal > > >	_ad_default_value
	Will hold the default value for optional coupled variables for automatic differentiation. More...

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

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

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

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

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

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

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

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

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

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

const VariablePhiValue &	_phi_zero

const MooseArray< DualReal > &	_ad_zero

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

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

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

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

const MooseArray< ADRealTensorValue > &	_ad_second_zero

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

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

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

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

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

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

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

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

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

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

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

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

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

IC that calls vectorValue method of a Function object.

Definition at line 28 of file VectorFunctionIC.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface< MooseObject >::DataFileParameterType = DataFileName

inherited

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

Definition at line 26 of file DataFileInterface.h.

◆ DataType

template<typename T >

typedef OutputTools<T>::OutputData InitialConditionTempl< T >::DataType

inherited

Definition at line 36 of file InitialConditionTempl.h.

◆ FEBaseType

template<typename T >

typedef FEGenericBase<ValueType> InitialConditionTempl< T >::FEBaseType

inherited

Definition at line 37 of file InitialConditionTempl.h.

◆ GradientShapeType

template<typename T >

typedef OutputTools<T>::OutputShapeGradient InitialConditionTempl< T >::GradientShapeType

inherited

Definition at line 35 of file InitialConditionTempl.h.

◆ GradientType

template<typename T >

typedef OutputTools<T>::OutputGradient InitialConditionTempl< T >::GradientType

inherited

Definition at line 34 of file InitialConditionTempl.h.

◆ ValueType

template<typename T >

typedef OutputTools<T>::OutputShape InitialConditionTempl< T >::ValueType

inherited

Definition at line 33 of file InitialConditionTempl.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

◆ VectorFunctionIC()

VectorFunctionIC::VectorFunctionIC ( const InputParameters & parameters )

Definition at line 33 of file VectorFunctionIC.C.

   : VectorInitialCondition(parameters),
     _function(isParamValid("function") ? &getFunction("function") : nullptr),
     _function_x(getFunction("function_x")),
     _function_y(getFunction("function_y")),
     _function_z(getFunction("function_z"))
 {
   if (_function && parameters.isParamSetByUser("function_x"))
     paramError("function_x", "The 'function' and 'function_x' parameters cannot both be set.");
   if (_function && parameters.isParamSetByUser("function_y"))
     paramError("function_y", "The 'function' and 'function_y' parameters cannot both be set.");
   if (_function && parameters.isParamSetByUser("function_z"))
     paramError("function_z", "The 'function' and 'function_z' parameters cannot both be set.");
 }

Member Function Documentation

◆ 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 2004 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 2154 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 (_c_nodal)
     mooseError("Not implemented");
 
   if (!_coupleable_neighbor)
     return var->adUDot();
   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 2171 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 2636 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 2095 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 2112 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 2615 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 2077 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 2035 of file Coupleable.C.

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

◆ adCoupledSecond()

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

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 2129 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 2057 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 2426 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 2188 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 2222 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 2204 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 2433 of file Coupleable.C.

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

◆ addFEVariableCoupleableMatrixTag()

void Coupleable::addFEVariableCoupleableMatrixTag ( TagID tag )

inlineinherited

Definition at line 104 of file Coupleable.h.

Referenced by Coupleable::coupledMatrixTagValue().

104 { _fe_coupleable_matrix_tags.insert(tag); }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1706

◆ addFEVariableCoupleableVectorTag()

void Coupleable::addFEVariableCoupleableVectorTag ( TagID tag )

inlineinherited

Definition at line 102 of file Coupleable.h.

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

102 { _fe_coupleable_vector_tags.insert(tag); }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1704

◆ 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 2297 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 2304 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 2290 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 190 of file BlockRestrictable.C.

Referenced by FunctorMaterial::addFunctorProperty(), DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), NodalPatchRecoveryAuxBase::blockRestrictElements(), MooseMesh::cacheFaceInfoVariableOwnership(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), BlockRestrictable::getBlockCoordSystem(), MaterialBase::getGenericZeroMaterialPropertyByName(), BlockRestrictable::hasBlockMaterialPropertyHelper(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), MooseVariableBase::MooseVariableBase(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), MaterialBase::registerPropName(), and FVPointValueConstraint::setMyElem().

 {
   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 178 of file BlockRestrictable.C.

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

 {
   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 184 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 360 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(), 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 205 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);
 }

◆ 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 147 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 222 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.");
 }

◆ 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 118 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 208 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 333 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 (variable.activeSubdomains().count(Moose::INTERNAL_SIDE_LOWERD_ID) > 0)
     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.

179 { return true; }

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

◆ choleskyAssembly()

template<typename T >

void InitialConditionTempl< T >::choleskyAssembly ( bool is_volume )

inherited

Assemble a small local system for cholesky solve.

Definition at line 430 of file InitialConditionTempl.C.

 {
   // Loop over the quadrature points
   for (_qp = 0; _qp < _n_qp; _qp++)
   {
     // solution at the quadrature point
     auto fineval = value((*_xyz_values)[_qp]);
     // solution grad at the quadrature point
     GradientType finegrad;
     if (_cont == C_ONE)
       finegrad = gradient((*_xyz_values)[_qp]);
 
     auto dofs_size = is_volume ? _dof_indices.size() : _side_dofs.size();
 
     // Form edge projection matrix
     for (decltype(dofs_size) geomi = 0, freei = 0; geomi != dofs_size; ++geomi)
     {
       auto i = is_volume ? geomi : _side_dofs[geomi];
 
       // fixed DoFs aren't test functions
       if (_dof_is_fixed[i])
         continue;
       for (decltype(dofs_size) geomj = 0, freej = 0; geomj != dofs_size; ++geomj)
       {
         auto j = is_volume ? geomj : _side_dofs[geomj];
         if (_dof_is_fixed[j])
           _Fe(freei) -= (*_phi)[i][_qp] * (*_phi)[j][_qp] * (*_JxW)[_qp] * _Ue(j);
         else
           _Ke(freei, freej) += (*_phi)[i][_qp] * (*_phi)[j][_qp] * (*_JxW)[_qp];
         if (_cont == C_ONE)
         {
           if (_dof_is_fixed[j])
             _Fe(freei) -= dotHelper((*_dphi)[i][_qp], (*_dphi)[j][_qp]) * (*_JxW)[_qp] * _Ue(j);
           else
             _Ke(freei, freej) += dotHelper((*_dphi)[i][_qp], (*_dphi)[j][_qp]) * (*_JxW)[_qp];
         }
         if (!_dof_is_fixed[j])
           freej++;
       }
       _Fe(freei) += (*_phi)[i][_qp] * fineval * (*_JxW)[_qp];
       if (_cont == C_ONE)
         _Fe(freei) += dotHelper(finegrad, (*_dphi)[i][_qp]) * (*_JxW)[_qp];
       freei++;
     }
   }
 }

◆ choleskySolve() [1/2]

template<typename T >

void InitialConditionTempl< T >::choleskySolve ( bool is_volume )

inherited

Perform the cholesky solves for edge, side, and interior projections.

Definition at line 479 of file InitialConditionTempl.C.

 {
   _Ke.resize(_free_dofs, _free_dofs);
   _Ke.zero();
   _Fe.resize(_free_dofs);
   _Fe.zero();
 
   choleskyAssembly(is_volume);
 
   // The new edge coefficients
   DenseVector<DataType> U(_free_dofs);
 
   _Ke.cholesky_solve(_Fe, U);
 
   // Transfer new edge solutions to element
   for (unsigned int i = 0; i != _free_dofs; ++i)
   {
     auto the_dof = is_volume ? _free_dof[i] : _side_dofs[_free_dof[i]];
     DataType & ui = _Ue(the_dof);
     libmesh_assert(std::abs(ui) < TOLERANCE || std::abs(ui - U(i)) < TOLERANCE);
     ui = U(i);
     _dof_is_fixed[the_dof] = true;
   }
 }

◆ choleskySolve() [2/2]

template<>

void InitialConditionTempl< RealEigenVector >::choleskySolve ( bool is_volume )

inherited

Definition at line 506 of file InitialConditionTempl.C.

 {
   _Ke.resize(_free_dofs, _free_dofs);
   _Ke.zero();
   _Fe.resize(_free_dofs);
   for (unsigned int i = 0; i < _free_dofs; ++i)
     _Fe(i).setZero(_var.count());
 
   choleskyAssembly(is_volume);
 
   // The new edge coefficients
   DenseVector<DataType> U = _Fe;
 
   for (unsigned int i = 0; i < _var.count(); ++i)
   {
     DenseVector<Real> v(_free_dofs), x(_free_dofs);
     for (unsigned int j = 0; j < _free_dofs; ++j)
       v(j) = _Fe(j)(i);
 
     _Ke.cholesky_solve(v, x);
 
     for (unsigned int j = 0; j < _free_dofs; ++j)
       U(j)(i) = x(j);
   }
 
   // Transfer new edge solutions to element
   for (unsigned int i = 0; i != _free_dofs; ++i)
   {
     auto the_dof = is_volume ? _free_dof[i] : _side_dofs[_free_dof[i]];
     DataType & ui = _Ue(the_dof);
     libmesh_assert(ui.matrix().norm() < TOLERANCE || (ui - U(i)).matrix().norm() < TOLERANCE);
     ui = U(i);
     _dof_is_fixed[the_dof] = true;
   }
 }

◆ compute()

template<typename T >

void InitialConditionTempl< T >::compute ( )

overridevirtualinherited

Workhorse method for projecting the initial conditions for block initial conditions.

Implements InitialConditionBase.

Definition at line 46 of file InitialConditionTempl.C.

 {
   // -- NOTE ----
   // The following code is a copy from libMesh project_vector.C plus it adds some features, so we
   // can couple variable values
   // and we also do not call any callbacks, but we use our initial condition system directly.
   // ------------
 
   // The dimension of the current element
   _dim = _current_elem->dim();
   // The element type
   const ElemType elem_type = _current_elem->type();
   // The number of nodes on the new element
   const unsigned int n_nodes = _current_elem->n_nodes();
 
   // Get FE objects of the appropriate type
   // We cannot use the FE object in Assembly, since the following code is messing with the
   // quadrature rules
   // for projections and would screw it up. However, if we implement projections from one mesh to
   // another,
   // this code should use that implementation.
   std::unique_ptr<FEBaseType> fe(FEBaseType::build(_dim, _fe_type));
 
   // Prepare variables for projection
   std::unique_ptr<QBase> qrule(_fe_type.default_quadrature_rule(_dim));
   std::unique_ptr<QBase> qedgerule(_fe_type.default_quadrature_rule(1));
   std::unique_ptr<QBase> qsiderule(_fe_type.default_quadrature_rule(_dim - 1));
 
   // The values of the shape functions at the quadrature points
   _phi = &fe->get_phi();
 
   // The gradients of the shape functions at the quadrature points on the child element.
   _dphi = nullptr;
 
   _cont = fe->get_continuity();
 
   if (_cont == C_ONE)
   {
     const std::vector<std::vector<GradientShapeType>> & ref_dphi = fe->get_dphi();
     _dphi = &ref_dphi;
   }
 
   // The Jacobian * quadrature weight at the quadrature points
   _JxW = &fe->get_JxW();
   // The XYZ locations of the quadrature points
   _xyz_values = &fe->get_xyz();
 
   // Update the DOF indices for this element based on the current mesh
   _var.prepareIC();
   _dof_indices = _var.dofIndices();
 
   // The number of DOFs on the element
   const unsigned int n_dofs = _dof_indices.size();
   if (n_dofs == 0)
     return;
 
   // Fixed vs. free DoFs on edge/face projections
   _dof_is_fixed.clear();
   _dof_is_fixed.resize(n_dofs, false);
   _free_dof.clear();
   _free_dof.resize(n_dofs, 0);
 
   // Zero the interpolated values
   _Ue.resize(n_dofs);
   _Ue.zero();
 
   DenseVector<char> mask(n_dofs, true);
 
   // In general, we need a series of
   // projections to ensure a unique and continuous
   // solution.  We start by interpolating nodes, then
   // hold those fixed and project edges, then
   // hold those fixed and project faces, then
   // hold those fixed and project interiors
 
   // Interpolate node values first
   _current_dof = 0;
 
   for (_n = 0; _n != n_nodes; ++_n)
   {
     _nc = FEInterface::n_dofs_at_node(_dim, _fe_type, elem_type, _n);
 
     // for nodes that are in more than one subdomain, only compute the initial
     // condition once on the lowest numbered block
     auto curr_node = _current_elem->node_ptr(_n);
     const auto & block_ids = _sys.mesh().getNodeBlockIds(*curr_node);
 
     auto priority_block = *(block_ids.begin());
     for (auto id : block_ids)
       if (_var.hasBlocks(id))
       {
         priority_block = id;
         break;
       }
 
     if (!hasBlocks(priority_block) && _var.isNodal())
     {
       for (decltype(_nc) i = 0; i < _nc; ++i)
       {
         mask(_current_dof) = false;
         _current_dof++;
       }
       continue;
     }
 
     // FIXME: this should go through the DofMap,
     // not duplicate _dof_indices code badly!
     if (!_current_elem->is_vertex(_n))
     {
       _current_dof += _nc;
       continue;
     }
 
     if (_cont == DISCONTINUOUS || _cont == H_CURL || _cont == H_DIV)
       libmesh_assert(_nc == 0);
     else if (_cont == C_ZERO)
       setCZeroVertices();
     else if (_fe_type.family == HERMITE)
       setHermiteVertices();
     else if (_cont == C_ONE)
       setOtherCOneVertices();
     else if (_cont == SIDE_DISCONTINUOUS)
       continue;
     else
       libmesh_error();
   } // loop over nodes
 
   // From here on out we won't be sampling at nodes anymore
   _current_node = nullptr;
 
   auto & dof_map = _var.dofMap();
   const bool add_p_level =
       dof_map.should_p_refine(dof_map.var_group_from_var_number(_var.number()));
 
   // In 3D, project any edge values next
   if (_dim > 2 && _cont != DISCONTINUOUS)
     for (unsigned int e = 0; e != _current_elem->n_edges(); ++e)
     {
       FEInterface::dofs_on_edge(_current_elem, _dim, _fe_type, e, _side_dofs, add_p_level);
 
       // Some edge dofs are on nodes and already
       // fixed, others are free to calculate
       _free_dofs = 0;
       for (unsigned int i = 0; i != _side_dofs.size(); ++i)
         if (!_dof_is_fixed[_side_dofs[i]])
           _free_dof[_free_dofs++] = i;
 
       // There may be nothing to project
       if (!_free_dofs)
         continue;
 
       // Initialize FE data on the edge
       fe->attach_quadrature_rule(qedgerule.get());
       fe->edge_reinit(_current_elem, e);
       _n_qp = qedgerule->n_points();
 
       choleskySolve(false);
     }
 
   // Project any side values (edges in 2D, faces in 3D)
   if (_dim > 1 && _cont != DISCONTINUOUS)
     for (unsigned int s = 0; s != _current_elem->n_sides(); ++s)
     {
       FEInterface::dofs_on_side(_current_elem, _dim, _fe_type, s, _side_dofs, add_p_level);
 
       // Some side dofs are on nodes/edges and already
       // fixed, others are free to calculate
       _free_dofs = 0;
       for (unsigned int i = 0; i != _side_dofs.size(); ++i)
         if (!_dof_is_fixed[_side_dofs[i]])
           _free_dof[_free_dofs++] = i;
 
       // There may be nothing to project
       if (!_free_dofs)
         continue;
 
       // Initialize FE data on the side
       fe->attach_quadrature_rule(qsiderule.get());
       fe->reinit(_current_elem, s);
       _n_qp = qsiderule->n_points();
 
       choleskySolve(false);
     }
 
   // Project the interior values, finally
 
   // Some interior dofs are on nodes/edges/sides and
   // already fixed, others are free to calculate
   _free_dofs = 0;
   for (unsigned int i = 0; i != n_dofs; ++i)
     if (!_dof_is_fixed[i])
       _free_dof[_free_dofs++] = i;
 
   // There may be nothing to project
   if (_free_dofs)
   {
     // Initialize FE data
     fe->attach_quadrature_rule(qrule.get());
     fe->reinit(_current_elem);
     _n_qp = qrule->n_points();
 
     choleskySolve(true);
   } // if there are free interior dofs
 
   // Make sure every DoF got reached!
   for (unsigned int i = 0; i != n_dofs; ++i)
     libmesh_assert(_dof_is_fixed[i]);
 
   // Lock the new_vector since it is shared among threads.
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     for (size_t i = 0; i < mask.size(); i++)
       if (mask(i))
         _var.setDofValue(_Ue(i), i);
   }
 }

◆ computeNodal()

template<typename T >

void InitialConditionTempl< T >::computeNodal ( const Point & p )

overridevirtualinherited

Workhorse method for projecting the initial conditions for boundary restricted initial conditions.

Implements InitialConditionBase.

Definition at line 544 of file InitialConditionTempl.C.

 {
   _var.reinitNode();
   _var.computeNodalValues(); // has to call this to resize the internal array
   auto return_value = value(p);
 
   _var.setNodalValue(return_value); // update variable data, which is referenced by others, so the
                                     // value is up-to-date
 
   // We are done, so update the solution vector
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     _var.insert(_var.sys().solution());
   }
 }

◆ 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())
     {
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name);
     }
   }
 }

◆ 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 441 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 1943 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 1963 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 1983 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 1991 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 1318 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 1340 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 1384 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 vector variable
comp	Component number for vector of coupled vector variables

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

Definition at line 1456 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 1362 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 1626 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 1665 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 1639 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 1652 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 vector variable
comp	Component number for vector of coupled vector variables

Returns: Reference to a ArrayVariableValue for the coupled vector variable

See also: ArrayKernel::_u

Definition at line 834 of file Coupleable.C.

Referenced by Coupleable::coupledArrayValues().

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

◆ coupledArrayValueOld()

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

protectedvirtualinherited

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

Parameters

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

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

See also: ArrayKernel::_u_old

Definition at line 1078 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 variable
comp	Component number for vector of coupled variables

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

See also: ArrayKernel::_u_older

Definition at line 1100 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 856 of file Coupleable.C.

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

◆ coupledCallback()

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

inlineprotectedvirtualinherited

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

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

Definition at line 135 of file Coupleable.h.

Referenced by Coupleable::checkFuncType().

135 {}

◆ coupledComponents()

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

protectedinherited

Number of coupled components.

Parameters

var_name Name of the variable

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

Definition at line 157 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 1678 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 1694 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 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::Older);
 
   if (!_coupleable_neighbor)
     return var->curlSlnOlder();
   return var->curlSlnOlderNeighbor();
 }

◆ 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 1930 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 1950 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 1970 of file Coupleable.C.

Referenced by Coupleable::coupledAllDofValuesOlder().

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

◆ coupledDot()

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

protectedvirtualinherited

Time derivative of a coupled variable.

Parameters

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

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

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

Definition at line 1122 of file Coupleable.C.

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

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

◆ coupledDotDot()

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

protectedvirtualinherited

Second time derivative of a coupled variable.

Parameters

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

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

Definition at line 1147 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 1431 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 1197 of file Coupleable.C.

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

◆ coupledDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

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

Definition at line 1406 of file Coupleable.C.

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

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

◆ coupledDotOld()

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

protectedvirtualinherited

Old time derivative of a coupled variable.

Parameters

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

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

Definition at line 1172 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 2629 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 574 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 581 of file Coupleable.C.

 {
   return adCoupledDofValues(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 2354 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 2361 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 2601 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 2608 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);
 }

◆ 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 469 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 476 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 2413 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 2420 of file Coupleable.C.

 {
   return adCoupledValues(var_name);
 }

◆ 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 1481 of file Coupleable.C.

Referenced by Coupleable::coupledGradients(), NodeElemConstraint::coupledSecondaryGradient(), 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 1546 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 1562 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 1497 of file Coupleable.C.

Referenced by Coupleable::coupledGradientsOld(), NodeElemConstraint::coupledSecondaryGradientOld(), 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 1513 of file Coupleable.C.

Referenced by NodeElemConstraint::coupledSecondaryGradientOlder(), and 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 1529 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 2593 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 2622 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 2367 of file Coupleable.C.

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

◆ coupledMatrixTagValue() [1/2]

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

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 776 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 793 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 2556 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 2564 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 2374 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 2391 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 1868 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 1882 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 1914 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 1898 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 1792 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 1812 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 1832 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 1852 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();
 }

◆ 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 1726 of file Coupleable.C.

Referenced by NodeElemConstraint::coupledSecondarySecond(), and 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 1742 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 1758 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 1774 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 482 of file Coupleable.C.

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

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

◆ coupledValueLower()

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

protectedvirtualinherited

Returns value of a coupled lower-dimensional variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 587 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 985 of file Coupleable.C.

Referenced by NodeElemConstraint::coupledSecondaryValueOld(), 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 1007 of file Coupleable.C.

Referenced by NodeElemConstraint::coupledSecondaryValueOlder(), 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 1029 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 2398 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 2579 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 2586 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 1222 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 1238 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 1302 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 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::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 1286 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 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::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 1578 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 1594 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 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::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 1608 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 768 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 674 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 696 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 2510 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 2518 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 620 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 628 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 2464 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 2472 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 752 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 760 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 2533 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 2541 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 636 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 658 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 2487 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 2495 of file Coupleable.C.

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

◆ coupledVectorTagValue() [1/2]

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

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 604 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 612 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 2441 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 2449 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 809 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 1052 of file Coupleable.C.

 {
   const auto * var = getVectorVar(var_name, comp);
   if (!var)
     return *getDefaultVectorValue(var_name);
   checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
   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 1065 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 2405 of file Coupleable.C.

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

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

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

◆ dotHelper() [1/3]

template<typename T >

Real InitialConditionTempl< T >::dotHelper	(	const RealGradient &	op1,
		const RealGradient &	op2
	)

inlineinherited

Helps perform multiplication of GradientTypes: a normal dot product for vectors and a contraction for tensors.

Definition at line 90 of file InitialConditionTempl.h.

90 { return op1 * op2; }

◆ dotHelper() [2/3]

template<typename T >

Real InitialConditionTempl< T >::dotHelper	(	const RealTensor &	op1,
		const RealTensor &	op2
	)

inlineinherited

Definition at line 91 of file InitialConditionTempl.h.

91 { return op1.contract(op2); }

libMesh::TensorValue::contract

CompareTypes< T, T2 >::supertype contract(const TypeTensor< T2 > &) const

◆ dotHelper() [3/3]

template<typename T >

RealEigenVector InitialConditionTempl< T >::dotHelper	(	const RealVectorArrayValue &	op1,
		const RealGradient &	op2
	)

inlineinherited

Definition at line 92 of file InitialConditionTempl.h.

   {
     RealEigenVector v = op1.col(0) * op2(0);
     for (const auto i : make_range(Moose::dim))
       v += op1.col(i) * op2(i);
     return v;
   }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 50 of file MooseObject.h.

Referenced by EigenKernel::enabled().

50 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition: MooseObject.h:61

◆ 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::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 2326 of file Coupleable.C.

 {
   return _grad_zero;
 }

◆ genericZeroGradient() [3/3]

template<>

const GenericVariableGradient<true>& Coupleable::genericZeroGradient ( )

protectedinherited

Definition at line 2333 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 2340 of file Coupleable.C.

 {
   return _second_zero;
 }

◆ genericZeroSecond() [3/3]

template<>

const GenericVariableSecond<true>& Coupleable::genericZeroSecond ( )

protectedinherited

Definition at line 2347 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 2312 of file Coupleable.C.

 {
   return _zero;
 }

◆ genericZeroValue() [3/3]

template<>

const GenericVariableValue<true>& Coupleable::genericZeroValue ( )

protectedinherited

Definition at line 2319 of file Coupleable.C.

 {
   return _ad_zero;
 }

◆ 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: VariableGradient * a pointer to the associated VariableGradient.

Definition at line 2269 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: VariableSecond * a pointer to the associated VariableSecond.

Definition at line 2283 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 VarirableValue.

Definition at line 2238 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: VariableGradient * a pointer to the associated VectorVariableGradient.

Definition at line 2276 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: VariableVectorValue * a pointer to the associated VarirableVectorValue.

Definition at line 2252 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 305 of file Coupleable.C.

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

◆ getArrayVar() [2/2]

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

protectedinherited

Extract pointer to a coupled array variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 328 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 311 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 268 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;
   }

◆ 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(), DomainUserObject::DomainUserObject(), ElementIndicator::ElementIndicator(), ElementUserObject::ElementUserObject(), InterfaceMaterial::InterfaceMaterial(), InterfaceUserObjectBase::InterfaceUserObjectBase(), InternalSideIndicator::InternalSideIndicator(), InternalSideUserObject::InternalSideUserObject(), Material::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalScalarKernel::NodalScalarKernel(), NodalUserObject::NodalUserObject(), and SideUserObject::SideUserObject().

   {
     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< MooseObject >::getDataFileName ( const std::string & param ) const

inherited

Returns the path of a data file for a given FileName type parameter, searching (in the following order)

relative to the input file directory
relative to the running binary (assuming the application is installed)
relative to all registered data file directories

Definition at line 24 of file DataFileInterface.C.

 {
   // The path from the parameters, which has not been modified because it is a DataFileName
   const auto & value = _parent.template getParam<DataFileParameterType>(param);
   if (value.empty())
     _parent.paramInfo(param, "Data file name is empty");
 
   const std::filesystem::path value_path = std::filesystem::path(std::string(value));
 
   // If the file is absolute, we should reference that directly and don't need to add
   // any info beacuse this is not ambiguous
   if (value_path.is_absolute() && MooseUtils::checkFileReadable(value, false, false, false))
     return value;
 
   // Look relative to the input file
   const auto base = _parent.parameters().getParamFileBase(param);
   const std::string relative_to_context = std::filesystem::absolute(base / value_path).c_str();
   if (MooseUtils::checkFileReadable(relative_to_context, false, false, false))
   {
     _parent.paramInfo(param, "Data file '", value, "' found relative to the input file.");
     return relative_to_context;
   }
 
   // Isn't absolute and couldn't find relative to the input file, so search the data
   return getDataFileNameByName(value, &param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface< MooseObject >::getDataFileNameByName	(	const std::string &	name,
		const std::string *	param = `nullptr`
	)		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. The optional param pointer can be used to turn the mooseErrors this function emits into paramErrors

relative to the running binary (assuming the application is installed)
relative to all registered data file directories

Definition at line 53 of file DataFileInterface.C.

 {
   const auto share_dir = MooseUtils::pathjoin(Moose::getExecutablePath(), "..", "share");
   if (MooseUtils::pathIsDirectory(share_dir))
   {
     const auto dirs = MooseUtils::listDir(share_dir, false);
     for (const auto & data_dir : dirs)
     {
       const auto path = MooseUtils::pathjoin(data_dir, "data", relative_path);
       if (MooseUtils::checkFileReadable(path, false, false, false))
       {
         if (param)
           _parent.paramInfo(
               *param, "Data file '", path, "' found in an installed app distribution.");
         else
           mooseInfo("Data file '", path, "' found in an installed app distribution.");
         return path;
       }
     }
   }
 
   for (const auto & data_dir : Registry::getRegistry().getDataFilePaths())
   {
     const auto path = MooseUtils::pathjoin(data_dir, relative_path);
     if (MooseUtils::checkFileReadable(path, false, false, false))
     {
       if (param)
         _parent.paramInfo(*param, "Data file '", path, "' found in a source repository.");
       else
         mooseInfo("Data file '", path, "' found in a source repository.");
       return path;
     }
   }
 
   mooseException(param ? _parent.parameters().inputLocation(*param) : _parent.name(),
                  ": Unable to find data file '",
                  relative_path,
                  "' anywhere");
 }

◆ getDependObjects()

const std::set<UserObjectName>& InitialConditionBase::getDependObjects ( ) const

inlineinherited

getter method for dependent user objects

Definition at line 70 of file InitialConditionBase.h.

70 { return _depend_uo; }

InitialConditionBase::_depend_uo

std::set< UserObjectName > _depend_uo

Depend UserObjects. Mutable so that the getters can be const and still add dependencies.

Definition: InitialConditionBase.h:111

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

◆ 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 267 of file Coupleable.C.

 {
   mooseDeprecated("Coupleable::getFEVar is deprecated. Please use Coupleable::getFieldVar instead. "
                   "Note that this method could potentially return a finite volume variable");
   return getFieldVar(var_name, comp);
 }

◆ getFEVariableCoupleableMatrixTags() [1/2]

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

inlineinherited

Definition at line 108 of file Coupleable.h.

108 { return _fe_coupleable_matrix_tags; }

Coupleable::_fe_coupleable_matrix_tags

std::set< TagID > _fe_coupleable_matrix_tags

Definition: Coupleable.h:1706

◆ getFEVariableCoupleableMatrixTags() [2/2]

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

inlineinherited

Definition at line 115 of file Coupleable.h.

   {
     return _fe_coupleable_matrix_tags;
   }

◆ getFEVariableCoupleableVectorTags() [1/2]

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

inlineinherited

Definition at line 106 of file Coupleable.h.

Referenced by ComputeUserObjectsThread::subdomainChanged(), and MooseObjectWarehouseBase< Indicator >::updateFEVariableCoupledVectorTagDependencyHelper().

106 { return _fe_coupleable_vector_tags; }

Coupleable::_fe_coupleable_vector_tags

std::set< TagID > _fe_coupleable_vector_tags

Definition: Coupleable.h:1704

◆ 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 281 of file Coupleable.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), Coupleable::coupled(), Coupleable::coupledName(), Coupleable::getFEVar(), DomainUserObject::getInterfaceFieldVar(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), and ParsedAux::ParsedAux().

 {
   return getVarHelper<MooseVariableFieldBase>(var_name, comp);
 }

◆ getFieldVar() [2/2]

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

protectedinherited

Definition at line 275 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);
 }

◆ getGenericMaterialProperty() [1/2]

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/2]

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

◆ 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 189 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 195 of file MaterialPropertyInterface.C.

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

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

◆ getMaterialProperty() [1/2]

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/2]

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 87 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 81 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 93 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 99 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.

320 { return _get_material_property_called; }

MaterialPropertyInterface::_get_material_property_called

bool _get_material_property_called

Initialized to false.

Definition: MaterialPropertyInterface.h:543

◆ 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 73 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]

template<typename T >

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

inlineinherited

Definition at line 108 of file MaterialPropertyInterface.h.

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

◆ 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]

template<typename T >

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

inlineinherited

Definition at line 113 of file MaterialPropertyInterface.h.

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

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

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

inlineinherited

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

Definition at line 328 of file MaterialPropertyInterface.h.

Referenced by 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 ReporterTransferInterface::checkHasReporterValue(), Coupleable::checkWritableVar(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ 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 204 of file MooseBaseParameterInterface.h.

 {
   return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0), &_moose_base);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 261 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ 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(), ParsedPostprocessor::ParsedPostprocessor(), and PicardSolve::PicardSolve().

 {
   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(), SteffensenSolve::transformPostprocessors(), SecantSolve::transformPostprocessors(), PicardSolve::transformPostprocessors(), and VectorOfPostprocessors::VectorOfPostprocessors().

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 0);
 }

◆ getPostprocessorValueOld()

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

inherited

Definition at line 43 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueInternal(param_name, index, /* t_index = */ 1);
 }

◆ getPostprocessorValueOldByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOldByName ( const PostprocessorName & name ) const

inherited

Definition at line 63 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 1);
 }

◆ getPostprocessorValueOlder()

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

inherited

Definition at line 50 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueInternal(param_name, index, /* t_index = */ 2);
 }

◆ getPostprocessorValueOlderByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlderByName ( const PostprocessorName & name ) const

inherited

Definition at line 69 of file PostprocessorInterface.C.

 {
   return getPostprocessorValueByNameInternal(name, /* t_index = */ 2);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 211 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 > & InitialConditionBase::getRequestedItems ( )

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 69 of file InitialConditionBase.C.

 {
   return _depend_vars;
 }

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

◆ 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 72 of file MooseObject.C.

 {
   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 85 of file MooseObject.C.

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSuppliedItems()

const std::set< std::string > & InitialConditionBase::getSuppliedItems ( )

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 75 of file InitialConditionBase.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 160 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 79 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 91 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 167 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 34 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 287 of file Coupleable.C.

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

◆ getVar() [2/2]

const MooseVariable * Coupleable::getVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 311 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 1777 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 1723 of file Coupleable.h.

 {
   const auto var_name = _c_parameters.checkForRename(var_name_in);
   auto name_to_use = var_name;
 
   // First check for supplied name
   if (!checkVar(var_name, comp, 0))
   {
     // See if there is an associated deprecated name that the user may have used instead
     auto it = _new_to_deprecated_coupled_vars.find(var_name);
     if (it == _new_to_deprecated_coupled_vars.end())
       return nullptr;
     else
     {
       auto deprecated_name = it->second;
       if (checkVar(deprecated_name, comp, 0))
         name_to_use = deprecated_name;
       else
         return nullptr;
     }
   }
 
   auto coupled_vars_it = _coupled_vars.find(name_to_use);
 
   mooseAssert(coupled_vars_it != _coupled_vars.end(),
               "Trying to get a coupled var " << name_to_use << " that doesn't exist");
 
   if (auto coupled_var = dynamic_cast<T *>(coupled_vars_it->second[comp]))
     return coupled_var;
   else
   {
     for (auto & var : _coupled_standard_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a standard variable, try a "
                    "'coupled[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_vector_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a vector variable, try a "
                    "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_array_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is an array variable, try a "
                    "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
     for (auto & var : _coupled_standard_fv_moose_vars)
       if (var->name() == name_to_use)
         mooseError("The named variable is a finite volume variable, which the coupled[...] routine "
                    "used does not support. Try using the functor system routines instead.");
     mooseError(
         "Variable '", name_to_use, "' is of a different C++ type than you tried to fetch it as.");
   }
 }

◆ getVectorVar() [1/2]

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

protectedinherited

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 293 of file Coupleable.C.

 {
   auto * const var =
       const_cast<VectorMooseVariable *>(getVarHelper<VectorMooseVariable>(var_name, comp));
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getVectorVar() [2/2]

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

protectedinherited

Extract pointer to a coupled vector variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns: Pointer to the desired variable

Definition at line 317 of file Coupleable.C.

 {
   const auto * const var = getVarHelper<VectorMooseVariable>(var_name, comp);
 
   if (_c_nodal && var && var->feType().family != LAGRANGE_VEC)
     mooseError(_c_name, ": Only LAGRANGE_VEC vector variables are defined at nodes");
 
   return var;
 }

◆ getWritableCoupledVariables()

auto& Coupleable::getWritableCoupledVariables ( ) const

inlineinherited

returns a reference to the set of writable coupled variables

Definition at line 123 of file Coupleable.h.

Referenced by Coupleable::hasWritableCoupledVariables().

123 { return _writable_coupled_variables[_c_tid]; }

Coupleable::_c_tid

THREAD_ID _c_tid

Thread ID of the thread using this object.

Definition: Coupleable.h:1358

Coupleable::_writable_coupled_variables

std::vector< std::set< MooseWritableVariable * > > _writable_coupled_variables

keep a set of allocated writable variable references to make sure only one object can obtain them per...

Definition: Coupleable.h:1718

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

template<typename T >

virtual GradientType InitialConditionTempl< T >::gradient ( const Point & )

inlinevirtualinherited

The gradient of the variable at a point.

This is optional. Note that if you are using C1 continuous elements you will want to use an initial condition that defines this!

Reimplemented in FunctionIC, and ArrayFunctionIC.

Definition at line 69 of file InitialConditionTempl.h.

69 { return GradientType(); };

InitialConditionTempl::GradientType

OutputTools< T >::OutputGradient GradientType

Definition: InitialConditionTempl.h:34

◆ gradientComponent() [1/3]

template<typename T >

T InitialConditionTempl< T >::gradientComponent	(	GradientType	grad,
		unsigned int	i
	)

inherited

Definition at line 294 of file InitialConditionTempl.C.

 {
   return grad(i);
 }

◆ gradientComponent() [2/3]

template<>

RealVectorValue InitialConditionTempl< RealVectorValue >::gradientComponent	(	GradientType	grad,
		unsigned int	i
	)

inherited

Definition at line 301 of file InitialConditionTempl.C.

 {
   return grad.row(i);
 }

◆ gradientComponent() [3/3]

template<>

RealEigenVector InitialConditionTempl< RealEigenVector >::gradientComponent	(	GradientType	grad,
		unsigned int	i
	)

inherited

Definition at line 308 of file InitialConditionTempl.C.

 {
   return grad.col(i);
 }

◆ 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 264 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 275 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/5]

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 205 of file BlockRestrictable.C.

Referenced by LinearFVFluxKernel::addMatrixContribution(), DiracKernelBase::addPoint(), LinearFVFluxKernel::addRightHandSideContribution(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), DomainUserObject::checkVariable(), ComputeJacobianThread::compute(), DomainUserObject::DomainUserObject(), ExtraIDIntegralVectorPostprocessor::execute(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), BlockRestrictable::hasBlocks(), MooseVariableField< Real >::hasBlocks(), FVFluxKernel::hasFaceSide(), and PointwiseRenormalizeVector::PointwiseRenormalizeVector().

 {
   // 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/5]

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 215 of file BlockRestrictable.C.

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

◆ hasBlocks() [3/5]

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 221 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() [4/5]

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 230 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/5]

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

82 { return _id_mesh->hasElementID(id_name); }

ElementIDInterface::_id_mesh

std::shared_ptr< MooseMesh > & _id_mesh

References to the mesh and displaced mesh (currently in the ActionWarehouse)

Definition: ElementIDInterface.h:151

◆ 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 67 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 175 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 73 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 182 of file UserObjectInterface.h.

 {
   if (!hasUserObjectByName(object_name))
     return false;
   return dynamic_cast<const T *>(&_uoi_feproblem.getUserObjectBase(object_name));
 }

◆ hasWritableCoupledVariables()

bool Coupleable::hasWritableCoupledVariables ( ) const

inlineinherited

Checks whether the object has any writable coupled variables.

Definition at line 128 of file Coupleable.h.

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

Coupleable::getWritableCoupledVariables

auto & getWritableCoupledVariables() const

returns a reference to the set of writable coupled variables

Definition: Coupleable.h:123

◆ 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 = ", ";
       }
       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()

virtual void InitialConditionBase::initialSetup ( )

inlinevirtualinherited

Gets called at the beginning of the simulation before this object is asked to do its job.

Note: This method is normally inherited from SetupInterface. However in this case it makes no sense to inherit the other virtuals available in that class so we are adding this virtual directly to this class with out the extra inheritance.

Reimplemented in RandomICBase, IntegralPreservingFunctionIC, and SolutionIC.

Definition at line 88 of file InitialConditionBase.h.

88 {}

◆ 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 246 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 262 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 128 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 151 of file Coupleable.C.

Referenced by Coupleable::coupledName(), and DerivativeFunctionMaterialBaseTempl< is_ad >::DerivativeFunctionMaterialBaseTempl().

 {
   return _c_parameters.hasDefaultCoupledValue(var_name);
 }

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

◆ 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 117 of file MooseBaseParameterInterface.h.

Referenced by SetupDebugAction::act(), SetAdaptivityOptionsAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), PhysicsBase::checkSecondParamSetOnlyIfFirstOneTrue(), LibtorchNeuralNetControl::conditionalParameterError(), FixedPointSolve::FixedPointSolve(), MooseBaseParameterInterface::getRenamedParam(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObject::readXda(), and SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator().

117 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

bool isParamSetByUser(const std::string &name) const

Method returns true if the parameter was by the user.

Definition: InputParameters.C:1074

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:162

◆ 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 111 of file MooseBaseParameterInterface.h.

111 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:162

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:376

◆ markMatPropRequested()

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

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 135 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 269 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();
 }

◆ 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(), Executioner::augmentedPicardConvergenceCheck(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), 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(), Executioner::picardSolve(), ReferenceResidualProblem::ReferenceResidualProblem(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

   {
     moose::internal::mooseDeprecatedStream(_console, false, true, 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.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

void MooseBaseErrorInterface::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

void MooseBaseErrorInterface::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 97 of file MooseBaseErrorInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualProblem::ReferenceResidualProblem(), FEProblemBase::setRestartFile(), and SymmetryTransformGenerator::SymmetryTransformGenerator().

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

◆ mooseWarning()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

Referenced by AddKernelAction::act(), SetupMeshAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), BoundsBase::BoundsBase(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), PhysicsBase::checkRequiredTasks(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), Positions::getNearestPositionIndex(), LineValueSampler::getValue(), Terminator::handleMessage(), CartesianGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CylindricalGridDivision::initialize(), ReferenceResidualProblem::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 85 of file MooseBaseErrorInterface.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

◆ name()

virtual const std::string& MooseBase::name ( ) const

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 199 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::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 237 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:162

◆ 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 254 of file MooseBaseParameterInterface.h.

Referenced by 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 247 of file MooseBaseParameterInterface.h.

Referenced by MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), FixedPointSolve::FixedPointSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), and MooseMesh::MooseMesh().

 {
   mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
 }

◆ resolveOptionalProperties()

void MaterialPropertyInterface::resolveOptionalProperties ( )

virtualinherited

resolve all optional properties

Reimplemented in Material.

Definition at line 230 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();
 }

◆ setCZeroVertices() [1/2]

template<typename T >

void InitialConditionTempl< T >::setCZeroVertices ( )

inherited

set the temporary solution vector for node projections of C0 variables

Definition at line 265 of file InitialConditionTempl.C.

 {
   // Assume that C_ZERO elements have a single nodal
   // value shape function
   libmesh_assert(_nc == 1);
   _qp = _n;
   _current_node = _current_elem->node_ptr(_n);
   _Ue(_current_dof) = value(*_current_node);
   _dof_is_fixed[_current_dof] = true;
   _current_dof++;
 }

◆ setCZeroVertices() [2/2]

template<>

void InitialConditionTempl< RealVectorValue >::setCZeroVertices ( )

inherited

Definition at line 279 of file InitialConditionTempl.C.

 {
   _qp = _n;
   _current_node = _current_elem->node_ptr(_n);
   auto point_value = value(*_current_node);
   for (decltype(_nc) i = 0; i < _nc; ++i)
   {
     _Ue(_current_dof) = point_value(i);
     _dof_is_fixed[_current_dof] = true;
     _current_dof++;
   }
 }

◆ setHermiteVertices() [1/2]

template<typename T >

void InitialConditionTempl< T >::setHermiteVertices ( )

inherited

set the temporary solution vector for node projections of Hermite variables

Definition at line 315 of file InitialConditionTempl.C.

 {
   // The hermite element vertex shape functions are weird
   _qp = _n;
   _current_node = _current_elem->node_ptr(_n);
   _Ue(_current_dof) = value(*_current_node);
   _dof_is_fixed[_current_dof] = true;
   _current_dof++;
   GradientType grad = gradient(*_current_node);
   // x derivative
   _Ue(_current_dof) = gradientComponent(grad, 0);
   _dof_is_fixed[_current_dof] = true;
   _current_dof++;
   if (_dim > 1)
   {
     // We'll finite difference mixed derivatives
     Point nxminus = _current_elem->point(_n), nxplus = _current_elem->point(_n);
     nxminus(0) -= TOLERANCE;
     nxplus(0) += TOLERANCE;
     GradientType gxminus = gradient(nxminus);
     GradientType gxplus = gradient(nxplus);
     // y derivative
     _Ue(_current_dof) = gradientComponent(grad, 1);
     _dof_is_fixed[_current_dof] = true;
     _current_dof++;
     // xy derivative
     _Ue(_current_dof) =
         (gradientComponent(gxplus, 1) - gradientComponent(gxminus, 1)) / 2. / TOLERANCE;
     _dof_is_fixed[_current_dof] = true;
     _current_dof++;
 
     if (_dim > 2)
     {
       // z derivative
       _Ue(_current_dof) = gradientComponent(grad, 2);
       _dof_is_fixed[_current_dof] = true;
       _current_dof++;
       // xz derivative
       _Ue(_current_dof) =
           (gradientComponent(gxplus, 2) - gradientComponent(gxminus, 2)) / 2. / TOLERANCE;
       _dof_is_fixed[_current_dof] = true;
       _current_dof++;
       // We need new points for yz
       Point nyminus = _current_elem->point(_n), nyplus = _current_elem->point(_n);
       nyminus(1) -= TOLERANCE;
       nyplus(1) += TOLERANCE;
       GradientType gyminus = gradient(nyminus);
       GradientType gyplus = gradient(nyplus);
       // xz derivative
       _Ue(_current_dof) =
           (gradientComponent(gyplus, 2) - gradientComponent(gyminus, 2)) / 2. / TOLERANCE;
       _dof_is_fixed[_current_dof] = true;
       _current_dof++;
       // Getting a 2nd order xyz is more tedious
       Point nxmym = _current_elem->point(_n), nxmyp = _current_elem->point(_n),
             nxpym = _current_elem->point(_n), nxpyp = _current_elem->point(_n);
       nxmym(0) -= TOLERANCE;
       nxmym(1) -= TOLERANCE;
       nxmyp(0) -= TOLERANCE;
       nxmyp(1) += TOLERANCE;
       nxpym(0) += TOLERANCE;
       nxpym(1) -= TOLERANCE;
       nxpyp(0) += TOLERANCE;
       nxpyp(1) += TOLERANCE;
       GradientType gxmym = gradient(nxmym);
       GradientType gxmyp = gradient(nxmyp);
       GradientType gxpym = gradient(nxpym);
       GradientType gxpyp = gradient(nxpyp);
       DataType gxzplus =
           (gradientComponent(gxpyp, 2) - gradientComponent(gxmyp, 2)) / 2. / TOLERANCE;
       DataType gxzminus =
           (gradientComponent(gxpym, 2) - gradientComponent(gxmym, 2)) / 2. / TOLERANCE;
       // xyz derivative
       _Ue(_current_dof) = (gxzplus - gxzminus) / 2. / TOLERANCE;
       _dof_is_fixed[_current_dof] = true;
       _current_dof++;
     }
   }
 }

◆ setHermiteVertices() [2/2]

template<>

void InitialConditionTempl< RealVectorValue >::setHermiteVertices ( )

inherited

Definition at line 397 of file InitialConditionTempl.C.

398 {

399 }

◆ setOtherCOneVertices() [1/2]

template<typename T >

void InitialConditionTempl< T >::setOtherCOneVertices ( )

inherited

set the temporary solution vector for node projections of non-Hermitian C1 variables

Definition at line 403 of file InitialConditionTempl.C.

 {
   // Assume that other C_ONE elements have a single nodal
   // value shape function and nodal gradient component
   // shape functions
   libmesh_assert(_nc == 1 + _dim);
   _current_node = _current_elem->node_ptr(_n);
   _Ue(_current_dof) = value(*_current_node);
   _dof_is_fixed[_current_dof] = true;
   _current_dof++;
   GradientType grad = gradient(*_current_node);
   for (unsigned int i = 0; i != _dim; ++i)
   {
     _Ue(_current_dof) = gradientComponent(grad, i);
     _dof_is_fixed[_current_dof] = true;
     _current_dof++;
   }
 }

◆ setOtherCOneVertices() [2/2]

template<>

void InitialConditionTempl< RealVectorValue >::setOtherCOneVertices ( )

inherited

Definition at line 424 of file InitialConditionTempl.C.

425 {

426 }

◆ 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 141 of file MaterialPropertyInterface.C.

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

 {
   _stateful_allowed = stateful_allowed;
 }

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

The unique name for accessing input parameters of this object in the InputParameterWarehouse.

Definition at line 67 of file MooseBaseParameterInterface.h.

Referenced by MooseBaseParameterInterface::connectControllableParams(), and Action::uniqueActionName().

   {
     return MooseObjectName(_pars.get<std::string>("_unique_name"));
   }

◆ uniqueParameterName()

MooseObjectParameterName MooseBaseParameterInterface::uniqueParameterName ( const std::string & parameter_name ) const

inlineinherited

The unique parameter name of a valid parameter of this object for accessing parameter controls.

Definition at line 52 of file MooseBaseParameterInterface.h.

   {
     return MooseObjectParameterName(
         _pars.get<std::string>("_moose_base"), _moose_base.name(), parameter_name);
   }

◆ 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 2021 of file Coupleable.C.

 {
   if (!_c_fe_problem.isTransient())
     mooseError(_c_name,
                ": Calling \"",
                fn_name,
                "\" on variable \"",
                name,
                "\" when using a \"Steady\" executioner is not allowed. This value is available "
                "only in transient simulations.");
 }

◆ validParams()

InputParameters VectorFunctionIC::validParams ( )

static

Definition at line 16 of file VectorFunctionIC.C.

 {
   InputParameters params = VectorInitialCondition::validParams();
   params.addParam<FunctionName>("function",
                                 "The initial condition vector function. This cannot be supplied "
                                 "with the component parameters.");
   params.addParam<FunctionName>(
       "function_x", "0", "A function that describes the x-component of the initial condition");
   params.addParam<FunctionName>(
       "function_y", "0", "A function that describes the y-component of the initial condition");
   params.addParam<FunctionName>(
       "function_z", "0", "A function that describes the z-component of the initial condition");
   params.addClassDescription(
       "Sets component values for a vector field variable based on a vector function.");
   return params;
 }

◆ value()

RealVectorValue VectorFunctionIC::value ( const Point & p )

overridevirtual

The value of the variable at a point.

This must be overridden by derived classes.

Implements InitialConditionTempl< T >.

Definition at line 49 of file VectorFunctionIC.C.

 {
   if (_function)
     return _function->vectorValue(_t, p);
   else
     return RealVectorValue(
         _function_x.value(_t, p), _function_y.value(_t, p), _function_z.value(_t, p));
 }

◆ variable()

template<typename T >

virtual MooseVariableFEBase& InitialConditionTempl< T >::variable ( )

inlineoverridevirtualinherited

retrieves the MOOSE variable that this initial condition acts upon

Implements InitialConditionBase.

Definition at line 50 of file InitialConditionTempl.h.

50 { return _var; }

InitialConditionTempl::_var

MooseVariableField< T > & _var

The variable that this initial condition is acting upon.

Definition: InitialConditionTempl.h:118

◆ 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 898 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 863 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);
 
   if (!aux && !euo && !nuo && !nfc)
     mooseError("writableVariable() can only be called from AuxKernels, ElementUserObjects, "
                "NodalUserObjects, or NodeFaceConstraints. '",
                _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 168 of file MooseBaseParameterInterface.h.

Referenced by PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _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 1388 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 1397 of file Coupleable.h.

Referenced by Coupleable::getADDefaultSecond().

◆ _ad_default_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<DualReal> > > Coupleable::_ad_default_value

mutableprotectedinherited

Will hold the default value for optional coupled variables for automatic differentiation.

Definition at line 1365 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 1391 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 1376 of file Coupleable.h.

Referenced by Coupleable::getADDefaultVectorValue().

◆ _ad_grad_zero

const MooseArray<ADRealVectorValue>& Coupleable::_ad_grad_zero

protectedinherited

Definition at line 1406 of file Coupleable.h.

Referenced by Coupleable::adZeroGradient().

◆ _ad_second_zero

const MooseArray<ADRealTensorValue>& Coupleable::_ad_second_zero

protectedinherited

Definition at line 1413 of file Coupleable.h.

Referenced by Coupleable::adZeroSecond().

◆ _ad_zero

const MooseArray<DualReal>& Coupleable::_ad_zero

protectedinherited

Definition at line 1402 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

template<typename T >

Assembly& InitialConditionTempl< T >::_assembly

protectedinherited

the finite element/volume assembly object

Definition at line 122 of file InitialConditionTempl.h.

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 207 of file BlockRestrictable.h.

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

◆ _c_allow_element_to_nodal_coupling

const bool Coupleable::_c_allow_element_to_nodal_coupling

protectedinherited

Definition at line 1355 of file Coupleable.h.

Referenced by Coupleable::checkVar().

◆ _c_fe_problem

FEProblemBase& Coupleable::_c_fe_problem

protectedinherited

Definition at line 1319 of file Coupleable.h.

◆ _c_is_implicit

bool Coupleable::_c_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 1352 of file Coupleable.h.

◆ _c_name

const std::string& Coupleable::_c_name

protectedinherited

The name of the object this interface is part of.

Definition at line 1314 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 1349 of file Coupleable.h.

◆ _c_parameters

const InputParameters& Coupleable::_c_parameters

protectedinherited

Definition at line 1311 of file Coupleable.h.

◆ _c_sys

const SystemBase* const Coupleable::_c_sys

protectedinherited

Pointer to the system object if the moose object this is an interface for has one.

Definition at line 1322 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 1358 of file Coupleable.h.

Referenced by Coupleable::checkWritableVar(), Coupleable::Coupleable(), 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 1316 of file Coupleable.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _cont

template<typename T >

FEContinuity InitialConditionTempl< T >::_cont

protectedinherited

The type of continuity, e.g. C0, C1.

Definition at line 151 of file InitialConditionTempl.h.

◆ _coord_sys

template<typename T >

const Moose::CoordinateSystemType& InitialConditionTempl< T >::_coord_sys

protectedinherited

The coordinate system type for this problem, references the value in Assembly.

Definition at line 125 of file InitialConditionTempl.h.

◆ _coupleable_neighbor

bool Coupleable::_coupleable_neighbor

protectedinherited

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

Definition at line 1618 of file Coupleable.h.

◆ _coupled_array_moose_vars

std::vector<ArrayMooseVariable *> Coupleable::_coupled_array_moose_vars

protectedinherited

Vector of array coupled variables.

Definition at line 1337 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getCoupledArrayMooseVars(), and Coupleable::getVarHelper().

◆ _coupled_moose_vars

std::vector<MooseVariableFieldBase *> Coupleable::_coupled_moose_vars

protectedinherited

Vector of all coupled variables.

Definition at line 1328 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), 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 1340 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 1343 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 1331 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), 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 1325 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 1334 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getCoupledVectorMooseVars(), and Coupleable::getVarHelper().

◆ _current_dof

template<typename T >

dof_id_type InitialConditionTempl< T >::_current_dof

protectedinherited

The current dof being operated on.

Definition at line 171 of file InitialConditionTempl.h.

◆ _current_elem

template<typename T >

const Elem* const& InitialConditionTempl< T >::_current_elem

protectedinherited

The current element we are on will retrieving values at specific points in the domain.

Note that this IS valid even for nodes shared among several elements.

Definition at line 129 of file InitialConditionTempl.h.

Referenced by RandomICBase::generateRandom().

◆ _current_elem_volume

template<typename T >

const Real& InitialConditionTempl< T >::_current_elem_volume

protectedinherited

the volume of the current element

Definition at line 132 of file InitialConditionTempl.h.

◆ _current_node

template<typename T >

const Node* InitialConditionTempl< T >::_current_node

protectedinherited

The current node if the point we are evaluating at also happens to be a node.

Otherwise the pointer will be NULL.

Definition at line 136 of file InitialConditionTempl.h.

Referenced by RandomICBase::generateRandom().

◆ _default_array_curl

ArrayVariableCurl Coupleable::_default_array_curl

protectedinherited

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

Definition at line 1443 of file Coupleable.h.

◆ _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 1440 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 1372 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 1437 of file Coupleable.h.

Referenced by Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), and Coupleable::coupledArrayDotOld().

◆ _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 1385 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 1394 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 1362 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 1382 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 1431 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 1428 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 1369 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 1425 of file Coupleable.h.

Referenced by Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotOld(), and Coupleable::coupledVectorDotOld().

◆ _dim

template<typename T >

unsigned int InitialConditionTempl< T >::_dim

protectedinherited

the mesh dimension

Definition at line 187 of file InitialConditionTempl.h.

◆ _dof_indices

template<typename T >

std::vector<dof_id_type> InitialConditionTempl< T >::_dof_indices

protectedinherited

The global DOF indices.

Definition at line 154 of file InitialConditionTempl.h.

◆ _dof_is_fixed

template<typename T >

std::vector<char> InitialConditionTempl< T >::_dof_is_fixed

protectedinherited

Whether the degree of freedom is fixed (true/false)

Definition at line 164 of file InitialConditionTempl.h.

◆ _dphi

template<typename T >

const std::vector<std::vector<GradientShapeType> >* InitialConditionTempl< T >::_dphi

protectedinherited

pointers to shape function gradients

Definition at line 178 of file InitialConditionTempl.h.

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition at line 61 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 165 of file MooseBaseParameterInterface.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), SetupPreconditionerAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupResidualDebugAction::act(), SetAdaptivityOptionsAction::act(), MaterialDerivativeTestAction::act(), CreateDisplacedProblemAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddNodalNormalsAction::act(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), MooseBaseParameterInterface::connectControllableParams(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _Fe

template<typename T >

DenseVector<DataType> InitialConditionTempl< T >::_Fe

protectedinherited

Linear b vector.

Definition at line 144 of file InitialConditionTempl.h.

◆ _fe_problem

template<typename T >

FEProblemBase& InitialConditionTempl< T >::_fe_problem

protectedinherited

Definition at line 111 of file InitialConditionTempl.h.

Referenced by IntegralPreservingFunctionIC::initialSetup(), and RandomICBase::RandomICBase().

◆ _fe_type

template<typename T >

const FEType& InitialConditionTempl< T >::_fe_type

protectedinherited

The finite element type for the IC variable.

Definition at line 149 of file InitialConditionTempl.h.

◆ _fe_var

template<typename T >

MooseVariableFE<T>* InitialConditionTempl< T >::_fe_var

protectedinherited

Definition at line 119 of file InitialConditionTempl.h.

◆ _free_dof

template<typename T >

std::vector<int> InitialConditionTempl< T >::_free_dof

protectedinherited

Stores the ids of the free dofs.

Definition at line 166 of file InitialConditionTempl.h.

◆ _free_dofs

template<typename T >

dof_id_type InitialConditionTempl< T >::_free_dofs

protectedinherited

The number of free dofs.

Definition at line 169 of file InitialConditionTempl.h.

◆ _function

const Function* const VectorFunctionIC::_function

protected

Optional vectorValue function.

Definition at line 39 of file VectorFunctionIC.h.

Referenced by value(), and VectorFunctionIC().

◆ _function_x

const Function& VectorFunctionIC::_function_x

protected

Optional component function value.

Definition at line 42 of file VectorFunctionIC.h.

Referenced by value().

◆ _function_y

const Function& VectorFunctionIC::_function_y

protected

Definition at line 43 of file VectorFunctionIC.h.

Referenced by value().

◆ _function_z

const Function& VectorFunctionIC::_function_z

protected

Definition at line 44 of file VectorFunctionIC.h.

Referenced by value().

◆ _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 1409 of file Coupleable.h.

◆ _grad_zero

const VariableGradient& Coupleable::_grad_zero

protectedinherited

Zero gradient of a variable.

Definition at line 1405 of file Coupleable.h.

◆ _ignore_uo_dependency

const bool InitialConditionBase::_ignore_uo_dependency

protectedinherited

If set, UOs retrieved by this IC will not be executed before this IC.

Definition at line 99 of file InitialConditionBase.h.

Referenced by InitialConditionBase::addPostprocessorDependencyHelper(), and InitialConditionBase::addUserObjectDependencyHelper().

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

◆ _JxW

template<typename T >

const std::vector<Real>* InitialConditionTempl< T >::_JxW

protectedinherited

pointers to the Jacobian * quadrature weights for current element

Definition at line 180 of file InitialConditionTempl.h.

◆ _Ke

template<typename T >

DenseMatrix<Real> InitialConditionTempl< T >::_Ke

protectedinherited

Matrix storage member.

Definition at line 142 of file InitialConditionTempl.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().

◆ _mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 469 of file MaterialPropertyInterface.h.

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

◆ _n

template<typename T >

unsigned int InitialConditionTempl< T >::_n

protectedinherited

node counter

Definition at line 185 of file InitialConditionTempl.h.

◆ _n_nodes

template<typename T >

unsigned int InitialConditionTempl< T >::_n_nodes

protectedinherited

The number of nodes for a given element.

Definition at line 161 of file InitialConditionTempl.h.

◆ _n_qp

template<typename T >

unsigned int InitialConditionTempl< T >::_n_qp

protectedinherited

The number of quadrature points for a given element.

Definition at line 159 of file InitialConditionTempl.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(), AddDamperAction::act(), AddInterfaceKernelAction::act(), AddDGKernelAction::act(), AddFunctorMaterialAction::act(), AddKernelAction::act(), AddMaterialAction::act(), AddIndicatorAction::act(), AddDiracKernelAction::act(), AddMarkerAction::act(), AddFVInterfaceKernelAction::act(), AddUserObjectAction::act(), ReadExecutorParamsAction::act(), AddConstraintAction::act(), AddMultiAppAction::act(), AddVectorPostprocessorAction::act(), AddMeshGeneratorAction::act(), AddInitialConditionAction::act(), AddTransferAction::act(), AddFVInitialConditionAction::act(), AddNodalKernelAction::act(), AddPostprocessorAction::act(), AddScalarKernelAction::act(), PartitionerAction::act(), AddReporterAction::act(), AddFieldSplitAction::act(), AddTimesAction::act(), AddPositionsAction::act(), AddFVBCAction::act(), AddFVKernelAction::act(), AddFunctionAction::act(), AddMeshDivisionAction::act(), AddTimeStepperAction::act(), AddDistributionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddLinearFVBCAction::act(), AddLinearFVKernelAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddPeriodicBCAction::act(), AddControlAction::act(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CombinerGenerator::CombinerGenerator(), Executor::Executor(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), FillBetweenCurvesGenerator::generate(), NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >::name(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), and Split::setup().

◆ _nc

template<typename T >

dof_id_type InitialConditionTempl< T >::_nc

protectedinherited

number of dofs per node per variable

Definition at line 173 of file InitialConditionTempl.h.

◆ _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 1346 of file Coupleable.h.

Referenced by Coupleable::getVarHelper().

◆ _pars

const InputParameters& MooseBaseParameterInterface::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 162 of file MooseBaseParameterInterface.h.

◆ _phi

template<typename T >

const std::vector<std::vector<ValueType> >* InitialConditionTempl< T >::_phi

protectedinherited

pointers to shape functions

Definition at line 176 of file InitialConditionTempl.h.

◆ _phi_zero

const VariablePhiValue& Coupleable::_phi_zero

protectedinherited

Definition at line 1401 of file Coupleable.h.

◆ _qp

template<typename T >

unsigned int InitialConditionTempl< T >::_qp

protectedinherited

The current quadrature point, contains the "nth" node number when visiting nodes.

Definition at line 139 of file InitialConditionTempl.h.

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

◆ _second_phi_zero

const VariablePhiSecond& Coupleable::_second_phi_zero

protectedinherited

Zero second derivative of a test function.

Definition at line 1415 of file Coupleable.h.

◆ _second_zero

const VariableSecond& Coupleable::_second_zero

protectedinherited

Zero second derivative of a variable.

Definition at line 1412 of file Coupleable.h.

◆ _side_dofs

template<typename T >

std::vector<unsigned int> InitialConditionTempl< T >::_side_dofs

protectedinherited

Side/edge DOF indices.

Definition at line 156 of file InitialConditionTempl.h.

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

◆ _sys

SystemBase& InitialConditionBase::_sys

protectedinherited

The system object.

Definition at line 96 of file InitialConditionBase.h.

Referenced by SolutionIC::initialSetup().

◆ _t

template<typename T >

Real& InitialConditionTempl< T >::_t

protectedinherited

Time.

Definition at line 115 of file InitialConditionTempl.h.

Referenced by ArrayFunctionIC::gradient(), FunctionIC::gradient(), ArrayFunctionIC::value(), IntegralPreservingFunctionIC::value(), value(), and FunctionIC::value().

◆ _tid

template<typename T >

THREAD_ID InitialConditionTempl< T >::_tid

protectedinherited

Definition at line 112 of file InitialConditionTempl.h.

◆ _type

const std::string MooseBase::_type

protectedinherited

The type of this class.

Definition at line 87 of file MooseBase.h.

Referenced by FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), FEProblemBase::init(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _Ue

template<typename T >

DenseVector<DataType> InitialConditionTempl< T >::_Ue

protectedinherited

Linear solution vector.

Definition at line 146 of file InitialConditionTempl.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

template<typename T >

MooseVariableField<T>& InitialConditionTempl< T >::_var

protectedinherited

The variable that this initial condition is acting upon.

Definition at line 118 of file InitialConditionTempl.h.

Referenced by ArrayConstantIC::ArrayConstantIC(), ArrayFunctionIC::ArrayFunctionIC(), ArrayFunctionIC::gradient(), ArrayFunctionIC::value(), and InitialConditionTempl< T >::variable().

◆ _vector_curl_zero

const VectorVariableCurl& Coupleable::_vector_curl_zero

protectedinherited

Zero value of the curl of a vector variable.

Definition at line 1419 of file Coupleable.h.

◆ _vector_zero

const VectorVariableValue& Coupleable::_vector_zero

protectedinherited

Zero value of a vector variable.

Definition at line 1417 of file Coupleable.h.

◆ _xyz_values

template<typename T >

const std::vector<Point>* InitialConditionTempl< T >::_xyz_values

protectedinherited

pointers to the xyz coordinates of the quadrature points for the current element

Definition at line 182 of file InitialConditionTempl.h.

◆ _zero

const VariableValue& Coupleable::_zero

protectedinherited

Zero value of a variable.

Definition at line 1400 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/ics/VectorFunctionIC.h
src/ics/VectorFunctionIC.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

◆ DataType

◆ FEBaseType

◆ GradientShapeType

◆ GradientType

◆ ValueType

Member Enumeration Documentation

◆ TEST_TYPE

Constructor & Destructor Documentation

◆ VectorFunctionIC()

Member Function Documentation

◆ adCoupledDofValues()

◆ adCoupledDot()

◆ adCoupledDotDot()

◆ adCoupledDots()

◆ adCoupledGradient()

◆ adCoupledGradientDot()

◆ adCoupledGradients()

◆ adCoupledLowerValue()

◆ adCoupledNodalValue()

◆ adCoupledSecond()

◆ adCoupledValue()

◆ adCoupledValues()

◆ adCoupledVectorDot()

◆ adCoupledVectorGradient()

◆ adCoupledVectorSecond()

◆ adCoupledVectorValue()

◆ adCoupledVectorValues()

◆ addFEVariableCoupleableMatrixTag()

◆ addFEVariableCoupleableVectorTag()

◆ adZeroGradient()

◆ adZeroSecond()

◆ adZeroValue()

◆ areElemIDsIdentical()

◆ blockIDs()

◆ blockRestricted()

◆ blocks()

◆ blocksMaxDimension()

◆ boundaryIDs()

◆ boundaryNames()

◆ boundaryRestricted()

◆ buildRequiredMaterials()

◆ callMooseError()

◆ checkBlockAndBoundaryCompatibility()

◆ checkExecutionStage()

◆ checkMaterialProperty()

◆ checkVar()

◆ checkVariable()

◆ checkVariableBoundaryIntegrity()

◆ checkWritableVar()

◆ choleskyAssembly()

◆ choleskySolve() [1/2]

◆ choleskySolve() [2/2]

◆ compute()

◆ computeNodal()

◆ connectControllableParams()

◆ coupled()

◆ coupledAllDofValues()

◆ coupledAllDofValuesOld()

◆ coupledAllDofValuesOlder()

◆ coupledArrayDofValues()

◆ coupledArrayDot()

◆ coupledArrayDotDot()

◆ coupledArrayDotDotOld()

◆ coupledArrayDotDu()

◆ coupledArrayDotOld()

◆ coupledArrayGradient()

◆ coupledArrayGradientDot()

◆ coupledArrayGradientOld()

◆ coupledArrayGradientOlder()