#include <UserObjectBase.h>

Inheritance diagram for UserObjectBase:

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

Public Member Functions
	UserObjectBase (const InputParameters &params)

virtual	~UserObjectBase ()=default

	UserObjectBase (const UserObjectBase &object, const Moose::Kokkos::FunctorCopy &key)
	Special constructor used for Kokkos functor copy during parallel dispatch. More...

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

virtual void	finalize ()=0
	Finalize. More...

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

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

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

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

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

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

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

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

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

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

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const
	Whether or not a threaded copy of this object is needed when obtaining it in another object, like via the UserObjectInterface. More...

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

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

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

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

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

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

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

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

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

MooseObjectName	uniqueName () const

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

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

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

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

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

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

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

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

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

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

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

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

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

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

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

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

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


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

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)
	External method for calling moose error with added object context. More...

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

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

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

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

Public Attributes
	usingCombinedWarningSolutionWarnings

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<typename T , typename... Args>
T &	declareRestartableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it. More...

template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to `declareRestartableData` but returns a const reference to the object. More...

template<typename T , typename... Args>
T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declare a piece of data as "restartable" and initialize it. More...

template<typename T , typename... Args>
T &	declareRecoverableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "recoverable" and initialize it. More...

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
	Declare a piece of data as "restartable". More...

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
	Declare a piece of data as "restartable". More...

std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix. More...

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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


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

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const


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

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const


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

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


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

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


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

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

bool	hasReporterValueByName (const ReporterName &reporter_name) const

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


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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

ActionFactory &	_action_factory
	Builds Actions. More...

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

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

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

const Parallel::Communicator &	_communicator

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
std::set< std::string >	_supplied_uo
	A name of the "supplied" user objects, which is just this object. More...

Detailed Description

Definition at line 37 of file UserObjectBase.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ UserObjectBase() [1/2]

UserObjectBase::UserObjectBase ( const InputParameters & params )

