#include <Indicator.h>

Inheritance diagram for Indicator:

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

Public Member Functions
	Indicator (const InputParameters &parameters)

virtual	~Indicator ()

virtual void	computeIndicator ()=0
	Pure virtual that must be overridden. More...

virtual void	finalize ()
	Can be overridden to do a final postprocessing of the indicator field. More...

SubProblem &	subProblem ()

bool	isActive () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Returns the path of a data file for a given FileName type parameter, searching (in the following order) More...

std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const
	Returns the path of a data file for a given relative file path. More...

const std::vector< SubdomainName > &	blocks () const
	Return the block names for this object. More...

unsigned int	numBlocks () const
	Return the number of blocks for this object. More...

virtual const std::set< SubdomainID > &	blockIDs () const
	Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids. More...

unsigned int	blocksMaxDimension () const
	Return the largest mesh dimension of the elements in the blocks for this object. More...

bool	hasBlocks (const SubdomainName &name) const
	Test if the supplied block name is valid for this object. More...

bool	hasBlocks (const std::vector< SubdomainName > &names) const
	Test if the supplied vector of block names are valid for this object. More...

bool	hasBlocks (SubdomainID id) const
	Test if the supplied block ids are valid for this object. More...

bool	hasBlocks (const std::vector< SubdomainID > &ids) const
	Test if the supplied vector block ids are valid for this object. More...

bool	hasBlocks (const std::set< SubdomainID > &ids) const
	Test if the supplied set of block ids are valid for this object. More...

bool	isBlockSubset (const std::set< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...

template<typename T , bool is_ad = false>
bool	hasBlockMaterialProperty (const std::string &prop_name)
	Check if a material property is valid for all blocks of this object. More...

const std::set< SubdomainID > &	meshBlockIDs () const
	Return all of the SubdomainIDs for the mesh. More...

virtual bool	blockRestricted () const
	Returns true if this object has been restricted to a block. More...

virtual void	checkVariable (const MooseVariableFieldBase &variable) const
	Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	buildOutputHideVariableList (std::set< std::string > variable_names)
	Builds hide lists for output objects NOT listed in the 'outputs' parameter. More...

const std::set< OutputName > &	getOutputs ()
	Get the list of output objects that this class is restricted. More...

template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the generic property named "name" for the specified `material_data` at state `state`. More...

template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" for the specified `material_data`. More...

template<typename T >
const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)
	Retrieve the AD property named "name" for the specified `material_data`. More...

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
	Retrieve the old property deduced from the name `name` for the specified `material_data`. More...

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
	Retrieve the older property deduced from the name `name` for the specified `material_data`. More...

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

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
	Retrieve the property named "name" without any deduction for the specified `material_data`. More...

template<typename T >
const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the AD property named "name" without any deduction for the specified material_data. More...

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the old property named `name` without any deduction for the specified `material_data`. More...

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
	Retrieve the older property named `name` without any deduction for the specified `material_data`. More...

template<typename T >
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file. More...

template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...

template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()
	Return a constant zero anonymous material property. More...

template<typename T , bool is_ad>
const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

template<typename T , typename... Ts>
const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)
	for backwards compatibility More...

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
	Retrieve the block ids that the material property is defined. More...

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
	Retrieve the block names that the material property is defined. More...

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)
	Retrieve the boundary ids that the material property is defined. More...

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)
	Retrieve the boundary namess that the material property is defined. More...

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
	Check if block and boundary restrictions of a given material are compatible with the current material. More...

std::unordered_map< SubdomainID, std::vector< MaterialBase * > >	buildRequiredMaterials (bool allow_stateful=true)
	get a map of MaterialBase pointers for all material objects that this object depends on for each block More...

void	statefulPropertiesAllowed (bool)
	Derived classes can declare whether or not they work with stateful material properties. More...

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

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

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

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


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

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

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

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

Protected Member Functions
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
	A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...

void	initializeBlockRestrictable (const MooseObject *moose_object)
	An initialization routine needed for dual constructors. More...

Moose::CoordinateSystemType	getBlockCoordSystem ()
	Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...

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

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

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

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

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

void	markMatPropRequested (const std::string &)
	A proxy method for _mi_feproblem.markMatPropRequested(name) More...

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

void	checkExecutionStage ()
	Check and throw an error if the execution has progressed past the construction stage. More...


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

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

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

Protected Attributes
SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

NumericVector< Number > &	_solution

THREAD_ID	_tid

Assembly &	_assembly

MooseMesh &	_mesh

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

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

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

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

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

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

ActionFactory &	_action_factory
	Builds Actions. More...

const Parallel::Communicator &	_communicator

const MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object. More...

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

const InputParameters &	_mi_params
	Parameters of the object with this interface. More...

const std::string	_mi_name
	The name of the object that this interface belongs to. More...

const MooseObjectName	_mi_moose_object_name
	The "complete" name of the object that this interface belongs for material property output. More...

FEProblemBase &	_mi_feproblem
	Reference to the FEProblemBase class. More...

SubProblem &	_mi_subproblem
	Reference to the subproblem. More...

const THREAD_ID	_mi_tid
	Current threaded it. More...

const Moose::MaterialDataType	_material_data_type
	The type of data. More...

MaterialData &	_material_data
	The material data class that stores properties. More...

bool	_stateful_allowed
	True by default. More...

bool	_get_material_property_called
	Initialized to false. More...

std::vector< std::unique_ptr< PropertyValue > >	_default_properties
	Storage vector for default properties. More...

std::unordered_set< unsigned int >	_material_property_dependencies
	The set of material properties (as given by their IDs) that this object depends on. More...

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state
	Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction. More...

Static Protected Attributes

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

static const std::string	_interpolated_older = "_interpolated_older"

Detailed Description

Definition at line 26 of file Indicator.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface< MooseObject >::DataFileParameterType = DataFileName

inherited

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

Definition at line 26 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ Indicator()

Indicator::Indicator ( const InputParameters & parameters )

