User object that reads an existing solution from an input file and uses it in the current simulation. More...

#include <SolutionUserObject.h>

Inheritance diagram for SolutionUserObject:

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

typedef GenericSymFunction< is_ad >	SymFunction
	Shorthand for an autodiff function parser object. More...

typedef std::shared_ptr< SymFunction >	SymFunctionPtr
	Shorthand for an smart pointer to an autodiff function parser object. More...

Public Member Functions
	SolutionUserObject (const InputParameters &parameters)

virtual Real	solutionSampleTime () override
	Get the time at which to sample the solution. More...

virtual void	timestepSetup () override
	When reading ExodusII files, this will update the interpolation times. More...

unsigned int	getLocalVarIndex (const std::string &var_name) const
	Returns the local index for a given variable name. More...

Real	pointValueWrapper (Real t, const Point &p, const std::string &var_name, const MooseEnum &weighting_type=weightingType(), const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns a value at a specific location and variable checking for multiple values and weighting these values to obtain a single unique value (see SolutionFunction) More...

Real	pointValue (Real t, const Point &p, const unsigned int local_var_index, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns a value at a specific location and variable (see SolutionFunction) More...

Real	pointValue (Real t, const Point &p, const std::string &var_name, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns a value at a specific location and variable (see SolutionFunction) More...

std::map< const Elem *, Real >	discontinuousPointValue (Real t, Point pt, const unsigned int local_var_index, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns a value at a specific location and variable for cases where the solution is multivalued at element faces Use pointValue for continuous shape functions or if you are sure your point is within an element! More...

std::map< const Elem *, Real >	discontinuousPointValue (Real t, const Point &p, const std::string &var_name, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns a value at a specific location and variable for cases where the solution is multivalued at element faces Use pointValue for continuous shape functions or if you are sure your point is within an element! More...

libMesh::RealGradient	pointValueGradientWrapper (Real t, const Point &p, const std::string &var_name, const MooseEnum &weighting_type=weightingType(), const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns the gradient at a specific location and variable checking for multiple values and weighting these values to obtain a single unique value (see SolutionFunction) More...

libMesh::RealGradient	pointValueGradient (Real t, const Point &p, const std::string &var_name, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns the gradient at a specific location and variable (see SolutionFunction) More...

libMesh::RealGradient	pointValueGradient (Real t, Point pt, const unsigned int local_var_index, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns the gradient at a specific location and variable (see SolutionFunction) More...

std::map< const Elem *, libMesh::RealGradient >	discontinuousPointValueGradient (Real t, const Point &p, const std::string &var_name, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns the gradient at a specific location and variable for cases where the gradient is multivalued (e.g. More...

std::map< const Elem *, libMesh::RealGradient >	discontinuousPointValueGradient (Real t, Point pt, const unsigned int local_var_index, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	Returns the gradient at a specific location and variable for cases where the gradient is multivalued (e.g. More...

Real	directValue (const Node *node, const std::string &var_name) const
	Return a value directly from a Node. More...

Real	directValue (const Elem *elem, const std::string &var_name) const
	Return a value from the centroid of an element. More...

Real	scalarValue (Real t, const std::string &var_name) const
	Returns a value of a global variable. More...

virtual void	initialize () override
	Called before execute() is ever called so that data can be cleared. More...

virtual void	finalize () override
	Finalize. More...

virtual void	execute () override
	Execute method. More...

virtual void	initialSetup () override
	Initialize the System and Mesh objects for the solution being read. More...

const std::vector< std::string > &	variableNames () const

bool	isVariableNodal (const std::string &var_name) const

unsigned int	getMeshFileDimension () const
	Return the spatial dimension of the mesh file. More...

const std::string	getMeshFileName () const
	Return the name of the mesh file this object read the solution from. More...

const std::map< SubdomainName, SubdomainID > &	getBlockNamesToIds () const
	Get the map from block name to block ID. More...

const std::map< SubdomainID, SubdomainName > &	getBlockIdsToNames () const
	Get the map from block id to block name. More...

MooseEnum	getSolutionFileType () const
	Get the type of file that was read. More...

virtual Real	spatialValue (const Point &) const
	Optional interface function for "evaluating" a UserObject at a spatial position. More...

virtual const std::vector< Point >	spatialPoints () const
	Optional interface function for providing the points at which a UserObject attains spatial values. More...

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const
	Returns a reference to the subproblem that this postprocessor is tied to. More...

bool	shouldDuplicateInitialExecution () const
	Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC. More...

template<typename T >
void	gatherSum (T &value)
	Gather the parallel sum of the variable passed in. More...

template<typename T >
void	gatherMax (T &value)
	Gather the parallel max of the variable passed in. More...

template<typename T >
void	gatherMin (T &value)
	Gather the parallel min of the variable passed in. More...

template<typename T1 , typename T2 >
void	gatherProxyValueMax (T1 &proxy, T2 &value)
	Deteremine the value of a variable according to the parallel maximum of the provided proxy. More...

template<typename T1 , typename T2 >
void	gatherProxyValueMin (T1 &proxy, T2 &value)
	Determine the value of a variable according to which process has the parallel minimum of the provided proxy. More...

std::set< UserObjectName >	getDependObjects () const
	Recursively return a set of user objects this user object depends on Note: this can be called only after all user objects are constructed. More...

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

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

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const
	Whether or not a threaded copy of this object is needed when obtaining it in another object, like via the UserObjectInterface. 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

bool	isKokkosObject () const
	Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes. More...

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

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

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

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

MooseObjectName	uniqueName () const

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

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

template<typename T >
bool	haveParameter (const std::string &name) const
	Test if a parameter of the given name and type exists. More...

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

bool	isParamSetByUser (const std::string &name) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. 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	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	paramWarning (const std::string &param, Args... args) const

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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available. More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

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

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

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

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

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

template<typename... Args>
void	mooseDeprecated (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and a stack trace. More...

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

template<typename... Args>
void	mooseDeprecatedNoTrace (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and no stack trace. More...

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
	External method for calling moose error with added object context. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

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

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

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

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

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

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

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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`. More...

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

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

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

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

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 , unsigned int dimension = 0, unsigned int state = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)
	Get a Kokkos material property by property name for any state. More...

template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)
	Get an old Kokkos material property by property name. More...

template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)
	Get an older Kokkos material property by property name. More...

template<typename T , unsigned int dimension = 0, unsigned int state = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)
	Get a Kokkos material property for any state. More...

template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)
	Get an old Kokkos material property. More...

template<typename T , unsigned int dimension = 0>
Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)
	Get an older Kokkos material property. 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 , unsigned int dimension = 0, unsigned int state = 0>
std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve a Kokkos material property with the mesh blocks where it is defined NOTE: This is not a drop-in replacement of getBlockMaterialProperty(). 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...

virtual bool	getMaterialPropertyCalled () const
	Returns true if getMaterialProperty() has been called, false otherwise. More...

virtual const std::unordered_set< unsigned int > &	getMatPropDependencies () const
	Retrieve the set of material properties that this object depends on. More...

virtual void	resolveOptionalProperties ()
	resolve all optional properties More...

template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
	Retrieve the generic property named "prop_name" without any deduction for the specified `material_data` for state `state`. More...

bool	isImplicit ()

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

void	setParserFeatureFlags (SymFunctionPtr &) const
	apply input parameters to internal feature flags of the parser object More...


virtual void	threadJoin (const UserObject &) override
	This method is not used and should not be used in a custom GeneralUserObject. More...

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


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

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


bool	hasUserObjectByName (const UserObjectName &object_name) const

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


template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	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 , unsigned int dimension = 0>
bool	hasKokkosMaterialProperty (const std::string &name)

template<typename T , unsigned int dimension = 0>
bool	hasKokkosMaterialPropertyByName (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)

Static Public Member Functions
static InputParameters	validParams ()

static MooseEnum	weightingType ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)
	External method for calling moose error with added object context. 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 , typename NameFunc >
static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func)
	A helper method for cyclic errors. More...

template<typename T , typename T2 >
static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
SymFunctionPtr	_time_transformation
	function parser object for transforming the solution sample time More...

	usingCombinedWarningSolutionWarnings

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

Static Public Attributes
static const std::string	type_param = "_type"
	The name of the parameter that contains the object type. More...

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name. More...

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name. More...

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp. More...

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base. More...

static const std::string	kokkos_object_param = "_kokkos_object"
	The name of the parameter that indicates an object is a Kokkos functor. More...

static constexpr PropertyValue::id_type	default_property_id
	The material property ID for a default (parsed from input) property. More...

static constexpr PropertyValue::id_type	zero_property_id = PropertyValue::invalid_property_id - 2
	The material property ID for a zero property. More...

Protected Types
enum	FailureMethod
	Enum for failure method. More...

Protected Member Functions
virtual Real	directValue (dof_id_type dof_index) const
	Method for extracting value of solution based on the DOF, this is called by the public overloaded function that accept a node or element pointer. More...

void	readXda ()
	Method for reading XDA mesh and equation systems file(s) This method is called by the constructor when 'file_type = xda' is set in the input file. More...

void	readExodusIIOrNemesis ()
	Method for reading an ExodusII or Nemesis file, which is called when a mesh file with a .e, .exo, .n or .nem extension is provided in the input file. More...

void	updateTimeInterpolationFromFile ()
	Updates the times for interpolating ExodusII or Nemesis data. More...

bool	updateInterpolationBracketingTimeIndices ()
	Updates the time indices to interpolate between for ExodusII or Nemesis data. More...

Real	evalMeshFunction (const Point &p, const unsigned int local_var_index, unsigned int func_num, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	A wrapper method for calling the various MeshFunctions used for reading the data. More...

std::map< const Elem *, Real >	evalMultiValuedMeshFunction (const Point &p, const unsigned int local_var_index, unsigned int func_num, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	A wrapper method for calling the various MeshFunctions that calls the mesh function functionality for evaluating discontinuous shape functions near a face (where it's multivalued) More...

libMesh::RealGradient	evalMeshFunctionGradient (const Point &p, const unsigned int local_var_index, unsigned int func_num, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	A wrapper method interfacing with the libMesh mesh function for evaluating the gradient. More...

std::map< const Elem *, libMesh::RealGradient >	evalMultiValuedMeshFunctionGradient (const Point &p, const unsigned int local_var_index, unsigned int func_num, const std::set< subdomain_id_type > *subdomain_ids=nullptr) const
	A wrapper method interfacing with the libMesh mesh function that calls the gradient functionality for evaluating potentially discontinuous gradients at element's faces (where it's multivalued) More...

void	readBlockIdMapFromExodusII ()
	Read block ID map from the ExodusII file. More...

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

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
	Helper for deriving classes to override to add dependencies when a VectorPostprocessor is requested. More...

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

void	addReporterDependencyHelper (const ReporterName &reporter_name) override
	A method that can be overridden to update the UO dependencies. More...

template<bool warning>
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
	Set solution invalid mark for the given solution ID. More...

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

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

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const
	Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU. More...

template<typename T >
const T &	getKokkosFunction (const std::string &name) const
	Get a Kokkos function of a concrete type with a given name. More...

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const
	Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU. More...

template<typename T >
const T &	getKokkosFunctionByName (const FunctionName &name) const
	Get a Kokkos function of a concrete type with a given name. More...

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

bool	hasKokkosFunctionByName (const FunctionName &name) const
	Determine if the Kokkos function exists. 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...

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of a VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of the VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by parameter. More...

bool	hasVectorPostprocessor (const std::string &param_name) const
	Determine if the VectorPostprocessor exists by parameter. More...

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by name. More...

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
	Determine if the VectorPostprocessor exists by name. More...

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const
	Get the name of a VectorPostprocessor associated with a parameter. More...

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const
	Get the reporter context to allow non-typed operations with the data. More...

const ReporterName &	getReporterName (const std::string &param_name) const

template<typename T = Sampler>
T &	getSampler (const std::string &name)
	Get a sampler with a given name. More...

template<>
Sampler &	getSampler (const std::string &name)

template<typename T = Sampler>
T &	getSamplerByName (const SamplerName &name)
	Get a sampler with a given name. More...

template<>
Sampler &	getSamplerByName (const SamplerName &name)

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 >
const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)
	Method for retrieving a property with the given type and name exists in the mesh meta-data store. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

virtual void	meshChanged ()
	Called on this object when the mesh changes. More...

virtual void	meshDisplaced ()
	Called on this object when the displaced mesh gets updated. More...

PerfGraph &	perfGraph ()
	Get the PerfGraph. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const
	Call to register a named section for timing. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing. More...

std::string	timedSectionName (const std::string &section_name) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)
	A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method. More...

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)
	A virtual method that can be overriden by Kokkos objects to insert additional operations in getKokkosMaterialProperty. 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...

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::string &object_name="")
	Evaluate FParser object and check EvalError. More...

GenericReal< is_ad >	evaluate (SymFunctionPtr &, const std::vector< GenericReal< is_ad >> &, const std::string &object_name="")
	Evaluate FParser object and check EvalError. More...

void	addFParserConstants (SymFunctionPtr &parser, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions) const
	add constants (which can be complex expressions) to the parser object More...

virtual void	functionsOptimize (SymFunctionPtr &parsed_function)
	run FPOptimizer on the parsed function More...

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	functionsOptimize (SymFunctionPtr &parsed_function)

void	parsedFunctionSetup (SymFunctionPtr &function, const std::string &expression, const std::string &variables, const std::vector< std::string > &constant_names, const std::vector< std::string > &constant_expressions, const libMesh::Parallel::Communicator &comm) const
	Performs setup steps on a SymFunction. More...


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


bool	isVectorPostprocessorDistributed (const std::string &param_name) const
	Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED. More...

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const


template<typename T >
const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)
	doco-normal-methods-begin Returns read-only reference to a Reporter value that is provided by an input parameter. More...

template<typename T >
const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)


template<typename T >
const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
	Returns read-only reference to a Reporter value that is provided by name directly. More...

template<typename T >
const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)


bool	hasReporterValue (const std::string &param_name) const
	Return True if the Reporter value exists. More...

template<typename T >
bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

template<typename T >
bool	hasReporterValueByName (const ReporterName &reporter_name) const


const Distribution &	getDistribution (const std::string &name) const
	Get a distribution with a given name. More...

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


const Distribution &	getDistributionByName (const DistributionName &name) const
	Get a distribution with a given name. More...

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


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)

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
MooseEnum	_file_type
	File type to read (0 = xda; 1 = ExodusII, 2 = xdr, 3 = Nemesis) More...

std::string	_mesh_file
	The XDA/ExodusII/XDR/Nemesis file that is being read. More...

std::string	_es_file
	The XDA/XDR file that contians the EquationSystems data (xda/xdr only) More...

std::string	_system_name
	The system name to extract from the XDA/XDR file (xda/xdr only) More...

std::vector< std::string >	_system_variables
	A list of variables to extract from the read system. More...

std::map< std::string, unsigned int >	_local_variable_index
	Stores the local index need by MeshFunction. More...

std::vector< std::string >	_nodal_variables
	Stores names of nodal variables. More...

std::vector< std::string >	_elemental_variables
	Stores names of elemental variables. More...

std::vector< std::string >	_scalar_variables
	Stores names of scalar variables. More...

int	_exodus_time_index
	Current ExodusII time index. More...

bool	_interpolate_times
	Flag for triggering interpolation of ExodusII data. More...

std::unique_ptr< libMesh::MeshBase >	_mesh
	Pointer the libMesh::mesh object. More...

std::unique_ptr< libMesh::EquationSystems >	_es
	Pointer to the libMesh::EquationSystems object. More...

libMesh::System *	_system
	Pointer libMesh::System class storing the read solution. More...

std::unique_ptr< libMesh::MeshFunction >	_mesh_function
	Pointer the libMesh::MeshFunction object that the read data is stored. More...

std::unique_ptr< libMesh::ExodusII_IO >	_exodusII_io
	Pointer to the libMesh::ExodusII used to read the files. More...

std::unique_ptr< libMesh::Nemesis_IO >	_nemesis_io
	Pointer to the libMesh::Nemesis_IO used to read the files. More...

std::unique_ptr< NumericVector< Number > >	_serialized_solution
	Pointer to the serial solution vector. More...

std::unique_ptr< libMesh::EquationSystems >	_es2
	Pointer to second libMesh::EquationSystems object, used for interpolation. More...

libMesh::System *	_system2
	Pointer to a second libMesh::System object, used for interpolation. More...

std::unique_ptr< libMesh::MeshFunction >	_mesh_function2
	Pointer to second libMesh::MeshFuntion, used for interpolation. More...

std::unique_ptr< NumericVector< Number > >	_serialized_solution2
	Pointer to second serial solution, used for interpolation. More...

Real	_interpolation_time
	Time in the current simulation at which the solution interpolation was last updated. More...

Real	_interpolation_factor
	Interpolation weight factor. More...

const std::vector< Real > *	_exodus_times
	The times available in the ExodusII file. More...

int	_exodus_index1
	Time index 1, used for interpolation. More...

int	_exodus_index2
	Time index 2, used for interpolation. More...

const MooseEnum	_nodal_variable_order
	Nodal variable order, used when reading in solution data. More...

std::vector< Real >	_scale
	Scale parameter. More...

std::vector< Real >	_scale_multiplier
	scale_multiplier parameter More...

std::vector< Real >	_translation
	Translation. More...

RealVectorValue	_rotation0_vector
	vector about which to rotate More...

Real	_rotation0_angle
	angle (in degrees) which to rotate through about vector _rotation0_vector More...

RealTensorValue	_r0
	Rotation matrix that performs the "_rotation0_angle about rotation0_vector". More...

RealVectorValue	_rotation1_vector
	vector about which to rotate More...

Real	_rotation1_angle
	angle (in degrees) which to rotate through about vector _rotation1_vector More...

RealTensorValue	_r1
	Rotation matrix that performs the "_rotation1_angle about rotation1_vector". More...

MultiMooseEnum	_transformation_order
	transformations (rotations, translation, scales) are performed in this order More...

const bool	_force_replicated_source
	Whether to force the source mesh to be replicated. More...

bool	_initialized
	True if initial_setup has executed. More...

std::map< SubdomainName, SubdomainID >	_block_name_to_id
	Map from block ID to block names. Read from the ExodusII file. More...

std::map< SubdomainID, SubdomainName >	_block_id_to_name
	Map from block names to block IDs. Read from the ExodusII file. More...

Point	_cached_p = Point(std::numeric_limits<Real>::max(), 0., 0.)
	Cached points. More...

Point	_cached_p2 = Point(std::numeric_limits<Real>::max(), 0., 0.)

std::set< subdomain_id_type >	_cached_subdomain_ids
	Cached subdomain ids. More...

std::set< subdomain_id_type >	_cached_subdomain_ids2

DenseVector< Number >	_cached_values
	Cached values. More...

DenseVector< Number >	_cached_values2

const Moose::CoordinateSystemType &	_coord_sys
	Coordinate system. More...

const THREAD_ID	_tid
	Thread ID of this postprocessor. More...

SubProblem &	_subproblem
	Reference to the Subproblem for this user object. More...

FEProblemBase &	_fe_problem
	Reference to the FEProblemBase for this user object. More...

SystemBase &	_sys
	Reference to the system object for this user object. More...

Assembly &	_assembly
	Reference to the assembly object for this user object. More...

const bool	_duplicate_initial_execution
	Whether to execute this object twice on initial. More...

std::set< std::string >	_depend_uo
	Depend UserObjects that to be used both for determining user object sorting and by AuxKernel for finding the full UO dependency. 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...

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

ActionFactory &	_action_factory
	Builds Actions. More...

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

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

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

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

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

MooseApp &	_restartable_app
	Reference to the application. More...

const std::string	_restartable_system_name
	The system name this object is in. More...

const THREAD_ID	_restartable_tid
	The thread ID for this object. More...

const bool	_restartable_read_only
	Flag for toggling read only status (see ReporterData) More...

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

FEProblemBase &	_mdi_feproblem
	Reference to FEProblemBase instance. More...

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph. More...

const std::string	_prefix
	A prefix to use for all sections. More...

FEProblemBase &	_sc_fe_problem

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

const Real &	_real_zero
	Scalar zero. More...

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

const Point &	_point_zero
	Zero point. More...

const InputParameters &	_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 bool	_is_kokkos_object
	Whether the MOOSE object is a Kokkos object. 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...

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

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

Real &	_t
	Time. More...

const Real &	_t_old
	Old time. More...

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

Real &	_dt
	Time step size. More...

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

bool	_is_transient

enum FunctionParserUtils::FailureMethod	_evalerror_behavior

const Real	_quiet_nan
	appropriate not a number value to return More...

std::vector< GenericReal< is_ad > >	_func_params
	Array to stage the parameters passed to the functions when calling Eval. More...

const Real	_epsilon
	fuzzy comparison tolerance More...


bool	_enable_jit
	feature flags More...

bool	_enable_ad_cache

bool	_disable_fpoptimizer

bool	_enable_auto_optimize

Static Protected Attributes
static constexpr auto	SYSTEM = "MeshMetaData"
	The system name used when initializing the Restartable interface. More...

static constexpr auto	NAME = "<empty>"
	The data name used when initializing the Restartable interface for non-MeshGenerator objects. More...

static const char *	_eval_error_msg []
	table of FParser eval error codes More...


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

User object that reads an existing solution from an input file and uses it in the current simulation.

Definition at line 20 of file SolutionUserObject.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

◆ SymFunction

typedef GenericSymFunction<is_ad> FunctionParserUtils< is_ad >::SymFunction

inherited

Shorthand for an autodiff function parser object.

Definition at line 62 of file FunctionParserUtils.h.

◆ SymFunctionPtr

typedef std::shared_ptr<SymFunction> FunctionParserUtils< is_ad >::SymFunctionPtr

inherited

Shorthand for an smart pointer to an autodiff function parser object.

Definition at line 65 of file FunctionParserUtils.h.

Member Enumeration Documentation

◆ FailureMethod

enum FunctionParserUtils::FailureMethod

strongprotectedinherited

Enum for failure method.

Definition at line 116 of file FunctionParserUtils.h.

116 { nan, nan_warning, error, exception } _evalerror_behavior;

FunctionParserUtils< false >::_evalerror_behavior

enum FunctionParserUtils::FailureMethod _evalerror_behavior

Constructor & Destructor Documentation

◆ SolutionUserObject()

SolutionUserObject::SolutionUserObject ( const InputParameters & parameters )

Definition at line 53 of file SolutionUserObject.C.

   : SolutionUserObjectBase(parameters), FunctionParserUtils<false>(parameters)
 {
   // Create parsed function
   _time_transformation = std::make_shared<SymFunction>();
   parsedFunctionSetup(
       _time_transformation, getParam<std::string>("time_transformation"), "t", {}, {}, comm());
 
   // the only parameter is time
   _func_params.resize(1);
 }

Member Function Documentation

◆ adCoupledScalarDot()

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

protectedinherited

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

Parameters

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

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

Definition at line 267 of file ScalarCoupleable.C.

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

◆ adCoupledScalarValue()

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

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 150 of file ScalarCoupleable.C.

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

◆ addFParserConstants()

void FunctionParserUtils< is_ad >::addFParserConstants	(	SymFunctionPtr &	parser,
		const std::vector< std::string > &	constant_names,
		const std::vector< std::string > &	constant_expressions
	)		const

protectedinherited

add constants (which can be complex expressions) to the parser object

Definition at line 153 of file FunctionParserUtils.C.

Referenced by LevelSetMeshingHelper::LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), and ParsedODEKernel::ParsedODEKernel().

 {
   // check constant vectors
   unsigned int nconst = constant_expressions.size();
   if (nconst != constant_names.size())
     mooseError("The parameter vectors constant_names (size " +
                std::to_string(constant_names.size()) + ") and constant_expressions (size " +
                std::to_string(nconst) + ") must have equal length.");
 
   // previously evaluated constant_expressions may be used in following constant_expressions
   std::vector<Real> constant_values(nconst);
 
   for (unsigned int i = 0; i < nconst; ++i)
   {
     // no need to use dual numbers for the constant expressions
     auto expression = std::make_shared<FunctionParserADBase<Real>>();
 
     // add previously evaluated constants
     for (unsigned int j = 0; j < i; ++j)
       if (!expression->AddConstant(constant_names[j], constant_values[j]))
         mooseError("Invalid constant name: ", constant_names[j], " and value ", constant_values[j]);
 
     // build the temporary constant expression function
     if (expression->Parse(constant_expressions[i], "") >= 0)
       mooseError("Invalid constant expression\n",
                  constant_expressions[i],
                  "\n in parsed function object.\n",
                  expression->ErrorMsg());
 
     constant_values[i] = expression->Eval(NULL);
 
     if (!parser->AddConstant(constant_names[i], constant_values[i]))
       mooseError("Invalid constant name in parsed function object");
   }
 }

◆ addPostprocessorDependencyHelper()

void UserObjectBase::addPostprocessorDependencyHelper ( const PostprocessorName & ) const

overrideprotectedvirtualinherited

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

Reimplemented from PostprocessorInterface.

Definition at line 156 of file UserObjectBase.C.

 {
   _depend_uo.insert(name);
 }

◆ addReporterDependencyHelper()

void UserObjectBase::addReporterDependencyHelper ( const ReporterName & )

overrideprotectedvirtualinherited

A method that can be overridden to update the UO dependencies.

This is needed because the get methods for this interface cannot be virtual because of the template parameter. See GeneralUserObject for how it is utilized.

Reimplemented from ReporterInterface.

Definition at line 168 of file UserObjectBase.C.

 {
   _depend_uo.insert(reporter_name.getObjectName());
 }

◆ addUserObjectDependencyHelper()

void UserObjectBase::addUserObjectDependencyHelper ( const UserObjectBase & ) const

overrideprotectedvirtualinherited

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

Reimplemented from UserObjectInterface.

Definition at line 150 of file UserObjectBase.C.

 {
   _depend_uo.insert(uo.name());
 }

◆ addVectorPostprocessorDependencyHelper()

void UserObjectBase::addVectorPostprocessorDependencyHelper ( const VectorPostprocessorName & ) const

overrideprotectedvirtualinherited

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 162 of file UserObjectBase.C.

 {
   _depend_uo.insert(name);
 }

◆ 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 243 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() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`,
		const bool	show_trace = `true`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 105 of file MooseBase.C.

Referenced by InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

 {
   callMooseError(&_app, _pars, msg, with_prefix, node, show_trace);
 }

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node,
		const bool	show_trace = `true`
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 114 of file MooseBase.C.

 {
   if (!node)
     node = MooseBase::getHitNode(params);
 
   std::string multiapp_prefix = "";
   if (app)
   {
     if (!app->isUltimateMaster())
       multiapp_prefix = app->name();
     app->getOutputWarehouse().mooseConsole();
   }
 
   if (with_prefix)
     // False here because the hit context will get processed by the node
     msg = messagePrefix(params, false) + msg;
 
   moose::internal::mooseErrorRaw(msg, multiapp_prefix, node, show_trace);
 }

◆ 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 184 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    " << discrete->parameters().paramLocationPrefix("block")
         << " material defined on blocks ";
     for (const auto & sbd_id : discrete->blockIDs())
       oss << sbd_id << ", ";
 
     oss << "\n    " << _mi_params.paramLocationPrefix("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    " << discrete->parameters().paramLocationPrefix("boundary")
         << " material defined on boundaries ";
     for (const auto & bnd_id : discrete->boundaryIDs())
       oss << bnd_id << ", ";
 
     oss << "\n    " << _mi_params.paramLocationPrefix("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 260 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

 {
   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, and Moose::Kokkos::Material.

Definition at line 155 of file MaterialPropertyInterface.C.

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

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

◆ connectControllableParams()

void MooseBase::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 77 of file MooseBase.C.

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

◆ coupledGenericScalarValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled scalar variable

◆ coupledGenericScalarValue() [2/3]

template<>

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

protectedinherited

Definition at line 167 of file ScalarCoupleable.C.

 {
   return coupledScalarValue(var_name, comp);
 }

◆ coupledGenericScalarValue() [3/3]

template<>

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

protectedinherited

Definition at line 175 of file ScalarCoupleable.C.

 {
   return adCoupledScalarValue(var_name, comp);
 }

◆ coupledMatrixTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 217 of file ScalarCoupleable.C.

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

◆ 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 139 of file PostprocessorInterface.C.

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

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

◆ coupledScalar()

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

protectedinherited

Returns the index for a scalar coupled variable by name.

Parameters

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

Returns: Index of coupled variable

Definition at line 108 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

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

◆ coupledScalarComponents()

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

protectedinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 368 of file ScalarCoupleable.C.

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

◆ coupledScalarDot()

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

protectedinherited

Returns the time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 259 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDot()

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

protectedinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 275 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 307 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotOld()

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

protectedinherited

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

Parameters

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

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

Definition at line 291 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 299 of file ScalarCoupleable.C.

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

◆ coupledScalarDotOld()

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

protectedinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 283 of file ScalarCoupleable.C.

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

◆ coupledScalarOrder()

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

protectedinherited

Returns the order for a scalar coupled variable by name.

Parameters

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

Returns: Order of coupled variable

Definition at line 115 of file ScalarCoupleable.C.

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

◆ coupledScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 139 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

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

◆ coupledScalarValueOld()

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

protectedinherited

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

Parameters

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

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 231 of file ScalarCoupleable.C.

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

◆ coupledScalarValueOlder()

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

protectedinherited

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

Parameters

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

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 243 of file ScalarCoupleable.C.

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

◆ coupledVectorTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 196 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
 
   if (!_sc_fe_problem.vectorTagExists(tag))
     mooseError("Attempting to couple to vector tag scalar with ID ",
                tag,
                "in ",
                _sc_name,
                ", but a vector tag with that ID does not exist");
 
   _sc_coupleable_vector_tags.insert(tag);
 
   return getScalarVar(var_name, comp)->vectorTagSln(tag);
 }

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.

Reimplemented in Function.

Definition at line 69 of file SetupInterface.h.

69 {}

◆ cyclicDependencyError() [1/2]

template<typename T , typename T2 , typename NameFunc >

void DependencyResolverInterface::cyclicDependencyError	(	CyclicDependencyException< T2 > &	e,
		const std::string &	header,
		NameFunc &&	name_func
	)

staticinherited

A helper method for cyclic errors.

Definition at line 134 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] = name_func(cycle[i]);
   oss << MooseUtils::join(names, " <- ");
   mooseError(oss.str());
 }

◆ cyclicDependencyError() [2/2]

template<typename T , typename T2 >

void DependencyResolverInterface::cyclicDependencyError	(	CyclicDependencyException< T2 > &	e,
		const std::string &	header
	)

staticinherited

Definition at line 151 of file DependencyResolverInterface.h.

 {
   cyclicDependencyError<T>(e, header, [](const auto & obj) { return static_cast<T>(obj)->name(); });
 }

◆ 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 283 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 358 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 276 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 301 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 330 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 340 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 653 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 750 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 648 of file MaterialPropertyInterface.h.

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

◆ determineState()

Moose::StateArg TransientInterface::determineState ( ) const

inlineinherited

Create a functor state argument that corresponds to the implicit state of this object.

If we are implicit then we will return the current state. If we are not, then we will return the old state

Definition at line 92 of file TransientInterface.h.

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

◆ directValue() [1/3]

Real SolutionUserObjectBase::directValue	(	const Node *	node,
		const std::string &	var_name
	)		const

inherited

Return a value directly from a Node.

Parameters

node	A pointer to the node at which a value is desired
var_name	The variable from which to extract a value

Returns: The desired value for the given node and variable name

Definition at line 439 of file SolutionUserObjectBase.C.

Referenced by SolutionAux::computeValue(), SolutionUserObjectBase::directValue(), and SolutionUserObjectBase::scalarValue().

 {
   // Get the libmesh variable and system numbers
   unsigned int var_num = _system->variable_number(var_name);
   unsigned int sys_num = _system->number();
 
   // Get the node id and associated dof
   dof_id_type node_id = node->id();
   const Node & sys_node = _system->get_mesh().node_ref(node_id);
   mooseAssert(sys_node.n_dofs(sys_num, var_num) > 0,
               "Variable " << var_name << " has no DoFs on node " << sys_node.id());
   dof_id_type dof_id = sys_node.dof_number(sys_num, var_num, 0);
 
   // Return the desired value for the dof
   return directValue(dof_id);
 }

◆ directValue() [2/3]

Real SolutionUserObjectBase::directValue	(	const Elem *	elem,
		const std::string &	var_name
	)		const

inherited

Return a value from the centroid of an element.

Parameters

elem	A pointer to the element at which a value is desired
var_name	The variable from which to extract a value

Returns: The desired value for the given element and variable name

Definition at line 457 of file SolutionUserObjectBase.C.

 {
   // Get the libmesh variable and system numbers
   unsigned int var_num = _system->variable_number(var_name);
   unsigned int sys_num = _system->number();
 
   // Get the element id and associated dof
   dof_id_type elem_id = elem->id();
   const Elem & sys_elem = _system->get_mesh().elem_ref(elem_id);
   mooseAssert(sys_elem.n_dofs(sys_num, var_num) > 0,
               "Variable " << var_name << " has no DoFs on element " << sys_elem.id());
   dof_id_type dof_id = sys_elem.dof_number(sys_num, var_num, 0);
 
   // Return the desired value
   return directValue(dof_id);
 }

◆ directValue() [3/3]

Real SolutionUserObjectBase::directValue ( dof_id_type dof_index ) const

protectedvirtualinherited

Method for extracting value of solution based on the DOF, this is called by the public overloaded function that accept a node or element pointer.

Parameters

dof_index The DOF of the solution desired

Returns: The solution at the given DOF

Definition at line 1083 of file SolutionUserObjectBase.C.

 {
   Real val = (*_serialized_solution)(dof_index);
   if (_interpolate_times && (_file_type == "exodusII" || _file_type == "nemesis"))
   {
     Real val2 = (*_serialized_solution2)(dof_index);
     val = val + (val2 - val) * _interpolation_factor;
   }
   return val;
 }

◆ discontinuousPointValue() [1/2]

std::map<const Elem *, Real> SolutionUserObjectBase::discontinuousPointValue	(	Real	t,
		Point	pt,
		const unsigned int	local_var_index,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns a value at a specific location and variable for cases where the solution is multivalued at element faces Use pointValue for continuous shape functions or if you are sure your point is within an element!

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
local_var_index	The local index of the variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Referenced by SolutionUserObjectBase::discontinuousPointValue(), and SolutionUserObjectBase::pointValueWrapper().

◆ discontinuousPointValue() [2/2]

std::map< const Elem *, Real > SolutionUserObjectBase::discontinuousPointValue	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns a value at a specific location and variable for cases where the solution is multivalued at element faces Use pointValue for continuous shape functions or if you are sure your point is within an element!

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 846 of file SolutionUserObjectBase.C.

 {
   const unsigned int local_var_index = getLocalVarIndex(var_name);
   return discontinuousPointValue(t, p, local_var_index, subdomain_ids);
 }

◆ discontinuousPointValueGradient() [1/2]

std::map< const Elem *, RealGradient > SolutionUserObjectBase::discontinuousPointValueGradient	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns the gradient at a specific location and variable for cases where the gradient is multivalued (e.g.

at element faces) Use pointValueGradient for continuous gradients or if you are sure your point is within an element!

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 1016 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::pointValueGradientWrapper().

 {
   const unsigned int local_var_index = getLocalVarIndex(var_name);
   return discontinuousPointValueGradient(t, p, local_var_index, subdomain_ids);
 }

◆ discontinuousPointValueGradient() [2/2]

std::map<const Elem *, libMesh::RealGradient> SolutionUserObjectBase::discontinuousPointValueGradient	(	Real	t,
		Point	pt,
		const unsigned int	local_var_index,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns the gradient at a specific location and variable for cases where the gradient is multivalued (e.g.

at element faces) Use pointValueGradient for continuous gradients or if you are sure your point is within an element!

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
local_var_index	The local index of the variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 49 of file MooseObject.h.

Referenced by EigenKernel::enabled().

49 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:71

◆ errorPrefix()

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

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 274 of file MooseBase.h.

274 { return messagePrefix(); }

MooseBase::messagePrefix

std::string messagePrefix(const bool hit_prefix=true) const

Definition: MooseBase.h:266

◆ evalMeshFunction()

Real SolutionUserObjectBase::evalMeshFunction	(	const Point &	p,
		const unsigned int	local_var_index,
		unsigned int	func_num,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

protectedinherited

A wrapper method for calling the various MeshFunctions used for reading the data.

Parameters

p	The location at which data is desired
local_var_index	The local index of the variable to extract data from
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere
func_num	The MeshFunction index to use (1 = _mesh_function; 2 = _mesh_function2)

Definition at line 1095 of file SolutionUserObjectBase.C.

 {
   // Storage for mesh function output
   DenseVector<Number> output;
 
   // Extract a value from the _mesh_function
   {
     Threads::spin_mutex::scoped_lock lock(_solution_user_object_mutex);
 
     if (func_num == 1)
     {
       // Check the cache
       if (p == _cached_p && (!subdomain_ids || (*subdomain_ids == _cached_subdomain_ids)))
         return _cached_values(local_var_index);
 
       // else get a new value
       (*_mesh_function)(p, 0.0, output, subdomain_ids);
       // and cache it
       _cached_p = p;
       if (subdomain_ids)
         _cached_subdomain_ids = *subdomain_ids;
       _cached_values = output;
     }
 
     // Extract a value from _mesh_function2
     else if (func_num == 2)
     {
       // Check the cache
       if (p == _cached_p2 && (!subdomain_ids || (*subdomain_ids == _cached_subdomain_ids2)))
         return _cached_values2(local_var_index);
 
       // else get a new value
       (*_mesh_function2)(p, 0.0, output, subdomain_ids);
       // and cache it
       _cached_p2 = p;
       if (subdomain_ids)
         _cached_subdomain_ids2 = *subdomain_ids;
       _cached_values2 = output;
     }
     else
       mooseError("The func_num must be 1 or 2");
   }
 
   // Error if the data is out-of-range, which will be the case if the mesh functions are evaluated
   // outside the domain
   if (output.size() == 0)
   {
     std::ostringstream oss;
     p.print(oss);
     mooseError("Failed to access the data for variable '",
                _system_variables[local_var_index],
                "' at point ",
                oss.str(),
                " in the '",
                name(),
                "' SolutionUserObjectBase");
   }
   return output(local_var_index);
 }

◆ evalMeshFunctionGradient()

RealGradient SolutionUserObjectBase::evalMeshFunctionGradient	(	const Point &	p,
		const unsigned int	local_var_index,
		unsigned int	func_num,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

protectedinherited

A wrapper method interfacing with the libMesh mesh function for evaluating the gradient.

Parameters

p	The location at which data is desired
local_var_index	The local index of the variable to extract data from
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere
func_num	The MeshFunction index to use (1 = _mesh_function; 2 = _mesh_function2)

Definition at line 1212 of file SolutionUserObjectBase.C.

 {
   // Storage for mesh function output
   std::vector<Gradient> output;
 
   // Extract a value from the _mesh_function
   {
     Threads::spin_mutex::scoped_lock lock(_solution_user_object_mutex);
     if (func_num == 1)
       _mesh_function->gradient(p, 0.0, output, subdomain_ids);
 
     // Extract a value from _mesh_function2
     else if (func_num == 2)
       _mesh_function2->gradient(p, 0.0, output, subdomain_ids);
 
     else
       mooseError("The func_num must be 1 or 2");
   }
 
   // Error if the data is out-of-range, which will be the case if the mesh functions are evaluated
   // outside the domain
   if (output.size() == 0)
   {
     std::ostringstream oss;
     p.print(oss);
     mooseError("Failed to access the data for variable '",
                _system_variables[local_var_index],
                "' at point ",
                oss.str(),
                " in the '",
                name(),
                "' SolutionUserObjectBase");
   }
   return output[local_var_index];
 }

◆ evalMultiValuedMeshFunction()

std::map< const Elem *, Real > SolutionUserObjectBase::evalMultiValuedMeshFunction	(	const Point &	p,
		const unsigned int	local_var_index,
		unsigned int	func_num,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

protectedinherited

A wrapper method for calling the various MeshFunctions that calls the mesh function functionality for evaluating discontinuous shape functions near a face (where it's multivalued)

Parameters

p	The location at which data is desired
local_var_index	The local index of the variable to extract data from
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere
func_num	The MeshFunction index to use (1 = _mesh_function; 2 = _mesh_function2)

Definition at line 1159 of file SolutionUserObjectBase.C.

 {
   // Storage for mesh function output
   std::map<const Elem *, DenseVector<Number>> temporary_output;
 
   // Extract a value from the _mesh_function
   {
     Threads::spin_mutex::scoped_lock lock(_solution_user_object_mutex);
     if (func_num == 1)
       _mesh_function->discontinuous_value(p, 0.0, temporary_output, subdomain_ids);
 
     // Extract a value from _mesh_function2
     else if (func_num == 2)
       _mesh_function2->discontinuous_value(p, 0.0, temporary_output, subdomain_ids);
 
     else
       mooseError("The func_num must be 1 or 2");
   }
 
   // Error if the data is out-of-range, which will be the case if the mesh functions are evaluated
   // outside the domain
   if (temporary_output.size() == 0)
   {
     std::ostringstream oss;
     p.print(oss);
     mooseError("Failed to access the data for variable '",
                _system_variables[local_var_index],
                "' at point ",
                oss.str(),
                " in the '",
                name(),
                "' SolutionUserObjectBase");
   }
 
   // Fill the actual map that is returned
   std::map<const Elem *, Real> output;
   for (auto & k : temporary_output)
   {
     mooseAssert(
         k.second.size() > local_var_index,
         "In SolutionUserObjectBase::evalMultiValuedMeshFunction variable with local_var_index "
             << local_var_index << " does not exist");
     output[k.first] = k.second(local_var_index);
   }
 
   return output;
 }

◆ evalMultiValuedMeshFunctionGradient()

std::map< const Elem *, RealGradient > SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient	(	const Point &	p,
		const unsigned int	local_var_index,
		unsigned int	func_num,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

protectedinherited

A wrapper method interfacing with the libMesh mesh function that calls the gradient functionality for evaluating potentially discontinuous gradients at element's faces (where it's multivalued)

Parameters

p	The location at which data is desired
local_var_index	The local index of the variable to extract data from
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere
func_num	The MeshFunction index to use (1 = _mesh_function; 2 = _mesh_function2)

Definition at line 1253 of file SolutionUserObjectBase.C.

 {
   // Storage for mesh function output
   std::map<const Elem *, std::vector<Gradient>> temporary_output;
 
   // Extract a value from the _mesh_function
   {
     Threads::spin_mutex::scoped_lock lock(_solution_user_object_mutex);
     if (func_num == 1)
       _mesh_function->discontinuous_gradient(p, 0.0, temporary_output, subdomain_ids);
 
     // Extract a value from _mesh_function2
     else if (func_num == 2)
       _mesh_function2->discontinuous_gradient(p, 0.0, temporary_output, subdomain_ids);
 
     else
       mooseError("The func_num must be 1 or 2");
   }
 
   // Error if the data is out-of-range, which will be the case if the mesh functions are evaluated
   // outside the domain
   if (temporary_output.size() == 0)
   {
     std::ostringstream oss;
     p.print(oss);
     mooseError("Failed to access the data for variable '",
                _system_variables[local_var_index],
                "' at point ",
                oss.str(),
                " in the '",
                name(),
                "' SolutionUserObjectBase");
   }
 
   // Fill the actual map that is returned
   std::map<const Elem *, RealGradient> output;
   for (auto & k : temporary_output)
   {
     mooseAssert(
         k.second.size() > local_var_index,
         "In SolutionUserObjectBase::evalMultiValuedMeshFunction variable with local_var_index "
             << local_var_index << " does not exist");
     output[k.first] = k.second[local_var_index];
   }
 
   return output;
 }

◆ evaluate() [1/2]

GenericReal< is_ad > FunctionParserUtils< is_ad >::evaluate	(	SymFunctionPtr &	parser,
		const std::string &	object_name = `""`
	)

protectedinherited

Evaluate FParser object and check EvalError.

Definition at line 87 of file FunctionParserUtils.C.

Referenced by ParsedSubdomainIDsGenerator::assignElemSubdomainID(), ParsedSubdomainMeshGenerator::assignElemSubdomainID(), ParsedConvergence::checkConvergence(), ParsedODEKernel::computeQpJacobian(), ParsedODEKernel::computeQpOffDiagJacobianScalar(), ParsedODEKernel::computeQpResidual(), ArrayParsedAux::computeValue(), ParsedVectorAux::computeValue(), ParsedAux::computeValue(), ParsedScalarReporter::finalize(), ParsedVectorReporter::finalize(), ParsedVectorRealReductionReporter::finalize(), ParsedVectorVectorRealReductionReporter::finalize(), ParsedPostprocessor::finalize(), ParsedGenerateNodeset::generate(), ParsedExtraElementIDGenerator::generate(), ParsedNodeTransformGenerator::generate(), ParsedCurveGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), LevelSetMeshingHelper::levelSetEvaluator(), ProjectSideSetOntoLevelSetGenerator::levelSetEvaluator(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), ParsedCurveGenerator::pointCalculator(), ParsedElementDeletionGenerator::shouldDelete(), and solutionSampleTime().

 {
   return evaluate(parser, _func_params, name);
 }

◆ evaluate() [2/2]

GenericReal< is_ad > FunctionParserUtils< is_ad >::evaluate	(	SymFunctionPtr &	parser,
		const std::vector< GenericReal< is_ad >> &	func_params,
		const std::string &	object_name = `""`
	)

protectedinherited

Evaluate FParser object and check EvalError.

This version uses a supplied vector of function parameters, which is useful if an object uses more than one parsed function, which may have different function parameter values.

Definition at line 94 of file FunctionParserUtils.C.

 {
   using std::isnan;
 
   // null pointer is a shortcut for vanishing derivatives, see functionsOptimize()
   if (parser == NULL)
     return 0.0;
 
   // set desired epsilon
   auto tmp_eps = parser->epsilon();
   parser->setEpsilon(_epsilon);
 
   // evaluate expression
   auto result = parser->Eval(func_params.data());
 
   // restore epsilon
   parser->setEpsilon(tmp_eps);
 
   // fetch fparser evaluation error (set to unknown if the JIT result is nan)
   int error_code = _enable_jit ? (isnan(result) ? -1 : 0) : parser->EvalError();
 
   // no error
   if (error_code == 0)
     return result;
 
   // hard fail or return not a number
   switch (_evalerror_behavior)
   {
     case FailureMethod::nan:
       return _quiet_nan;
 
     case FailureMethod::nan_warning:
       mooseWarning("In ",
                    name,
                    ": Parsed function evaluation encountered an error: ",
                    _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code]);
       return _quiet_nan;
 
     case FailureMethod::error:
       mooseError("In ",
                  name,
                  ": Parsed function evaluation encountered an error: ",
                  _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code]);
 
     case FailureMethod::exception:
       mooseException("In ",
                      name,
                      ": Parsed function evaluation encountered an error: ",
                      _eval_error_msg[(error_code < 0 || error_code > 5) ? 0 : error_code],
                      "\n Cutting timestep");
   }
 
   return _quiet_nan;
 }

◆ execute()

void SolutionUserObjectBase::execute ( )

overridevirtualinherited

Execute method.

Implements UserObject.

Definition at line 497 of file SolutionUserObjectBase.C.

498 {

499 }

◆ finalize()

void SolutionUserObjectBase::finalize ( )

overridevirtualinherited

Finalize.

This is called after execute() and after threadJoin()! This is probably where you want to do MPI communication!

Implements UserObjectBase.

Definition at line 480 of file SolutionUserObjectBase.C.

481 {

482 }

◆ flagInvalidSolutionInternal()

template<bool warning>

template void SolutionInvalidInterface::flagInvalidSolutionInternal< false > ( const InvalidSolutionID invalid_solution_id ) const

protectedinherited

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

 {
   mooseAssert(
       warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
       "Inconsistent warning flag");
   auto & solution_invalidity = _si_moose_base.getMooseApp().solutionInvalidity();
   if constexpr (!warning)
     if (!_si_problem || _si_problem->immediatelyPrintInvalidSolution())
       solution_invalidity.printDebug(invalid_solution_id);
   return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
 }

◆ functionsOptimize() [1/3]

virtual void FunctionParserUtils< is_ad >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedvirtualinherited

run FPOptimizer on the parsed function

◆ functionsOptimize() [2/3]

void FunctionParserUtils< true >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedinherited

◆ functionsOptimize() [3/3]

void FunctionParserUtils< true >::functionsOptimize ( SymFunctionPtr & parsed_function )

protectedinherited

Definition at line 211 of file FunctionParserUtils.C.

 {
   // set desired epsilon for optimization!
   auto tmp_eps = parsed_function->epsilon();
   parsed_function->setEpsilon(_epsilon);
 
   // base function
   if (!_disable_fpoptimizer)
     parsed_function->Optimize();
   if (!_enable_jit || !parsed_function->JITCompile())
     mooseError("AD parsed objects require JIT compilation to be enabled and working.");
 
   parsed_function->setEpsilon(tmp_eps);
 }

◆ gatherMax()

template<typename T >

void UserObjectBase::gatherMax ( T & value )

inlineinherited

Gather the parallel max of the variable passed in.

It takes care of values across all threads and CPUs (we DO hybrid parallelism!)

After calling this, the variable that was passed in will hold the gathered value.

Definition at line 108 of file UserObjectBase.h.

Referenced by SidesetInfoVectorPostprocessor::finalize(), ElementMaxLevelPostProcessor::finalize(), NodalMaxValue::finalize(), MeshDivisionFunctorReductionVectorPostprocessor::finalize(), and MemoryUsage::finalize().

   {
     _communicator.max(value);
   }

◆ gatherMin()

template<typename T >

void UserObjectBase::gatherMin ( T & value )

inlineinherited

Gather the parallel min of the variable passed in.

It takes care of values across all threads and CPUs (we DO hybrid parallelism!)

After calling this, the variable that was passed in will hold the gathered value.

Definition at line 120 of file UserObjectBase.h.

Referenced by PointValue::execute(), SidesetInfoVectorPostprocessor::finalize(), ScalarVariable::finalize(), NearestNodeNumberUO::finalize(), MeshDivisionFunctorReductionVectorPostprocessor::finalize(), and MemoryUsage::finalize().

   {
     _communicator.min(value);
   }

◆ gatherProxyValueMax()

template<typename T1 , typename T2 >

void UserObjectBase::gatherProxyValueMax	(	T1 &	proxy,
		T2 &	value
	)

inherited

Deteremine the value of a variable according to the parallel maximum of the provided proxy.

Parameters

[in]	proxy	maximum proxy will be selected
[in]	value	value to be obtained corresponding to the location of maximum proxy

Definition at line 203 of file UserObjectBase.h.

Referenced by NodalMaxValueId::finalize(), and ElementVariablesDifferenceMax::finalize().

 {
   // Get all proxy, value pairs. _communicator.maxloc would be faster but leads to
   // partitioning dependent results if the maximum proxy is not unique.
   std::vector<std::pair<T1, T2>> all(n_processors());
   const auto pair = std::make_pair(proxy, value);
   _communicator.allgather(pair, all);
 
   // find maximum, disambiguated by the value
   const auto it = std::max_element(all.begin(), all.end());
   proxy = it->first;
   value = it->second;
 }

◆ gatherProxyValueMin()

template<typename T1 , typename T2 >

void UserObjectBase::gatherProxyValueMin	(	T1 &	proxy,
		T2 &	value
	)

inherited

Determine the value of a variable according to which process has the parallel minimum of the provided proxy.

Parameters

[in]	proxy	minimum proxy will be selected
[in]	value	value to be obtained corresponding to the location of minimum proxy

Definition at line 219 of file UserObjectBase.h.

 {
   // get all proxy, value pairs
   std::vector<std::pair<T1, T2>> all(n_processors());
   const auto pair = std::make_pair(proxy, value);
   _communicator.allgather(pair, all);
 
   // find minimum, disambiguated by the value
   const auto it = std::min_element(all.begin(), all.end());
   proxy = it->first;
   value = it->second;
 }

◆ gatherSum()

template<typename T >

void UserObjectBase::gatherSum ( T & value )

inlineinherited

Gather the parallel sum of the variable passed in.

It takes care of values across all threads and CPUs (we DO hybrid parallelism!)

After calling this, the variable that was passed in will hold the gathered value.

Definition at line 96 of file UserObjectBase.h.

   {
     _communicator.sum(value);
   }

◆ getADMaterialProperty() [1/2]

template<typename T >

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

inlineinherited

Definition at line 115 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 476 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 152 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 519 of file MaterialPropertyInterface.h.

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

◆ getBase()

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

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 147 of file MooseBase.h.

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

147 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:505

◆ getBlockIdsToNames()

const std::map<SubdomainID, SubdomainName>& SolutionUserObjectBase::getBlockIdsToNames ( ) const

inlineinherited

Get the map from block id to block name.

Only works for ExodusII files.

Returns: Map from block ID to block name

Definition at line 293 of file SolutionUserObjectBase.h.

Referenced by SolutionIC::initialSetup().

   {
     return _block_id_to_name;
   }

◆ 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 780 of file MaterialPropertyInterface.h.

 {
   if (_mi_block_ids.empty())
     mooseError("getBlockMaterialProperty must be called by a block restrictable object");
 
   const auto name = _get_suffix.empty()
                         ? static_cast<const std::string &>(name_in)
                         : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
 
   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;
 }

◆ getBlockNamesToIds()

const std::map<SubdomainName, SubdomainID>& SolutionUserObjectBase::getBlockNamesToIds ( ) const

inlineinherited

Get the map from block name to block ID.

Only works for ExodusII files.

Returns: Map from block name to block ID

Definition at line 283 of file SolutionUserObjectBase.h.

Referenced by SolutionIC::initialSetup().

   {
     return _block_name_to_id;
   }

◆ getCheckedPointerParam()

template<typename T >

T MooseBase::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 460 of file MooseBase.h.

 {
   return _pars.getCheckedPointerParam<T>(name, error_string);
 }

◆ getCoupledMooseScalarVars()

const std::vector<MooseVariableScalar *>& ScalarCoupleable::getCoupledMooseScalarVars ( )

inlineinherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 52 of file ScalarCoupleable.h.

Referenced by AuxScalarKernel::AuxScalarKernel(), MortarScalarBase::computeJacobian(), KernelScalarBase::computeResidualAndJacobian(), and ScalarInitialCondition::ScalarInitialCondition().

   {
     return _coupled_moose_scalar_vars;
   }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // This will search the data paths for this relative path
   std::optional<std::string> error;
   Moose::DataFileUtils::Path found_path;
   {
     // Throw on error so that if getPath() fails, we can throw an error
     // with the context of _parent.mooseError()
     Moose::ScopedThrowOnError scoped_throw_on_error;
 
     try
     {
       found_path = Moose::DataFileUtils::getPath(relative_path);
     }
     catch (std::exception & e)
     {
       error = e.what();
     }
   }
 
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getDependObjects()

std::set< UserObjectName > UserObjectBase::getDependObjects ( ) const

inherited

Recursively return a set of user objects this user object depends on Note: this can be called only after all user objects are constructed.

Definition at line 126 of file UserObjectBase.C.

Referenced by AuxKernelBase::addUserObjectDependencyHelper().

 {
   std::set<UserObjectName> all;
   for (auto & v : _depend_uo)
   {
     all.insert(v);
     auto & uo = UserObjectInterface::getUserObjectBaseByName(v);
 
     // Add dependencies of other objects, but don't allow it to call itself. This can happen
     // through the PostprocessorInterface if a Postprocessor calls getPostprocessorValueByName
     // with it's own name. This happens in the Receiver, which could use the FEProblem version of
     // the get method, but this is a fix that prevents an infinite loop occurring by accident for
     // future objects.
     if (uo.name() != name())
     {
       auto uos = uo.getDependObjects();
       for (auto & t : uos)
         all.insert(t);
     }
   }
   return all;
 }

◆ getDistribution() [1/2]

const Distribution & DistributionInterface::getDistribution ( const std::string & name ) const

inherited

Get a distribution with a given name.

Parameters

name	The name of the parameter key of the distribution to retrieve

Returns: The distribution with name associated with the parameter 'name'

Definition at line 41 of file DistributionInterface.C.

Referenced by DistributionInterface::getDistribution(), and DistributionInterface::getDistributionByName().

 {
   DistributionName dist_name = _dni_params.get<DistributionName>(name);
   return _dni_feproblem.getDistribution(dist_name);
 }

◆ getDistribution() [2/2]

template<typename T >

const T & DistributionInterface::getDistribution ( const std::string & name ) const

inherited

Definition at line 77 of file DistributionInterface.h.

 {
   try
   {
     const T & dist = dynamic_cast<const T &>(getDistribution(name));
     return dist;
   }
   catch (std::bad_cast & exception)
   {
     DistributionName dist_name = _dni_params.get<DistributionName>(name);
     mooseError("The '",
                _dni_moose_object_ptr->name(),
                "' object failed to retrieve '",
                dist_name,
                "' distribution with the desired type.");
   }
 }

◆ getDistributionByName() [1/2]

const Distribution & DistributionInterface::getDistributionByName ( const DistributionName & name ) const

inherited

Get a distribution with a given name.

Parameters

name	The name of the distribution to retrieve

Returns: The distribution with name 'name'

Definition at line 48 of file DistributionInterface.C.

Referenced by RandomIC::RandomIC().

 {
   return _dni_feproblem.getDistribution(name);
 }

◆ getDistributionByName() [2/2]

template<typename T >

const T & DistributionInterface::getDistributionByName ( const std::string & name ) const

inherited

Definition at line 97 of file DistributionInterface.h.

 {
   try
   {
     const T & dist = dynamic_cast<const T &>(getDistribution(name));
     return dist;
   }
   catch (std::bad_cast & exception)
   {
     mooseError("The '",
                _dni_moose_object_ptr->name(),
                "' object failed to retrieve '",
                name,
                "' distribution with the desired type.");
   }
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 73 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), Control::Control(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), GeneralReporter::shouldStore(), and PIDTransientControl::timestepSetup().

 {
   return _execute_enum;
 }

◆ 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 34 of file FunctionInterface.C.

Referenced by FunctionDT::FunctionDT(), and Output::Output().

 {
   return getFunctionByName(_fni_params.get<FunctionName>(name));
 }

◆ 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 40 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(), FunctionInterface::getFunction(), LinearCombinationFunction::LinearCombinationFunction(), LineFunctionSampler::LineFunctionSampler(), and PiecewiseFunction::PiecewiseFunction().

 {
   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 103 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 921 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 141 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 934 of file MaterialPropertyInterface.h.

 {
 #ifdef MOOSE_KOKKOS_ENABLED
   if (_is_kokkos_object)
     _mi_moose_object.mooseError(
         "Attempted to retrieve a standard MOOSE material property from a Kokkos object.");
 #endif
 
   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 886 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 828 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 847 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 836 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>();
 }

◆ getHitNode()

const hit::Node* MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 136 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

136 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:136

◆ getKokkosBlockMaterialProperty()

template<typename T , unsigned int dimension, unsigned int state>

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > MaterialPropertyInterface::getKokkosBlockMaterialProperty ( const MaterialPropertyName & name )

inherited

Retrieve a Kokkos material property with the mesh blocks where it is defined NOTE: This is not a drop-in replacement of getBlockMaterialProperty().

Unlike the original API, this function cannot be called after object construction

Template Parameters

T	The property data type
dimension	The property dimension
state	The property state

Parameters

name	The name of the material property to retrieve

Returns: The Kokkos material property with the name 'name' and the set of blocks where the property is valid

Definition at line 1047 of file MaterialPropertyInterface.h.

 {
   if (!_is_kokkos_object)
     _mi_moose_object.mooseError(
         "Attempted to retrieve a Kokkos material property from a standard MOOSE object.");
 
   if (_mi_block_ids.empty())
     mooseError("getKokkosBlockMaterialProperty must be called by a block restrictable object");
 
   const auto name = _get_suffix.empty()
                         ? static_cast<const std::string &>(name_in)
                         : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
 
   using pair_type = std::pair<Moose::Kokkos::MaterialProperty<T, dimension>, std::set<SubdomainID>>;
 
   if (!hasKokkosMaterialPropertyByName<T, dimension>(name))
     return pair_type(Moose::Kokkos::MaterialProperty<T, dimension>(), {});
 
   checkExecutionStage();
 
   // Mark property as requested
   markMatPropRequested(name);
 
   // Call first so that the ID gets registered
   auto prop = _material_data.getKokkosProperty<T, dimension, state>(name);
   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
   if constexpr (state == 0)
     addConsumedPropertyName(_mi_moose_object_name, name);
 
   getKokkosMaterialPropertyHook(name_in, state);
 
   return prop_blocks_pair;
 }

◆ getKokkosFunction() [1/2]

Moose::Kokkos::Function FunctionInterface::getKokkosFunction ( const std::string & name ) const

inherited

Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU.

Parameters

name	The name of the parameter key of the Kokkos function to retrieve

Returns: The copy of the Kokkos function of the abstract type with name associated with the parameter 'name'

◆ getKokkosFunction() [2/2]

template<typename T >

const T & FunctionInterface::getKokkosFunction ( const std::string & name ) const

inherited

Get a Kokkos function of a concrete type with a given name.

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the parameter key of the Kokkos function to retrieve

Returns: The reference of the Kokkos function of the concrete type with name associated with the parameter 'name'. Always store it in a reference wrapper if to be used on GPU.

Definition at line 165 of file FunctionInterface.h.

 {
   return getKokkosFunctionByName<T>(_fni_params.get<FunctionName>(name));
 }

◆ getKokkosFunctionByName() [1/2]

Moose::Kokkos::Function FunctionInterface::getKokkosFunctionByName ( const FunctionName & name ) const

inherited

Get a Kokkos function of an abstract type with a given name Calling this function will error out currently if Kokkos was configured with GPU.

Parameters

name	The name of the Kokkos function to retrieve

Returns: The copy of the Kokkos function of the abstract type with name 'name'

◆ getKokkosFunctionByName() [2/2]

template<typename T >

const T & FunctionInterface::getKokkosFunctionByName ( const FunctionName & name ) const

inherited

Get a Kokkos function of a concrete type with a given name.

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the Kokkos function to retrieve

Returns: The reference of the Kokkos function of the concrete type with name 'name'. Always store it in a reference wrapper if to be used on GPU.

Definition at line 172 of file FunctionInterface.h.

 {
   auto function = dynamic_cast<const T *>(getKokkosFunctionByNameHelper(name));
 
   if (!function)
     _fni_object.mooseError(
         "Kokkos function '", name, "' is not of type '", MooseUtils::prettyCppType<T>(), "'");
 
   return *function;
 }

◆ getKokkosMaterialProperty()

template<typename T , unsigned int dimension = 0, unsigned int state = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialProperty ( const std::string & name )

inlineinherited

Get a Kokkos material property for any state.

Template Parameters

T	The property data type
dimension	The property dimension
state	The property state

Parameters

name	The property name or the parameter name containing the property name

Returns: The Kokkos material property

Definition at line 215 of file MaterialPropertyInterface.h.

   {
     return getKokkosMaterialPropertyByName<T, dimension, state>(getMaterialPropertyName(name));
   }

◆ getKokkosMaterialPropertyByName()

template<typename T , unsigned int dimension, unsigned int state>

Moose::Kokkos::MaterialProperty< T, dimension > MaterialPropertyInterface::getKokkosMaterialPropertyByName ( const std::string & prop_name_in )

inherited

Get a Kokkos material property by property name for any state.

Template Parameters

T	The property data type
dimension	The property dimension
state	The property state

Parameters

prop_name_in The property name

Returns: The Kokkos material property

Definition at line 1001 of file MaterialPropertyInterface.h.

 {
   if (!_is_kokkos_object)
     _mi_moose_object.mooseError(
         "Attempted to retrieve a Kokkos material property from a standard MOOSE object.");
 
   if constexpr (std::is_same_v<T, Real>)
   {
     std::istringstream ss(prop_name_in);
     Real value;
 
     // Check if the string parsed cleanly into a Real number
     if (ss >> value && ss.eof())
       return Moose::Kokkos::MaterialProperty<T, dimension>(value);
   }
 
   const auto prop_name =
       _get_suffix.empty()
           ? static_cast<const std::string &>(prop_name_in)
           : MooseUtils::join(std::vector<std::string>({prop_name_in, _get_suffix}), "_");
 
   checkExecutionStage();
   checkMaterialProperty(prop_name, state);
 
   // Mark property as requested
   markMatPropRequested(prop_name);
 
   // Update the boolean flag
   _get_material_property_called = true;
 
   // Call first so that the ID gets registered
   auto prop = _material_data.getKokkosProperty<T, dimension, state>(prop_name);
 
   // Does the material data used here matter?
   _material_property_dependencies.insert(_material_data.getPropertyId(prop_name));
 
   if constexpr (state == 0)
     addConsumedPropertyName(_mi_moose_object_name, prop_name);
 
   getKokkosMaterialPropertyHook(prop_name_in, state);
 
   return prop;
 }

◆ getKokkosMaterialPropertyHook()

virtual void MaterialPropertyInterface::getKokkosMaterialPropertyHook	(	const std::string &	,
		const unsigned int
	)

inlineprotectedvirtualinherited

A virtual method that can be overriden by Kokkos objects to insert additional operations in getKokkosMaterialProperty.

Parameters

prop_name_in	The property name
state	The property state

Reimplemented in Moose::Kokkos::AuxKernel, and Moose::Kokkos::Material.

Definition at line 616 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

618 {

619 }

◆ getKokkosMaterialPropertyOld()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOld ( const std::string & name )

inlineinherited

Get an old Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

name	The property name or the parameter name containing the property name

Returns: The Kokkos material property

Definition at line 228 of file MaterialPropertyInterface.h.

   {
     return getKokkosMaterialPropertyByName<T, dimension, 1>(getMaterialPropertyName(name));
   }

◆ getKokkosMaterialPropertyOldByName()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOldByName ( const std::string & prop_name )

inlineinherited

Get an old Kokkos material property by property name.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name The property name

Returns: The Kokkos material property

Definition at line 189 of file MaterialPropertyInterface.h.

   {
     return getKokkosMaterialPropertyByName<T, dimension, 1>(prop_name);
   }

◆ getKokkosMaterialPropertyOlder()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOlder ( const std::string & name )

inlineinherited

Get an older Kokkos material property.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

name	The property name or the parameter name containing the property name

Returns: The Kokkos material property

Definition at line 241 of file MaterialPropertyInterface.h.

   {
     return getKokkosMaterialPropertyByName<T, dimension, 2>(getMaterialPropertyName(name));
   }

◆ getKokkosMaterialPropertyOlderByName()

template<typename T , unsigned int dimension = 0>

Moose::Kokkos::MaterialProperty<T, dimension> MaterialPropertyInterface::getKokkosMaterialPropertyOlderByName ( const std::string & prop_name )

inlineinherited

Get an older Kokkos material property by property name.

Template Parameters

T	The property data type
dimension	The property dimension

Parameters

prop_name The property name

Returns: The Kokkos material property

Definition at line 202 of file MaterialPropertyInterface.h.

   {
     return getKokkosMaterialPropertyByName<T, dimension, 2>(prop_name);
   }

◆ getLocalVarIndex()

unsigned int SolutionUserObjectBase::getLocalVarIndex ( const std::string & var_name ) const

inherited

Returns the local index for a given variable name.

Parameters

var_name The name of the variable for which the index is located

Returns: The local index of the variable

Definition at line 714 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::discontinuousPointValue(), SolutionUserObjectBase::discontinuousPointValueGradient(), Axisymmetric2D3DSolutionFunction::initialSetup(), SolutionUserObjectBase::pointValue(), and SolutionUserObjectBase::pointValueGradient().

 {
   // Extract the variable index for the MeshFunction(s)
   std::map<std::string, unsigned int>::const_iterator it = _local_variable_index.find(var_name);
   if (it == _local_variable_index.end())
     mooseError("Value requested for nonexistent variable '",
                var_name,
                "' in the '",
                name(),
                "' SolutionUserObjectBase.\nSystem selected: ",
                _system_name,
                "\nAvailable variables:\n",
                ConsoleUtils::formatString(Moose::stringify(_system_variables), ""));
   return it->second;
 }

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

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

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

◆ getMaterialProperty() [1/2]

template<typename T >

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

inlineinherited

Definition at line 109 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 463 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 124 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 118 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosBlockMaterialProperty().

 {
   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 130 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 136 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 146 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 507 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyCalled()

virtual bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlinevirtualinherited

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

Reimplemented in IPHDGKernel, and IPHDGBC.

Definition at line 434 of file MaterialPropertyInterface.h.

Referenced by IPHDGBC::getMaterialPropertyCalled(), and IPHDGKernel::getMaterialPropertyCalled().

434 { return _get_material_property_called; }

MaterialPropertyInterface::_get_material_property_called

bool _get_material_property_called

Initialized to false.

Definition: MaterialPropertyInterface.h:675

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

Referenced by InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), MaterialPropertyInterface::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), MaterialPropertyInterface::getGenericZeroMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyOld(), MaterialPropertyInterface::getKokkosMaterialPropertyOlder(), MaterialPropertyInterface::hasADMaterialProperty(), MaterialPropertyInterface::hasKokkosMaterialProperty(), 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 120 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 529 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 157 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 551 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 125 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 540 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 162 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 562 of file MaterialPropertyInterface.h.

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

◆ getMatPropDependencies()

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

inlinevirtualinherited

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

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

Reimplemented in Material, InterfaceMaterial, Moose::Kokkos::Material, IPHDGKernel, and IPHDGBC.

Definition at line 442 of file MaterialPropertyInterface.h.

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

   {
     return _material_property_dependencies;
   }

◆ getMeshFileDimension()

unsigned int SolutionUserObjectBase::getMeshFileDimension ( ) const

inlineinherited

Return the spatial dimension of the mesh file.

Returns: The spatial dimension of the mesh file

Definition at line 271 of file SolutionUserObjectBase.h.

271 { return _mesh->spatial_dimension(); }

SolutionUserObjectBase::_mesh

std::unique_ptr< libMesh::MeshBase > _mesh

Pointer the libMesh::mesh object.

Definition: SolutionUserObjectBase.h:430

◆ getMeshFileName()

const std::string SolutionUserObjectBase::getMeshFileName ( ) const

inlineinherited

Return the name of the mesh file this object read the solution from.

Definition at line 276 of file SolutionUserObjectBase.h.

Referenced by SolutionIC::initialSetup().

276 { return _mesh_file; }

SolutionUserObjectBase::_mesh_file

std::string _mesh_file

The XDA/ExodusII/XDR/Nemesis file that is being read.

Definition: SolutionUserObjectBase.h:400

◆ getMeshProperty() [1/2]

template<typename T >

const T & MeshMetaDataInterface::getMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)

protectedinherited

Method for retrieving a property with the given type and name exists in the mesh meta-data store.

This method will throw an error if the property does not exist.

Definition at line 142 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     mooseErrorInternal("Failed to get mesh property '", prefix, "/", data_name, "'");
 
   auto value = &getMeshPropertyInternal(data_name, prefix);
   mooseAssert(value->declared(), "Value has not been declared");
   const RestartableData<T> * T_value = dynamic_cast<const RestartableData<T> *>(value);
   if (!T_value)
     mooseErrorInternal("While retrieving mesh property '",
                        prefix,
                        "/",
                        data_name,
                        "' with type '",
                        MooseUtils::prettyCppType<T>(),
                        "',\nthe property exists with different type '",
                        value->type(),
                        "'");
   return T_value->get();
 }

◆ getMeshProperty() [2/2]

template<typename T >

const T& MeshMetaDataInterface::getMeshProperty ( const std::string & data_name )

inlineprotectedinherited

Definition at line 64 of file MeshMetaDataInterface.h.

   {
     return getMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarInterfaceWarehouse::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), FEProblemBase::getDistribution(), FEProblemBase::getFunction(), FEProblemBase::getFVInterpolationMethod(), FEProblemBase::getMultiApp(), FEProblemBase::getSampler(), DefaultConvergenceBase::getSharedExecutionerParam(), FEProblemBase::getUserObjectBase(), FEProblemBase::getVectorPostprocessorObjectByName(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

87 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:385

◆ getOptionalADMaterialProperty()

template<typename T >

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

inlineinherited

Definition at line 260 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 254 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 266 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 271 of file MaterialPropertyInterface.h.

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

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::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 416 of file MooseBase.h.

 {
   return InputParameters::getParamHelper<T>(name, _pars);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::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 453 of file MooseBase.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 898 of file MaterialPropertyInterface.h.

 {
   // Check if it's just a constant
   if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
   {
     _get_material_property_called = true;
     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 195 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 46 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel(), FunctionValuePostprocessor::FunctionValuePostprocessor(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), and ParsedPostprocessor::ParsedPostprocessor().

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

◆ getPostprocessorValueByName()

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

virtualinherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns: A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 67 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel(), PIDTransientControl::execute(), IterationAdaptiveDT::IterationAdaptiveDT(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MultiPostprocessorConvergence::MultiPostprocessorConvergence(), ParsedODEKernel::ParsedODEKernel(), SecantSolve::savePostprocessorValues(), SteffensenSolve::savePostprocessorValues(), PicardSolve::savePostprocessorValues(), SumPostprocessor::SumPostprocessor(), Terminator::Terminator(), SecantSolve::transformPostprocessors(), SteffensenSolve::transformPostprocessors(), PicardSolve::transformPostprocessors(), and VectorOfPostprocessors::VectorOfPostprocessors().

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

◆ getPostprocessorValueOld()

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

inherited

Definition at line 53 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 73 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 60 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 79 of file PostprocessorInterface.C.

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

◆ getRenamedParam()

template<typename T >

const T & MooseBase::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 430 of file MooseBase.h.

 {
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Second most: accept old parameter
   if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return getParam<T>(old_name);
   // Third most: accept default for new parameter
   if (isParamValid(new_name) && !isParamValid(old_name))
     return getParam<T>(new_name);
   // Refuse: no default, no value passed
   if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError("parameter '" + new_name +
                "' is being retrieved without being set.\nDid you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
                old_name + "'");
 }

◆ getReporterContextBaseByName()

const ReporterContextBase & ReporterInterface::getReporterContextBaseByName ( const ReporterName & reporter_name ) const

protectedinherited

Get the reporter context to allow non-typed operations with the data.

Parameters

reporter_name A ReporterName object that for the desired Reporter context.

Returns: ReporterContextBase of the reporter value

Definition at line 60 of file ReporterInterface.C.

 {
   if (!reportersAdded())
     _ri_moose_object.mooseError(
         "Cannot call getReporterContextBaseByName() until all Reporters have been constructed.");
 
   return _ri_reporter_data.getReporterContextBase(reporter_name);
 }

◆ getReporterName()

const ReporterName & ReporterInterface::getReporterName ( const std::string & param_name ) const

protectedinherited

Returns: The ReporterName associated with the parametre param_name.

Performs error checking to mak sure that the parameter is valid.

Definition at line 70 of file ReporterInterface.C.

Referenced by ReporterInterface::getReporterValue(), and ReporterInterface::hasReporterValue().

 {
   if (!_ri_params.isParamValid(param_name))
     _ri_moose_object.mooseError(
         "When getting a Reporter, failed to get a parameter with the name \"",
         param_name,
         "\".",
         "\n\nKnown parameters:\n",
         _ri_moose_object.parameters());
 
   if (_ri_params.isType<ReporterName>(param_name))
     return _ri_params.get<ReporterName>(param_name);
 
   _ri_moose_object.mooseError("Supplied parameter with name \"",
                               param_name,
                               "\" of type \"",
                               _ri_params.type(param_name),
                               "\" is not an expected type for getting a Reporter.\n\n",
                               "The expected type is \"ReporterName\".");
 }

◆ getReporterValue() [1/2]

template<typename T >

const T & ReporterInterface::getReporterValue	(	const std::string &	param_name,
		const std::size_t	time_index = `0`
	)

protectedinherited

doco-normal-methods-begin Returns read-only reference to a Reporter value that is provided by an input parameter.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

param_name	The name of the parameter that gives the name of the Reporter, which must be a ReporterName parameter (i.e., getParam<ReporterName>(param_name)).
mode	The mode that the object will consume the Reporter value time_index (optional) If zero is provided the current value is returned. Use a positive index to return previous values (1 = older, 2 = older, etc.). The maximum number of old values is dictated by the ReporterData object.

Definition at line 148 of file ReporterInterface.h.

 {
   return getReporterValue<T>(param_name, REPORTER_MODE_UNSET, time_index);
 }

◆ getReporterValue() [2/2]

template<typename T >

const T & ReporterInterface::getReporterValue	(	const std::string &	param_name,
		ReporterMode	mode,
		const std::size_t	time_index = `0`
	)

protectedinherited

Definition at line 155 of file ReporterInterface.h.

 {
   const auto & reporter_name = getReporterName(param_name);
 
   possiblyCheckHasReporter<T>(reporter_name, param_name);
 
   return getReporterValueByName<T>(reporter_name, mode, time_index);
 }

◆ getReporterValueByName() [1/2]

template<typename T >

const T & ReporterInterface::getReporterValueByName	(	const ReporterName &	reporter_name,
		const std::size_t	time_index = `0`
	)

protectedinherited

Returns read-only reference to a Reporter value that is provided by name directly.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

reporter_name	A ReporterName object that for the desired Reporter value.
mode	The mode that the object will consume the Reporter value time_index (optional) If zero is provided the current value is returned. Use a positive index to return previous values (1 = older, 2 = older, etc.). The maximum number of old values is dictated by the ReporterData object.

Definition at line 168 of file ReporterInterface.h.

Referenced by ParsedVectorReporter::ParsedVectorReporter().

 {
   return getReporterValueByName<T>(reporter_name, REPORTER_MODE_UNSET, time_index);
 }

◆ getReporterValueByName() [2/2]

template<typename T >

const T & ReporterInterface::getReporterValueByName	(	const ReporterName &	reporter_name,
		ReporterMode	mode,
		const std::size_t	time_index = `0`
	)

protectedinherited

Definition at line 176 of file ReporterInterface.h.

 {
   possiblyCheckHasReporter<T>(reporter_name);
 
   addReporterDependencyHelper(reporter_name);
 
   return _ri_reporter_data.getReporterValue<T>(reporter_name, _ri_moose_object, mode, time_index);
 }

◆ getRequestedItems()

const std::set<std::string>& UserObjectBase::getRequestedItems ( )

inlineoverridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 149 of file UserObjectBase.h.

149 { return _depend_uo; }

UserObjectBase::_depend_uo

std::set< std::string > _depend_uo

Depend UserObjects that to be used both for determining user object sorting and by AuxKernel for find...

Definition: UserObjectBase.h:194

◆ 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 294 of file Restartable.h.

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

◆ getSampler() [1/2]

template<>

Sampler& SamplerInterface::getSampler ( const std::string & name )

inherited

Definition at line 38 of file SamplerInterface.C.

 {
   return _si_feproblem.getSampler(_si_params.get<SamplerName>(name));
 }

◆ getSampler() [2/2]

template<typename T >

T & SamplerInterface::getSampler ( const std::string & name )

inherited

Get a sampler with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns: The sampler with name associated with the parameter 'name'

Definition at line 77 of file SamplerInterface.h.

 {
   return getSamplerByName<T>(_si_params.get<SamplerName>(name));
 }

◆ getSamplerByName() [1/2]

template<>

Sampler& SamplerInterface::getSamplerByName ( const SamplerName & name )

inherited

Definition at line 45 of file SamplerInterface.C.

 {
   return _si_feproblem.getSampler(name, _si_tid);
 }

◆ getSamplerByName() [2/2]

template<typename T >

T & SamplerInterface::getSamplerByName ( const SamplerName & name )

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 84 of file SamplerInterface.h.

 {
   Sampler * base_ptr = &_si_feproblem.getSampler(name, _si_tid);
   T * obj_ptr = dynamic_cast<T *>(base_ptr);
   if (!obj_ptr)
     mooseError("Failed to find a Sampler object with the name '", name, "' for the desired type.");
   return *obj_ptr;
 }

◆ getScalarVar()

const MooseVariableScalar * ScalarCoupleable::getScalarVar	(	const std::string &	var_name,
		unsigned int	comp
	)		const

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

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

Returns: Pointer to the desired variable

Definition at line 336 of file ScalarCoupleable.C.

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

◆ getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 62 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_matrix_tags;
   }

◆ getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 57 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_vector_tags;
   }

◆ getScatterVectorPostprocessorValue()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 119 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueByName()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 128 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

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

◆ getScatterVectorPostprocessorValueOld()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 135 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueOldByName()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 144 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

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

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

Referenced by MFEMProblem::addImagComponentToBC(), MFEMProblem::addImagComponentToKernel(), MFEMProblem::addRealComponentToBC(), MFEMProblem::addRealComponentToKernel(), and WebServerControl::addServerAction().

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

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

◆ getSolutionFileType()

MooseEnum SolutionUserObjectBase::getSolutionFileType ( ) const

inherited

Get the type of file that was read.

Returns: Returns a MooseEnum that specifies the type of file read

Definition at line 619 of file SolutionUserObjectBase.C.

Referenced by SolutionIC::initialSetup().

 {
   return _file_type;
 }

◆ getSubProblem()

SubProblem& UserObjectBase::getSubProblem ( ) const

inlineinherited

Returns a reference to the subproblem that this postprocessor is tied to.

Definition at line 81 of file UserObjectBase.h.

81 { return _subproblem; }

UserObjectBase::_subproblem

SubProblem & _subproblem

Reference to the Subproblem for this user object.

Definition: UserObjectBase.h:177

◆ getSuppliedItems()

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

inlineoverridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 151 of file UserObjectBase.h.

151 { return _supplied_uo; }

UserObjectBase::_supplied_uo

std::set< std::string > _supplied_uo

A name of the "supplied" user objects, which is just this object.

Definition: UserObjectBase.h:198

◆ 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 172 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBase(param_name, is_dependency), param_name);
 }

◆ getUserObjectBase()

const UserObjectBase & 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 115 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 UserObjectBase & 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 127 of file UserObjectInterface.C.

Referenced by AuxKernelBase::addPostprocessorDependencyHelper(), AuxKernelBase::addVectorPostprocessorDependencyHelper(), FunctorAux::FunctorAux(), UserObjectBase::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 = getUserObjectFromFEProblem(object_name);
   if (is_dependency)
     addUserObjectDependencyHelper(uo_base_tid0);
 
   const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
   return getUserObjectFromFEProblem(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 179 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 45 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;
 }

◆ getVectorPostprocessorName()

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

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name The name of the VectorPostprocessor parameter

Returns: The name of the given VectorPostprocessor

Definition at line 216 of file VectorPostprocessorInterface.C.

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

 {
   const auto & params = _vpi_moose_object.parameters();
 
   if (!params.isParamValid(param_name))
     _vpi_moose_object.mooseError(
         "When getting a VectorPostprocessor, failed to get a parameter with the name \"",
         param_name,
         "\".",
         "\n\nKnown parameters:\n",
         _vpi_moose_object.parameters());
 
   if (!params.isType<VectorPostprocessorName>(param_name))
     _vpi_moose_object.mooseError(
         "Supplied parameter with name \"",
         param_name,
         "\" of type \"",
         params.type(param_name),
         "\" is not an expected type for getting a VectorPostprocessor.\n\n",
         "The allowed type is \"VectorPostprocessorName\".");
 
   return params.get<VectorPostprocessorName>(param_name);
 }

◆ getVectorPostprocessorValue() [1/2]

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

inherited

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

Retrieve the value of a VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

The name required by this method is the name that is hard-coded into your source code. For example, if you have a Kernel that requires a VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 49 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValue() [2/2]

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

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

The name required by this method is the name that is hard-coded into your source code. For example, if you have a Kernel that requires a VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 79 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueByName() [1/2]

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

inherited

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

Retrieve the value of the VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 57 of file VectorPostprocessorInterface.C.

Referenced by CombinedVectorPostprocessor::CombinedVectorPostprocessor(), and VectorPostprocessorInterface::getVectorPostprocessorValue().

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

◆ getVectorPostprocessorValueByName() [2/2]

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

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 89 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 64 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 99 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOldByName() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 72 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld().

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

◆ getVectorPostprocessorValueOldByName() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 109 of file VectorPostprocessorInterface.C.

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

◆ getZeroMaterialProperty()

template<typename T , typename... Ts>

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

inlineinherited

for backwards compatibility

Definition at line 327 of file MaterialPropertyInterface.h.

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

◆ hasADMaterialProperty()

template<typename T >

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

inherited

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

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 142 of file MooseBase.h.

142 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:499

◆ 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 46 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 52 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 407 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 415 of file MaterialPropertyInterface.h.

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

◆ hasKokkosFunction()

bool FunctionInterface::hasKokkosFunction ( const std::string & param_name ) const

inherited

Determine if the Kokkos function exists.

Parameters

param_name	The name of the Kokkos function parameter
index	The index of the Kokkos function

Returns: True if the Kokkos function exists

◆ hasKokkosFunctionByName()

bool FunctionInterface::hasKokkosFunctionByName ( const FunctionName & name ) const

inherited

Determine if the Kokkos function exists.

Parameters

name	The name of the Kokkos function

Returns: True if the Kokkos function exists

◆ hasKokkosMaterialProperty()

template<typename T , unsigned int dimension>

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

inherited

Definition at line 982 of file MaterialPropertyInterface.h.

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

◆ hasKokkosMaterialPropertyByName()

template<typename T , unsigned int dimension>

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

inherited

Definition at line 991 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.haveKokkosProperty<T, dimension>(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 809 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 818 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);
 }

◆ hasMeshProperty() [1/4]

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists.

Definition at line 33 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshProperty(), MeshMetaDataInterface::hasMeshProperty(), and MeshGenerator::setMeshProperty().

 {
   return _meta_data_app.hasRestartableMetaData(meshPropertyName(data_name, prefix),
                                                MooseApp::MESH_META_DATA);
 }

◆ hasMeshProperty() [2/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists with the given type.

Definition at line 166 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     return false;
   const auto & value = getMeshPropertyInternal(data_name, prefix);
   return dynamic_cast<const RestartableData<T> *>(&value) != nullptr;
 }

◆ hasMeshProperty() [3/4]

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix.

Definition at line 82 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty(data_name, meshPropertyPrefix(data_name));
   }

◆ hasMeshProperty() [4/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix and the given type.

Definition at line 90 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty<T>(data_name, meshPropertyPrefix(data_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 117 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 128 of file PostprocessorInterface.C.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), AdvancedOutput::initShowHideLists(), TableOutput::outputReporters(), and Exodus::outputReporters().

 {
   if (!postprocessorsAdded())
     _ppi_moose_object.mooseError(
         "Cannot call hasPostprocessorByName() until all Postprocessors have been constructed.");
 
   return _ppi_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(
       PostprocessorReporterName(name));
 }

◆ hasReporterValue() [1/2]

bool ReporterInterface::hasReporterValue ( const std::string & param_name ) const

protectedinherited

Return True if the Reporter value exists.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

reporter_name A ReporterName object that for the desired Reporter value.

Definition at line 40 of file ReporterInterface.C.

 {
   if (!reportersAdded())
     _ri_moose_object.mooseError(
         "Cannot call hasReporterValue() until all Reporters have been constructed.");
 
   return hasReporterValueByName(getReporterName(param_name));
 }

◆ hasReporterValue() [2/2]

template<typename T >

bool ReporterInterface::hasReporterValue ( const std::string & param_name ) const

protectedinherited

Definition at line 189 of file ReporterInterface.h.

 {
   if (!reportersAdded())
     _ri_moose_object.mooseError(
         "Cannot call hasReporterValue() until all Reporters have been constructed.");
 
   return hasReporterValueByName<T>(getReporterName(param_name));
 }

◆ hasReporterValueByName() [1/2]

bool ReporterInterface::hasReporterValueByName ( const ReporterName & reporter_name ) const

protectedinherited

Definition at line 50 of file ReporterInterface.C.

Referenced by ReporterInterface::hasReporterValue(), and AdvancedOutput::initShowHideLists().

 {
   if (!reportersAdded())
     _ri_moose_object.mooseError(
         "Cannot call hasReporterValueByName() until all Reporters have been constructed.");
 
   return _ri_reporter_data.hasReporterValue(reporter_name);
 }

◆ hasReporterValueByName() [2/2]

template<typename T >

bool ReporterInterface::hasReporterValueByName ( const ReporterName & reporter_name ) const

protectedinherited

Definition at line 200 of file ReporterInterface.h.

 {
   if (!reportersAdded())
     _ri_moose_object.mooseError(
         "Cannot call hasReporterValueByName() until all Reporters have been constructed.");
 
   return _ri_reporter_data.hasReporterValue<T>(reporter_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 78 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 187 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 84 of file UserObjectInterface.C.

Referenced by FunctorAux::FunctorAux(), UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::hasUserObject(), and UserObjectInterface::hasUserObjectByName().

 {
   bool flag = _uoi_feproblem.hasUserObject(object_name);
 
 #ifdef MOOSE_KOKKOS_ENABLED
   flag = flag || _uoi_feproblem.hasKokkosUserObject(object_name);
 #endif
 
   return flag;
 }

◆ hasUserObjectByName() [2/2]

template<class T >

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 194 of file UserObjectInterface.h.

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

◆ hasVectorPostprocessor() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 151 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessor() until all VectorPostprocessors "
                               "have been constructed.");
 
   return hasVectorPostprocessorByName(getVectorPostprocessorName(param_name), vector_name);
 }

◆ hasVectorPostprocessor() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

Definition at line 175 of file VectorPostprocessorInterface.C.

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

◆ hasVectorPostprocessorByName() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 162 of file VectorPostprocessorInterface.C.

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

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   return _vpi_feproblem.getReporterData().hasReporterValue<VectorPostprocessorValue>(
              VectorPostprocessorReporterName(name, vector_name)) &&
          hasVectorPostprocessorByName(name);
 }

◆ hasVectorPostprocessorByName() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

Definition at line 185 of file VectorPostprocessorInterface.C.

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   std::vector<VectorPostprocessor *> objs;
   _vpi_feproblem.theWarehouse()
       .query()
       .condition<AttribInterfaces>(Interfaces::VectorPostprocessor)
       .condition<AttribThread>(0)
       .condition<AttribName>(name)
       .queryInto(objs);
   return !objs.empty();
 }

◆ haveParameter()

template<typename T >

bool MooseBase::haveParameter ( const std::string & name ) const

inlineinherited

Test if a parameter of the given name and type exists.

Parameters

name	The name of the parameter to test

Definition at line 200 of file MooseBase.h.

   {
     return _pars.have_parameter<T>(name);
   }

◆ initialize()

void SolutionUserObjectBase::initialize ( )

overridevirtualinherited

Called before execute() is ever called so that data can be cleared.

Implements UserObjectBase.

Definition at line 475 of file SolutionUserObjectBase.C.

476 {

477 }

◆ initialSetup()

void SolutionUserObjectBase::initialSetup ( )

overridevirtualinherited

Initialize the System and Mesh objects for the solution being read.

Reimplemented from SetupInterface.

Definition at line 502 of file SolutionUserObjectBase.C.

 {
 
   // Make sure this only happens once
   if (_initialized)
     return;
 
   // We need to detect exodus files early
   const bool has_exodus_extension =
       MooseUtils::hasExtension(_mesh_file, "e", /*strip_exodus_ext =*/true) ||
       MooseUtils::hasExtension(_mesh_file, "exo", true);
   const bool has_nemesis_extension =
       MooseUtils::hasExtension(_mesh_file, "n", /*strip_exodus_ext =*/true) ||
       MooseUtils::hasExtension(_mesh_file, "nem", true);
   if (has_exodus_extension)
     _file_type = "exodusII";
   else if (has_nemesis_extension)
     _file_type = "nemesis";
 
   // Create a libmesh::Mesh object for storing the loaded data.
   if (!_fe_problem.mesh().isDistributedMesh() || (_file_type == "exodusII") ||
       _force_replicated_source)
     _mesh = std::make_unique<ReplicatedMesh>(_communicator);
   else
     _mesh = std::make_unique<DistributedMesh>(_communicator);
 
   // ExodusII or Nemesis mesh file supplied
   if (has_exodus_extension || has_nemesis_extension)
     readExodusIIOrNemesis();
 
   // XDA mesh file supplied
   else if (MooseUtils::hasExtension(_mesh_file, "xda"))
   {
     _file_type = "xda";
     readXda();
   }
 
   // XDR mesh file supplied
   else if (MooseUtils::hasExtension(_mesh_file, "xdr"))
   {
     _file_type = "xdr";
     readXda();
   }
 
   // Produce an error for an unknown file type
   else
     mooseError(
         "In SolutionUserObjectBase, invalid file type: only .xda, .xdr, .exo and .e supported");
 
   // Initialize the serial solution vector
   _serialized_solution = NumericVector<Number>::build(_communicator);
   _serialized_solution->init(_system->n_dofs(), false, libMesh::SERIAL);
 
   // Pull down a full copy of this vector on every processor so we can get values in parallel
   _system->solution->localize(*_serialized_solution);
 
   // Vector of variable numbers to apply the MeshFunction to
   std::vector<unsigned int> var_nums;
 
   // If no variables were given, use all of them
   if (_system_variables.empty())
   {
     _system->get_all_variable_numbers(var_nums);
     for (const auto & var_num : var_nums)
       _system_variables.push_back(_system->variable_name(var_num));
   }
 
   // Otherwise, gather the numbers for the variables given
   else
   {
     for (const auto & var_name : _system_variables)
       var_nums.push_back(_system->variable_number(var_name));
   }
 
   // Create the MeshFunction for working with the solution data
   _mesh_function = std::make_unique<libMesh::MeshFunction>(
       *_es, *_serialized_solution, _system->get_dof_map(), var_nums);
   _mesh_function->init();
 
   // Tell the MeshFunctions that we might be querying them outside the
   // mesh, so we can handle any errors at the MOOSE rather than at the
   // libMesh level.
   DenseVector<Number> default_values;
   _mesh_function->enable_out_of_mesh_mode(default_values);
 
   // Build second MeshFunction for interpolation
   if (_interpolate_times)
   {
     // Need to pull down a full copy of this vector on every processor so we can get values in
     // parallel
     _serialized_solution2 = NumericVector<Number>::build(_communicator);
     _serialized_solution2->init(_system2->n_dofs(), false, libMesh::SERIAL);
     _system2->solution->localize(*_serialized_solution2);
 
     // Create the MeshFunction for the second copy of the data
     _mesh_function2 = std::make_unique<libMesh::MeshFunction>(
         *_es2, *_serialized_solution2, _system2->get_dof_map(), var_nums);
     _mesh_function2->init();
     _mesh_function2->enable_out_of_mesh_mode(default_values);
   }
 
   // Populate the MeshFunction variable index
   for (unsigned int i = 0; i < _system_variables.size(); ++i)
   {
     std::string name = _system_variables[i];
     _local_variable_index[name] = i;
   }
 
   // If the start time is not the same as in the exodus file, we may need this on INITIAL
   if (_interpolate_times)
     updateTimeInterpolationFromFile();
 
   // Set initialization flag
   _initialized = true;
 }

◆ isCoupledScalar()

bool ScalarCoupleable::isCoupledScalar	(	const std::string &	var_name,
		unsigned int	i = `0`
	)		const

protectedinherited

Returns true if a variables has been coupled_as name.

Parameters

var_name	The of the coupled variable
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Definition at line 85 of file ScalarCoupleable.C.

Referenced by ScalarCoupleable::adCoupledScalarValue(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

 {
   const auto var_name = _sc_parameters.checkForRename(var_name_in);
 
   auto it = _coupled_scalar_vars.find(var_name);
   if (it != _coupled_scalar_vars.end())
     return (i < it->second.size());
   else
   {
     // Make sure the user originally requested this value in the InputParameter syntax
     if (!_sc_parameters.hasCoupledValue(var_name))
       mooseError(_sc_name,
                  ": The coupled scalar variable \"",
                  var_name,
                  "\" was never added to this object's "
                  "InputParameters, please double-check "
                  "your spelling");
 
     return false;
   }
 }

◆ isDefaultPostprocessorValue()

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

inherited

Determine whether or not the Postprocessor is a default value.

A default value is when the value is either the value set by addParam, or is a user-set value in input instead of a name to a postprocessor.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the postprocessor

Returns: True if the Postprocessor is a default value, false if the Postprocessor is the name of a Postprocessor

Definition at line 85 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return isDefaultPostprocessorValueByName(getPostprocessorNameInternal(param_name, index));
 }

◆ isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 47 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

47 { return _is_implicit; }

TransientInterface::_is_implicit

bool _is_implicit

If the object is using implicit or explicit form.

Definition: TransientInterface.h:67

◆ isKokkosObject()

bool MooseObject::isKokkosObject ( ) const

inlineinherited

Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

Definition at line 63 of file MooseObject.h.

Referenced by BlockRestrictable::initializeBlockRestrictable(), and BoundaryRestrictable::initializeBoundaryRestrictable().

63 { return parameters().isKokkosObject(); }

MooseBase::parameters

const InputParameters & parameters() const

Get the parameters of the object.

Definition: MooseBase.h:131

InputParameters::isKokkosObject

bool isKokkosObject() const

Returns whether this InputParameters belongs to a Kokkos object Checks whether MooseBase::kokkos_obje...

Definition: InputParameters.C:433

◆ isParamSetByUser()

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

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

name	The name of the parameter to test

Definition at line 215 of file MooseBase.h.

Referenced by SetupDebugAction::act(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MFEMMesh::buildMesh(), MFEMDomainSubMesh::buildSubMesh(), MFEMBoundarySubMesh::buildSubMesh(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< false >::ConservativeAdvectionBCTempl(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), FileMesh::FileMesh(), FullSolveMultiApp::FullSolveMultiApp(), OrientSurfaceMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), MFEMVectorFESpace::getFECName(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MortarConstraintBase::MortarConstraintBase(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SmoothMeshGenerator::SmoothMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SurfaceSubdomainsFromAllNormalsGenerator::SurfaceSubdomainsFromAllNormalsGenerator(), TagVectorAux::TagVectorAux(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ isParamValid()

bool MooseBase::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 209 of file MooseBase.h.

209 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:103

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:386

◆ isVariableNodal()

bool SolutionUserObjectBase::isVariableNodal ( const std::string & var_name ) const

inherited

Definition at line 1312 of file SolutionUserObjectBase.C.

 {
   return std::find(_nodal_variables.begin(), _nodal_variables.end(), var_name) !=
          _nodal_variables.end();
 }

◆ isVectorPostprocessorDistributed()

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

inherited

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

Definition at line 203 of file VectorPostprocessorInterface.C.

 {
   return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
 }

◆ isVectorPostprocessorDistributedByName()

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

inherited

Definition at line 209 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

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

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, ADArrayNodalKernel, DiffusionLHDGKernel, IPHDGKernel, EqualValueEmbeddedConstraintTempl< is_ad >, ADArrayKernel, ADKernelTempl< T >, IPHDGBC, DiffusionLHDGPrescribedGradientBC, DiffusionLHDGDirichletBC, and ADDiracKernel.

Definition at line 58 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().

59 {

60 }

◆ markMatPropRequested()

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

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 172 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

 {
   _mi_feproblem.markMatPropRequested(name);
 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableDataFV< OutputType >, NEML2FEInterpolation, DiracKernelBase, Positions, Console, MeshDivision, Exodus, ElementSubdomainModifierBase, NEML2Assembly, SampledOutput, RadialAverage, Nemesis, NEML2ModelExecutor, GhostingUserObject, FVPointValueConstraint, ExplicitTimeIntegrator, NEML2BatchIndexGenerator, MultiAppVariableValueSamplePostprocessorTransfer, MoveNodesToGeometryModifierBase, SidesetInfoVectorPostprocessor, NearestNodeNumberUO, and EqualValueBoundaryConstraint.

Definition at line 40 of file MeshChangedInterface.h.

Referenced by MooseVariableFV< Real >::meshChanged(), and MooseVariableFE< Real >::meshChanged().

40 {}

◆ meshDisplaced()

virtual void MeshDisplacedInterface::meshDisplaced ( )

inlinevirtualinherited

Called on this object when the displaced mesh gets updated.

Definition at line 40 of file MeshDisplacedInterface.h.

40 {}

◆ meshPropertyName() [1/2]

std::string MeshMetaDataInterface::meshPropertyName	(	const std::string &	data_name,
		const std::string &	prefix
	)

staticprotectedinherited

Returns: The full name for mesh property data.

Definition at line 41 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MeshMetaDataInterface::meshPropertyName(), and MeshGenerator::setMeshPropertyHelper().

 {
   return std::string(SYSTEM) + "/" + prefix + "/" + data_name;
 }

◆ meshPropertyName() [2/2]

std::string MeshMetaDataInterface::meshPropertyName ( const std::string & data_name ) const

inlineprotectedinherited

Returns: The default mesh property name for mesh property data

Definition at line 103 of file MeshMetaDataInterface.h.

   {
     return meshPropertyName(data_name, meshPropertyPrefix(data_name));
   }

◆ messagePrefix()

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

Returns: A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 266 of file MooseBase.h.

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated() [1/2]

template<typename... Args>

void SolutionInvalidInterface::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::hasPostprocessor(), MooseMesh::isTranslatedPeriodic(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), TagVectorAux::TagVectorAux(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     _si_moose_base.MooseBase::mooseDeprecated(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": deprecation");
   }

◆ mooseDeprecated() [2/2]

template<typename... Args>

void MooseBase::mooseDeprecated ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and a stack trace.

Definition at line 327 of file MooseBase.h.

Referenced by MooseApp::addCapability(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), MooseApp::getRecoverFileBase(), MooseApp::hasRecoverFileBase(), and MooseApp::setupOptions().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, true, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseDeprecatedNoTrace()

template<typename... Args>

void MooseBase::mooseDeprecatedNoTrace ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and no stack trace.

Definition at line 337 of file MooseBase.h.

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, false, messagePrefix(true), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBase::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Definition at line 287 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), LowerDIntegratedBC::LowerDIntegratedBC(), and ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

   {
     callMooseError(moose::internal::formatMooseDocumentedError(
                        repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                    /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 281 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 300 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 344 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldKDTreeTransferBase::evaluateNearestNodeFromKDTrees(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), PolyLineMeshFollowingNodeSetGenerator::generate(), ManifoldSubdomainGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MultiAppTransfer::mapBackWithoutCollapsing(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), and TransientBase::TransientBase().

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

◆ mooseWarning() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), RenumberBySubdomainGenerator::generate(), BSplineCurveGenerator::generate(), StitchMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), ParsedGenerateSideset::generate(), SurfaceSubdomainsDelaunayRemesher::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), MFEMVectorFESpace::getFECName(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), ElementGroupCentroidPositions::initialize(), SphericalGridDivision::initialize(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MFEMRefinementMarker::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), ElementSubdomainModifierBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), PNGOutput::makePNG(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MaterialOutputAction::outputHelper(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     _si_moose_base.MooseBase::mooseWarning(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
   }

◆ mooseWarning() [2/2]

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 309 of file MooseBase.h.

Referenced by DiracKernelInfo::findPoint(), DataFileInterface::getDataFilePath(), MooseApp::loadLibraryAndDependencies(), and MooseBase::paramWarning().

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

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 80 of file SolutionInvalidInterface.h.

   {
     _si_moose_base.MooseBase::mooseWarningNonPrefixed(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
   }

◆ mooseWarningNonPrefixed() [2/2]

template<typename... Args>

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

inlineinherited

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

Definition at line 318 of file MooseBase.h.

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

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 103 of file MooseBase.h.

   {
     mooseAssert(_name.size(), "Empty name");
     return _name;
   }

◆ needThreadedCopy()

virtual bool UserObjectBase::needThreadedCopy ( ) const

inlinevirtualinherited

Whether or not a threaded copy of this object is needed when obtaining it in another object, like via the UserObjectInterface.

Derived classes should override this as needed.

Reimplemented in Moose::Kokkos::UserObject, DiscreteElementUserObject, and ThreadedGeneralUserObject.

Definition at line 164 of file UserObjectBase.h.

164 { return false; }

◆ paramError()

template<typename... Args>

void MooseBase::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 467 of file MooseBase.h.

 {
   _pars.paramError(param, std::forward<Args>(args)...);
 }

◆ parameters()

const InputParameters& MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 131 of file MooseBase.h.

131 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

◆ paramInfo()

template<typename... Args>

void MooseBase::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 481 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
 }

◆ paramWarning() [1/2]

template<typename... Args>

void SolutionInvalidInterface::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

Referenced by GridPartitioner::_do_partition(), CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), MooseMeshUtils::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), FullSolveMultiApp::initialSetup(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), PNGOutput::PNGOutput(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

   {
     _si_moose_base.MooseBase::paramWarning(param, std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning for parameter '" +
                                             param + "'");
   }

◆ paramWarning() [2/2]

template<typename... Args>

void MooseBase::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 474 of file MooseBase.h.

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

◆ parsedFunctionSetup()

void FunctionParserUtils< is_ad >::parsedFunctionSetup	(	SymFunctionPtr &	function,
		const std::string &	expression,
		const std::string &	variables,
		const std::vector< std::string > &	constant_names,
		const std::vector< std::string > &	constant_expressions,
		const libMesh::Parallel::Communicator &	comm
	)		const

protectedinherited

Performs setup steps on a SymFunction.

Parameters

function	reference to pointer to the function to set up
expression	expression to parse
variables	comma separated string holding all the variables of the expression
constant_names	vector of names (symbols) of constants in the expression
constant_expressions	vectors of expressions (=values) of constants in the expression
comm	communicator used to stagger JIT file creations

Definition at line 228 of file FunctionParserUtils.C.

Referenced by ArrayParsedAux::ArrayParsedAux(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), ParsedSubdomainGeneratorBase::functionInitialize(), ParsedConvergence::makeParsedFunction(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), and SolutionUserObject().

 {
   // set FParser internal feature flags
   setParserFeatureFlags(function);
 
   // add the constant expressions
   addFParserConstants(function, constant_names, constant_expressions);
 
   // parse function
   if (function->Parse(expression, variables) >= 0)
     mooseError("Invalid function\n", expression, "\nError:\n", function->ErrorMsg());
 
   // optimize
   if (!_disable_fpoptimizer)
     function->Optimize();
 
   // just-in-time compile
   if (_enable_jit)
   {
     // let rank 0 do the JIT compilation first
     if (comm.rank() != 0)
       comm.barrier();
 
     function->JITCompile();
 
     // wait for ranks > 0 to catch up
     if (comm.rank() == 0)
       comm.barrier();
   }
 }

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 86 of file PerfGraphInterface.C.

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), PerfGraphReporter::finalize(), and PerfGraphOutput::output().

 {
   return _pg_moose_app.perfGraph();
 }

◆ pointValue() [1/2]

Real SolutionUserObjectBase::pointValue	(	Real	t,
		const Point &	p,
		const unsigned int	local_var_index,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns a value at a specific location and variable (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
local_var_index	The local index of the variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Referenced by SolutionAux::computeValue(), SolutionUserObjectBase::pointValue(), SolutionUserObjectBase::pointValueWrapper(), SolutionIC::value(), and Axisymmetric2D3DSolutionFunction::value().

◆ pointValue() [2/2]

Real SolutionUserObjectBase::pointValue	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns a value at a specific location and variable (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 794 of file SolutionUserObjectBase.C.

 {
   const unsigned int local_var_index = getLocalVarIndex(var_name);
   return pointValue(t, p, local_var_index, subdomain_ids);
 }

◆ pointValueGradient() [1/2]

RealGradient SolutionUserObjectBase::pointValueGradient	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns the gradient at a specific location and variable (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 967 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::pointValueGradientWrapper().

 {
   const unsigned int local_var_index = getLocalVarIndex(var_name);
   return pointValueGradient(t, p, local_var_index, subdomain_ids);
 }

◆ pointValueGradient() [2/2]

libMesh::RealGradient SolutionUserObjectBase::pointValueGradient	(	Real	t,
		Point	pt,
		const unsigned int	local_var_index,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns the gradient at a specific location and variable (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
local_var_index	The local index of the variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

◆ pointValueGradientWrapper()

RealGradient SolutionUserObjectBase::pointValueGradientWrapper	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const MooseEnum &	weighting_type = `weightingType()`,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns the gradient at a specific location and variable checking for multiple values and weighting these values to obtain a single unique value (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 912 of file SolutionUserObjectBase.C.

 {
   // the default weighting_type found_first shortcuts out
   if (weighting_type == 1)
     return pointValueGradient(t, p, var_name, subdomain_ids);
 
   // the shape function is discontinuous so we need to compute a suitable unique value
   std::map<const Elem *, RealGradient> values =
       discontinuousPointValueGradient(t, p, var_name, subdomain_ids);
   switch (weighting_type)
   {
     case 2:
     {
       RealGradient average = RealGradient(0.0, 0.0, 0.0);
       for (auto & v : values)
         average += v.second;
       return average / Real(values.size());
     }
     case 4:
     {
       RealGradient smallest_elem_id_value;
       dof_id_type smallest_elem_id = _fe_problem.mesh().maxElemId();
       for (auto & v : values)
         if (v.first->id() < smallest_elem_id)
         {
           smallest_elem_id = v.first->id();
           smallest_elem_id_value = v.second;
         }
       return smallest_elem_id_value;
     }
     case 8:
     {
       RealGradient largest_elem_id_value;
       dof_id_type largest_elem_id = 0;
       for (auto & v : values)
         if (v.first->id() > largest_elem_id)
         {
           largest_elem_id = v.first->id();
           largest_elem_id_value = v.second;
         }
       return largest_elem_id_value;
     }
   }
 
   mooseError("SolutionUserObjectBase::pointValueGradientWrapper reaches line that it should not be "
              "able to reach.");
   return RealGradient(0.0, 0.0, 0.0);
 }

◆ pointValueWrapper()

Real SolutionUserObjectBase::pointValueWrapper	(	Real	t,
		const Point &	p,
		const std::string &	var_name,
		const MooseEnum &	weighting_type = `weightingType()`,
		const std::set< subdomain_id_type > *	subdomain_ids = `nullptr`
	)		const

inherited

Returns a value at a specific location and variable checking for multiple values and weighting these values to obtain a single unique value (see SolutionFunction)

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
p	The location at which to return a value
var_name	The variable to be evaluated
subdomain_ids	Subdomains IDs where to look for the value, if nullptr look everywhere

Returns: The desired value for the given variable at a location

Definition at line 731 of file SolutionUserObjectBase.C.

 {
   // first check if the FE type is continuous because in that case the value is
   // unique and we can take a short cut, the default weighting_type found_first also
   // shortcuts out
   auto family =
       _fe_problem
           .getVariable(
               _tid, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_STANDARD)
           .feType()
           .family;
 
   if (weighting_type == 1 ||
       (family != L2_LAGRANGE && family != MONOMIAL && family != L2_HIERARCHIC))
     return pointValue(t, p, var_name, subdomain_ids);
 
   // the shape function is discontinuous so we need to compute a suitable unique value
   std::map<const Elem *, Real> values = discontinuousPointValue(t, p, var_name);
   switch (weighting_type)
   {
     case 2:
     {
       Real average = 0.0;
       for (auto & v : values)
         average += v.second;
       return average / Real(values.size());
     }
     case 4:
     {
       Real smallest_elem_id_value = std::numeric_limits<Real>::max();
       dof_id_type smallest_elem_id = _fe_problem.mesh().maxElemId();
       for (auto & v : values)
         if (v.first->id() < smallest_elem_id)
         {
           smallest_elem_id = v.first->id();
           smallest_elem_id_value = v.second;
         }
       return smallest_elem_id_value;
     }
     case 8:
     {
       Real largest_elem_id_value = std::numeric_limits<Real>::lowest();
       dof_id_type largest_elem_id = 0;
       for (auto & v : values)
         if (v.first->id() > largest_elem_id)
         {
           largest_elem_id = v.first->id();
           largest_elem_id_value = v.second;
         }
       return largest_elem_id_value;
     }
   }
 
   mooseError("SolutionUserObjectBase::pointValueWrapper reaches line that it should not be able to "
              "reach.");
   return 0.0;
 }

◆ primaryThreadCopy()

UserObject* UserObject::primaryThreadCopy ( )

inlineinherited

Definition at line 62 of file UserObject.h.

62 { return _primary_thread_copy; }

UserObject::_primary_thread_copy

UserObject * _primary_thread_copy

Definition: UserObject.h:69

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or if the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 423 of file MooseBase.h.

Referenced by MFEMExecutedObject::getRequestedItems().

 {
   return haveParameter<T>(name) && isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ readBlockIdMapFromExodusII()

void SolutionUserObjectBase::readBlockIdMapFromExodusII ( )

protectedinherited

Read block ID map from the ExodusII file.

Definition at line 1330 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis().

 {
 #ifdef LIBMESH_HAVE_EXODUS_API
   const auto * exio_helper = (_file_type == "exodusII") ? &_exodusII_io->get_exio_helper()
                                                         : &_nemesis_io->get_nemio_helper();
   const auto & id_to_block = exio_helper->id_to_block_names;
   _block_name_to_id.clear();
   _block_id_to_name.clear();
   for (const auto & it : id_to_block)
   {
     _block_name_to_id[it.second] = it.first;
     _block_id_to_name[it.first] = it.second;
   }
 #endif
 }

◆ readExodusIIOrNemesis()

void SolutionUserObjectBase::readExodusIIOrNemesis ( )

protectedinherited

Method for reading an ExodusII or Nemesis file, which is called when a mesh file with a .e, .exo, .n or .nem extension is provided in the input file.

Definition at line 230 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::initialSetup().

 {
   // Define a default system name
   if (_system_name == "")
     _system_name = "SolutionUserObjectSystem";
 
   // Read the Exodus or Nemesis file
   if (_file_type == "exodusII")
   {
     _exodusII_io = std::make_unique<libMesh::ExodusII_IO>(*_mesh);
     _exodusII_io->read(_mesh_file);
     _exodus_times = &_exodusII_io->get_time_steps();
   }
   else
   {
     _nemesis_io = std::make_unique<libMesh::Nemesis_IO>(*_mesh);
     _nemesis_io->read(_mesh_file);
     _exodus_times = &_nemesis_io->get_time_steps();
   }
   // Same routine for Nemesis
   readBlockIdMapFromExodusII();
 
   if (isParamValid("timestep"))
   {
     std::string s_timestep = getParam<std::string>("timestep");
     int n_steps = (_file_type == "exodusII") ? _exodusII_io->get_num_time_steps()
                                              : _nemesis_io->get_num_time_steps();
     if (s_timestep == "LATEST")
       _exodus_time_index = n_steps;
     else
     {
       std::istringstream ss(s_timestep);
       if (!((ss >> _exodus_time_index) && ss.eof()) || _exodus_time_index > n_steps)
         mooseError("Invalid value passed as \"timestep\". Expected \"LATEST\" or a valid integer "
                    "less than ",
                    n_steps,
                    ", received ",
                    s_timestep);
     }
   }
   else
     // Interpolate between times rather than using values from a set timestep
     _interpolate_times = true;
 
   // Check that the number of time steps is valid
   int num_exo_times = _exodus_times->size();
   if (num_exo_times == 0)
     mooseError("In SolutionUserObjectBase, exodus file contains no timesteps.");
 
   // Account for parallel mesh
   if (_fe_problem.mesh().isDistributedMesh() && (_file_type != "exodusII") &&
       !_force_replicated_source)
   {
     _mesh->allow_renumbering(true);
     _mesh->prepare_for_use();
   }
   else
   {
     _mesh->allow_renumbering(false);
     _mesh->prepare_for_use();
   }
 
   // Create EquationSystems object for solution
   _es = std::make_unique<EquationSystems>(*_mesh);
   _es->add_system<libMesh::ExplicitSystem>(_system_name);
   _system = &_es->get_system(_system_name);
 
   // Get the variable name lists as set; these need to be sets to perform set_intersection
   const std::vector<std::string> & all_nodal((_file_type == "exodusII")
                                                  ? _exodusII_io->get_nodal_var_names()
                                                  : _nemesis_io->get_nodal_var_names());
   const std::vector<std::string> & all_elemental((_file_type == "exodusII")
                                                      ? _exodusII_io->get_elem_var_names()
                                                      : _nemesis_io->get_elem_var_names());
   const std::vector<std::string> & all_scalar((_file_type == "exodusII")
                                                   ? _exodusII_io->get_global_var_names()
                                                   : _nemesis_io->get_global_var_names());
 
   // Build nodal/elemental variable lists, limit to variables listed in 'system_variables', if
   // provided
   // This function could be called more than once, so clear the member variables so we don't keep
   // adding to the vectors
   _nodal_variables.clear();
   _elemental_variables.clear();
   _scalar_variables.clear();
   if (!_system_variables.empty())
   {
     for (const auto & var_name : _system_variables)
     {
       if (std::find(all_nodal.begin(), all_nodal.end(), var_name) != all_nodal.end())
         _nodal_variables.push_back(var_name);
       else if (std::find(all_elemental.begin(), all_elemental.end(), var_name) !=
                all_elemental.end())
         _elemental_variables.push_back(var_name);
       else if (std::find(all_scalar.begin(), all_scalar.end(), var_name) != all_scalar.end())
         // We checked other variables types first, so if a postprocessor has the same name as a
         // field variable, it won't get loaded as a scalar variable
         _scalar_variables.push_back(var_name);
       else
         paramError("system_variables", "Variable '" + var_name + "' was not found in Exodus file");
     }
   }
   else
   {
     _nodal_variables = all_nodal;
     _elemental_variables = all_elemental;
 
     for (auto var_name : all_scalar)
       // Check if the scalar matches any field variables, and ignore the var if it does. This means
       // its a Postprocessor.
       if (std::find(begin(_nodal_variables), end(_nodal_variables), var_name) ==
               _nodal_variables.end() &&
           std::find(begin(_elemental_variables), end(_elemental_variables), var_name) ==
               _elemental_variables.end())
         _scalar_variables.push_back(var_name);
   }
 
   // Add the variables to the system
   for (const auto & var_name : _nodal_variables)
     _system->add_variable(var_name, Utility::string_to_enum<Order>(_nodal_variable_order));
 
   for (const auto & var_name : _elemental_variables)
     _system->add_variable(var_name, CONSTANT, MONOMIAL);
 
   for (const auto & var_name : _scalar_variables)
     _system->add_variable(var_name, FIRST, SCALAR);
 
   // Helper for copying from the ExodusII/Nemesis file
   const auto copy_solutions = [this](auto & io, libMesh::System & system, unsigned int index)
   {
     for (const auto & var_name : _nodal_variables)
       io.copy_nodal_solution(system, var_name, var_name, index);
 
     for (const auto & var_name : _elemental_variables)
       io.copy_elemental_solution(system, var_name, var_name, index);
 
     if (_scalar_variables.size() > 0)
       io.copy_scalar_solution(system, _scalar_variables, _scalar_variables, index);
   };
 
   // Initialize the equations systems
   _es->init();
 
   // Interpolate times
   if (_interpolate_times)
   {
     // Create a second equation system
     _es2 = std::make_unique<EquationSystems>(*_mesh);
     _es2->add_system<libMesh::ExplicitSystem>(_system_name);
     _system2 = &_es2->get_system(_system_name);
 
     // Add the variables to the system
     for (const auto & var_name : _nodal_variables)
       _system2->add_variable(var_name, Utility::string_to_enum<Order>(_nodal_variable_order));
 
     for (const auto & var_name : _elemental_variables)
       _system2->add_variable(var_name, CONSTANT, MONOMIAL);
 
     for (const auto & var_name : _scalar_variables)
       _system2->add_variable(var_name, FIRST, SCALAR);
 
     // Initialize
     _es2->init();
 
     // Update the times for interpolation (initially start at 0)
     updateInterpolationBracketingTimeIndices();
 
     // Copy the solutions from the first system
     if (_file_type == "exodusII")
     {
       copy_solutions(*_exodusII_io, *_system, _exodus_index1 + 1);
       copy_solutions(*_exodusII_io, *_system2, _exodus_index2 + 1);
     }
     else
     {
       copy_solutions(*_nemesis_io, *_system, _exodus_index1 + 1);
       copy_solutions(*_nemesis_io, *_system2, _exodus_index2 + 1);
     }
 
     // Update the systems
     _system->update();
     _es->update();
     _system2->update();
     _es2->update();
   }
 
   // Non-interpolated times
   else
   {
     if (_exodus_time_index > num_exo_times)
       mooseError("In SolutionUserObjectBase, timestep = ",
                  _exodus_time_index,
                  ", but there are only ",
                  num_exo_times,
                  " time steps.");
 
     // Copy the values from the ExodusII/Nemsis file
     if (_file_type == "exodusII")
       copy_solutions(*_exodusII_io, *_system, _exodus_time_index);
     else
       copy_solutions(*_nemesis_io, *_system, _exodus_time_index);
 
     // Update the equations systems
     _system->update();
     _es->update();
   }
 }

◆ readXda()

void SolutionUserObjectBase::readXda ( )

protectedinherited

Method for reading XDA mesh and equation systems file(s) This method is called by the constructor when 'file_type = xda' is set in the input file.

Definition at line 190 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::initialSetup().

 {
   if (!isParamSetByUser("es"))
     paramError("es", "Equation system file (.xda or .xdr) should have been specified");
 
   // Check that the required files exist
   MooseUtils::checkFileReadable(_es_file);
   MooseUtils::checkFileReadable(_mesh_file);
 
   // Read the libmesh::mesh from the xda file
   _mesh->read(_mesh_file);
 
   // Create the libmesh::EquationSystems
   _es = std::make_unique<EquationSystems>(*_mesh);
 
   // Use new read syntax (binary)
   if (_file_type == "xdr")
     _es->read(_es_file,
               libMesh::DECODE,
               EquationSystems::READ_HEADER | EquationSystems::READ_DATA |
                   EquationSystems::READ_ADDITIONAL_DATA);
 
   // Use new read syntax
   else if (_file_type == "xda")
     _es->read(_es_file,
               libMesh::READ,
               EquationSystems::READ_HEADER | EquationSystems::READ_DATA |
                   EquationSystems::READ_ADDITIONAL_DATA);
 
   // This should never occur, just in case produce an error
   else
     mooseError("Failed to determine proper read method for XDA/XDR equation system file: ",
                _es_file);
 
   // Update and store the EquationSystems name locally
   _es->update();
   _system = &_es->get_system(_system_name);
 }

◆ registerInvalidSolutionInternal()

InvalidSolutionID SolutionInvalidInterface::registerInvalidSolutionInternal	(	const std::string &	message,
		const bool	warning
	)		const

protectedinherited

Definition at line 55 of file SolutionInvalidInterface.C.

 {
   return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
       _si_moose_base.type(), message, warning);
 }

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 61 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 72 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(
         timedSectionName(section_name), level, live_message, print_dots);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, NodeFaceConstraint, Positions, and Times.

Definition at line 63 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().

64 {

65 }

◆ resolveOptionalProperties()

void MaterialPropertyInterface::resolveOptionalProperties ( )

virtualinherited

resolve all optional properties

Reimplemented in Material.

Definition at line 268 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 78 of file Restartable.C.

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

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

◆ scalarValue()

Real SolutionUserObjectBase::scalarValue	(	Real	t,
		const std::string &	var_name
	)		const

inherited

Returns a value of a global variable.

Parameters

t	The time at which to extract (not used, it is handled automatically when reading the data)
var_name	The variable from which to extract a value

Returns: The desired value for the given variable

Definition at line 1319 of file SolutionUserObjectBase.C.

Referenced by SolutionScalarAux::computeValue(), and ScalarSolutionIC::value().

 {
   unsigned int var_num = _system->variable_number(var_name);
   const DofMap & dof_map = _system->get_dof_map();
   std::vector<dof_id_type> dofs;
   dof_map.SCALAR_dof_indices(dofs, var_num);
   // We can handle only FIRST order scalar variables
   return directValue(dofs[0]);
 }

◆ setParserFeatureFlags()

void FunctionParserUtils< is_ad >::setParserFeatureFlags ( SymFunctionPtr & parser ) const

inherited

apply input parameters to internal feature flags of the parser object

Definition at line 79 of file FunctionParserUtils.C.

Referenced by CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), LevelSetMeshingHelper::LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedODEKernel::ParsedODEKernel(), and TransfiniteMeshGenerator::TransfiniteMeshGenerator().

 {
   parser->SetADFlags(SymFunction::ADCacheDerivatives, _enable_ad_cache);
   parser->SetADFlags(SymFunction::ADAutoOptimize, _enable_auto_optimize);
 }

◆ setPrimaryThreadCopy()

void UserObject::setPrimaryThreadCopy ( UserObject * primary )

inherited

Definition at line 29 of file UserObject.C.

 {
   if (!_primary_thread_copy && primary != this)
     _primary_thread_copy = primary;
 }

◆ shouldDuplicateInitialExecution()

bool UserObjectBase::shouldDuplicateInitialExecution ( ) const

inlineinherited

Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC.

Definition at line 87 of file UserObjectBase.h.

87 { return _duplicate_initial_execution; }

UserObjectBase::_duplicate_initial_execution

const bool _duplicate_initial_execution

Whether to execute this object twice on initial.

Definition: UserObjectBase.h:190

◆ solutionSampleTime()

Real SolutionUserObject::solutionSampleTime ( )

overridevirtual

Get the time at which to sample the solution.

Implements SolutionUserObjectBase.

Definition at line 66 of file SolutionUserObject.C.

 {
   _func_params[0] = _t;
   return evaluate(_time_transformation);
 }

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

◆ spatialPoints()

virtual const std::vector<Point> UserObject::spatialPoints ( ) const

inlinevirtualinherited

Optional interface function for providing the points at which a UserObject attains spatial values.

If a UserObject overrides this function, then other objects that take both the UserObject and points can instead directly use the points specified on the UserObject.

Reimplemented in NearestPointBase< ElementIntegralVariablePostprocessor, ElementVariableVectorPostprocessor >, NearestPointBase< LayeredSideIntegral, SideIntegralVariableUserObject >, NearestPointBase< LayeredAverage, ElementIntegralVariableUserObject >, NearestPointBase< LayeredSideAverage, SideIntegralVariableUserObject >, NearestPointBase< LayeredSideAverageFunctor, SideIntegralFunctorUserObject >, NearestPointBase< LayeredIntegral, ElementIntegralVariableUserObject >, NearestPointBase< ElementAverageValue, ElementVariableVectorPostprocessor >, NearestPointBase< LayeredSideIntegralFunctor, SideIntegralFunctorUserObject >, NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >, NearestPointIntegralVariablePostprocessor, FunctionLayeredIntegral, LayeredExtremumMaterialProperty, LayeredIntegralBase< SideIntegralFunctorUserObject >, LayeredIntegralBase< SideIntegralVariableUserObject >, LayeredIntegralBase< ElementIntegralFunctorUserObject >, and LayeredIntegralBase< ElementIntegralVariableUserObject >.

Definition at line 47 of file UserObject.h.

Referenced by SpatialUserObjectVectorPostprocessor::fillPoints().

   {
     mooseError("Spatial UserObject interface is not satisfied; spatialPoints() must be overridden");
   }

◆ spatialValue()

virtual Real UserObject::spatialValue ( const Point & ) const

inlinevirtualinherited

Optional interface function for "evaluating" a UserObject at a spatial position.

If a UserObject overrides this function that UserObject can then be used in a Transfer to transfer information from one domain to another.

Reimplemented in NearestPointBase< ElementIntegralVariablePostprocessor, ElementVariableVectorPostprocessor >, NearestPointBase< LayeredSideIntegral, SideIntegralVariableUserObject >, NearestPointBase< LayeredAverage, ElementIntegralVariableUserObject >, NearestPointBase< LayeredSideAverage, SideIntegralVariableUserObject >, NearestPointBase< LayeredSideAverageFunctor, SideIntegralFunctorUserObject >, NearestPointBase< LayeredIntegral, ElementIntegralVariableUserObject >, NearestPointBase< ElementAverageValue, ElementVariableVectorPostprocessor >, NearestPointBase< LayeredSideIntegralFunctor, SideIntegralFunctorUserObject >, NearestPointBase< LayeredSideDiffusiveFluxAverage, SideIntegralVariableUserObject >, LineValueSampler, MeshDivisionFunctorReductionVectorPostprocessor, FunctionLayeredIntegral, LayeredExtremumMaterialProperty, LayeredIntegralBase< SideIntegralFunctorUserObject >, LayeredIntegralBase< SideIntegralVariableUserObject >, LayeredIntegralBase< ElementIntegralFunctorUserObject >, LayeredIntegralBase< ElementIntegralVariableUserObject >, PostprocessorSpatialUserObject, NearestPointAverage, and NearestPointIntegralVariablePostprocessor.

Definition at line 36 of file UserObject.h.

Referenced by SpatialUserObjectAux::computeValue(), MultiAppGeneralFieldUserObjectTransfer::evaluateInterpValuesWithUserObjects(), MultiAppUserObjectTransfer::execute(), and SpatialUserObjectVectorPostprocessor::execute().

   {
     mooseError(name(), " does not satisfy the Spatial UserObject interface!");
   }

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

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

 {
   _stateful_allowed = stateful_allowed;
 }

◆ subdomainSetup()

void GeneralUserObject::subdomainSetup ( )

overridevirtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented from SetupInterface.

Reimplemented in ThreadedGeneralUserObject.

Definition at line 37 of file GeneralUserObject.C.

 {
   mooseError("GeneralUserObjects do not execute subdomainSetup method, this function does nothing "
              "and should not be used.");
 }

◆ systemNumber()

unsigned int UserObjectBase::systemNumber ( ) const

inlineinherited

Returns: the number of the system associated with this object

Definition at line 156 of file UserObjectBase.h.

156 { return _sys.number(); }

SystemBase::number

unsigned int number() const

Gets the number of this system.

Definition: SystemBase.C:1158

UserObjectBase::_sys

SystemBase & _sys

Reference to the system object for this user object.

Definition: UserObjectBase.h:184

◆ threadJoin()

void GeneralUserObject::threadJoin ( const UserObject & )

overridevirtualinherited

This method is not used and should not be used in a custom GeneralUserObject.

Implements UserObject.

Reimplemented in PointwiseRenormalizeVector, GeneralReporter, and ThreadedGeneralUserObject.

Definition at line 30 of file GeneralUserObject.C.

 {
   mooseError("GeneralUserObjects do not execute using threads, this function does nothing and "
              "should not be used.");
 }

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 55 of file PerfGraphInterface.C.

Referenced by PerfGraphInterface::registerTimedSection().

 {
   return _prefix.empty() ? "" : (_prefix + "::") + section_name;
 }

◆ timestepSetup()

void SolutionUserObjectBase::timestepSetup ( )

overridevirtualinherited

When reading ExodusII files, this will update the interpolation times.

Reimplemented from SetupInterface.

Definition at line 485 of file SolutionUserObjectBase.C.

 {
   // Update time interpolation for ExodusII or Nemesis solution
   if (_interpolate_times)
     updateTimeInterpolationFromFile();
 
   // Clear the caches
   _cached_p(0) = std::numeric_limits<Real>::max();
   _cached_p2(0) = std::numeric_limits<Real>::max();
 }

◆ 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 93 of file MooseBase.h.

   {
     mooseAssert(_type.size(), "Empty type");
     return _type;
   }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

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

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

Definition at line 57 of file MooseBase.C.

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

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

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 69 of file MooseBase.C.

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

 {
   if (!_pars.have_parameter<std::string>(unique_name_param))
     mooseError("uniqueName(): Object does not have a unique name");
   return MooseObjectName(_pars.get<std::string>(unique_name_param));
 }

◆ uniqueParameterName()

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

inherited

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

Definition at line 63 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ updateInterpolationBracketingTimeIndices()

bool SolutionUserObjectBase::updateInterpolationBracketingTimeIndices ( )

protectedinherited

Updates the time indices to interpolate between for ExodusII or Nemesis data.

Definition at line 665 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

 {
   if (_file_type != "exodusII" && _file_type != "nemesis")
     mooseError("getTimeInterpolationData only applicable for exodusII or Nemesis file type");
 
   int old_index1 = _exodus_index1;
   int old_index2 = _exodus_index2;
 
   int num_exo_times = _exodus_times->size();
 
   const auto solution_time = solutionSampleTime();
 
   if (solution_time < (*_exodus_times)[0])
   {
     _exodus_index1 = 0;
     _exodus_index2 = 0;
     _interpolation_factor = 0.0;
   }
   else
   {
     for (int i = 0; i < num_exo_times - 1; ++i)
     {
       if (solution_time <= (*_exodus_times)[i + 1])
       {
         _exodus_index1 = i;
         _exodus_index2 = i + 1;
         _interpolation_factor =
             (solution_time - (*_exodus_times)[i]) / ((*_exodus_times)[i + 1] - (*_exodus_times)[i]);
         break;
       }
       else if (i == num_exo_times - 2)
       {
         _exodus_index1 = num_exo_times - 1;
         _exodus_index2 = num_exo_times - 1;
         _interpolation_factor = 1.0;
         break;
       }
     }
   }
 
   bool indices_modified(false);
 
   if (_exodus_index1 != old_index1 || _exodus_index2 != old_index2)
     indices_modified = true;
 
   return indices_modified;
 }

◆ updateTimeInterpolationFromFile()

void SolutionUserObjectBase::updateTimeInterpolationFromFile ( )

protectedinherited

Updates the times for interpolating ExodusII or Nemesis data.

Definition at line 625 of file SolutionUserObjectBase.C.

Referenced by SolutionUserObjectBase::initialSetup(), and SolutionUserObjectBase::timestepSetup().

 {
   if (_t != _interpolation_time)
   {
     if (updateInterpolationBracketingTimeIndices())
     {
       // Helper to copy/update solutions from a file IO to a system
       const auto update_solutions = [this](auto & io, libMesh::System & system, unsigned int index)
       {
         for (const auto & var_name : _nodal_variables)
           io.copy_nodal_solution(system, var_name, var_name, index);
         for (const auto & var_name : _elemental_variables)
           io.copy_elemental_solution(system, var_name, var_name, index);
         if (_scalar_variables.size() > 0)
           io.copy_scalar_solution(system, _scalar_variables, _scalar_variables, index);
       };
 
       if (_file_type == "exodusII")
         update_solutions(*_exodusII_io, *_system, _exodus_index1 + 1);
       else
         update_solutions(*_nemesis_io, *_system, _exodus_index1 + 1);
 
       _system->update();
       _es->update();
       _system->solution->localize(*_serialized_solution);
 
       if (_file_type == "exodusII")
         update_solutions(*_exodusII_io, *_system2, _exodus_index2 + 1);
       else
         update_solutions(*_nemesis_io, *_system2, _exodus_index2 + 1);
 
       _system2->update();
       _es2->update();
       _system2->solution->localize(*_serialized_solution2);
     }
     _interpolation_time = _t;
   }
 }

◆ validParams()

InputParameters SolutionUserObject::validParams ( )

static

Definition at line 37 of file SolutionUserObject.C.

 {
   // Get the input parameters from the parent class
   InputParameters params = SolutionUserObjectBase::validParams();
   params += FunctionParserUtils<false>::validParams();
 
   params.addCustomTypeParam<std::string>(
       "time_transformation",
       "t",
       "FunctionExpression",
       "Expression to transform from current simulation time to time at "
       "which to sample the solution.");
 
   return params;
 }

◆ variableNames()

const std::vector< std::string > & SolutionUserObjectBase::variableNames ( ) const

inherited

Definition at line 1306 of file SolutionUserObjectBase.C.

Referenced by SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), and Axisymmetric2D3DSolutionFunction::initialSetup().

 {
   return _system_variables;
 }

◆ weightingType()

static MooseEnum SolutionUserObjectBase::weightingType ( )

inlinestaticinherited

Definition at line 261 of file SolutionUserObjectBase.h.

   {
     return MooseEnum("found_first=1 average=2 smallest_element_id=4 largest_element_id=8",
                      "found_first");
   }

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 385 of file MooseBase.h.

◆ _assembly

Assembly& UserObjectBase::_assembly

protectedinherited

Reference to the assembly object for this user object.

Definition at line 187 of file UserObjectBase.h.

Referenced by InternalSideUserObject::getNeighborElemVolume(), and PointVariableSamplerBase::initialize().

◆ _block_id_to_name

std::map<SubdomainID, SubdomainName> SolutionUserObjectBase::_block_id_to_name

protectedinherited

Map from block names to block IDs. Read from the ExodusII file.

Definition at line 520 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getBlockIdsToNames(), and SolutionUserObjectBase::readBlockIdMapFromExodusII().

◆ _block_name_to_id

std::map<SubdomainName, SubdomainID> SolutionUserObjectBase::_block_name_to_id

protectedinherited

Map from block ID to block names. Read from the ExodusII file.

Definition at line 517 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getBlockNamesToIds(), and SolutionUserObjectBase::readBlockIdMapFromExodusII().

◆ _cached_p

Point SolutionUserObjectBase::_cached_p = Point(std::numeric_limits<Real>::max(), 0., 0.)

mutableprotectedinherited

Cached points.

Definition at line 524 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction(), and SolutionUserObjectBase::timestepSetup().

◆ _cached_p2

Point SolutionUserObjectBase::_cached_p2 = Point(std::numeric_limits<Real>::max(), 0., 0.)

mutableprotectedinherited

Definition at line 525 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction(), and SolutionUserObjectBase::timestepSetup().

◆ _cached_subdomain_ids

std::set<subdomain_id_type> SolutionUserObjectBase::_cached_subdomain_ids

mutableprotectedinherited

Cached subdomain ids.

Definition at line 527 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction().

◆ _cached_subdomain_ids2

std::set<subdomain_id_type> SolutionUserObjectBase::_cached_subdomain_ids2

mutableprotectedinherited

Definition at line 528 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction().

◆ _cached_values

DenseVector<Number> SolutionUserObjectBase::_cached_values

mutableprotectedinherited

Cached values.

Definition at line 530 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction().

◆ _cached_values2

DenseVector<Number> SolutionUserObjectBase::_cached_values2

mutableprotectedinherited

Definition at line 531 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction().

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

◆ _coord_sys

const Moose::CoordinateSystemType& UserObject::_coord_sys

protectedinherited

Coordinate system.

Definition at line 66 of file UserObject.h.

Referenced by SideAverageValue::getValue().

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 86 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _default_properties

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

protectedinherited

Storage vector for default properties.

Definition at line 678 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

◆ _depend_uo

std::set<std::string> UserObjectBase::_depend_uo

mutableprotectedinherited

Depend UserObjects that to be used both for determining user object sorting and by AuxKernel for finding the full UO dependency.

Definition at line 194 of file UserObjectBase.h.

Referenced by UserObjectBase::addPostprocessorDependencyHelper(), UserObjectBase::addReporterDependencyHelper(), UserObjectBase::addUserObjectDependencyHelper(), UserObjectBase::addVectorPostprocessorDependencyHelper(), FunctionValuePostprocessor::FunctionValuePostprocessor(), UserObjectBase::getDependObjects(), UserObjectBase::getRequestedItems(), ElementSubdomainModifierBase::initialSetup(), and NEML2ModelExecutor::NEML2ModelExecutor().

◆ _disable_fpoptimizer

bool FunctionParserUtils< is_ad >::_disable_fpoptimizer

protectedinherited

Definition at line 111 of file FunctionParserUtils.h.

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ _dt

Real& TransientInterface::_dt

protectedinherited

Time step size.

Definition at line 79 of file TransientInterface.h.

Referenced by InterfaceQpValueUserObject::computeRealValue(), ForcingFunctionAux::computeValue(), TimeIntegratedPostprocessor::execute(), PIDTransientControl::execute(), ChangeOverTimePostprocessor::finalize(), VariableTimeIntegrationAux::getIntegralValue(), and PIDChainControl::updateValues().

◆ _dt_old

Real& TransientInterface::_dt_old

protectedinherited

Size of the old time step.

Definition at line 82 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _duplicate_initial_execution

const bool UserObjectBase::_duplicate_initial_execution

protectedinherited

Whether to execute this object twice on initial.

Definition at line 190 of file UserObjectBase.h.

Referenced by UserObjectBase::shouldDuplicateInitialExecution().

◆ _elemental_variables

std::vector<std::string> SolutionUserObjectBase::_elemental_variables

protectedinherited

Stores names of elemental variables.

Definition at line 418 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _enable_ad_cache

bool FunctionParserUtils< is_ad >::_enable_ad_cache

protectedinherited

Definition at line 110 of file FunctionParserUtils.h.

◆ _enable_auto_optimize

bool FunctionParserUtils< is_ad >::_enable_auto_optimize

protectedinherited

Definition at line 112 of file FunctionParserUtils.h.

◆ _enable_jit

bool FunctionParserUtils< is_ad >::_enable_jit

protectedinherited

feature flags

Definition at line 109 of file FunctionParserUtils.h.

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _epsilon

const Real FunctionParserUtils< is_ad >::_epsilon

protectedinherited

fuzzy comparison tolerance

Definition at line 128 of file FunctionParserUtils.h.

◆ _es

std::unique_ptr<libMesh::EquationSystems> SolutionUserObjectBase::_es

protectedinherited

Pointer to the libMesh::EquationSystems object.

Definition at line 433 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::readXda(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _es2

std::unique_ptr<libMesh::EquationSystems> SolutionUserObjectBase::_es2

protectedinherited

Pointer to second libMesh::EquationSystems object, used for interpolation.

Definition at line 451 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _es_file

std::string SolutionUserObjectBase::_es_file

protectedinherited

The XDA/XDR file that contians the EquationSystems data (xda/xdr only)

Definition at line 403 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readXda().

◆ _eval_error_msg

const char * FunctionParserUtils< is_ad >::_eval_error_msg

staticprotectedinherited

table of FParser eval error codes

Definition at line 122 of file FunctionParserUtils.h.

◆ _evalerror_behavior

enum FunctionParserUtils::FailureMethod FunctionParserUtils< is_ad >::_evalerror_behavior

protectedinherited

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 83 of file SetupInterface.h.

◆ _exodus_index1

int SolutionUserObjectBase::_exodus_index1

protectedinherited

Time index 1, used for interpolation.

Definition at line 472 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::updateInterpolationBracketingTimeIndices(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _exodus_index2

int SolutionUserObjectBase::_exodus_index2

protectedinherited

Time index 2, used for interpolation.

Definition at line 475 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::updateInterpolationBracketingTimeIndices(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _exodus_time_index

int SolutionUserObjectBase::_exodus_time_index

protectedinherited

Current ExodusII time index.

Definition at line 424 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis().

◆ _exodus_times

const std::vector<Real>* SolutionUserObjectBase::_exodus_times

protectedinherited

The times available in the ExodusII file.

Definition at line 469 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateInterpolationBracketingTimeIndices().

◆ _exodusII_io

std::unique_ptr<libMesh::ExodusII_IO> SolutionUserObjectBase::_exodusII_io

protectedinherited

Pointer to the libMesh::ExodusII used to read the files.

Definition at line 442 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readBlockIdMapFromExodusII(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupResidualDebugAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), AddControlAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), AddPeriodicBCAction::act(), AddNodalNormalsAction::act(), CylinderComponent::addMeshGenerators(), ComponentJunction::addMeshGenerators(), ComponentMeshTransformHelper::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getFactory(), ActionComponent::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _fe_problem

FEProblemBase& UserObjectBase::_fe_problem

protectedinherited

Reference to the FEProblemBase for this user object.

Definition at line 180 of file UserObjectBase.h.

◆ _file_type

MooseEnum SolutionUserObjectBase::_file_type

protectedinherited

File type to read (0 = xda; 1 = ExodusII, 2 = xdr, 3 = Nemesis)

Definition at line 397 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::directValue(), SolutionUserObjectBase::getSolutionFileType(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readBlockIdMapFromExodusII(), SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::readXda(), SolutionUserObjectBase::updateInterpolationBracketingTimeIndices(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _force_replicated_source

const bool SolutionUserObjectBase::_force_replicated_source

protectedinherited

Whether to force the source mesh to be replicated.

Definition at line 511 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), and SolutionUserObjectBase::readExodusIIOrNemesis().

◆ _func_params

std::vector<GenericReal<is_ad> > FunctionParserUtils< is_ad >::_func_params

protectedinherited

Array to stage the parameters passed to the functions when calling Eval.

Definition at line 125 of file FunctionParserUtils.h.

Referenced by ArrayParsedAux::ArrayParsedAux(), ParsedSubdomainIDsGenerator::assignElemSubdomainID(), ParsedSubdomainMeshGenerator::assignElemSubdomainID(), ParsedVectorAux::computeValue(), ArrayParsedAux::computeValue(), ParsedAux::computeValue(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), ParsedScalarReporter::finalize(), ParsedVectorRealReductionReporter::finalize(), ParsedVectorReporter::finalize(), ParsedVectorVectorRealReductionReporter::finalize(), ParsedPostprocessor::finalize(), ParsedSubdomainGeneratorBase::functionInitialize(), ParsedGenerateNodeset::generate(), ParsedExtraElementIDGenerator::generate(), ParsedCurveGenerator::generate(), ParsedNodeTransformGenerator::generate(), ParsedGenerateSideset::generate(), ParsedDownSelectionPositions::initialize(), ProjectSideSetOntoLevelSetGenerator::levelSetEvaluator(), CutMeshByLevelSetGeneratorBase::levelSetEvaluator(), LevelSetMeshingHelper::LevelSetMeshingHelper(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedExtraElementIDGenerator::ParsedExtraElementIDGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedODEKernel::ParsedODEKernel(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ParsedCurveGenerator::pointCalculator(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), ParsedElementDeletionGenerator::shouldDelete(), solutionSampleTime(), SolutionUserObject(), TransfiniteMeshGenerator::TransfiniteMeshGenerator(), and ParsedODEKernel::updateParams().

◆ _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 675 of file MaterialPropertyInterface.h.

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

◆ _get_suffix

const MaterialPropertyName MaterialPropertyInterface::_get_suffix

protectedinherited

Definition at line 683 of file MaterialPropertyInterface.h.

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

◆ _initialized

bool SolutionUserObjectBase::_initialized

protectedinherited

True if initial_setup has executed.

Definition at line 514 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup().

◆ _interpolate_times

bool SolutionUserObjectBase::_interpolate_times

protectedinherited

Flag for triggering interpolation of ExodusII data.

Definition at line 427 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::directValue(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::timestepSetup().

◆ _interpolated_old

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

staticprotectedinherited

name suffixes for interpolated old and older properties

Definition at line 689 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 690 of file MaterialPropertyInterface.h.

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

◆ _interpolation_factor

Real SolutionUserObjectBase::_interpolation_factor

protectedinherited

Interpolation weight factor.

Definition at line 466 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::directValue(), and SolutionUserObjectBase::updateInterpolationBracketingTimeIndices().

◆ _interpolation_time

Real SolutionUserObjectBase::_interpolation_time

protectedinherited

Time in the current simulation at which the solution interpolation was last updated.

Definition at line 463 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _is_implicit

bool TransientInterface::_is_implicit

protectedinherited

If the object is using implicit or explicit form.

This does NOT mean time scheme, but which values are going to be used in the object - either from current time or old time. Note that even explicit schemes have implicit form (it is the time derivative "kernel")

Definition at line 67 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), Kernel::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), BoundaryIntegralValueConstraint::computeResidualAndJacobian(), KernelScalarBase::computeResidualAndJacobian(), TransientInterface::determineState(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and TransientInterface::isImplicit().

◆ _is_kokkos_object

const bool MaterialPropertyInterface::_is_kokkos_object

protectedinherited

Whether the MOOSE object is a Kokkos object.

Definition at line 593 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

◆ _is_transient

bool TransientInterface::_is_transient

protectedinherited

Definition at line 85 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _local_variable_index

std::map<std::string, unsigned int> SolutionUserObjectBase::_local_variable_index

protectedinherited

Stores the local index need by MeshFunction.

Definition at line 412 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getLocalVarIndex(), and SolutionUserObjectBase::initialSetup().

◆ _material_data

MaterialData& MaterialPropertyInterface::_material_data

protectedinherited

The material data class that stores properties.

Definition at line 600 of file MaterialPropertyInterface.h.

◆ _material_data_type

const Moose::MaterialDataType MaterialPropertyInterface::_material_data_type

protectedinherited

The type of data.

Definition at line 597 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), MaterialPropertyInterface::getMaterialByName(), Moose::Kokkos::Material::materialDataType(), InterfaceMaterial::materialDataType(), and Material::materialDataType().

◆ _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 681 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), and MaterialPropertyInterface::getMatPropDependencies().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mdi_feproblem

FEProblemBase& MeshDisplacedInterface::_mdi_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshDisplacedInterface.h.

Referenced by MeshDisplacedInterface::MeshDisplacedInterface().

◆ _mesh

std::unique_ptr<libMesh::MeshBase> SolutionUserObjectBase::_mesh

protectedinherited

Pointer the libMesh::mesh object.

Definition at line 430 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getMeshFileDimension(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::readXda().

◆ _mesh_file

std::string SolutionUserObjectBase::_mesh_file

protectedinherited

The XDA/ExodusII/XDR/Nemesis file that is being read.

Definition at line 400 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getMeshFileName(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::readXda().

◆ _mesh_function

std::unique_ptr<libMesh::MeshFunction> SolutionUserObjectBase::_mesh_function

protectedinherited

Pointer the libMesh::MeshFunction object that the read data is stored.

Definition at line 439 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), and SolutionUserObjectBase::initialSetup().

◆ _mesh_function2

std::unique_ptr<libMesh::MeshFunction> SolutionUserObjectBase::_mesh_function2

protectedinherited

Pointer to second libMesh::MeshFuntion, used for interpolation.

Definition at line 457 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), and SolutionUserObjectBase::initialSetup().

◆ _mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 583 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 580 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), and MaterialPropertyInterface::getKokkosMaterialPropertyByName().

◆ _mi_name

const std::string MaterialPropertyInterface::_mi_name

protectedinherited

The name of the object that this interface belongs to.

Definition at line 577 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 574 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 586 of file MaterialPropertyInterface.h.

◆ _mi_tid

const THREAD_ID MaterialPropertyInterface::_mi_tid

protectedinherited

Current threaded it.

Definition at line 589 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::buildRequiredMaterials(), and MaterialPropertyInterface::getMaterialByName().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 391 of file MooseBase.h.

◆ _nemesis_io

std::unique_ptr<libMesh::Nemesis_IO> SolutionUserObjectBase::_nemesis_io

protectedinherited

Pointer to the libMesh::Nemesis_IO used to read the files.

Definition at line 445 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readBlockIdMapFromExodusII(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _nodal_variable_order

const MooseEnum SolutionUserObjectBase::_nodal_variable_order

protectedinherited

Nodal variable order, used when reading in solution data.

Definition at line 478 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis().

◆ _nodal_variables

std::vector<std::string> SolutionUserObjectBase::_nodal_variables

protectedinherited

Stores names of nodal variables.

Definition at line 415 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::isVariableNodal(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 394 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddMFEMComplexKernelComponentAction::act(), AddMFEMComplexBCComponentAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), MooseBase::haveParameter(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 135 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 251 of file ScalarCoupleable.h.

Referenced by FunctionDT::computeDT(), FunctionScalarAux::computeValue(), and FunctionScalarIC::value().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 138 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _quiet_nan

const Real FunctionParserUtils< is_ad >::_quiet_nan

protectedinherited

appropriate not a number value to return

Definition at line 119 of file FunctionParserUtils.h.

◆ _r0

RealTensorValue SolutionUserObjectBase::_r0

protectedinherited

Rotation matrix that performs the "_rotation0_angle about rotation0_vector".

Definition at line 496 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _r1

RealTensorValue SolutionUserObjectBase::_r1

protectedinherited

Rotation matrix that performs the "_rotation1_angle about rotation1_vector".

Definition at line 505 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 245 of file ScalarCoupleable.h.

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 234 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 243 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 237 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 240 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _rotation0_angle

Real SolutionUserObjectBase::_rotation0_angle

protectedinherited

angle (in degrees) which to rotate through about vector _rotation0_vector

Definition at line 493 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _rotation0_vector

RealVectorValue SolutionUserObjectBase::_rotation0_vector

protectedinherited

vector about which to rotate

Definition at line 490 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _rotation1_angle

Real SolutionUserObjectBase::_rotation1_angle

protectedinherited

angle (in degrees) which to rotate through about vector _rotation1_vector

Definition at line 502 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _rotation1_vector

RealVectorValue SolutionUserObjectBase::_rotation1_vector

protectedinherited

vector about which to rotate

Definition at line 499 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::SolutionUserObjectBase().

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 239 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledVectorTagScalarValue(), ScalarCoupleable::getADDefaultValue(), ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_tid

const THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 242 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_variables

std::vector<std::string> SolutionUserObjectBase::_scalar_variables

protectedinherited

Stores names of scalar variables.

Definition at line 421 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 248 of file ScalarCoupleable.h.

◆ _scale

std::vector<Real> SolutionUserObjectBase::_scale

protectedinherited

Scale parameter.

Definition at line 481 of file SolutionUserObjectBase.h.

◆ _scale_multiplier

std::vector<Real> SolutionUserObjectBase::_scale_multiplier

protectedinherited

scale_multiplier parameter

Definition at line 484 of file SolutionUserObjectBase.h.

◆ _serialized_solution

std::unique_ptr<NumericVector<Number> > SolutionUserObjectBase::_serialized_solution

protectedinherited

Pointer to the serial solution vector.

Definition at line 448 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _serialized_solution2

std::unique_ptr<NumericVector<Number> > SolutionUserObjectBase::_serialized_solution2

protectedinherited

Pointer to second serial solution, used for interpolation.

Definition at line 460 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _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 668 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName(), and MaterialPropertyInterface::statefulPropertiesAllowed().

◆ _subproblem

SubProblem& UserObjectBase::_subproblem

protectedinherited

◆ _sys

SystemBase& UserObjectBase::_sys

protectedinherited

Reference to the system object for this user object.

This should correspond to a nonlinear system (either through the FEProblemBase or the DisplacedProblem)

Definition at line 184 of file UserObjectBase.h.

Referenced by ElementSubdomainModifierBase::applyIC(), PseudoTimestep::currentResidualNorm(), VariableResidual::execute(), GreaterThanLessThanPostprocessor::execute(), PointwiseRenormalizeVector::execute(), NEML2FEInterpolation::execute(), PointwiseRenormalizeVector::finalize(), NumNonlinearIterations::finalize(), NumLinearIterations::getValue(), NumResidualEvaluations::getValue(), Residual::getValue(), PointwiseRenormalizeVector::initialize(), NEML2FEInterpolation::initialSetup(), ActivateElementsUserObjectBase::initSolutions(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and UserObjectBase::systemNumber().

◆ _system

libMesh::System* SolutionUserObjectBase::_system

protectedinherited

Pointer libMesh::System class storing the read solution.

Definition at line 436 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::directValue(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::readXda(), SolutionUserObjectBase::scalarValue(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _system2

libMesh::System* SolutionUserObjectBase::_system2

protectedinherited

Pointer to a second libMesh::System object, used for interpolation.

Definition at line 454 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::updateTimeInterpolationFromFile().

◆ _system_name

std::string SolutionUserObjectBase::_system_name

protectedinherited

The system name to extract from the XDA/XDR file (xda/xdr only)

Definition at line 406 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::getLocalVarIndex(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::readXda().

◆ _system_variables

std::vector<std::string> SolutionUserObjectBase::_system_variables

protectedinherited

A list of variables to extract from the read system.

Definition at line 409 of file SolutionUserObjectBase.h.

Referenced by SolutionUserObjectBase::evalMeshFunction(), SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), SolutionUserObjectBase::getLocalVarIndex(), SolutionUserObjectBase::initialSetup(), SolutionUserObjectBase::readExodusIIOrNemesis(), and SolutionUserObjectBase::variableNames().

◆ _t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 70 of file TransientInterface.h.

◆ _t_old

const Real& TransientInterface::_t_old

protectedinherited

Old time.

Definition at line 73 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), and TimedSubdomainModifier::computeSubdomainID().

◆ _t_step

int& TransientInterface::_t_step

protectedinherited

The number of the time step.

Definition at line 76 of file TransientInterface.h.

Referenced by NEML2ModelExecutor::advanceState(), AccumulateReporter::execute(), IterationInfo::execute(), PIDTransientControl::execute(), LeastSquaresFitHistory::execute(), NEML2ModelExecutor::fillInputs(), ChangeOverFixedPointPostprocessor::finalize(), ChangeOverTimePostprocessor::finalize(), and ElementSubdomainModifierBase::timestepSetup().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protectedinherited

Definition at line 59 of file TransientInterface.h.

Referenced by Function::evaluate(), Function::evaluateDotHelper(), Function::evaluateGradientHelper(), Function::evaluateHelper(), PiecewiseConstantFromCSV::initialSetup(), and PiecewiseConstantFromCSV::PiecewiseConstantFromCSV().

◆ _ti_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 57 of file TransientInterface.h.

◆ _tid

const THREAD_ID UserObjectBase::_tid

protectedinherited

Thread ID of this postprocessor.

Definition at line 174 of file UserObjectBase.h.

Referenced by NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), ElementalVariableValue::execute(), NodalVariableValue::execute(), NodalNormalsPreprocessor::execute(), NodalNormalsPreprocessor::initialize(), BoundaryLinearFVFluxIntegral::initialSetup(), SideFVFluxBCIntegral::initialSetup(), Terminator::initialSetup(), NEML2FEInterpolation::initialSetup(), and SolutionUserObjectBase::pointValueWrapper().

◆ _time_transformation

SymFunctionPtr SolutionUserObject::_time_transformation

function parser object for transforming the solution sample time

Definition at line 33 of file SolutionUserObject.h.

Referenced by solutionSampleTime(), and SolutionUserObject().

◆ _transformation_order

MultiMooseEnum SolutionUserObjectBase::_transformation_order

protectedinherited

transformations (rotations, translation, scales) are performed in this order

Definition at line 508 of file SolutionUserObjectBase.h.

◆ _translation

std::vector<Real> SolutionUserObjectBase::_translation

protectedinherited

Translation.

Definition at line 487 of file SolutionUserObjectBase.h.

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 388 of file MooseBase.h.

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

◆ _use_interpolated_state

const bool MaterialPropertyInterface::_use_interpolated_state

protectedinherited

Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction.

Definition at line 686 of file MaterialPropertyInterface.h.

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

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ 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 87 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"

staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 33 of file MeshMetaDataInterface.h.

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), ActionUnitTest::buildMinimalObjects(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

MooseObject::usingCombinedWarningSolutionWarnings

inherited

Definition at line 67 of file MooseObject.h.

◆ 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 90 of file MaterialPropertyInterface.h.

Referenced by MaterialBase::getGenericZeroMaterialProperty(), and MaterialPropertyInterface::getGenericZeroMaterialProperty().

The documentation for this class was generated from the following files:

include/userobjects/SolutionUserObject.h
src/userobjects/SolutionUserObject.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

◆ SymFunction

◆ SymFunctionPtr

Member Enumeration Documentation

◆ FailureMethod

Constructor & Destructor Documentation

◆ SolutionUserObject()

Member Function Documentation

◆ adCoupledScalarDot()

◆ adCoupledScalarValue()

◆ addFParserConstants()

◆ addPostprocessorDependencyHelper()

◆ addReporterDependencyHelper()

◆ addUserObjectDependencyHelper()

◆ addVectorPostprocessorDependencyHelper()

◆ buildRequiredMaterials()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ checkBlockAndBoundaryCompatibility()

◆ checkExecutionStage()

◆ checkMaterialProperty()

◆ connectControllableParams()

◆ coupledGenericScalarValue() [1/3]

◆ coupledGenericScalarValue() [2/3]

◆ coupledGenericScalarValue() [3/3]

◆ coupledMatrixTagScalarValue()

◆ coupledPostprocessors()

◆ coupledScalar()

◆ coupledScalarComponents()

◆ coupledScalarDot()

◆ coupledScalarDotDot()

◆ coupledScalarDotDotDu()

◆ coupledScalarDotDotOld()

◆ coupledScalarDotDu()

◆ coupledScalarDotOld()

◆ coupledScalarOrder()

◆ coupledScalarValue()

◆ coupledScalarValueOld()

◆ coupledScalarValueOlder()

◆ coupledVectorTagScalarValue()

◆ customSetup()

◆ cyclicDependencyError() [1/2]

◆ cyclicDependencyError() [2/2]

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ defaultADMaterialProperty()

◆ defaultGenericMaterialProperty()

◆ defaultMaterialProperty()

◆ determineState()

◆ directValue() [1/3]

◆ directValue() [2/3]

◆ directValue() [3/3]

◆ discontinuousPointValue() [1/2]

◆ discontinuousPointValue() [2/2]

◆ discontinuousPointValueGradient() [1/2]

◆ discontinuousPointValueGradient() [2/2]

◆ enabled()

◆ errorPrefix()

◆ evalMeshFunction()

◆ evalMeshFunctionGradient()

◆ evalMultiValuedMeshFunction()

◆ evalMultiValuedMeshFunctionGradient()

◆ evaluate() [1/2]

◆ evaluate() [2/2]