Definition at line 67 of file UserObjectBase.C.

   : MooseObject(parameters),
     SetupInterface(this),
     FunctionInterface(this),
     UserObjectInterface(this),
     PostprocessorInterface(this),
     VectorPostprocessorInterface(this),
     ReporterInterface(this),
     DistributionInterface(this),
     SamplerInterface(this),
     Restartable(this, "UserObjects"),
     MeshMetaDataInterface(this),
     MeshChangedInterface(parameters),
     MeshDisplacedInterface(parameters),
     PerfGraphInterface(this),
     _tid(parameters.get<THREAD_ID>("_tid")),
     _subproblem(*getCheckedPointerParam<SubProblem *>("_subproblem")),
     _fe_problem(*getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
     _sys(*getCheckedPointerParam<SystemBase *>("_sys")),
     _assembly(_subproblem.assembly(_tid, 0)),
     _duplicate_initial_execution(getParam<bool>("allow_duplicate_execution_on_initial"))
 {
   // Check the pre/post aux flag
   if (getParam<bool>("force_preaux") && getParam<bool>("force_postaux"))
     paramError("force_preaux",
                "A user object may be specified as executing before or after "
                "AuxKernels, not both.");
 
   _supplied_uo.insert(name());
 }

◆ ~UserObjectBase()

virtual UserObjectBase::~UserObjectBase ( )

virtualdefault

◆ UserObjectBase() [2/2]

UserObjectBase::UserObjectBase	(	const UserObjectBase &	object,
		const Moose::Kokkos::FunctorCopy &	key
	)

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 99 of file UserObjectBase.C.

   : MooseObject(object, key),
     SetupInterface(object, key),
     FunctionInterface(object, key),
     UserObjectInterface(object, key),
     PostprocessorInterface(object, key),
     VectorPostprocessorInterface(object, key),
     ReporterInterface(object, key),
     DistributionInterface(object, key),
     SamplerInterface(object, key),
     Restartable(object, key),
     MeshMetaDataInterface(object, key),
     MeshChangedInterface(object, key),
     MeshDisplacedInterface(object, key),
     PerfGraphInterface(object, key),
     _tid(object._tid),
     _subproblem(object._subproblem),
     _fe_problem(object._fe_problem),
     _sys(object._sys),
     _assembly(object._assembly),
     _duplicate_initial_execution(object._duplicate_initial_execution)
 {
 }

Member Function Documentation

◆ addPostprocessorDependencyHelper()

void UserObjectBase::addPostprocessorDependencyHelper ( const PostprocessorName & ) const

overrideprotectedvirtual

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

Reimplemented from PostprocessorInterface.

Definition at line 156 of file UserObjectBase.C.

 {
   _depend_uo.insert(name);
 }

◆ addReporterDependencyHelper()

void UserObjectBase::addReporterDependencyHelper ( const ReporterName & )

overrideprotectedvirtual

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

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

Reimplemented from ReporterInterface.

Definition at line 168 of file UserObjectBase.C.

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

◆ addUserObjectDependencyHelper()

void UserObjectBase::addUserObjectDependencyHelper ( const UserObjectBase & ) const

overrideprotectedvirtual

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

Reimplemented from UserObjectInterface.

Definition at line 150 of file UserObjectBase.C.

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

◆ addVectorPostprocessorDependencyHelper()

void UserObjectBase::addVectorPostprocessorDependencyHelper ( const VectorPostprocessorName & ) const

overrideprotectedvirtual

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 162 of file UserObjectBase.C.

 {
   _depend_uo.insert(name);
 }

◆ callMooseError() [1/2]

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

inherited

External method for calling moose error with added object context.

Parameters

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

Definition at line 105 of file MooseBase.C.

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

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

◆ callMooseError() [2/2]

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

staticinherited

External method for calling moose error with added object context.

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

Parameters

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

Definition at line 114 of file MooseBase.C.

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

◆ connectControllableParams()

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

inherited

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

Parameters

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

Definition at line 77 of file MooseBase.C.

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

◆ coupledPostprocessors()

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

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

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

Definition at line 139 of file PostprocessorInterface.C.

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

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

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 69 of file SetupInterface.h.

69 {}

◆ cyclicDependencyError() [1/2]

template<typename T , typename T2 , typename NameFunc >

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

staticinherited

A helper method for cyclic errors.

Definition at line 134 of file DependencyResolverInterface.h.

 {
   std::ostringstream oss;
 
   oss << header << ":\n";
   const auto cycle = e.getCyclicDependencies();
   std::vector<std::string> names(cycle.size());
   for (const auto i : index_range(cycle))
     names[i] = name_func(cycle[i]);
   oss << MooseUtils::join(names, " <- ");
   mooseError(oss.str());
 }

◆ cyclicDependencyError() [2/2]

template<typename T , typename T2 >

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

staticinherited

Definition at line 151 of file DependencyResolverInterface.h.

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

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 283 of file Restartable.h.

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

◆ declareRecoverableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 358 of file Restartable.h.

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

◆ declareRestartableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 276 of file Restartable.h.

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

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 301 of file Restartable.h.

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

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 330 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 340 of file Restartable.h.

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

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 49 of file MooseObject.h.

Referenced by EigenKernel::enabled().

49 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:71

◆ errorPrefix()

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

inlineinherited

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

Definition at line 274 of file MooseBase.h.

274 { return messagePrefix(); }

MooseBase::messagePrefix

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

Definition: MooseBase.h:266

◆ finalize()

virtual void UserObjectBase::finalize ( )

pure virtual

Finalize.

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

◆ flagInvalidSolutionInternal()

template<bool warning>

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

protectedinherited

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

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

◆ gatherMax()

template<typename T >

void UserObjectBase::gatherMax ( T & value )

inline

Gather the parallel max of the variable passed in.

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

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

Definition at line 108 of file UserObjectBase.h.

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

   {
     _communicator.max(value);
   }

◆ gatherMin()

template<typename T >

void UserObjectBase::gatherMin ( T & value )

inline

Gather the parallel min of the variable passed in.

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

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

Definition at line 120 of file UserObjectBase.h.

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

   {
     _communicator.min(value);
   }

◆ gatherProxyValueMax()

template<typename T1 , typename T2 >

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

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

Parameters

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

Definition at line 203 of file UserObjectBase.h.

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

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

◆ gatherProxyValueMin()

template<typename T1 , typename T2 >

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

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

Parameters

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

Definition at line 219 of file UserObjectBase.h.

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

◆ gatherSum()

template<typename T >

void UserObjectBase::gatherSum ( T & value )

inline

Gather the parallel sum of the variable passed in.

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

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

Definition at line 96 of file UserObjectBase.h.

   {
     _communicator.sum(value);
   }

◆ getBase()

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

inlineinherited

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

Definition at line 147 of file MooseBase.h.

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

147 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:505

◆ getCheckedPointerParam()

template<typename T >

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

inherited

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

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

Definition at line 460 of file MooseBase.h.

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

◆ getDataFileName()

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

inherited

Deprecated method.

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

Definition at line 21 of file DataFileInterface.C.

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

◆ getDataFileNameByName()

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

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

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

◆ getDataFilePath()

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

inherited

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

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

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

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

◆ getDependObjects()

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

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

Definition at line 126 of file UserObjectBase.C.

Referenced by AuxKernelBase::addUserObjectDependencyHelper().

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

◆ getDistribution() [1/2]

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

inherited

Get a distribution with a given name.

Parameters

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

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

Definition at line 41 of file DistributionInterface.C.

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

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

◆ getDistribution() [2/2]

template<typename T >

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

inherited

Definition at line 77 of file DistributionInterface.h.

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

◆ getDistributionByName() [1/2]

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

inherited

Get a distribution with a given name.

Parameters

name	The name of the distribution to retrieve

Returns: The distribution with name 'name'

Definition at line 48 of file DistributionInterface.C.

Referenced by RandomIC::RandomIC().

 {
   return _dni_feproblem.getDistribution(name);
 }

◆ getDistributionByName() [2/2]

template<typename T >

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

inherited

Definition at line 97 of file DistributionInterface.h.

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

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 73 of file SetupInterface.C.

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

 {
   return _execute_enum;
 }

◆ getFunction()

const Function & FunctionInterface::getFunction ( const std::string & name ) const

inherited

Get a function with a given name.

Parameters

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

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

Definition at line 34 of file FunctionInterface.C.

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

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

◆ getFunctionByName()

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

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 40 of file FunctionInterface.C.

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

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

◆ getHitNode()

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

inlineinherited

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

Definition at line 136 of file MooseBase.h.

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

136 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:136

◆ getKokkosFunction() [1/2]

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

inherited

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

Parameters

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

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

◆ getKokkosFunction() [2/2]

template<typename T >

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

inherited

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

Template Parameters

T	The Kokkos function type

Parameters

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

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

Definition at line 165 of file FunctionInterface.h.

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

◆ getKokkosFunctionByName() [1/2]

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

inherited

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

Parameters

name	The name of the Kokkos function to retrieve

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

◆ getKokkosFunctionByName() [2/2]

template<typename T >

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

inherited

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

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the Kokkos function to retrieve

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

Definition at line 172 of file FunctionInterface.h.

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

◆ getMeshProperty() [1/2]

template<typename T >

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

protectedinherited

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

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

Definition at line 142 of file MeshMetaDataInterface.h.

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

◆ getMeshProperty() [2/2]

template<typename T >

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

inlineprotectedinherited

Definition at line 64 of file MeshMetaDataInterface.h.

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

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

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

87 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:385

◆ getParam() [1/2]

template<typename T >

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

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 416 of file MooseBase.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

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

inherited

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

Parameters

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

Returns: Vector of pairs of first and second parameters

Definition at line 453 of file MooseBase.h.

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

◆ getPostprocessorName()

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

inherited

Get the name of a postprocessor.

This can only be used if the postprocessor parameter does not have a default value set (see isDefaultPostprocessorValue()), in which case the "name" is actually the default value.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: The name of the given Postprocessor

Definition at line 195 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return getPostprocessorNameInternal(param_name, index, /* allow_default_value = */ false);
 }