Definition at line 42 of file Indicator.C.

   : MooseObject(parameters),
     BlockRestrictable(this),
     SetupInterface(this),
     FunctionInterface(this),
     UserObjectInterface(this),
     MooseVariableDependencyInterface(this),
     Restartable(this, "Indicators"),
     OutputInterface(parameters),
     MaterialPropertyInterface(this, blockIDs(), Moose::EMPTY_BOUNDARY_IDS),
     _subproblem(*getCheckedPointerParam<SubProblem *>("_subproblem")),
     _fe_problem(*getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
     _sys(*getCheckedPointerParam<SystemBase *>("_sys")),
     _solution(_sys.solution()),
     _tid(parameters.get<THREAD_ID>("_tid")),
     _assembly(_subproblem.assembly(_tid, 0)),
     _mesh(_subproblem.mesh())
 {
 }

◆ ~Indicator()

virtual Indicator::~Indicator ( )

inlinevirtual

Definition at line 41 of file Indicator.h.

41 {};

Member Function Documentation

◆ addMooseVariableDependency() [1/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( MooseVariableFieldBase * var )

inlineprotectedinherited

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

Definition at line 73 of file MooseVariableDependencyInterface.h.

Referenced by ADDGKernel::ADDGKernel(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), ArrayNodalBC::ArrayNodalBC(), AuxKernelTempl< Real >::AuxKernelTempl(), AuxNodalScalarKernel::AuxNodalScalarKernel(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), DGKernel::DGKernel(), DiracKernelTempl< T >::DiracKernelTempl(), DomainUserObject::DomainUserObject(), ElemElemConstraint::ElemElemConstraint(), ElementIndicator::ElementIndicator(), ElementIntegralArrayVariablePostprocessor::ElementIntegralArrayVariablePostprocessor(), ElementIntegralVariablePostprocessor::ElementIntegralVariablePostprocessor(), ElementIntegralVariableUserObject::ElementIntegralVariableUserObject(), ElementUserObject::ElementUserObject(), ElementVariablePostprocessor::ElementVariablePostprocessor(), FVBoundaryCondition::FVBoundaryCondition(), FVElementalKernel::FVElementalKernel(), FVInterfaceKernel::FVInterfaceKernel(), IntegratedBC::IntegratedBC(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceMaterial::InterfaceMaterial(), InterfaceUserObjectBase::InterfaceUserObjectBase(), InternalSideIndicator::InternalSideIndicator(), InternalSideIntegralVariablePostprocessor::InternalSideIntegralVariablePostprocessor(), InternalSideUserObject::InternalSideUserObject(), Kernel::Kernel(), LinearFVBoundaryCondition::LinearFVBoundaryCondition(), LinearFVKernel::LinearFVKernel(), Marker::Marker(), Material::Material(), MortarConstraintBase::MortarConstraintBase(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalBC::NodalBC(), NodalConstraint::NodalConstraint(), NodalKernel::NodalKernel(), NodalScalarKernel::NodalScalarKernel(), NodalUserObject::NodalUserObject(), NodeElemConstraint::NodeElemConstraint(), NodeFaceConstraint::NodeFaceConstraint(), PointVariableSamplerBase::PointVariableSamplerBase(), QuadraturePointMarker::QuadraturePointMarker(), SideIntegralVariablePostprocessor::SideIntegralVariablePostprocessor(), SideIntegralVariableUserObject::SideIntegralVariableUserObject(), SideUserObject::SideUserObject(), SideVariablePostprocessor::SideVariablePostprocessor(), VectorIntegratedBC::VectorIntegratedBC(), VectorKernel::VectorKernel(), and VectorNodalBC::VectorNodalBC().

   {
     _moose_variable_dependencies.insert(var);
   }

◆ addMooseVariableDependency() [2/2]

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

inlineprotectedinherited

Definition at line 77 of file MooseVariableDependencyInterface.h.

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

◆ addUserObjectDependencyHelper()

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

inlineprotectedvirtualinherited

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

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

Definition at line 108 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBaseByName().

108 {}

◆ blockIDs()

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

virtualinherited

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

Returns: a set of SubdomainIDs that are valid for this object

Definition at line 190 of file BlockRestrictable.C.

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

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

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 178 of file BlockRestrictable.C.

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

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

◆ blocks()

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

inherited

Return the block names for this object.

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

Returns: vector of SubdomainNames that are valid for this object

Definition at line 184 of file BlockRestrictable.C.

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

 {
   return _blocks;
 }

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

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

Definition at line 360 of file BlockRestrictable.C.

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

◆ buildOutputHideVariableList()

void OutputInterface::buildOutputHideVariableList ( std::set< std::string > variable_names )

inherited

Builds hide lists for output objects NOT listed in the 'outputs' parameter.

Parameters

variable_names A set of variables for which the 'outputs' parameter controls

By default this is called by the constructor and passes the block name as the list of variables. This needs to be called explicitly if the build_list flag is set to False in the constructor. The latter cases is needed by the Material object to work correctly with the automatic material output capability.

Definition at line 61 of file OutputInterface.C.

Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface::OutputInterface().

 {
   // Set of available names
   const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();
 
   // Check for 'none'; hide variables on all outputs
   if (_oi_outputs.find("none") != _oi_outputs.end())
     for (const auto & name : avail)
       _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
 
   // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
   // these cases
   else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
     return;
 
   // Limit the variable output to Output objects listed
   else
   {
     // Create a list of outputs where the variable should be hidden
     std::set<OutputName> hide;
     std::set_difference(avail.begin(),
                         avail.end(),
                         _oi_outputs.begin(),
                         _oi_outputs.end(),
                         std::inserter(hide, hide.begin()));
 
     // If 'outputs' is specified add the object name to the list of items to hide
     for (const auto & name : hide)
       _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
   }
 }

◆ buildRequiredMaterials()

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

inherited

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

Definition at line 205 of file MaterialPropertyInterface.C.

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

◆ callMooseError()

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

inherited

Calls moose error with the message msg.

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

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

Definition at line 33 of file MooseBase.C.

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

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

◆ checkAllVariables()

template<typename DofObjectType >

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

inherited

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

Parameters

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

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

Definition at line 91 of file MooseVariableDependencyInterface.h.

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

◆ checkBlockAndBoundaryCompatibility()

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

inherited

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

Error out otherwise.

Definition at line 147 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterialByName().

 {
   // Check block compatibility
   if (!discrete->hasBlocks(_mi_block_ids))
   {
     std::ostringstream oss;
     oss << "Incompatible material and object blocks:";
 
     oss << "\n    " << paramErrorPrefix(discrete->parameters(), "block")
         << " material defined on blocks ";
     for (const auto & sbd_id : discrete->blockIDs())
       oss << sbd_id << ", ";
 
     oss << "\n    " << paramErrorPrefix(_mi_params, "block") << " object needs material on blocks ";
     for (const auto & block_id : _mi_block_ids)
       oss << block_id << ", ";
 
     mooseError(oss.str());
   }
 
   // Check boundary compatibility
   if (!discrete->hasBoundary(_mi_boundary_ids))
   {
     std::ostringstream oss;
     oss << "Incompatible material and object boundaries:";
 
     oss << "\n    " << paramErrorPrefix(discrete->parameters(), "boundary")
         << " material defined on boundaries ";
     for (const auto & bnd_id : discrete->boundaryIDs())
       oss << bnd_id << ", ";
 
     oss << "\n    " << paramErrorPrefix(_mi_params, "boundary")
         << " object needs material on boundaries ";
     for (const auto & bnd_id : _mi_boundary_ids)
       oss << bnd_id << ", ";
 
     mooseError(oss.str());
   }
 }

◆ checkExecutionStage()

void MaterialPropertyInterface::checkExecutionStage ( )

protectedinherited

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

Definition at line 222 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName().

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

◆ checkMaterialProperty()

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

protectedvirtualinherited

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

Reimplemented in Material.

Definition at line 118 of file MaterialPropertyInterface.C.

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

 {
   if (state == 0)
   {
     // If the material property is boundary restrictable, add to the list of materials to check
     if (_mi_boundary_restricted)
       for (const auto & bnd_id : _mi_boundary_ids)
         _mi_feproblem.storeBoundaryDelayedCheckMatProp(_mi_name, bnd_id, name);
 
     // The default is to assume block restrictions
     else
       for (const auto & blk_ids : _mi_block_ids)
         _mi_feproblem.storeSubdomainDelayedCheckMatProp(_mi_name, blk_ids, name);
   }
 }

◆ checkVariable()

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

virtualinherited

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

Parameters

variable The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 333 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

 {
   // a variable defined on all internal sides does not need this check because
   // it can be coupled with other variables in DG kernels
   if (variable.activeSubdomains().count(Moose::INTERNAL_SIDE_LOWERD_ID) > 0)
     return;
 
   if (!isBlockSubset(variable.activeSubdomains()))
   {
     std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
     std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
     mooseError("The 'block' parameter of the object '",
                _blk_name,
                "' must be a subset of the 'block' parameter of the variable '",
                variable.name(),
                "':\n    Object '",
                _blk_name,
                "': ",
                obj_ids,
                "\n    Variable '",
                variable.name(),
                "': ",
                var_ids);
   }
 }

◆ checkVariables()

template<typename DofObjectType >

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

inherited

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

Parameters

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

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

Definition at line 25 of file MooseVariableDependencyInterface.C.

Referenced by MooseVariableDependencyInterface::checkAllVariables().

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

◆ computeIndicator()

virtual void Indicator::computeIndicator ( )

pure virtual

Pure virtual that must be overridden.

This is generally overridden by an intermediate base class. Usually you will want to inherit from InternalSideIndicator or ElementIndicator. They contain other virtual functions you will probably want to override instead.

Implemented in InternalSideIndicator, and ElementIntegralIndicator.

◆ connectControllableParams()

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

inherited

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

Parameters

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

Definition at line 33 of file MooseBaseParameterInterface.C.

 {
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = _factory.getValidParams(object_type).get<std::string>("_moose_base");
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
       primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name);
     }
   }
 }

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 276 of file Restartable.h.

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

◆ declareRecoverableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 351 of file Restartable.h.

 {
   const auto full_name = restartableName(data_name);
 
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
 
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 269 of file Restartable.h.

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

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 294 of file Restartable.h.

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

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 323 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 333 of file Restartable.h.

 {
   std::string old_name = _restartable_name;
 
   _restartable_name = object_name;
 
   T & value = declareRestartableDataWithContext<T>(data_name, context, std::forward<Args>(args)...);
 
   _restartable_name = old_name;
 
   return value;
 }

◆ defaultADMaterialProperty()

template<typename T >

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

inlineprotectedinherited

Definition at line 521 of file MaterialPropertyInterface.h.

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

◆ defaultGenericMaterialProperty()

template<typename T , bool is_ad>

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

protectedinherited

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

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

Definition at line 618 of file MaterialPropertyInterface.h.

 {
   if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
   {
     std::istringstream ss(name);
     Real real_value;
 
     // check if the string parsed cleanly into a Real number
     if (ss >> real_value && ss.eof())
     {
       using prop_type = GenericMaterialProperty<T, is_ad>;
 
       const auto nqp = Moose::constMaxQpsPerElem;
       auto & property =
           _default_properties.emplace_back(std::make_unique<prop_type>(default_property_id));
       auto & T_property = static_cast<prop_type &>(*property);
 
       T_property.resize(nqp);
       for (const auto qp : make_range(nqp))
         T_property[qp] = real_value;
 
       return &T_property;
     }
   }
 
   return nullptr;
 }

◆ defaultMaterialProperty()

template<typename T >

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

inlineprotectedinherited

Definition at line 516 of file MaterialPropertyInterface.h.

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

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 50 of file MooseObject.h.

Referenced by EigenKernel::enabled().

50 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:61

◆ errorPrefix()

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

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ finalize()

virtual void Indicator::finalize ( )

inlinevirtual

Can be overridden to do a final postprocessing of the indicator field.

This will allow you to sum up error from multiple places and then do something like take the square root of it in this function.

Reimplemented in InternalSideIndicator.

Definition at line 57 of file Indicator.h.

57 {};

◆ getADMaterialProperty() [1/2]

template<typename T >

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

inlineinherited

Definition at line 103 of file MaterialPropertyInterface.h.

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

◆ getADMaterialProperty() [2/2]

template<typename T >

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

inlineinherited

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

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

Definition at line 362 of file MaterialPropertyInterface.h.

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

◆ getADMaterialPropertyByName() [1/2]

template<typename T >

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

inlineinherited

Definition at line 140 of file MaterialPropertyInterface.h.

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

◆ getADMaterialPropertyByName() [2/2]

template<typename T >

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

inlineinherited

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

Definition at line 405 of file MaterialPropertyInterface.h.

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

◆ getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )

protectedinherited

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

Definition at line 311 of file BlockRestrictable.C.

 {
   if (!_blk_mesh)
     mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
   if (!_blk_feproblem)
     mooseError("No problem available in BlockRestrictable::checkCoordSystem()");
 
   const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   if (subdomains.empty())
     mooseError("No subdomains found in the problem.");
 
   // make sure all subdomains are using the same coordinate system
   auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
   for (auto subdomain : subdomains)
     if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
       mooseError("This object requires all subdomains to have the same coordinate system.");
 
   return coord_system;
 }

◆ getBlockMaterialProperty()

template<typename T >

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

inherited

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

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

Parameters

name	The name of the material property to retrieve

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

Definition at line 648 of file MaterialPropertyInterface.h.

 {
   const auto name = _get_suffix.empty()
                         ? static_cast<const std::string &>(name_in)
                         : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
 
   if (_mi_block_ids.empty())
     mooseError("getBlockMaterialProperty must be called by a block restrictable object");
 
   using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;
 
   if (!hasMaterialPropertyByName<T>(name))
     return pair_type(nullptr, {});
 
   // Call first so that the ID gets registered
   const auto & prop = _material_data.getProperty<T, false>(name, 0, _mi_moose_object);
   auto blocks = getMaterialPropertyBlocks(name);
   auto prop_blocks_pair = pair_type(&prop, std::move(blocks));
 
   _material_property_dependencies.insert(_material_data.getPropertyId(name));
 
   // Update consumed properties in MaterialPropertyDebugOutput
   addConsumedPropertyName(_mi_moose_object_name, name);
 
   return prop_blocks_pair;
 }

◆ getCheckedPointerParam()

template<typename T >

T MooseBaseParameterInterface::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 268 of file MooseBaseParameterInterface.h.

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

◆ getDataFileName()

std::string DataFileInterface< MooseObject >::getDataFileName ( const std::string & param ) const

inherited

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

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

Definition at line 24 of file DataFileInterface.C.

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

◆ getDataFileNameByName()

std::string DataFileInterface< MooseObject >::getDataFileNameByName	(	const std::string &	name,
		const std::string *	param = `nullptr`
	)		const

inherited

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

This can be used for hardcoded datafile names and will search the same locations as getDataFileName. The optional param pointer can be used to turn the mooseErrors this function emits into paramErrors

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

Definition at line 53 of file DataFileInterface.C.

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

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 65 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   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 30 of file FunctionInterface.C.

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

 {
   return _fni_feproblem.getFunction(_fni_params.get<FunctionName>(name), _fni_tid);
 }

◆ getFunctionByName()

const Function & FunctionInterface::getFunctionByName ( const FunctionName & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 36 of file FunctionInterface.C.

Referenced by ArrayBodyForce::ArrayBodyForce(), ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionArrayAux::FunctionArrayAux(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterialTempl< is_ad >::GenericFunctionMaterialTempl(), GenericFunctionRankTwoTensorTempl< is_ad >::GenericFunctionRankTwoTensorTempl(), GenericFunctionVectorMaterialTempl< is_ad >::GenericFunctionVectorMaterialTempl(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

 {
   return _fni_feproblem.getFunction(name, _fni_tid);
 }

◆ getGenericMaterialProperty() [1/2]

template<typename T , bool is_ad>

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

inlineinherited

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

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

Parameters

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

Returns: Reference to the desired material property

Definition at line 91 of file MaterialPropertyInterface.h.

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

◆ getGenericMaterialProperty() [2/2]

template<typename T , bool is_ad>

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

inherited

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

Definition at line 786 of file MaterialPropertyInterface.h.

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

◆ getGenericMaterialPropertyByName() [1/2]

template<typename T , bool is_ad>

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

inlineinherited

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

Parameters

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

Returns: Reference to the material property with the name 'name'

Definition at line 129 of file MaterialPropertyInterface.h.

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

◆ getGenericMaterialPropertyByName() [2/2]

template<typename T , bool is_ad>

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

inherited

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

Definition at line 799 of file MaterialPropertyInterface.h.

 {
   if (_use_interpolated_state)
   {
     if (state == 1)
       return getGenericMaterialPropertyByName<T, is_ad>(
           name_in + _interpolated_old, material_data, 0);
     if (state == 2)
       return getGenericMaterialPropertyByName<T, is_ad>(
           name_in + _interpolated_older, material_data, 0);
   }
 
   const auto name = _get_suffix.empty()
                         ? static_cast<const std::string &>(name_in)
                         : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
 
   checkExecutionStage();
   checkMaterialProperty(name, state);
 
   // mark property as requested
   markMatPropRequested(name);
 
   // Update the boolean flag.
   _get_material_property_called = true;
 
   // Call first so that the ID gets registered
   auto & prop = material_data.getProperty<T, is_ad>(name, state, _mi_moose_object);
 
   // Does the material data used here matter?
   _material_property_dependencies.insert(material_data.getPropertyId(name));
 
   if (state == 0)
     addConsumedPropertyName(_mi_moose_object_name, name);
 
   return prop;
 }

◆ getGenericOptionalMaterialProperty()

template<typename T , bool is_ad>

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

inherited

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

Definition at line 754 of file MaterialPropertyInterface.h.

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

◆ getGenericZeroMaterialProperty() [1/2]

template<typename T , bool is_ad>

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

inherited

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

Definition at line 696 of file MaterialPropertyInterface.h.

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

◆ getGenericZeroMaterialProperty() [2/2]

template<typename T , bool is_ad>

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

inherited

Return a constant zero anonymous material property.

Definition at line 715 of file MaterialPropertyInterface.h.

 {
   // static zero property storage
   static GenericMaterialProperty<T, is_ad> zero(zero_property_id);
 
   // resize to accomodate maximum number of qpoints
   // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
   unsigned int nqp = getMaxQps();
   if (nqp > zero.size())
     zero.resize(nqp);
 
   // set values for all qpoints to zero
   for (unsigned int qp = 0; qp < nqp; ++qp)
     MathUtils::mooseSetToZero(zero[qp]);
 
   return zero;
 }

◆ getGenericZeroMaterialPropertyByName()

template<typename T , bool is_ad>

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

inherited

Definition at line 704 of file MaterialPropertyInterface.h.

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

◆ getMaterial()

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

inherited

Return a MaterialBase reference - usable for computing directly.

Parameters

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

Definition at line 189 of file MaterialPropertyInterface.C.

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

◆ getMaterialByName()

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

inherited

Definition at line 195 of file MaterialPropertyInterface.C.

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

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

◆ getMaterialProperty() [1/2]

template<typename T >

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

inlineinherited

Definition at line 97 of file MaterialPropertyInterface.h.

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

◆ getMaterialProperty() [2/2]

template<typename T >

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

inlineinherited

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

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

Definition at line 349 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyBlockNames()

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

inherited

Retrieve the block names that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the block names for the property

Definition at line 87 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBlockNames(name);
 }

◆ getMaterialPropertyBlocks()

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

inherited

Retrieve the block ids that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the block ids for the property

Definition at line 81 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getBlockMaterialProperty().

 {
   return _mi_feproblem.getMaterialPropertyBlocks(name);
 }

◆ getMaterialPropertyBoundaryIDs()

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

inherited

Retrieve the boundary ids that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the boundary ids for the property

Definition at line 93 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBoundaryIDs(name);
 }

◆ getMaterialPropertyBoundaryNames()

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

inherited

Retrieve the boundary namess that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the boundary names for the property

Definition at line 99 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBoundaryNames(name);
 }

◆ getMaterialPropertyByName() [1/2]

template<typename T >

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

inlineinherited

Definition at line 134 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyByName() [2/2]

template<typename T >

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

inlineinherited

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

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

Definition at line 393 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyCalled()

bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlineinherited

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

Definition at line 320 of file MaterialPropertyInterface.h.

320 { return _get_material_property_called; }

MaterialPropertyInterface::_get_material_property_called

bool _get_material_property_called

Initialized to false.

Definition: MaterialPropertyInterface.h:543

◆ getMaterialPropertyName()

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

protectedinherited

Returns: The name of the material property associated with name name.

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

Definition at line 73 of file MaterialPropertyInterface.C.

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

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

◆ getMaterialPropertyOld() [1/2]

template<typename T >

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

inlineinherited

Definition at line 108 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOld() [2/2]

template<typename T >

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

inlineinherited

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

Definition at line 415 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOldByName() [1/2]

template<typename T >

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

inlineinherited

Definition at line 145 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOldByName() [2/2]

template<typename T >

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

inlineinherited

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

Definition at line 437 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOlder() [1/2]

template<typename T >

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

inlineinherited

Definition at line 113 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOlder() [2/2]

template<typename T >

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

inlineinherited

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

Definition at line 426 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOlderByName() [1/2]

template<typename T >

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

inlineinherited

Definition at line 150 of file MaterialPropertyInterface.h.

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

◆ getMaterialPropertyOlderByName() [2/2]

template<typename T >

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

inlineinherited

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

Definition at line 448 of file MaterialPropertyInterface.h.

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

◆ getMatPropDependencies()

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

inlineinherited

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

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

Definition at line 328 of file MaterialPropertyInterface.h.

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

   {
     return _material_property_dependencies;
   }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

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

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ getMooseVariableDependencies()

const std::set<MooseVariableFieldBase *>& MooseVariableDependencyInterface::getMooseVariableDependencies ( ) const

inlineinherited

Retrieve the set of MooseVariableFieldBase that this object depends on.

Returns: The MooseVariableFieldBase that MUST be reinited before evaluating this object

Definition at line 35 of file MooseVariableDependencyInterface.h.

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

   {
     return _moose_variable_dependencies;
   }

◆ getOptionalADMaterialProperty()

template<typename T >

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

inlineinherited

Definition at line 169 of file MaterialPropertyInterface.h.

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

◆ getOptionalMaterialProperty()

template<typename T >

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

inlineinherited

Definition at line 163 of file MaterialPropertyInterface.h.

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

◆ getOptionalMaterialPropertyOld()

template<typename T >

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

inlineinherited

Definition at line 175 of file MaterialPropertyInterface.h.

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

◆ getOptionalMaterialPropertyOlder()

template<typename T >

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

inlineinherited

Definition at line 180 of file MaterialPropertyInterface.h.

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

◆ getOutputs()

const std::set< OutputName > & OutputInterface::getOutputs ( )

inherited

Get the list of output objects that this class is restricted.

Returns: A set of OutputNames

Definition at line 94 of file OutputInterface.C.

 {
   return _oi_outputs;
 }

◆ getParam() [1/2]

template<typename T >

const T & MooseBaseParameterInterface::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 204 of file MooseBaseParameterInterface.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

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

inherited

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

Parameters

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

Returns: Vector of pairs of first and second parameters

Definition at line 261 of file MooseBaseParameterInterface.h.

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

◆ getPossiblyConstantGenericMaterialPropertyByName()

template<typename T , bool is_ad>

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

inherited

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

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

Definition at line 766 of file MaterialPropertyInterface.h.

 {
   // Check if it's just a constant
   if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
     return *default_property;
 
   if (state > 0 && !_stateful_allowed)
     mooseError("Stateful material properties not allowed for this object."
                " State ",
                state,
                " property for \"",
                prop_name,
                "\" was requested.");
 
   return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
 }

◆ getRenamedParam()

template<typename T >

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

inherited

Retrieve a renamed parameter for the object.

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

Parameters

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

Definition at line 211 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getRestartableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 287 of file Restartable.h.

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

◆ getSharedPtr() [1/2]

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

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 72 of file MooseObject.C.

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

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 85 of file MooseObject.C.

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

◆ getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 160 of file UserObjectInterface.h.

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

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 79 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObject().

 {
   const auto object_name = getUserObjectName(param_name);
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.paramError(
         param_name, "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   return getUserObjectBaseByName(object_name, is_dependency);
 }

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 91 of file UserObjectInterface.C.

Referenced by UserObject::getDependObjects(), UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectByName().

 {
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.mooseError(
         "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   const auto & uo_base_tid0 = _uoi_feproblem.getUserObjectBase(object_name, /* tid = */ 0);
   if (is_dependency)
     addUserObjectDependencyHelper(uo_base_tid0);
 
   const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectBase(object_name, tid);
 }

◆ getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 167 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBaseByName(object_name, is_dependency));
 }

◆ getUserObjectName()

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

inherited

Returns: The name of the user object associated with the parameter param_name

Definition at line 34 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObjectBase(), and UserObjectInterface::hasUserObject().

 {
   const auto & params = _uoi_moose_object.parameters();
 
   if (!params.isParamValid(param_name))
     _uoi_moose_object.mooseError("Failed to get a parameter with the name \"",
                                  param_name,
                                  "\" when getting a UserObjectName.",
                                  "\n\nKnown parameters:\n",
                                  _uoi_moose_object.parameters());
 
   // Other interfaces will use this interface (PostprocessorInterface, VectorPostprocessorInterface)
   // to grab UOs with a specialized name, so we need to check them all
   UserObjectName name;
   if (params.isType<UserObjectName>(param_name))
     name = params.get<UserObjectName>(param_name);
   else if (params.isType<PostprocessorName>(param_name))
     name = params.get<PostprocessorName>(param_name);
   else if (params.isType<VectorPostprocessorName>(param_name))
     name = params.get<VectorPostprocessorName>(param_name);
   else if (params.isType<std::string>(param_name))
     name = params.get<std::string>(param_name);
   else
     _uoi_moose_object.paramError(
         param_name,
         "Parameter of type \"",
         params.type(param_name),
         "\" is not an expected type for getting the name of a UserObject.");
 
   return name;
 }

◆ getZeroMaterialProperty()

template<typename T , typename... Ts>

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

inlineinherited

for backwards compatibility

Definition at line 219 of file MaterialPropertyInterface.h.

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

◆ hasADMaterialProperty()

template<typename T >

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

inherited

Definition at line 735 of file MaterialPropertyInterface.h.

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

◆ hasADMaterialPropertyByName()

template<typename T >

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

inherited

Definition at line 744 of file MaterialPropertyInterface.h.

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

◆ hasBlockMaterialProperty()

template<typename T , bool is_ad>

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

inherited

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

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

Template Parameters

T	The type of material property

Parameters

prop_name the name of the property to query

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

See also: Material::hasBlockMaterialProperty

Definition at line 264 of file BlockRestrictable.h.

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

◆ hasBlockMaterialPropertyHelper()

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

protectedvirtualinherited

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

It also avoid circular #include problems.

See also: hasBlockMaterialProperty

Definition at line 275 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

 {
 
   // Reference to MaterialWarehouse for testing and retrieving block ids
   const MaterialWarehouse & warehouse = _blk_feproblem->getMaterialWarehouse();
 
   // Complete set of ids that this object is active
   const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   // Loop over each id for this object
   for (const auto & id : ids)
   {
     // Storage of material properties that have been DECLARED on this id
     std::set<std::string> declared_props;
 
     // If block materials exist, populated the set of properties that were declared
     if (warehouse.hasActiveBlockObjects(id))
     {
       const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
       for (const auto & mat : mats)
       {
         const std::set<std::string> & mat_props = mat->getSuppliedItems();
         declared_props.insert(mat_props.begin(), mat_props.end());
       }
     }
 
     // If the supplied property is not in the list of properties on the current id, return false
     if (declared_props.find(prop_name) == declared_props.end())
       return false;
   }
 
   // If you get here the supplied property is defined on all blocks
   return true;
 }

◆ hasBlocks() [1/5]

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

inherited

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

Parameters

name	A SubdomainName to check

Returns: True if the given id is valid for this object

Definition at line 205 of file BlockRestrictable.C.

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

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

◆ hasBlocks() [2/5]

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

inherited

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

Parameters

names A vector of SubdomainNames to check

Returns: True if the given ids are valid for this object

Definition at line 215 of file BlockRestrictable.C.

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

◆ hasBlocks() [3/5]

bool BlockRestrictable::hasBlocks ( SubdomainID id ) const

inherited

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

Parameters

id	A SubdomainID to check

Returns: True if the given id is valid for this object

Definition at line 221 of file BlockRestrictable.C.

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

◆ hasBlocks() [4/5]

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

inherited

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

Parameters

ids	A vector of SubdomainIDs ids to check

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

Definition at line 230 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/5]

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