◆ getPostprocessorValue()

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

inherited

doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values

Parameters

param_name	The name of the Postprocessor parameter (see below)
index	The index of the Postprocessor

Returns: A reference to the desired value

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

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 46 of file PostprocessorInterface.C.

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

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

◆ getPostprocessorValueByName()

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

virtualinherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns: A reference to the desired value

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

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 67 of file PostprocessorInterface.C.

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

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

◆ getPostprocessorValueOld()

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

inherited

Definition at line 53 of file PostprocessorInterface.C.

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

◆ getPostprocessorValueOldByName()

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

inherited

Definition at line 73 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ getPostprocessorValueOlder()

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

inherited

Definition at line 60 of file PostprocessorInterface.C.

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

◆ getPostprocessorValueOlderByName()

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

inherited

Definition at line 79 of file PostprocessorInterface.C.

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

◆ getRenamedParam()

template<typename T >

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

inherited

Retrieve a renamed parameter for the object.

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

Parameters

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

Definition at line 430 of file MooseBase.h.

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

◆ getReporterContextBaseByName()

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

protectedinherited

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

Parameters

reporter_name A ReporterName object that for the desired Reporter context.

Returns: ReporterContextBase of the reporter value

Definition at line 60 of file ReporterInterface.C.

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

◆ getReporterName()

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

protectedinherited

Returns: The ReporterName associated with the parametre param_name.

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

Definition at line 70 of file ReporterInterface.C.

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

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

◆ getReporterValue() [1/2]

template<typename T >

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

protectedinherited

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

Template Parameters

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

Parameters

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

Definition at line 148 of file ReporterInterface.h.

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

◆ getReporterValue() [2/2]

template<typename T >

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

protectedinherited

Definition at line 155 of file ReporterInterface.h.

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

◆ getReporterValueByName() [1/2]

template<typename T >

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

protectedinherited

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

Template Parameters

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

Parameters

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

Definition at line 168 of file ReporterInterface.h.

Referenced by ParsedVectorReporter::ParsedVectorReporter().

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

◆ getReporterValueByName() [2/2]

template<typename T >

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

protectedinherited

Definition at line 176 of file ReporterInterface.h.

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

◆ getRequestedItems()

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

inlineoverridevirtual

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

Implements DependencyResolverInterface.

Definition at line 149 of file UserObjectBase.h.

149 { return _depend_uo; }

UserObjectBase::_depend_uo

std::set< std::string > _depend_uo

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

Definition: UserObjectBase.h:194

◆ getRestartableData()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 294 of file Restartable.h.

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

◆ getSampler() [1/2]

template<>

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

inherited

Definition at line 38 of file SamplerInterface.C.

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

◆ getSampler() [2/2]

template<typename T >

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

inherited

Get a sampler with a given name.

Parameters

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

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

Definition at line 77 of file SamplerInterface.h.

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

◆ getSamplerByName() [1/2]

template<>

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

inherited

Definition at line 45 of file SamplerInterface.C.

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

◆ getSamplerByName() [2/2]

template<typename T >

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

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 84 of file SamplerInterface.h.

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

◆ getScatterVectorPostprocessorValue()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 119 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueByName()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 128 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

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

◆ getScatterVectorPostprocessorValueOld()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 135 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueOldByName()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 144 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

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

◆ getSharedPtr() [1/2]

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

inherited

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

Wrapper around shared_from_this().

Definition at line 70 of file MooseObject.C.

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

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

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 83 of file MooseObject.C.

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

◆ getSubProblem()

SubProblem& UserObjectBase::getSubProblem ( ) const

inline

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

Definition at line 81 of file UserObjectBase.h.

81 { return _subproblem; }

UserObjectBase::_subproblem

SubProblem & _subproblem

Reference to the Subproblem for this user object.

Definition: UserObjectBase.h:177

◆ getSuppliedItems()

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

inlineoverridevirtual

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

Implements DependencyResolverInterface.

Definition at line 151 of file UserObjectBase.h.

151 { return _supplied_uo; }

UserObjectBase::_supplied_uo

std::set< std::string > _supplied_uo

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

Definition: UserObjectBase.h:198

◆ getUserObject()

template<class T >

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

inherited

Get an user object with a given parameter param_name.

Parameters

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

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

Definition at line 172 of file UserObjectInterface.h.

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

◆ getUserObjectBase()

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

inherited

Get an user object with a given parameter param_name.

Parameters

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

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

Definition at line 115 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObject().

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

◆ getUserObjectBaseByName()

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

inherited

Get an user object with the name object_name.

Parameters

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

Returns: The user object with the name object_name

Definition at line 127 of file UserObjectInterface.C.

Referenced by AuxKernelBase::addPostprocessorDependencyHelper(), AuxKernelBase::addVectorPostprocessorDependencyHelper(), FunctorAux::FunctorAux(), getDependObjects(), UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectByName().

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

◆ getUserObjectByName()

template<class T >

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

inherited

Get an user object with the name object_name.

Parameters

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

Returns: The user object with the name object_name

Definition at line 179 of file UserObjectInterface.h.

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

◆ getUserObjectName()

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

inherited

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

Definition at line 45 of file UserObjectInterface.C.

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

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

◆ getVectorPostprocessorName()

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

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name The name of the VectorPostprocessor parameter

Returns: The name of the given VectorPostprocessor

Definition at line 216 of file VectorPostprocessorInterface.C.

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

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

◆ getVectorPostprocessorValue() [1/2]

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

inherited

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

Retrieve the value of a VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 49 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValue() [2/2]

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

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 79 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueByName() [1/2]

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

inherited

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

Retrieve the value of the VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 57 of file VectorPostprocessorInterface.C.

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

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

◆ getVectorPostprocessorValueByName() [2/2]

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

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 89 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 64 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 99 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOldByName() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 72 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld().

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

◆ getVectorPostprocessorValueOldByName() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 109 of file VectorPostprocessorInterface.C.

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

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

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

Definition at line 142 of file MooseBase.h.

142 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:499

◆ hasFunction()

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

inherited

Determine if the function exists.

Parameters

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

Returns: True if the function exists

Definition at line 46 of file FunctionInterface.C.

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

◆ hasFunctionByName()

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

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 52 of file FunctionInterface.C.

Referenced by FunctionInterface::hasFunction().

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

◆ hasKokkosFunction()

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

inherited

Determine if the Kokkos function exists.

Parameters

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

Returns: True if the Kokkos function exists

◆ hasKokkosFunctionByName()

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

inherited

Determine if the Kokkos function exists.

Parameters

name	The name of the Kokkos function

Returns: True if the Kokkos function exists

◆ hasMeshProperty() [1/4]

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

protectedinherited

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

Definition at line 33 of file MeshMetaDataInterface.C.

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

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

◆ hasMeshProperty() [2/4]

template<typename T >

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

protectedinherited

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

Definition at line 166 of file MeshMetaDataInterface.h.

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

◆ hasMeshProperty() [3/4]

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

inlineprotectedinherited

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

Definition at line 82 of file MeshMetaDataInterface.h.

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

◆ hasMeshProperty() [4/4]

template<typename T >

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

inlineprotectedinherited

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

Definition at line 90 of file MeshMetaDataInterface.h.

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

◆ hasPostprocessor()

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

inherited

Determine if the Postprocessor data exists.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessorByName getPostprocessorValue

Definition at line 117 of file PostprocessorInterface.C.

 {
   if (!postprocessorsAdded())
     _ppi_moose_object.mooseError(
         "Cannot call hasPostprocessor() until all Postprocessors have been constructed.");
 
   return hasPostprocessorByName(getPostprocessorNameInternal(param_name, index));
 }

◆ hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName & name ) const

inherited

Determine if the Postprocessor data exists.

Parameters

name	The name of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessor getPostprocessorValueByName

Definition at line 128 of file PostprocessorInterface.C.

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

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

◆ hasReporterValue() [1/2]

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

protectedinherited

Return True if the Reporter value exists.

Template Parameters

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

Parameters

reporter_name A ReporterName object that for the desired Reporter value.

Definition at line 40 of file ReporterInterface.C.

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

◆ hasReporterValue() [2/2]

template<typename T >

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

protectedinherited

Definition at line 189 of file ReporterInterface.h.

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

◆ hasReporterValueByName() [1/2]

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

protectedinherited

Definition at line 50 of file ReporterInterface.C.

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

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

◆ hasReporterValueByName() [2/2]

template<typename T >

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

protectedinherited

Definition at line 200 of file ReporterInterface.h.

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

◆ hasUserObject() [1/2]

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

inherited

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

Definition at line 78 of file UserObjectInterface.C.

 {
   return hasUserObjectByName(getUserObjectName(param_name));
 }

◆ hasUserObject() [2/2]

template<class T >

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

inherited

Definition at line 187 of file UserObjectInterface.h.

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

◆ hasUserObjectByName() [1/2]

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

inherited

Definition at line 84 of file UserObjectInterface.C.

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

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

◆ hasUserObjectByName() [2/2]

template<class T >

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

inherited

Definition at line 194 of file UserObjectInterface.h.

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

◆ hasVectorPostprocessor() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 151 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

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

◆ hasVectorPostprocessor() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

Definition at line 175 of file VectorPostprocessorInterface.C.

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

◆ hasVectorPostprocessorByName() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 162 of file VectorPostprocessorInterface.C.

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

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

◆ hasVectorPostprocessorByName() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

Definition at line 185 of file VectorPostprocessorInterface.C.

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

◆ haveParameter()

template<typename T >

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

inlineinherited

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

Parameters

name	The name of the parameter to test

Definition at line 200 of file MooseBase.h.

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

◆ initialize()

virtual void UserObjectBase::initialize ( )

pure virtual

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

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, SolutionUserObjectBase, AdvancedOutput, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableBase, ParsedMaterialHelper< is_ad >, MultiApp, NEML2FEInterpolation, AuxKernelBase, MooseParsedFunction, MooseParsedGradFunction, DerivativeFunctionMaterialBaseTempl< is_ad >, Transfer, ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >, CSV, MatReaction, ElementSubdomainModifierBase, Exodus, SampledOutput, Convergence, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, NEML2ModelExecutor, MultiAppTransfer, RadialAverage, MooseParsedVectorFunction, ImageFunction, Console, RealFunctionControl, PiecewiseConstantFromCSV, Nemesis, NodalVariableValue, PIDTransientControl, ReferenceResidualConvergence, DiffusionLHDGKernel, MortarNodalAuxKernelTempl< ComputeValueType >, KokkosParsedFunction, LibtorchArtificialNeuralNetParameters, TimePeriod, LinearFVDiffusion, TransientMultiApp, ElementalVariableValue, GhostingUserObject, InterfaceQpUserObjectBase, SolutionAux, LinearFVAdvection, BoundsBase, SetValueChainControlTempl< T >, MultiAppGeneralFieldFunctorTransfer, DiffusionLHDGPrescribedGradientBC, KokkosExtraIDIntegralVectorPostprocessor, MFEMParsedFunction, MultiAppProjectionTransfer, HistogramVectorPostprocessor, SolutionScalarAux, DiffusionLHDGDirichletBC, ParsedConvergence, PiecewiseTabularBase, KokkosPiecewiseTabularBase, LinearFVAnisotropicDiffusion, MultiAppPositions, MultiAppDofCopyTransfer, CoarsenedPiecewiseLinear, SideIntegralMaterialPropertyTempl< is_ad >, MultiAppGeneralFieldNearestLocationTransfer, SideIntegralPostprocessor, MultiAppVariableValueSamplePostprocessorTransfer, NodalPatchRecoveryMaterialProperty, ProjectedStatefulMaterialAuxTempl< T, is_ad >, PiecewiseLinear, FullSolveMultiApp, BoundaryLinearFVFluxIntegral, SideFVFluxBCIntegral, MultiAppFieldTransfer, MultiAppGeneralFieldKDTreeTransferBase, MultiAppVariableValueSampleTransfer, DefaultConvergenceBase, PiecewiseLinearBase, ChainControlDataPostprocessor, MultiAppConservativeTransfer, MultiPostprocessorConvergence, MultiAppCloneReporterTransfer, MultiAppReporterTransfer, DerivativeSumMaterialTempl< is_ad >, JSONOutput, and KokkosBoundNodalKernel.