inherited

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

Parameters

ids	A std::set of SubdomainIDs to check

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

See also: isSubset

Definition at line 237 of file BlockRestrictable.C.

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

◆ hasFunction()

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

inherited

Determine if the function exists.

Parameters

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

Returns: True if the function exists

Definition at line 42 of file FunctionInterface.C.

 {
   return hasFunctionByName(_fni_params.get<FunctionName>(param_name));
 }

◆ hasFunctionByName()

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

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 48 of file FunctionInterface.C.

Referenced by FunctionInterface::hasFunction().

 {
   return _fni_feproblem.hasFunction(name, _fni_tid);
 }

◆ hasGenericMaterialProperty()

template<typename T , bool is_ad>

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

inlineinherited

generic hasMaterialProperty helper

Definition at line 293 of file MaterialPropertyInterface.h.

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

◆ hasGenericMaterialPropertyByName()

template<typename T , bool is_ad>

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

inlineinherited

Definition at line 301 of file MaterialPropertyInterface.h.

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

◆ hasMaterialProperty()

template<typename T >

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

inherited

Check if the material property exists.

Parameters

name	the name of the property to query

Returns: true if the property exists, otherwise false

Definition at line 677 of file MaterialPropertyInterface.h.

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

◆ hasMaterialPropertyByName()