Definition at line 48 of file SetupInterface.C.

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

49 {

50 }

◆ isDefaultPostprocessorValue()

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

inherited

Determine whether or not the Postprocessor is a default value.

A default value is when the value is either the value set by addParam, or is a user-set value in input instead of a name to a postprocessor.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the postprocessor

Returns: True if the Postprocessor is a default value, false if the Postprocessor is the name of a Postprocessor

Definition at line 85 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

 {
   return isDefaultPostprocessorValueByName(getPostprocessorNameInternal(param_name, index));
 }

◆ isKokkosObject()

bool MooseObject::isKokkosObject ( ) const

inlineinherited

Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

Definition at line 63 of file MooseObject.h.

Referenced by BlockRestrictable::initializeBlockRestrictable(), and BoundaryRestrictable::initializeBoundaryRestrictable().

63 { return parameters().isKokkosObject(); }

MooseBase::parameters

const InputParameters & parameters() const

Get the parameters of the object.

Definition: MooseBase.h:131

InputParameters::isKokkosObject

bool isKokkosObject() const

Returns whether this InputParameters belongs to a Kokkos object Checks whether MooseBase::kokkos_obje...

Definition: InputParameters.C:433

◆ isParamSetByUser()

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

inlineinherited

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

Parameters

name	The name of the parameter to test

Definition at line 215 of file MooseBase.h.

Referenced by SetupDebugAction::act(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MFEMMesh::buildMesh(), MFEMDomainSubMesh::buildSubMesh(), MFEMBoundarySubMesh::buildSubMesh(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< false >::ConservativeAdvectionBCTempl(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), FileMesh::FileMesh(), FullSolveMultiApp::FullSolveMultiApp(), OrientSurfaceMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), MFEMVectorFESpace::getFECName(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MortarConstraintBase::MortarConstraintBase(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SmoothMeshGenerator::SmoothMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SurfaceSubdomainsFromAllNormalsGenerator::SurfaceSubdomainsFromAllNormalsGenerator(), TagVectorAux::TagVectorAux(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 209 of file MooseBase.h.

209 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:103

InputParameters::isParamValid

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

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

Definition: InputParameters.C:386

◆ isVectorPostprocessorDistributed()

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

inherited

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

Definition at line 203 of file VectorPostprocessorInterface.C.

 {
   return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
 }

◆ isVectorPostprocessorDistributedByName()

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

inherited

Definition at line 209 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

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

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, ADArrayNodalKernel, DiffusionLHDGKernel, IPHDGKernel, EqualValueEmbeddedConstraintTempl< is_ad >, ADArrayKernel, ADKernelTempl< T >, IPHDGBC, DiffusionLHDGPrescribedGradientBC, DiffusionLHDGDirichletBC, and ADDiracKernel.

Definition at line 58 of file SetupInterface.C.

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

59 {

60 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableDataFV< OutputType >, NEML2FEInterpolation, DiracKernelBase, Positions, Console, MeshDivision, Exodus, ElementSubdomainModifierBase, NEML2Assembly, SampledOutput, RadialAverage, Nemesis, NEML2ModelExecutor, GhostingUserObject, FVPointValueConstraint, ExplicitTimeIntegrator, NEML2BatchIndexGenerator, MultiAppVariableValueSamplePostprocessorTransfer, MoveNodesToGeometryModifierBase, SidesetInfoVectorPostprocessor, NearestNodeNumberUO, and EqualValueBoundaryConstraint.

Definition at line 40 of file MeshChangedInterface.h.

Referenced by MooseVariableFV< Real >::meshChanged(), and MooseVariableFE< Real >::meshChanged().

40 {}

◆ meshDisplaced()

virtual void MeshDisplacedInterface::meshDisplaced ( )

inlinevirtualinherited

Called on this object when the displaced mesh gets updated.

Definition at line 40 of file MeshDisplacedInterface.h.

40 {}

◆ meshPropertyName() [1/2]

std::string MeshMetaDataInterface::meshPropertyName	(	const std::string &	data_name,
		const std::string &	prefix
	)

staticprotectedinherited

Returns: The full name for mesh property data.

Definition at line 41 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MeshMetaDataInterface::meshPropertyName(), and MeshGenerator::setMeshPropertyHelper().

 {
   return std::string(SYSTEM) + "/" + prefix + "/" + data_name;
 }

◆ meshPropertyName() [2/2]

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

inlineprotectedinherited

Returns: The default mesh property name for mesh property data

Definition at line 103 of file MeshMetaDataInterface.h.

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

◆ messagePrefix()

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

inlineinherited

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

Definition at line 266 of file MooseBase.h.

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::hasPostprocessor(), MooseMesh::isTranslatedPeriodic(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), TagVectorAux::TagVectorAux(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     _si_moose_base.MooseBase::mooseDeprecated(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": deprecation");
   }

◆ mooseDeprecated() [2/2]

template<typename... Args>

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

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and a stack trace.

Definition at line 327 of file MooseBase.h.

Referenced by MooseApp::addCapability(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), MooseApp::getRecoverFileBase(), MooseApp::hasRecoverFileBase(), and MooseApp::setupOptions().

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

◆ mooseDeprecatedNoTrace()

template<typename... Args>

void MooseBase::mooseDeprecatedNoTrace ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and no stack trace.

Definition at line 337 of file MooseBase.h.

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

◆ mooseDocumentedError()

template<typename... Args>

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

inlineinherited

Definition at line 287 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), LowerDIntegratedBC::LowerDIntegratedBC(), and ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

   {
     callMooseError(moose::internal::formatMooseDocumentedError(
                        repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                    /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 281 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 300 of file MooseBase.h.

   {
     callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 344 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldKDTreeTransferBase::evaluateNearestNodeFromKDTrees(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), PolyLineMeshFollowingNodeSetGenerator::generate(), ManifoldSubdomainGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MultiAppTransfer::mapBackWithoutCollapsing(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), and TransientBase::TransientBase().

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

◆ mooseWarning() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), RenumberBySubdomainGenerator::generate(), BSplineCurveGenerator::generate(), StitchMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), ParsedGenerateSideset::generate(), SurfaceSubdomainsDelaunayRemesher::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), MFEMVectorFESpace::getFECName(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), ElementGroupCentroidPositions::initialize(), SphericalGridDivision::initialize(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MFEMRefinementMarker::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), ElementSubdomainModifierBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), PNGOutput::makePNG(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MaterialOutputAction::outputHelper(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     _si_moose_base.MooseBase::mooseWarning(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
   }

◆ mooseWarning() [2/2]

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 309 of file MooseBase.h.

Referenced by DiracKernelInfo::findPoint(), DataFileInterface::getDataFilePath(), MooseApp::loadLibraryAndDependencies(), and MooseBase::paramWarning().

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

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 80 of file SolutionInvalidInterface.h.

   {
     _si_moose_base.MooseBase::mooseWarningNonPrefixed(std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
   }

◆ mooseWarningNonPrefixed() [2/2]

template<typename... Args>

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

inlineinherited

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

Definition at line 318 of file MooseBase.h.

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

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 103 of file MooseBase.h.

   {
     mooseAssert(_name.size(), "Empty name");
     return _name;
   }

◆ needThreadedCopy()

virtual bool UserObjectBase::needThreadedCopy ( ) const

inlinevirtual

Whether or not a threaded copy of this object is needed when obtaining it in another object, like via the UserObjectInterface.

Derived classes should override this as needed.

Reimplemented in Moose::Kokkos::UserObject, DiscreteElementUserObject, and ThreadedGeneralUserObject.

Definition at line 164 of file UserObjectBase.h.

164 { return false; }

◆ paramError()

template<typename... Args>

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

inherited

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

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

Definition at line 467 of file MooseBase.h.

 {
   _pars.paramError(param, std::forward<Args>(args)...);
 }

◆ parameters()

const InputParameters& MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 131 of file MooseBase.h.

131 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:394

◆ paramInfo()

template<typename... Args>

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

inherited

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

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

Definition at line 481 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

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

◆ paramWarning() [1/2]

template<typename... Args>

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

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

Referenced by GridPartitioner::_do_partition(), CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), MooseMeshUtils::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), FullSolveMultiApp::initialSetup(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), PNGOutput::PNGOutput(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

   {
     _si_moose_base.MooseBase::paramWarning(param, std::forward<Args>(args)...);
     flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning for parameter '" +
                                             param + "'");
   }

◆ paramWarning() [2/2]

template<typename... Args>

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

inherited

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

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

Definition at line 474 of file MooseBase.h.

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

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 86 of file PerfGraphInterface.C.

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), PerfGraphReporter::finalize(), and PerfGraphOutput::output().

 {
   return _pg_moose_app.perfGraph();
 }

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or if the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 423 of file MooseBase.h.

Referenced by MFEMExecutedObject::getRequestedItems().

 {
   return haveParameter<T>(name) && isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ registerInvalidSolutionInternal()

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

protectedinherited

Definition at line 55 of file SolutionInvalidInterface.C.

 {
   return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
       _si_moose_base.type(), message, warning);
 }

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 61 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 72 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(
         timedSectionName(section_name), level, live_message, print_dots);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, NodeFaceConstraint, Positions, and Times.

Definition at line 63 of file SetupInterface.C.

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

64 {

65 }

◆ restartableName()

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

protectedinherited

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

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

Definition at line 78 of file Restartable.C.

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

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

◆ shouldDuplicateInitialExecution()

bool UserObjectBase::shouldDuplicateInitialExecution ( ) const

inline

Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC.

Definition at line 87 of file UserObjectBase.h.

87 { return _duplicate_initial_execution; }

UserObjectBase::_duplicate_initial_execution

const bool _duplicate_initial_execution

Whether to execute this object twice on initial.

Definition: UserObjectBase.h:190

◆ sort()

template<typename T >

void DependencyResolverInterface::sort ( typename std::vector< T > & vector )

staticinherited

Given a vector, sort using the getRequested/SuppliedItems sets.

Definition at line 79 of file DependencyResolverInterface.h.

Referenced by TheWarehouse::prepare().

 {
   sortDFS(vector);
 }

◆ sortDFS()

template<typename T >

void DependencyResolverInterface::sortDFS ( typename std::vector< T > & vector )

staticinherited

Given a vector, sort using the depth-first search.

Class that represents the dependency as a graph

Definition at line 86 of file DependencyResolverInterface.h.

Referenced by DependencyResolverInterface::sort().

 {
   if (vector.size() <= 1)
     return;
 
   DependencyResolver<T> graph;
 
   // Map of suppliers: what is supplied -> by what object
   std::multimap<std::string, T> suppliers_map;
   for (auto & v : vector)
   {
     // Whether or not this object supplies something, we will always
     // add it as a node because we want to make sure that it gets returned
     graph.addNode(v);
 
     for (const auto & supplied_item : v->getSuppliedItems())
       suppliers_map.emplace(supplied_item, v);
   }
 
   // build the dependency graph
   for (auto & v : vector)
     for (const auto & requested_item : v->getRequestedItems())
     {
       const auto & [begin_it, end_it] = suppliers_map.equal_range(requested_item);
       for (const auto & [supplier_name, supplier_object] : as_range(begin_it, end_it))
       {
         libmesh_ignore(supplier_name);
 
         // We allow an object to have a circular dependency within itself; e.g. we choose to
         // trust a developer knows what they are doing within a single object
         if (supplier_object != v)
           graph.addEdge(supplier_object, v);
       }
     }
 
   const auto & sorted = graph.dfs();
 
   // The set here gets unique objects, as it's valid to pass in duplicates
   mooseAssert(sorted.size() == std::set<T>(vector.begin(), vector.end()).size(), "Size mismatch");
 
   vector = sorted;
 }

◆ 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, Moose::Kokkos::AuxKernel, Moose::Kokkos::MaterialBase, GeneralUserObject, NodalUserObject, Moose::Kokkos::UserObject, Constraint, and ThreadedGeneralUserObject.

Definition at line 68 of file SetupInterface.C.

69 {

70 }

◆ systemNumber()

unsigned int UserObjectBase::systemNumber ( ) const

inline

Returns: the number of the system associated with this object

Definition at line 156 of file UserObjectBase.h.

156 { return _sys.number(); }

SystemBase::number

unsigned int number() const

Gets the number of this system.

Definition: SystemBase.C:1158

UserObjectBase::_sys

SystemBase & _sys

Reference to the system object for this user object.

Definition: UserObjectBase.h:184

◆ timedSectionName()

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

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 55 of file PerfGraphInterface.C.

Referenced by PerfGraphInterface::registerTimedSection().

 {
   return _prefix.empty() ? "" : (_prefix + "::") + section_name;
 }

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, ElementSubdomainModifierBase, SolutionUserObjectBase, PIDTransientControl, Console, EqualValueEmbeddedConstraintTempl< is_ad >, VectorPostprocessorVisualizationAux, NumNonlinearIterations, VectorMemoryUsage, JSONOutput, and MemoryUsage.

Definition at line 53 of file SetupInterface.C.

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

54 {

55 }

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 93 of file MooseBase.h.

   {
     mooseAssert(_type.size(), "Empty type");
     return _type;
   }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

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

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

Definition at line 57 of file MooseBase.C.

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

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

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 69 of file MooseBase.C.

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

 {
   if (!_pars.have_parameter<std::string>(unique_name_param))
     mooseError("uniqueName(): Object does not have a unique name");
   return MooseObjectName(_pars.get<std::string>(unique_name_param));
 }

◆ uniqueParameterName()

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

inherited

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

Definition at line 63 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ validParams()

InputParameters UserObjectBase::validParams ( )

static

Definition at line 18 of file UserObjectBase.C.

Referenced by UserObject::validParams().

 {
   InputParameters params = MooseObject::validParams();
   params += ReporterInterface::validParams();
 
   // Add the SetupInterface parameter, 'execute_on', and set it to a default of 'timestep_end'
   params += SetupInterface::validParams();
   params.set<ExecFlagEnum>("execute_on", true) = EXEC_TIMESTEP_END;
   ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", true);
   exec_enum.addAvailableFlags(EXEC_TRANSFER);
 
   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.");
 
   // Execution parameters
   params.addParam<bool>("allow_duplicate_execution_on_initial",
                         false,
                         "In the case where this UserObject is depended upon by an initial "
                         "condition, allow it to be executed twice during the initial setup (once "
                         "before the IC and again after mesh adaptivity (if applicable).");
   params.declareControllable("enable");
 
   params.addParam<bool>("force_preaux", false, "Forces the UserObject to be executed in PREAUX");
   params.addParam<bool>("force_postaux", false, "Forces the UserObject to be executed in POSTAUX");
   params.addParam<bool>(
       "force_preic", false, "Forces the UserObject to be executed in PREIC during initial setup");
   params.addParam<int>(
       "execution_order_group",
       0,
       "Execution order groups are executed in increasing order (e.g., the lowest "
       "number is executed first). Note that negative group numbers may be used to execute groups "
       "before the default (0) group. Please refer to the user object documentation "
       "for ordering of user object execution within a group.");
 
   params.addParamNamesToGroup("execute_on force_preaux force_postaux force_preic "
                               "allow_duplicate_execution_on_initial execution_order_group",
                               "Execution scheduling");
   params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
 
   params.registerBase("UserObject");
 
   return params;
 }

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 385 of file MooseBase.h.

◆ _assembly

Assembly& UserObjectBase::_assembly

protected

Reference to the assembly object for this user object.

Definition at line 187 of file UserObjectBase.h.

Referenced by InternalSideUserObject::getNeighborElemVolume(), and PointVariableSamplerBase::initialize().

◆ _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 86 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _depend_uo

std::set<std::string> UserObjectBase::_depend_uo

mutableprotected

Depend UserObjects that to be used both for determining user object sorting and by AuxKernel for finding the full UO dependency.

Definition at line 194 of file UserObjectBase.h.

Referenced by addPostprocessorDependencyHelper(), addReporterDependencyHelper(), addUserObjectDependencyHelper(), addVectorPostprocessorDependencyHelper(), FunctionValuePostprocessor::FunctionValuePostprocessor(), getDependObjects(), getRequestedItems(), ElementSubdomainModifierBase::initialSetup(), and NEML2ModelExecutor::NEML2ModelExecutor().

◆ _duplicate_initial_execution

const bool UserObjectBase::_duplicate_initial_execution

protected

Whether to execute this object twice on initial.

Definition at line 190 of file UserObjectBase.h.

Referenced by shouldDuplicateInitialExecution().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 83 of file SetupInterface.h.

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), CreateExecutionerAction::act(), PartitionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), AdaptivityAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupResidualDebugAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), AddControlAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), AddPeriodicBCAction::act(), AddNodalNormalsAction::act(), CylinderComponent::addMeshGenerators(), ComponentJunction::addMeshGenerators(), ComponentMeshTransformHelper::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getFactory(), ActionComponent::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _fe_problem