template<typename T >

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

inherited

Definition at line 686 of file MaterialPropertyInterface.h.

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

◆ hasUserObject() [1/2]

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

inherited

Returns: Whether or not a UserObject exists with the name given by the parameter param_name.

Definition at line 67 of file UserObjectInterface.C.

 {
   return hasUserObjectByName(getUserObjectName(param_name));
 }

◆ hasUserObject() [2/2]

template<class T >

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

inherited

Definition at line 175 of file UserObjectInterface.h.

 {
   return hasUserObjectByName<T>(getUserObjectName(param_name));
 }

◆ hasUserObjectByName() [1/2]

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

inherited

Definition at line 73 of file UserObjectInterface.C.

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

 {
   return _uoi_feproblem.hasUserObject(object_name);
 }

◆ hasUserObjectByName() [2/2]

template<class T >

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

inherited

Definition at line 182 of file UserObjectInterface.h.

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

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject * moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 74 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

 {
   // If the mesh pointer is not defined, but FEProblemBase is, get it from there
   if (_blk_feproblem != NULL && _blk_mesh == NULL)
     _blk_mesh = &_blk_feproblem->mesh();
 
   // Check that the mesh pointer was defined, it is required for this class to operate
   if (_blk_mesh == NULL)
     mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
                "pointer to the MooseMesh via '_mesh'");
 
   // Populate the MaterialData pointer
   if (_blk_feproblem != NULL)
     _blk_material_data = &_blk_feproblem->getMaterialData(Moose::BLOCK_MATERIAL_DATA, _blk_tid);
 
   // The 'block' input is defined
   if (moose_object->isParamValid("block"))
   {
     // Extract the blocks from the input
     _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");
 
     // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
     if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
       _blk_ids.insert(Moose::ANY_BLOCK_ID);
     else
     {
       // Get the IDs from the supplied names
       _vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
       _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
     }
   }
 
   // When 'blocks' is not set and there is a "variable", use the blocks from the variable
   else if (moose_object->isParamValid("variable"))
   {
     std::string variable_name = moose_object->parameters().getMooseType("variable");
     if (!variable_name.empty())
       _blk_ids = _blk_feproblem
                      ->getVariable(_blk_tid,
                                    variable_name,
                                    Moose::VarKindType::VAR_ANY,
                                    Moose::VarFieldType::VAR_FIELD_ANY)
                      .activeSubdomains();
   }
 
   // Produce error if the object is not allowed to be both block and boundary restricted
   if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
     if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
       moose_object->paramError("block",
                                "Attempted to restrict the object '",
                                _blk_name,
                                "' to a block, but the object is already restricted by boundary");
 
   // If no blocks were defined above, specify that it is valid on all blocks
   if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
   {
     _blk_ids.insert(Moose::ANY_BLOCK_ID);
     _blocks = {"ANY_BLOCK_ID"};
   }
 
   // If this object is block restricted, check that defined blocks exist on the mesh
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
   {
     const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
     std::vector<SubdomainID> diff;
 
     std::set_difference(_blk_ids.begin(),
                         _blk_ids.end(),
                         valid_ids.begin(),
                         valid_ids.end(),
                         std::back_inserter(diff));
 
     if (!diff.empty())
     {
       std::ostringstream msg;
       auto sep = " ";
       msg << "the following blocks (ids) do not exist on the mesh:";
       for (const auto & id : diff)
       {
         if (_blk_name.size() > 0)
         {
           auto & name =
               _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
           if (std::to_string(id) != name)
             msg << sep << name << " (" << id << ")";
           else
             msg << sep << id;
         }
         else
           msg << sep << id;
         sep = ", ";
       }
       moose_object->paramError("block", msg.str());
     }
   }
 
   // Get the mesh dimension for the blocks
   if (blockRestricted())
     _blk_dim = _blk_mesh->getBlocksMaxDimension(_blocks);
   else
     _blk_dim = _blk_mesh->dimension();
 }

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

Reimplemented in SolutionUserObject, AdvancedOutput, MooseVariableBase, MultiApp, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseParsedFunction, MooseParsedGradFunction, DerivativeFunctionMaterialBaseTempl< is_ad >, Transfer, ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >, CSV, Exodus, OversampleOutput, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, MultiAppTransfer, Nemesis, RadialAverage, MooseParsedVectorFunction, ImageFunction, Console, PiecewiseConstantFromCSV, NodalVariableValue, MortarNodalAuxKernelTempl< ComputeValueType >, LibtorchArtificialNeuralNetParameters, TimePeriod, MatDiffusionBase< T >, TransientMultiApp, ElementalVariableValue, GhostingUserObject, InterfaceQpUserObjectBase, MatDiffusionBase< Real >, SolutionAux, MultiAppProjectionTransfer, HistogramVectorPostprocessor, SolutionScalarAux, LinearFVAdvection, LinearFVDiffusion, MultiAppDofCopyTransfer, MultiAppGeneralFieldNearestLocationTransfer, CoarsenedPiecewiseLinear, PiecewiseTabularBase, MatReaction, SideIntegralMaterialPropertyTempl< is_ad >, SideIntegralPostprocessor, MultiAppVariableValueSamplePostprocessorTransfer, NodalPatchRecoveryMaterialProperty, ProjectedStatefulMaterialAuxTempl< T, is_ad >, PiecewiseLinear, FullSolveMultiApp, MultiAppFieldTransfer, MultiAppVariableValueSampleTransfer, PiecewiseLinearBase, MultiAppConservativeTransfer, MultiAppCloneReporterTransfer, MultiAppReporterTransfer, ElementSubdomainModifier, and DerivativeSumMaterialTempl< is_ad >.