FEProblemBase& UserObjectBase::_fe_problem

protected

Reference to the FEProblemBase for this user object.

Definition at line 180 of file UserObjectBase.h.

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mdi_feproblem

FEProblemBase& MeshDisplacedInterface::_mdi_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshDisplacedInterface.h.

Referenced by MeshDisplacedInterface::MeshDisplacedInterface().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 391 of file MooseBase.h.

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 394 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddMFEMComplexKernelComponentAction::act(), AddMFEMComplexBCComponentAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), MooseBase::haveParameter(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 135 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 138 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 234 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp(), and Restartable::registerRestartableNameWithFilterOnApp().

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 243 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 237 of file Restartable.h.

Referenced by Restartable::restartableName().

◆ _restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 240 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _subproblem

SubProblem& UserObjectBase::_subproblem

protected

◆ _supplied_uo

std::set<std::string> UserObjectBase::_supplied_uo

private

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

Definition at line 198 of file UserObjectBase.h.

Referenced by getSuppliedItems(), and UserObjectBase().

◆ _sys

SystemBase& UserObjectBase::_sys

protected

Reference to the system object for this user object.

This should correspond to a nonlinear system (either through the FEProblemBase or the DisplacedProblem)

Definition at line 184 of file UserObjectBase.h.

Referenced by ElementSubdomainModifierBase::applyIC(), PseudoTimestep::currentResidualNorm(), VariableResidual::execute(), GreaterThanLessThanPostprocessor::execute(), PointwiseRenormalizeVector::execute(), NEML2FEInterpolation::execute(), PointwiseRenormalizeVector::finalize(), NumNonlinearIterations::finalize(), NumLinearIterations::getValue(), NumResidualEvaluations::getValue(), Residual::getValue(), PointwiseRenormalizeVector::initialize(), NEML2FEInterpolation::initialSetup(), ActivateElementsUserObjectBase::initSolutions(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and systemNumber().

◆ _tid

const THREAD_ID UserObjectBase::_tid

protected

Thread ID of this postprocessor.

Definition at line 174 of file UserObjectBase.h.

Referenced by NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), ElementalVariableValue::execute(), NodalVariableValue::execute(), NodalNormalsPreprocessor::execute(), NodalNormalsPreprocessor::initialize(), SideFVFluxBCIntegral::initialSetup(), BoundaryLinearFVFluxIntegral::initialSetup(), Terminator::initialSetup(), NEML2FEInterpolation::initialSetup(), and SolutionUserObjectBase::pointValueWrapper().

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 388 of file MooseBase.h.

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

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"

staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 33 of file MeshMetaDataInterface.h.

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), ActionUnitTest::buildMinimalObjects(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

MooseObject::usingCombinedWarningSolutionWarnings

inherited

Definition at line 67 of file MooseObject.h.

The documentation for this class was generated from the following files:

include/userobjects/UserObjectBase.h
src/userobjects/UserObjectBase.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ UserObjectBase() [1/2]

◆ ~UserObjectBase()

◆ UserObjectBase() [2/2]

Member Function Documentation

◆ addPostprocessorDependencyHelper()

◆ addReporterDependencyHelper()

◆ addUserObjectDependencyHelper()

◆ addVectorPostprocessorDependencyHelper()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ connectControllableParams()

◆ coupledPostprocessors()

◆ customSetup()

◆ cyclicDependencyError() [1/2]

◆ cyclicDependencyError() [2/2]

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ enabled()

◆ errorPrefix()

◆ finalize()

◆ flagInvalidSolutionInternal()

◆ gatherMax()

◆ gatherMin()

◆ gatherProxyValueMax()

◆ gatherProxyValueMin()

◆ gatherSum()

◆ getBase()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getDependObjects()

◆ getDistribution() [1/2]

◆ getDistribution() [2/2]

◆ getDistributionByName() [1/2]

◆ getDistributionByName() [2/2]

◆ getExecuteOnEnum()

◆ getFunction()

◆ getFunctionByName()

◆ getHitNode()

◆ getKokkosFunction() [1/2]

◆ getKokkosFunction() [2/2]

◆ getKokkosFunctionByName() [1/2]

◆ getKokkosFunctionByName() [2/2]

◆ getMeshProperty() [1/2]

◆ getMeshProperty() [2/2]

◆ getMooseApp()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getPostprocessorName()

◆ getPostprocessorValue()

◆ getPostprocessorValueByName()

◆ getPostprocessorValueOld()

◆ getPostprocessorValueOldByName()

◆ getPostprocessorValueOlder()

◆ getPostprocessorValueOlderByName()

◆ getRenamedParam()

◆ getReporterContextBaseByName()

◆ getReporterName()

◆ getReporterValue() [1/2]

◆ getReporterValue() [2/2]

◆ getReporterValueByName() [1/2]