Definition at line 40 of file SetupInterface.C.

Referenced by SideIntegralPostprocessor::initialSetup(), ElementalVariableValue::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), and Positions::meshChanged().

41 {

42 }

◆ isActive()

bool Indicator::isActive ( ) const

inline

Definition at line 62 of file Indicator.h.

62 { return true; }

◆ isBlockSubset() [1/2]

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

inherited

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

Parameters

ids	A std::set of Subdomains to check

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

See also: hasBlocks

Definition at line 246 of file BlockRestrictable.C.

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

 {
   // An empty input is assumed to be ANY_BLOCK_ID
   if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
     return true;
 
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
     return std::includes(ids.begin(),
                          ids.end(),
                          _blk_mesh->meshSubdomains().begin(),
                          _blk_mesh->meshSubdomains().end());
   else
     return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
 }

◆ isBlockSubset() [2/2]

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

inherited

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

Parameters

ids	A std::vector of Subdomains to check

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

See also: hasBlocks

Definition at line 262 of file BlockRestrictable.C.

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

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 117 of file MooseBaseParameterInterface.h.

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

117 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

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

Method returns true if the parameter was by the user.

Definition: InputParameters.C:1074

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 111 of file MooseBaseParameterInterface.h.

111 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

InputParameters::isParamValid

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

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

Definition: InputParameters.C:376

◆ 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< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, ADKernelTempl< T >, and EqualValueEmbeddedConstraint.

Definition at line 50 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().

51 {

52 }

◆ markMatPropRequested()

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

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 135 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getGenericMaterialPropertyByName().

 {
   _mi_feproblem.markMatPropRequested(name);
 }

◆ meshBlockIDs()

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

inherited

Return all of the SubdomainIDs for the mesh.

Returns: A set of all subdomians for the entire mesh

Definition at line 269 of file BlockRestrictable.C.

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

 {
   return _blk_mesh->meshSubdomains();
 }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), Executioner::augmentedPicardConvergenceCheck(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), Executioner::picardSolve(), ReferenceResidualProblem::ReferenceResidualProblem(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

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

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

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

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

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

◆ mooseErrorNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 40 of file MooseBaseErrorInterface.h.

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

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 97 of file MooseBaseErrorInterface.h.

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

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

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

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 85 of file MooseBaseErrorInterface.h.

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

◆ name()

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

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 199 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::initialize().

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

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 237 of file MooseBaseParameterInterface.h.

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

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 254 of file MooseBaseParameterInterface.h.

Referenced by TransientMultiApp::TransientMultiApp().

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

◆ paramWarning()

template<typename... Args>

void MooseBaseParameterInterface::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 247 of file MooseBaseParameterInterface.h.

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

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

◆ 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< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, 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 55 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().

56 {

57 }

◆ resolveOptionalProperties()

void MaterialPropertyInterface::resolveOptionalProperties ( )

virtualinherited

resolve all optional properties

Reimplemented in Material.

Definition at line 230 of file MaterialPropertyInterface.C.

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

◆ restartableName()

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

protectedinherited

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

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

Definition at line 66 of file Restartable.C.

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

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

◆ statefulPropertiesAllowed()

void MaterialPropertyInterface::statefulPropertiesAllowed ( bool stateful_allowed )

inherited

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

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

Definition at line 141 of file MaterialPropertyInterface.C.

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

 {
   _stateful_allowed = stateful_allowed;
 }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in MaterialBase, Material, NodalUserObject, GeneralUserObject, Constraint, and ThreadedGeneralUserObject.

Definition at line 60 of file SetupInterface.C.

61 {

62 }

◆ subProblem()

SubProblem& Indicator::subProblem ( )

inline

Definition at line 59 of file Indicator.h.

59 { return _subproblem; }

Indicator::_subproblem

SubProblem & _subproblem

Definition: Indicator.h:65

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, VectorMemoryUsage, EqualValueEmbeddedConstraint, MemoryUsage, and JSONOutput.

Definition at line 45 of file SetupInterface.C.

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().

46 {

47 }

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

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

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

Definition at line 27 of file MooseBase.C.

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

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

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

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

Definition at line 67 of file MooseBaseParameterInterface.h.

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

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

◆ uniqueParameterName()

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

inlineinherited

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

Definition at line 52 of file MooseBaseParameterInterface.h.

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

◆ validParams()

InputParameters Indicator::validParams ( )

static

Definition at line 21 of file Indicator.C.

Referenced by ElementIndicator::validParams(), and InternalSideIndicator::validParams().

 {
   InputParameters params = MooseObject::validParams();
   params += BlockRestrictable::validParams();
   params += OutputInterface::validParams();
   params += MaterialPropertyInterface::validParams();
 
   params.addParam<bool>("use_displaced_mesh",
                         false,
                         "Whether or not this object should use the "
                         "displaced mesh for computation.  Note that "
                         "in the case this is true but no "
                         "displacements are provided in the Mesh block "
                         "the undisplaced mesh will still be used.");
   params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
 
   params.registerBase("Indicator");
 
   return params;
 }

Member Data Documentation

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

Definition at line 168 of file MooseBaseParameterInterface.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _assembly

Assembly& Indicator::_assembly

protected

Definition at line 72 of file Indicator.h.

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 207 of file BlockRestrictable.h.

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

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

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 78 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _default_properties

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

protectedinherited

Storage vector for default properties.

Definition at line 546 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultGenericMaterialProperty().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 61 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 165 of file MooseBaseParameterInterface.h.

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

◆ _fe_problem

FEProblemBase& Indicator::_fe_problem

protected

Definition at line 66 of file Indicator.h.

◆ _get_material_property_called

bool MaterialPropertyInterface::_get_material_property_called

protectedinherited

Initialized to false.

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

Definition at line 543 of file MaterialPropertyInterface.h.

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