Uses GriddedData to define data on a grid, and does linear interpolation on that data to provide function values. More...

#include <PiecewiseMultilinear.h>

Inheritance diagram for PiecewiseMultilinear:

[legend]

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

using	FunctorType = FunctorBase< Real >

using	ValueType = Real

using	GradientType = typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type
	This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).

using	DotType = ValueType

Public Member Functions
	PiecewiseMultilinear (const InputParameters &parameters)

virtual RealGradient	gradient (Real t, const Point &p) const override
	Function objects can optionally provide a gradient at a point.

virtual Real	timeDerivative (Real t, const Point &p) const override
	Get the time derivative of the function.

virtual Real	value (Real t, const Point &pt) const override
	Given t and p, return the interpolated value.

virtual ADReal	value (const ADReal &t, const ADPoint &p) const override
	Override this to evaluate the scalar function at point (t,x,y,z), using dual numbers by default this uses value, gradient, and timeDerivative to assemble a dual number, although the function can be overridden with a custom computation using dual numbers.

virtual Real	value (Real t, const Point &p) const
	Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero, you must override it.

virtual ADReal	value (const ADReal &t, const ADPoint &p) const
	Override this to evaluate the scalar function at point (t,x,y,z), using dual numbers by default this uses value, gradient, and timeDerivative to assemble a dual number, although the function can be overridden with a custom computation using dual numbers.

ChainedReal	value (const ChainedReal &t) const
	Helpers to call value(t,x,y,z)

template<typename U >
auto	value (const U &t) const

template<typename U >
auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual RealVectorValue	vectorValue (Real t, const Point &p) const
	Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

virtual RealVectorValue	curl (Real t, const Point &p) const
	Override this to evaluate the curl of the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

virtual Real	div (Real t, const Point &p) const
	Override this to evaluate the divergence of the vector function at a point (t,x,y,z), by default this returns zero, you must override it.

virtual Real	integral () const
	Returns the integral of the function over its domain.

virtual Real	average () const
	Returns the average of the function over its domain.

virtual Real	timeIntegral (Real t1, Real t2, const Point &p) const
	Computes the time integral at a spatial point between two time values.

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

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

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

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

bool	hasBlocks (SubdomainID) const override
	Returns whether the functor is defined on this block.

bool	supportsFaceArg () const override final
	Whether this functor supports evaluation with FaceArg.

bool	supportsElemSideQpArg () const override final
	Whether this functor supports evaluation with ElemSideQpArg.

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

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

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.

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

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

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

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

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

MooseObjectName	uniqueName () const

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

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.

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.

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

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

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.

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

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.

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.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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.

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.

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

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

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

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

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

bool	isImplicit ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FunctorReturnType< Real, FET >::type	genericEvaluate (const Space &r, const State &state) const
	Perform a generic evaluation based on the supplied template argument `FET` and supplied spatial and temporal arguments.

const MooseFunctorName &	functorName () const
	Return the functor name.

void	setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
	Set how often to clear the functor evaluation cache.

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
	Returns whether this (sided) face is an extrapolated boundary face for this functor.

bool	isInternalFace (const FaceInfo &) const
	Returns true if the face is an internal face.

virtual bool	isConstant () const
	Returns true if this functor is a constant.

virtual bool	hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override

void	checkFace (const Moose::FaceArg &face) const
	Examines the incoming face argument.


GradientType	gradient (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateGradient` overloads with the same arguments but allows for caching implementation.

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const


template<typename U >
auto	timeDerivative (const U &t) const
	Helpers to call timeDerivative(t,x,y,z)

template<typename U >
auto	timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) 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

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.

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const


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


ValueType	operator() (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluate` overloads with the same arguments but allows for caching implementation.

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const


DotType	dot (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateDot` overloads with the same arguments but allows for caching implementation.

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const


GradientType	gradDot (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateGradDot` overloads with the same arguments but allows for caching implementation.

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) 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.

Public Attributes
	usingCombinedWarningSolutionWarnings

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

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

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

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

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

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

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

Protected Types
typedef GriddedData::GridPoint	GridPoint

typedef GriddedData::ADGridPoint	ADGridPoint

typedef GriddedData::GridIndex	GridIndex

Protected Member Functions
virtual Real	sample (const GridPoint &pt) const override
	This does the core work.

virtual ADReal	sample (const ADGridPoint &pt) const override

template<bool is_ad>
Moose::GenericType< GridPoint, is_ad >	pointInGrid (const Moose::GenericType< Real, is_ad > &t, const Moose::GenericType< Point, is_ad > &p) const
	convert cartesian+time coordinates into grid coordinates

void	getNeighborIndices (std::vector< Real > in_arr, Real x, unsigned int &lower_x, unsigned int &upper_x) const
	Operates on monotonically increasing in_arr.

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

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

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

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

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

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.

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.

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.

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Functor evaluation routines
These methods are all for evaluating functors with different kinds of spatial arguments. Each of these methods also takes a state argument. For a description of the state argument, please see the `StateArg` doxygen
virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const
	Evaluate the functor gradient-dot with a given element.

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const
	Evaluate the functor gradient-dot with a given element and point.

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

Protected Attributes
const Real	_epsilon

std::unique_ptr< GriddedData >	_gridded_data
	object to provide function evaluations at points on the grid

unsigned int	_dim
	dimension of the grid

std::vector< int >	_axes
	_axes specifies how to embed the grid into the MOOSE coordinate frame if _axes[i] = 0 then the i_th axes of the grid lies along the MOOSE x direction if _axes[i] = 1 then the i_th axes of the grid lies along the MOOSE y direction if _axes[i] = 2 then the i_th axes of the grid lies along the MOOSE z direction if _axes[i] = 3 then the i_th axes of the grid lies along the MOOSE time direction

std::vector< std::vector< Real > >	_grid
	the grid

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

MooseApp &	_app
	The MOOSE application this is associated with.

Factory &	_factory
	The Factory associated with the MooseApp.

ActionFactory &	_action_factory
	Builds Actions.

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

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

const InputParameters &	_pars
	The object's parameters.

const Parallel::Communicator &	_communicator

const ExecFlagEnum &	_execute_enum
	Execute settings for this object.

const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase.

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

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

Real &	_t
	Time.

const Real &	_t_old
	Old time.

int &	_t_step
	The number of the time step.

Real &	_dt
	Time step size.

Real &	_dt_old
	Size of the old time step.

bool	_is_transient

MooseApp &	_restartable_app
	Reference to the application.

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

const THREAD_ID	_restartable_tid
	The thread ID for this object.

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

FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance.

FEProblemBase &	_sc_fe_problem

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

const Real &	_real_zero
	Scalar zero.

const VariableValue &	_scalar_zero
	Zero value of a scalar variable.

const Point &	_point_zero
	Zero point.

Private Types
using	ElemArg = Moose::ElemArg

using	ElemQpArg = Moose::ElemQpArg

using	ElemSideQpArg = Moose::ElemSideQpArg

using	FaceArg = Moose::FaceArg

using	ElemPointArg = Moose::ElemPointArg

using	NodeArg = Moose::NodeArg

Private Member Functions
template<bool is_ad>
Moose::GenericType< Real, is_ad >	sampleInternal (const Moose::GenericType< GridPoint, is_ad > pt) const

template<typename R >
ValueType	evaluateHelper (const R &r, const Moose::StateArg &state) const

ValueType	evaluate (const ElemArg &elem, const Moose::StateArg &state) const override final
	Evaluate the functor with a given element.

ValueType	evaluate (const FaceArg &face, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemQpArg &qp, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
	Evaluate the functor with a given element and point.

ValueType	evaluate (const NodeArg &node, const Moose::StateArg &state) const override final

template<typename R >
GradientType	evaluateGradientHelper (const R &r, const Moose::StateArg &state) const

GradientType	evaluateGradient (const ElemArg &elem, const Moose::StateArg &state) const override final
	Evaluate the functor gradient with a given element.

GradientType	evaluateGradient (const FaceArg &face, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemQpArg &qp, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
	Evaluate the functor gradient with a given element and point.

GradientType	evaluateGradient (const NodeArg &node, const Moose::StateArg &state) const override final

template<typename R >
DotType	evaluateDotHelper (const R &r, const Moose::StateArg &state) const

DotType	evaluateDot (const ElemArg &elem, const Moose::StateArg &state) const override final
	Evaluate the functor time derivative with a given element.

DotType	evaluateDot (const FaceArg &face, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemQpArg &qp, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final
	Evaluate the functor time derivative with a given element and point.

DotType	evaluateDot (const NodeArg &node, const Moose::StateArg &state) const override final

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
	Internal method for getting the PostprocessorName associated with a paremeter.

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
	Checks the parameters relating to a Postprocessor.

bool	postprocessorsAdded () const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
	Go directly to the FEProblem for the requested `object_name` for thread ID `tid`.

template<class T >
const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
	Internal helper that casts the UserObject `uo_base` to the requested type.

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const
	emit an error for the given parameter

const std::string &	userObjectType (const UserObjectBase &uo) const
	Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface.

const std::string &	userObjectName (const UserObjectBase &uo) const
	Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface.

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
	Helper function for actually registering the restartable data.

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
	Helper function for actually registering the restartable data.

template<typename T , typename... Args>
RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
	Helper function for declaring restartable data.

const VariableValue *	getDefaultValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the default value for an uncoupled variable.

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const
	Helper method to return (and insert if necessary) the AD default value for an uncoupled variable.

void	checkVar (const std::string &var_name) const
	Check that the right kind of variable is being coupled in.

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

void	clearCacheData ()
	clear cache data

ValueType	queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Real > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
	check a qp cache and if invalid then evaluate

ValueType	queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
	check a finite volume spatial argument cache and if invalid then evaluate


const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
	Internal methods for getting Postprocessor values.

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
	Internal method for getting a hit node (if available) given a set of parameters.

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)
	Internal method for getting the message prefix for an object (object type, name, etc).

Private Attributes
const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base
	The MooseBase that owns this interface.

const FEProblemBase *	_si_problem
	A pointer to FEProblem base.

ExecFlagEnum	_empty_execute_enum
	Empty ExecFlagEnum for the case when the "execute_on" parameter is not included.

const std::string	_ti_name

const MooseObject &	_ppi_moose_object
	The MooseObject that uses this interface.

const InputParameters &	_ppi_params
	PostprocessorInterface Parameters.

const FEProblemBase &	_ppi_feproblem
	Reference the the FEProblemBase class.

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values
	Holds the default postprocessor values that are requested (key is PostprocessorName)

const MooseObject &	_uoi_moose_object
	Moose object using the interface.

const FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance.

const THREAD_ID	_uoi_tid
	Thread ID.

const RestartableDataMapName	_metaname
	Restartable metadata name.

std::string	_restartable_name
	The name of the object.

const InputParameters &	_sc_parameters

const std::string &	_sc_name
	The name of the object this interface is part of.

const bool	_sc_is_implicit
	True if implicit value is required.

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
	Coupled vars whose values we provide.

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value
	Will hold the default value for optional coupled scalar variables.

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value
	Will hold the default AD value for optional coupled scalar variables.

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars
	Vector of coupled variables.

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars
	Field variables coupled into this object (for error checking)

std::set< TagID >	_sc_coupleable_vector_tags
	The scalar coupleable vector tags.

std::set< TagID >	_sc_coupleable_matrix_tags
	The scalar coupleable matrix tags.

std::set< ExecFlagType >	_clearance_schedule
	How often to clear the material property cache.

bool	_always_evaluate
	Boolean to check if we always need evaluation.

dof_id_type	_current_qp_map_key
	Current key for qp map cache.

std::vector< std::pair< bool, ValueType > > *	_current_qp_map_value
	Current value for qp map cache.

std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > >	_qp_to_value
	Cached element quadrature point functor property evaluations.

dof_id_type	_current_side_qp_map_key
	Current key for side-qp map cache.

std::vector< std::vector< std::pair< bool, ValueType > > > *	_current_side_qp_map_value
	Current value for side-qp map cache.

std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > >	_side_qp_to_value
	Cached element quadrature point functor property evaluations.

std::map< ElemArg, ValueType >	_elem_arg_to_value
	Map from element arguments to their cached evaluations.

std::map< FaceArg, ValueType >	_face_arg_to_value
	Map from face arguments to their cached evaluations.

std::map< NodeArg, ValueType >	_node_arg_to_value
	Map from nodal arguments to their cached evaluations.

MooseFunctorName	_functor_name
	name of the functor

Detailed Description

Uses GriddedData to define data on a grid, and does linear interpolation on that data to provide function values.

Gridded data can be 1D, 2D, 3D or 4D. See GriddedData for examples of file format.

Definition at line 24 of file PiecewiseMultilinear.h.

Member Typedef Documentation

◆ ADGridPoint

typedef GriddedData::ADGridPoint PiecewiseMultiInterpolation::ADGridPoint

protectedinherited

Definition at line 45 of file PiecewiseMultiInterpolation.h.

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

◆ DotType

using Moose::FunctorBase< Real >::DotType = ValueType

inherited

Definition at line 150 of file MooseFunctor.h.

◆ ElemArg

using Function::ElemArg = Moose::ElemArg

privateinherited

Definition at line 155 of file Function.h.

◆ ElemPointArg

using Function::ElemPointArg = Moose::ElemPointArg

privateinherited

Definition at line 159 of file Function.h.

◆ ElemQpArg

using Function::ElemQpArg = Moose::ElemQpArg

privateinherited

Definition at line 156 of file Function.h.

◆ ElemSideQpArg

using Function::ElemSideQpArg = Moose::ElemSideQpArg

privateinherited

Definition at line 157 of file Function.h.

◆ FaceArg

using Function::FaceArg = Moose::FaceArg

privateinherited

Definition at line 158 of file Function.h.

◆ FunctorType

using Moose::FunctorBase< Real >::FunctorType = FunctorBase<Real >

inherited

Definition at line 140 of file MooseFunctor.h.

◆ GradientType

using Moose::FunctorBase< Real >::GradientType = typename FunctorReturnType<Real , FunctorEvaluationKind::Gradient>::type

inherited

This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).

This logic will make it such that if a user requests a functor type T that is a container of algebraic types, for example Reals, then the GradientType will be a container of the gradients of those algebraic types, in this example VectorValue<Reals>. So if T is std::vector<Real>, then GradientType will be std::vector<VectorValue<Real>>. As another example: T = std::array<VectorValue<Real>, 1> -> GradientType = std::array<TensorValue<Real>, 1>

Definition at line 149 of file MooseFunctor.h.

◆ GridIndex

typedef GriddedData::GridIndex PiecewiseMultiInterpolation::GridIndex

protectedinherited

Definition at line 46 of file PiecewiseMultiInterpolation.h.

◆ GridPoint

typedef GriddedData::GridPoint PiecewiseMultiInterpolation::GridPoint

protectedinherited

Definition at line 44 of file PiecewiseMultiInterpolation.h.

◆ NodeArg

using Function::NodeArg = Moose::NodeArg

privateinherited

Definition at line 160 of file Function.h.

◆ ValueType

using Moose::FunctorBase< Real >::ValueType = Real

inherited

Definition at line 141 of file MooseFunctor.h.

Constructor & Destructor Documentation

◆ PiecewiseMultilinear()

PiecewiseMultilinear::PiecewiseMultilinear ( const InputParameters & parameters )

Definition at line 29 of file PiecewiseMultilinear.C.

  : PiecewiseMultiInterpolation(parameters), _epsilon(getParam<Real>("epsilon"))
{
}

Member Function Documentation

◆ adCoupledScalarDot()

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

protectedinherited

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

Parameters

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

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

Definition at line 267 of file ScalarCoupleable.C.

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

◆ adCoupledScalarValue()

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

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 150 of file ScalarCoupleable.C.

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

Referenced by ScalarCoupleable::coupledGenericScalarValue().

◆ addPostprocessorDependencyHelper()

virtual void PostprocessorInterface::addPostprocessorDependencyHelper ( const PostprocessorName & ) const

inlineprotectedvirtualinherited

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

Reimplemented in UserObjectBase, AuxKernelBase, and InitialConditionBase.

Definition at line 149 of file PostprocessorInterface.h.

149{}

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal().

◆ addUserObjectDependencyHelper()

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

inlineprotectedvirtualinherited

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

Reimplemented in UserObjectBase, AuxKernelBase, and InitialConditionBase.

Definition at line 111 of file UserObjectInterface.h.

111{}

Referenced by UserObjectInterface::getUserObjectBaseByName().

◆ average()

Real Function::average ( ) const

virtualinherited

Returns the average of the function over its domain.

Reimplemented in PiecewiseConstant, and PiecewiseLinearBase.

Definition at line 110 of file Function.C.

{
  mooseError("Average method not implemented for function ", name());
  return 0;
}

◆ callMooseError() [1/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);
}

◆ callMooseError() [2/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.

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

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

◆ castUserObject()

template<class T >

const T & UserObjectInterface::castUserObject	(	const UserObjectBase &	uo_base,
		const std::string &	param_name = `""`
	)		const

privateinherited

Internal helper that casts the UserObject uo_base to the requested type.

Exits with a useful error if the casting failed. If the parameter param_name is provided and is valid, a paramError() will be used instead.

Definition at line 151 of file UserObjectInterface.h.

{
  const T * uo = dynamic_cast<const T *>(&uo_base);
 
  if (!uo)
  {
    std::stringstream oss;
    oss << "The provided UserObject \"" << userObjectName(uo_base) << "\" of type "
        << userObjectType(uo_base)
        << " is not derived from the required type.\n\nThe UserObject must derive from "
        << MooseUtils::prettyCppType<T>() << ".";
 
    mooseObjectError(param_name, oss);
  }
 
  return *uo;
}

◆ checkFace()

void Moose::FunctorBase< Real >::checkFace ( const Moose::FaceArg & face ) const

inherited

Examines the incoming face argument.

If the face argument producer (residual object, postprocessor, etc.) did not indicate a sidedness to the face, e.g. if the face_side member of the FaceArg is nullptr, then we may "modify" the sidedness of the argument if we are only defined on one side of the face. If the face argument producer \emph has indicated a sidedness and we are not defined on that side, then we will error

Parameters

face	The face argument created by the face argument producer, likely a residual object

Returns: A face with possibly changed sidedness depending on whether we aren't defined on both sides of the face

Definition at line 280 of file MooseFunctor.h.

{
#if DEBUG
  const Elem * const elem = face.face_side;
  const FaceInfo * const fi = face.fi;
  mooseAssert(fi, "face info should be non-null");
  bool check_elem_def = false;
  bool check_neighbor_def = false;
  // We check if the functor is defined on both sides of the face
  if (!elem)
  {
    if (!hasFaceSide(*fi, true))
      check_neighbor_def = true;
    else if (!hasFaceSide(*fi, false))
      check_elem_def = true;
  }
  else if (elem == fi->elemPtr())
    check_elem_def = true;
  else
  {
    mooseAssert(elem == fi->neighborPtr(), "This has to match something");
    check_neighbor_def = true;
  }
 
  if (check_elem_def && !hasFaceSide(*fi, true))
  {
    std::string additional_message = "It is not defined on the neighbor side either.";
    if (hasFaceSide(*fi, false))
      additional_message = "It is however defined on the neighbor side.";
    additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
    mooseError(_functor_name,
               " is not defined on the element side of the face information, but a face argument "
               "producer "
               "(e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
               additional_message);
  }
  if (check_neighbor_def && !hasFaceSide(*fi, false))
  {
    std::string additional_message = "It is not defined on the element side either.";
    if (hasFaceSide(*fi, true))
      additional_message = "It is however defined on the element side.";
    additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
    mooseError(
        _functor_name,
        " is not defined on the neighbor side of the face information, but a face argument "
        "producer (e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
        additional_message);
  }
#endif
}

◆ checkParam()

void PostprocessorInterface::checkParam	(	const std::string &	param_name,
		const unsigned int	index = `std::numeric_limits<unsigned int>::max()`
	)		const

privateinherited

Checks the parameters relating to a Postprocessor.

If index is not set, index checking is not performed.

Definition at line 149 of file PostprocessorInterface.C.

{
  const bool check_index = index != std::numeric_limits<unsigned int>::max();
 
  if (!_ppi_params.isParamValid(param_name))
    _ppi_moose_object.mooseError(
        "When getting a Postprocessor, failed to get a parameter with the name \"",
        param_name,
        "\".",
        "\n\nKnown parameters:\n",
        _ppi_moose_object.parameters());
 
  if (_ppi_params.isType<PostprocessorName>(param_name))
  {
    if (check_index && index > 0)
      _ppi_moose_object.paramError(param_name,
                                   "A Postprocessor was requested with index ",
                                   index,
                                   " but a single Postprocessor is coupled.");
  }
  else if (_ppi_params.isType<std::vector<PostprocessorName>>(param_name))
  {
    const auto & names = _ppi_params.get<std::vector<PostprocessorName>>(param_name);
    if (check_index && names.size() <= index)
      _ppi_moose_object.paramError(param_name,
                                   "A Postprocessor was requested with index ",
                                   index,
                                   " but only ",
                                   names.size(),
                                   " Postprocessors are coupled.");
  }
  else
  {
    _ppi_moose_object.mooseError(
        "Supplied parameter with name \"",
        param_name,
        "\" of type \"",
        _ppi_params.type(param_name),
        "\" is not an expected type for getting a Postprocessor.\n\n",
        "Allowed types are \"PostprocessorName\" and \"std::vector<PostprocessorName>\".");
  }
}

Referenced by PostprocessorInterface::coupledPostprocessors(), and PostprocessorInterface::getPostprocessorNameInternal().

◆ checkVar()

void ScalarCoupleable::checkVar ( const std::string & var_name ) const

privateinherited

Check that the right kind of variable is being coupled in.

Parameters

var_name The name of the coupled variable

Definition at line 315 of file ScalarCoupleable.C.

{
  const auto & var_name = _sc_parameters.checkForRename(var_name_in);
 
  auto it = _sc_coupled_vars.find(var_name);
  if (it != _sc_coupled_vars.end())
  {
    std::string cvars;
    for (auto jt : it->second)
      cvars += " " + jt->name();
    mooseError(_sc_name,
               ": Trying to couple a field variable where scalar variable is expected, '",
               var_name,
               " =",
               cvars,
               "'");
  }
  // NOTE: non-existent variables are handled in the constructor
}

◆ clearCacheData()

void Moose::FunctorBase< Real >::clearCacheData ( )

privateinherited

clear cache data

Definition at line 500 of file MooseFunctor.h.

{
  for (auto & map_pr : _qp_to_value)
    for (auto & pr : map_pr.second)
      pr.first = false;
 
  for (auto & map_pr : _side_qp_to_value)
  {
    auto & side_vector = map_pr.second;
    for (auto & qp_vector : side_vector)
      for (auto & pr : qp_vector)
        pr.first = false;
  }
 
  _current_qp_map_key = libMesh::DofObject::invalid_id;
  _current_qp_map_value = nullptr;
  _current_side_qp_map_key = libMesh::DofObject::invalid_id;
  _current_side_qp_map_value = nullptr;
 
  _elem_arg_to_value.clear();
  _face_arg_to_value.clear();
  _node_arg_to_value.clear();
}

◆ connectControllableParams()

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

inherited

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

Parameters

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

Definition at line 77 of file MooseBase.C.

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

◆ coupledGenericScalarValue() [1/3]

template<>

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

protectedinherited

Definition at line 166 of file ScalarCoupleable.C.

{
  return coupledScalarValue(var_name, comp);
}

◆ coupledGenericScalarValue() [2/3]

template<>

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

protectedinherited

Definition at line 174 of file ScalarCoupleable.C.

{
  return adCoupledScalarValue(var_name, comp);
}

◆ coupledGenericScalarValue() [3/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled scalar variable

◆ coupledMatrixTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 217 of file ScalarCoupleable.C.

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

◆ coupledPostprocessors()

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

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

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

Definition at line 139 of file PostprocessorInterface.C.

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

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

◆ coupledScalar()

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

protectedinherited

Returns the index for a scalar coupled variable by name.

Parameters

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

Returns: Index of coupled variable

Definition at line 108 of file ScalarCoupleable.C.

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

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarComponents()

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

protectedinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 368 of file ScalarCoupleable.C.

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

◆ coupledScalarDot()

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

protectedinherited

Returns the time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 259 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDot()

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

protectedinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 275 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 307 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotOld()

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

protectedinherited

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

Parameters

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

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

Definition at line 291 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 299 of file ScalarCoupleable.C.

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

◆ coupledScalarDotOld()

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

protectedinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 283 of file ScalarCoupleable.C.

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

◆ coupledScalarOrder()

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

protectedinherited

Returns the order for a scalar coupled variable by name.

Parameters

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

Returns: Order of coupled variable

Definition at line 115 of file ScalarCoupleable.C.

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

◆ coupledScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 139 of file ScalarCoupleable.C.

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

Referenced by ScalarCoupleable::coupledGenericScalarValue(), and ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarValueOld()

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

protectedinherited

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

Parameters

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

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 231 of file ScalarCoupleable.C.

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

◆ coupledScalarValueOlder()

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

protectedinherited

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

Parameters

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

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 243 of file ScalarCoupleable.C.

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

◆ coupledVectorTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 196 of file ScalarCoupleable.C.

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

◆ curl()

RealVectorValue Function::curl	(	Real	t,
		const Point &	p
	)		const

virtualinherited

Override this to evaluate the curl of the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A vector of the curl of the function evaluated at the time and location

Reimplemented in MooseParsedVectorFunction.

Definition at line 89 of file Function.C.

{
  mooseError("curl method not implemented");
  return RealVectorValue(0, 0, 0);
}

Referenced by ElementHCurlSemiError::computeQpIntegral().

◆ customSetup()

void Function::customSetup ( const ExecFlagType & )

finaloverridevirtualinherited

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

Reimplemented from SetupInterface.

Definition at line 282 of file Function.C.

{
  FunctorBase<Real>::customSetup(exec_type);
}

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

◆ declareRestartableDataHelper()

template<typename T , typename... Args>

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

privateinherited

Helper function for declaring restartable data.

We use this function to reduce code duplication when returning const/nonconst references to the data.

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

{
  const auto full_name = restartableName(data_name);
 
  // Here we will create the RestartableData even though we may not use this instance.
  // If it's already in use, the App will return a reference to the existing instance and we'll
  // return that one instead. We might refactor this to have the app create the RestartableData
  // at a later date.
  auto data_ptr =
      std::make_unique<RestartableData<T>>(full_name, context, std::forward<Args>(args)...);
  auto & restartable_data_ref = static_cast<RestartableData<T> &>(
      registerRestartableDataOnApp(std::move(data_ptr), _restartable_tid));
 
  return restartable_data_ref;
}

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

◆ determineState()

Moose::StateArg TransientInterface::determineState ( ) const

inlineinherited

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

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

Definition at line 92 of file TransientInterface.h.

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

◆ div()

Real Function::div	(	Real	t,
		const Point &	p
	)		const

virtualinherited

Override this to evaluate the divergence of the vector function at a point (t,x,y,z), by default this returns zero, you must override it.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A scalar of the divergence of the function evaluated at the time and location

Reimplemented in MooseParsedVectorFunction.

Definition at line 96 of file Function.C.

{
  mooseError("div method not implemented");
  return 0;
}

Referenced by ElementHDivSemiError::computeQpIntegral().

◆ dot() [1/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 209 of file MooseFunctor.h.

{
  return evaluateDot(elem, state);
}

◆ dot() [2/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 213 of file MooseFunctor.h.

{
  return evaluateDot(elem_point, state);
}

◆ dot() [3/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 211 of file MooseFunctor.h.

{
  return evaluateDot(elem_qp, state);
}

◆ dot() [4/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 212 of file MooseFunctor.h.

{
  return evaluateDot(elem_side_qp, state);
}

◆ dot() [5/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 210 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateDot(face, state);
}

◆ dot() [6/6]

FunctorBase< Real >::DotType Moose::FunctorBase< Real >::dot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 214 of file MooseFunctor.h.

{
  return evaluateDot(node, state);
}

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

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

Referenced by EigenKernel::enabled(), BlockRestrictionDebugOutput::printBlockRestrictionGroups(), BlockRestrictionDebugOutput::printBoundaryRestrictionGroups(), and NodeFaceConstraint::validParams().

◆ errorPrefix()

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

inlineinherited

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

Definition at line 264 of file MooseBase.h.

264{ return messagePrefix(); }

◆ evaluate() [1/6]

Function::ValueType Function::evaluate	(	const ElemArg &	elem,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Implements Moose::FunctorBase< Real >.

Definition at line 124 of file Function.C.

{
  return evaluateHelper(elem_arg, state);
}

◆ evaluate() [2/6]

Function::ValueType Function::evaluate	(	const ElemPointArg &	elem_point,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor with a given element and point.

Some example implementations of this method could perform a two-term Taylor expansion using cell-centered value and gradient

Implements Moose::FunctorBase< Real >.

Definition at line 166 of file Function.C.

{
  return evaluateHelper(elem_point_arg, state);
}

◆ evaluate() [3/6]

Function::ValueType Function::evaluate	(	const ElemQpArg &	qp,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Real >.

Definition at line 154 of file Function.C.

{
  return evaluateHelper(elem_qp, state);
}

◆ evaluate() [4/6]

Function::ValueType Function::evaluate	(	const ElemSideQpArg &	side_qp,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Real >.

Definition at line 160 of file Function.C.

{
  return evaluateHelper(elem_side_qp, state);
}

◆ evaluate() [5/6]

Function::ValueType Function::evaluate	(	const FaceArg &	face,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Real >.

Definition at line 130 of file Function.C.

{
  if (face.face_side && face.fi->neighborPtr() &&
      (face.fi->elem().subdomain_id() != face.fi->neighbor().subdomain_id()))
  {
    // Some users like to put discontinuities in their functions at subdomain changes in which case
    // in order to always get the proper discontinuous effect we should evaluate ever so slightly
    // off the face. Consider evaluation of: if(x < 0, -1, 1) if the face centroid is right at x ==
    // 0 for example. The user likely doesn't want you to return 1 if they've asked for a 0-
    // evaluation
    //
    // I can't quite tell but I think the tolerance for comparing coordinates (x, y, z, t) in
    // fparser is ~1e-9 so we need to use something larger than that. The comparison is absolute
    static constexpr Real offset_tolerance = 1e-8;
    auto offset = offset_tolerance * face.fi->normal();
    if (face.face_side == face.fi->elemPtr())
      offset *= -1;
    return value(_ti_feproblem.getTimeFromStateArg(state), face.getPoint() + offset);
  }
  else
    return value(_ti_feproblem.getTimeFromStateArg(state), face.getPoint());
}

◆ evaluate() [6/6]

Function::ValueType Function::evaluate	(	const NodeArg &	node,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Implements Moose::FunctorBase< Real >.

Definition at line 172 of file Function.C.

{
  return evaluateHelper(node_arg, state);
}

◆ evaluateDot() [1/6]

Function::DotType Function::evaluateDot	(	const ElemArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor time derivative with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 228 of file Function.C.

{
  return evaluateDotHelper(elem_arg, state);
}

◆ evaluateDot() [2/6]

Function::DotType Function::evaluateDot	(	const ElemPointArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor time derivative with a given element and point.

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 252 of file Function.C.

{
  return evaluateDotHelper(elem_point_arg, state);
}

◆ evaluateDot() [3/6]

Function::DotType Function::evaluateDot	(	const ElemQpArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 240 of file Function.C.

{
  return evaluateDotHelper(elem_qp, state);
}

◆ evaluateDot() [4/6]

Function::DotType Function::evaluateDot	(	const ElemSideQpArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 246 of file Function.C.

{
  return evaluateDotHelper(elem_side_qp, state);
}

◆ evaluateDot() [5/6]

Function::DotType Function::evaluateDot	(	const FaceArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 234 of file Function.C.

{
  return evaluateDotHelper(face, state);
}

◆ evaluateDot() [6/6]

Function::DotType Function::evaluateDot	(	const NodeArg &	node,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 258 of file Function.C.

{
  return evaluateDotHelper(node_arg, state);
}

◆ evaluateDotHelper()

template<typename R >

Function::DotType Function::evaluateDotHelper	(	const R &	r,
		const Moose::StateArg &	state
	)		const

privateinherited

Definition at line 222 of file Function.C.

{
  return timeDerivative(_ti_feproblem.getTimeFromStateArg(state), r.getPoint());
}

Referenced by Function::evaluateDot(), Function::evaluateDot(), Function::evaluateDot(), Function::evaluateDot(), Function::evaluateDot(), and Function::evaluateDot().

◆ evaluateGradDot() [1/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const ElemArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Definition at line 445 of file MooseFunctor.h.

  {
    mooseError("Element gradient-dot not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [2/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element and point.

Definition at line 485 of file MooseFunctor.h.

  {
    mooseError("Element-point gradient-dot not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [3/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 465 of file MooseFunctor.h.

  {
    mooseError("Element quadrature point gradient-dot not implemented for functor " +
               functorName());
  }

◆ evaluateGradDot() [4/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 476 of file MooseFunctor.h.

  {
    mooseError("Element side quadrature point gradient-dot not implemented for functor " +
               functorName());
  }

◆ evaluateGradDot() [5/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 455 of file MooseFunctor.h.

  {
    mooseError("Face gradient-dot not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [6/6]

virtual GradientType Moose::FunctorBase< Real >::evaluateGradDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 490 of file MooseFunctor.h.

  {
    mooseError("Gradient-dot at node not implemented for functor " + functorName());
  }

◆ evaluateGradient() [1/6]

Function::GradientType Function::evaluateGradient	(	const ElemArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor gradient with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 185 of file Function.C.

{
  return evaluateGradientHelper(elem_arg, state);
}

◆ evaluateGradient() [2/6]

Function::GradientType Function::evaluateGradient	(	const ElemPointArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Evaluate the functor gradient with a given element and point.

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 209 of file Function.C.

{
  return evaluateGradientHelper(elem_point_arg, state);
}

◆ evaluateGradient() [3/6]

Function::GradientType Function::evaluateGradient	(	const ElemQpArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 197 of file Function.C.

{
  return evaluateGradientHelper(elem_qp, state);
}

◆ evaluateGradient() [4/6]

Function::GradientType Function::evaluateGradient	(	const ElemSideQpArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 203 of file Function.C.

{
  return evaluateGradientHelper(elem_side_qp, state);
}

◆ evaluateGradient() [5/6]

Function::GradientType Function::evaluateGradient	(	const FaceArg &	,
		const Moose::StateArg &
	)		const

finaloverrideprivatevirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 191 of file Function.C.

{
  return evaluateGradientHelper(face, state);
}

◆ evaluateGradient() [6/6]

Function::GradientType Function::evaluateGradient	(	const NodeArg &	node,
		const Moose::StateArg &	state
	)		const

finaloverrideprivatevirtualinherited

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 215 of file Function.C.

{
  return evaluateGradientHelper(node_arg, state);
}

◆ evaluateGradientHelper()

template<typename R >

Function::GradientType Function::evaluateGradientHelper	(	const R &	r,
		const Moose::StateArg &	state
	)		const

privateinherited

Definition at line 179 of file Function.C.

{
  return gradient(_ti_feproblem.getTimeFromStateArg(state), r.getPoint());
}

Referenced by Function::evaluateGradient(), Function::evaluateGradient(), Function::evaluateGradient(), Function::evaluateGradient(), Function::evaluateGradient(), and Function::evaluateGradient().

◆ evaluateHelper()

template<typename R >

Function::ValueType Function::evaluateHelper	(	const R &	r,
		const Moose::StateArg &	state
	)		const

privateinherited

Definition at line 118 of file Function.C.

{
  return value(_ti_feproblem.getTimeFromStateArg(state), r.getPoint());
}

Referenced by Function::evaluate(), Function::evaluate(), Function::evaluate(), Function::evaluate(), and Function::evaluate().

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

◆ functorName()

const MooseFunctorName & Moose::FunctorBase< Real >::functorName ( ) const

inlineinherited

Return the functor name.

Definition at line 176 of file MooseFunctor.h.

176{ return _functor_name; }

Moose::FunctorBase< Real >::_functor_name

MooseFunctorName _functor_name

name of the functor

Definition MooseFunctor.h:570

◆ genericEvaluate()

FunctorReturnType< Real , FET >::type Moose::FunctorBase< Real >::genericEvaluate	(	const Space &	r,
		const State &	state
	)		const

inherited

Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.

Definition at line 172 of file MooseFunctor.h.

{
  if constexpr (FET == FunctorEvaluationKind::Value)
    return (*this)(r, state);
  else if constexpr (FET == FunctorEvaluationKind::Gradient)
    return gradient(r, state);
  else if constexpr (FET == FunctorEvaluationKind::Dot)
    return dot(r, state);
  else
    return gradDot(r, state);
}

◆ getADDefaultValue()

const ADVariableValue * ScalarCoupleable::getADDefaultValue ( const std::string & var_name ) const

privateinherited

Helper method to return (and insert if necessary) the AD default value for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: ADVariableValue * a pointer to the associated ADVariableValue.

Definition at line 182 of file ScalarCoupleable.C.

{
  auto default_value_it = _dual_default_value.find(var_name);
  if (default_value_it == _dual_default_value.end())
  {
    auto value = std::make_unique<ADVariableValue>(_sc_fe_problem.getMaxScalarOrder(),
                                                   _sc_parameters.defaultCoupledValue(var_name));
    default_value_it = _dual_default_value.insert(std::make_pair(var_name, std::move(value))).first;
  }
 
  return default_value_it->second.get();
}

Referenced by ScalarCoupleable::adCoupledScalarValue().

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

147{ return _pars.getBase(); }

InputParameters::getBase

const std::string & getBase() const

Definition InputParameters.C:505

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

◆ 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 450 of file MooseBase.h.

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

◆ getCoupledMooseScalarVars()

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

inlineinherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 52 of file ScalarCoupleable.h.

  {
    return _coupled_moose_scalar_vars;
  }

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

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

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

Referenced by DataFileInterface::getDataFileNameByName().

◆ getDefaultPostprocessorValueByName()

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

privateinherited

Returns: The default value stored in the PostprocessorName name.

Definition at line 106 of file PostprocessorInterface.C.

{
  mooseAssert(isDefaultPostprocessorValueByName(name), "Not a default value");
 
  Real real_value = -std::numeric_limits<Real>::max();
  std::istringstream ss(name);
  ss >> real_value;
  return real_value;
}

Referenced by PostprocessorInterface::getPostprocessorValueInternal().

◆ getDefaultValue()

const VariableValue * ScalarCoupleable::getDefaultValue ( const std::string & var_name ) const

privateinherited

Helper method to return (and insert if necessary) the default value for an uncoupled variable.

Parameters

var_name the name of the variable for which to retrieve a default value

Returns: VariableValue * a pointer to the associated VariableValue.

Definition at line 125 of file ScalarCoupleable.C.

{
  auto default_value_it = _default_value.find(var_name);
  if (default_value_it == _default_value.end())
  {
    auto value = std::make_unique<VariableValue>(_sc_fe_problem.getMaxScalarOrder(),
                                                 _sc_parameters.defaultCoupledValue(var_name));
    default_value_it = _default_value.insert(std::make_pair(var_name, std::move(value))).first;
  }
 
  return default_value_it->second.get();
}

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

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 73 of file SetupInterface.C.

{
  return _execute_enum;
}

Referenced by ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), MultiAppTransfer::checkMultiAppExecuteOn(), Control::Control(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), ElementReporter::shouldStore(), GeneralReporter::shouldStore(), NodalReporter::shouldStore(), and PIDTransientControl::timestepSetup().

◆ getHitNode() [1/2]

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.

136{ return getHitNode(_pars); }

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

◆ getHitNode() [2/2]

const hit::Node * MooseBase::getHitNode ( const InputParameters & params )

staticprivateinherited

Internal method for getting a hit node (if available) given a set of parameters.

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 167 of file MooseBase.C.

{
  if (const auto hit_node = params.getHitNode())
    if (!hit_node->isRoot())
      return hit_node;
  return nullptr;
}

◆ getMooseApp()

MooseApp & MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

87{ return _app; }

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(), Moose::PetscSupport::PetscOptionsScope::PetscOptionsScope(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

◆ getNeighborIndices()

void PiecewiseMultiInterpolation::getNeighborIndices	(	std::vector< Real >	in_arr,
		Real	x,
		unsigned int &	lower_x,
		unsigned int &	upper_x
	)		const

protectedinherited

Operates on monotonically increasing in_arr.

Finds lower_x and upper_x which satisfy in_arr[lower_x] < x <= in_arr[upper_x]. End conditions: if x<in_arr[0] then lower_x = 0 = upper_x is returned if x>in_arr[N-1] then lower_x = N-1 = upper_x is returned (N=size of in_arr)

Parameters

in_arr	The monotonically increasing vector of real numbers
x	The real value for which we want the neighbor indices
lower_x	Upon return will contain lower_x specified above
upper_x	Upon return will contain upper_x specified above

Definition at line 104 of file PiecewiseMultiInterpolation.C.

{
  int N = in_arr.size();
  if (x <= in_arr[0])
  {
    lower_x = 0;
    upper_x = 0;
  }
  else if (x >= in_arr[N - 1])
  {
    lower_x = N - 1;
    upper_x = N - 1;
  }
  else
  {
    // returns up which points at the first element in inArr that is not less than x
    std::vector<double>::iterator up = std::lower_bound(in_arr.begin(), in_arr.end(), x);
 
    // std::distance returns std::difference_type, which can be negative in theory, but
    // in this context will always be >=0.  Therefore the explicit cast is just to shut
    // the compiler up.
    upper_x = static_cast<unsigned int>(std::distance(in_arr.begin(), up));
    if (in_arr[upper_x] == x)
      lower_x = upper_x;
    else
      lower_x = upper_x - 1;
  }
}

Referenced by PiecewiseMulticonstant::sample(), and sampleInternal().

◆ 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 406 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 443 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.

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

Referenced by EigenKernel::EigenKernel().

◆ getPostprocessorNameInternal()

const PostprocessorName & PostprocessorInterface::getPostprocessorNameInternal	(	const std::string &	param_name,
		const unsigned int	index,
		const bool	allow_default_value = `true`
	)		const

privateinherited

Internal method for getting the PostprocessorName associated with a paremeter.

Needed in order to allow the return of a name that is a default value.

Definition at line 202 of file PostprocessorInterface.C.

{
  checkParam(param_name, index);
 
  const auto & name = _ppi_params.isType<PostprocessorName>(param_name)
                          ? _ppi_params.get<PostprocessorName>(param_name)
                          : _ppi_params.get<std::vector<PostprocessorName>>(param_name)[index];
 
  if (!allow_default_value && isDefaultPostprocessorValueByName(name))
  {
    std::stringstream oss;
    oss << "Cannot get the name associated with PostprocessorName parameter \"" << param_name
        << "\"";
    if (index)
      oss << " at index " << index;
    oss << ",\nbecause said parameter is a default Postprocessor value.";
    _ppi_moose_object.paramError(param_name, oss.str());
  }
 
  return name;
}

Referenced by PostprocessorInterface::getPostprocessorName(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::isDefaultPostprocessorValue().

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

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

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

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

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

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

◆ getPostprocessorValueByNameInternal()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueByNameInternal	(	const PostprocessorName &	name,
		std::size_t	t_index
	)		const

privateinherited

Definition at line 256 of file PostprocessorInterface.C.

{
  mooseAssert(t_index < 3, "Invalid time index");
  mooseAssert(!isDefaultPostprocessorValueByName(name), "Should not be default");
 
  // If all pps have been added, we can check for existance
  if (postprocessorsAdded() && !hasPostprocessorByName(name))
    _ppi_moose_object.mooseError("A Postprocessor with the name \"", name, "\" was not found.");
 
  if (t_index == 0)
    addPostprocessorDependencyHelper(name);
 
  return _ppi_feproblem.getReporterData().getReporterValue<PostprocessorValue>(
      PostprocessorReporterName(name), _ppi_moose_object, REPORTER_MODE_ROOT, t_index);
}

Referenced by PostprocessorInterface::getPostprocessorValueByName(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::getPostprocessorValueOldByName(), and PostprocessorInterface::getPostprocessorValueOlderByName().

◆ getPostprocessorValueInternal()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueInternal	(	const std::string &	param_name,
		unsigned int	index,
		std::size_t	t_index
	)		const

privateinherited

Internal methods for getting Postprocessor values.

Definition at line 228 of file PostprocessorInterface.C.

{
  const auto & name = getPostprocessorNameInternal(param_name, index);
 
  // If the Postprocessor is a default value (either set by addParam or set to a constant
  // value by the user in input/an action), we covert the name to a value, store said
  // value locally, and return it so that it fits in with the rest of the interface
  // (needing a reference to a value)
  if (isDefaultPostprocessorValueByName(name))
  {
    const auto value = getDefaultPostprocessorValueByName(name);
    const auto & value_ref =
        *_default_values.emplace(name, std::make_unique<PostprocessorValue>(value))
             .first->second; // first is inserted pair, second is value in pair
    mooseAssert(value == value_ref, "Inconsistent default value");
    return value_ref;
  }
  // If not a default and all pps have been added, we check check for existance
  else if (postprocessorsAdded() && !hasPostprocessorByName(name))
    _ppi_moose_object.paramError(
        param_name, "A Postprocessor with the name \"", name, "\" was not found.");
 
  return getPostprocessorValueByNameInternal(name, t_index);
}

Referenced by PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), and PostprocessorInterface::getPostprocessorValueOlder().

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

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

Referenced by EigenKernel::EigenKernel().

◆ 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 420 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 + "'");
}

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

◆ getScalarVar()

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

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

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

Returns: Pointer to the desired variable

Definition at line 336 of file ScalarCoupleable.C.

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

◆ getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 62 of file ScalarCoupleable.h.

  {
    return _sc_coupleable_matrix_tags;
  }

◆ getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 57 of file ScalarCoupleable.h.

  {
    return _sc_coupleable_vector_tags;
  }

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

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

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

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

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

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

Referenced by MultiAppGeneralFieldUserObjectTransfer::evaluateInterpValuesWithUserObjects(), MultiAppUserObjectTransfer::execute(), and UserObjectInterface::getUserObject().

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

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

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

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

◆ getUserObjectFromFEProblem()

const UserObjectBase & UserObjectInterface::getUserObjectFromFEProblem	(	const UserObjectName &	object_name,
		const THREAD_ID	tid = `0`
	)		const

privateinherited

Go directly to the FEProblem for the requested object_name for thread ID tid.

Definition at line 96 of file UserObjectInterface.C.

{
  const UserObjectBase * uo = nullptr;
 
  if (_uoi_feproblem.hasUserObject(object_name))
    uo = &_uoi_feproblem.getUserObjectBase(object_name, tid);
 
#ifdef MOOSE_KOKKOS_ENABLED
  if (_uoi_feproblem.hasKokkosUserObject(object_name))
    uo = &_uoi_feproblem.getKokkosUserObject<UserObjectBase>(object_name);
#endif
 
  mooseAssert(uo, "getUserObjectFromFEProblem() could not find user object");
 
  return *uo;
}

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

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

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

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

◆ gradDot() [1/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 222 of file MooseFunctor.h.

{
  return evaluateGradDot(elem, state);
}

◆ gradDot() [2/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 226 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_point, state);
}

◆ gradDot() [3/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 224 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_qp, state);
}

◆ gradDot() [4/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 225 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_side_qp, state);
}

◆ gradDot() [5/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 223 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradDot(face, state);
}

◆ gradDot() [6/6]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 227 of file MooseFunctor.h.

{
  return evaluateGradDot(node, state);
}

◆ gradient() [1/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradient overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 196 of file MooseFunctor.h.

{
  return evaluateGradient(elem, state);
}

◆ gradient() [2/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 200 of file MooseFunctor.h.

{
  return evaluateGradient(elem_point, state);
}

◆ gradient() [3/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 198 of file MooseFunctor.h.

{
  return evaluateGradient(elem_qp, state);
}

◆ gradient() [4/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 199 of file MooseFunctor.h.

{
  return evaluateGradient(elem_side_qp, state);
}

◆ gradient() [5/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 197 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradient(face, state);
}

◆ gradient() [6/7]

FunctorBase< Real >::GradientType Moose::FunctorBase< Real >::gradient	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 201 of file MooseFunctor.h.

{
  return evaluateGradient(node, state);
}

◆ gradient() [7/7]

RealGradient PiecewiseMultilinear::gradient	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Function objects can optionally provide a gradient at a point.

By default this returns 0, you must override it.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A gradient of the function evaluated at the time and location

Reimplemented from Function.

Definition at line 112 of file PiecewiseMultilinear.C.

{
  RealGradient grad;
 
  // sample center point
  auto s1 = sample(pointInGrid<false>(t, p));
 
  // sample epsilon steps in all directions
  for (const auto dir : _axes)
    if (dir < 3)
    {
      Point pp = p;
      pp(dir) += _epsilon;
      grad(dir) = (sample(pointInGrid<false>(t, pp)) - s1) / _epsilon;
    }
 
  return grad;
}

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

InputParameters::hasBase

bool hasBase() const

Definition InputParameters.C:499

◆ hasBlocks()

bool Function::hasBlocks ( SubdomainID ) const

inlineoverridevirtualinherited

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< Real >.

Definition at line 145 of file Function.h.

145{ return true; }

◆ hasFaceSide()

bool Moose::FunctorBase< Real >::hasFaceSide	(	const FaceInfo &	fi,
		const bool	fi_elem_side
	)		const

overridevirtualinherited

Implements FaceArgInterface.

Reimplemented in InterfaceIntegralVariableValuePostprocessor, InternalSideIntegralVariablePostprocessor, SideIntegralFunctorPostprocessorTempl< is_ad >, SideIntegralFunctorPostprocessorTempl< false >, and SideIntegralVariablePostprocessor.

Definition at line 268 of file MooseFunctor.h.

{
  if (fi_elem_side)
    return hasBlocks(fi.elem().subdomain_id());
  else
    return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
}

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

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

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

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

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

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

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

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

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

Definition at line 48 of file SetupInterface.C.

49{

50}

Referenced by LibtorchControlValuePostprocessor::initialSetup(), Console::initialSetup(), CSV::initialSetup(), ElementalVariableValue::initialSetup(), SideIntegralPostprocessor::initialSetup(), SideUserObject::initialSetup(), MooseLinearVariableFV< OutputType >::initialSetup(), MooseVariableFV< OutputType >::initialSetup(), and Positions::meshChanged().

◆ integral()

Real Function::integral ( ) const

virtualinherited

Returns the integral of the function over its domain.

Reimplemented in PiecewiseConstant, and PiecewiseLinearBase.

Definition at line 103 of file Function.C.

{
  mooseError("Integral method not implemented for function ", name());
  return 0;
}

◆ isConstant()

virtual bool Moose::FunctorBase< Real >::isConstant ( ) const

inlinevirtualinherited

Returns true if this functor is a constant.

Definition at line 266 of file MooseFunctor.h.

266{ return false; }

◆ isCoupledScalar()

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

protectedinherited

Returns true if a variables has been coupled_as name.

Parameters

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

Definition at line 85 of file ScalarCoupleable.C.

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

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

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

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

Referenced by EigenKernel::EigenKernel().

◆ isDefaultPostprocessorValueByName()

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

privateinherited

Returns: True if the PostprocessorName name repesents a default value: the name converts to a value (set by addParam or set via input), and a Postprocessor does not exist with the same name (we do allow Postprocessors with numbered names...)

Definition at line 92 of file PostprocessorInterface.C.

{
  // We do allow actual Postprocessor objects to have names that will succeed in being
  // represented as a double... so if the name does actually exist as a PP, it's not a default
  if (_ppi_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(
          PostprocessorReporterName(name)))
    return false;
 
  std::istringstream ss(name);
  Real real_value = -std::numeric_limits<Real>::max();
  return (ss >> real_value && ss.eof());
}

Referenced by PostprocessorInterface::getDefaultPostprocessorValueByName(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), and PostprocessorInterface::isDefaultPostprocessorValue().

◆ isExtrapolatedBoundaryFace()

virtual bool Moose::FunctorBase< Real >::isExtrapolatedBoundaryFace	(	const FaceInfo &	,
		const Elem *	,
		const StateArg &
	)		const

inlinevirtualinherited

Returns whether this (sided) face is an extrapolated boundary face for this functor.

Definition at line 253 of file MooseFunctor.h.

  {
    mooseError("not implemented");
  }

◆ isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 47 of file TransientInterface.h.

47{ return _is_implicit; }

Referenced by ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), and ComputeJacobianThread::compute().

◆ isInternalFace()

bool Moose::FunctorBase< Real >::isInternalFace ( const FaceInfo & fi ) const

inherited

Returns true if the face is an internal face.

Definition at line 261 of file MooseFunctor.h.

{
  if (!fi.neighborPtr())
    return false;
 
  return hasBlocks(fi.elem().subdomain_id()) && hasBlocks(fi.neighborPtr()->subdomain_id());
}

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

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

InputParameters::isKokkosObject

bool isKokkosObject() const

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

Definition InputParameters.C:433

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

◆ 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 205 of file MooseBase.h.

  {
    return _pars.isParamSetByUser(name);
  }

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

◆ 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 199 of file MooseBase.h.

199{ return _pars.isParamValid(name); }

◆ jacobianSetup()

void Function::jacobianSetup ( )

finaloverridevirtualinherited

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

Reimplemented from SetupInterface.

Definition at line 276 of file Function.C.

{
  FunctorBase<Real>::jacobianSetup();
}

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

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

Definition at line 40 of file MeshChangedInterface.h.

40{}

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

◆ messagePrefix() [1/2]

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 256 of file MooseBase.h.

  {
    return messagePrefix(_pars, hit_prefix);
  }

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

◆ messagePrefix() [2/2]

std::string MooseBase::messagePrefix	(	const InputParameters &	params,
		const bool	hit_prefix
	)

staticprivateinherited

Internal method for getting the message prefix for an object (object type, name, etc).

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 140 of file MooseBase.C.

{
  std::string prefix = "";
 
  if (hit_prefix)
    if (const auto node = MooseBase::getHitNode(params))
      prefix += Moose::hitMessagePrefix(*node);
 
  // Don't have context without type and name
  if (!params.isMooseBaseObject())
    return prefix;
 
  const auto & name = params.getObjectName();
  const std::string base = params.hasBase() ? params.getBase() : "object";
  const bool is_main_app = base == "Application" && name == AppFactory::main_app_name;
  prefix += "The following occurred in the ";
  if (is_main_app)
    prefix += "main " + base;
  else
    prefix += base;
  if (base != params.getObjectName() && name.size() && !is_main_app)
    prefix += " '" + name + "'";
  prefix += " of type " + params.getObjectType() + ".";
  return prefix + "\n\n";
}

◆ mooseDeprecated() [1/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 317 of file MooseBase.h.

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

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

◆ mooseDeprecated() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

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

Referenced by MultiApp::appProblem(), AddVariableAction::determineType(), MooseMesh::elem(), MooseMesh::elem(), FunctionDT::FunctionDT(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), MooseMesh::isTranslatedPeriodic(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), MooseMesh::node(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), and MooseMesh::setBoundaryToNormalMap().

◆ 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 327 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 277 of file MooseBase.h.

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

Referenced by ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

◆ 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 271 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 290 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 334 of file MooseBase.h.

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

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), PIDTransientControl::execute(), Executioner::Executioner(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), ManifoldSubdomainGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), MultiAppTransfer::mapBackWithoutCollapsing(), SolutionInvalidityOutput::output(), MooseBase::paramInfo(), MooseApp::setupOptions(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ mooseObjectError()

void UserObjectInterface::mooseObjectError	(	const std::string &	param_name,
		std::stringstream &	oss
	)		const

privateinherited

emit an error for the given parameter

Definition at line 155 of file UserObjectInterface.C.

{
  if (_uoi_moose_object.parameters().isParamValid(param_name))
    _uoi_moose_object.paramError(param_name, oss.str());
  else
    _uoi_moose_object.mooseError(oss.str());
}

Referenced by UserObjectInterface::castUserObject().

◆ mooseWarning() [1/2]

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 299 of file MooseBase.h.

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

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

◆ mooseWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

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

Referenced by CopyMeshPartitioner::_do_partition(), AddFunctionAction::act(), AddKernelAction::act(), CommonOutputAction::act(), MaterialOutputAction::act(), MeshOnlyAction::act(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), Postprocessor::evaluateDotWarning(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), BSplineCurveGenerator::generate(), RenumberBySubdomainGenerator::generate(), SubdomainPerElementGenerator::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), MFEMRefinementMarker::initialSetup(), MaterialBase::initStatefulProperties(), IterationAdaptiveDT::limitDTToPostprocessorValue(), NewmarkBeta::NewmarkBeta(), Output::Output(), MaterialOutputAction::outputHelper(), Executioner::problem(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), MooseMesh::setCoordSystem(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

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

inlineinherited

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

Definition at line 308 of file MooseBase.h.

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

◆ mooseWarningNonPrefixed() [2/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");
  }

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

◆ operator()() [1/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluate overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 183 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem, state);
 
  mooseAssert(state.state == 0,
              "Cached evaluations are only currently supported for the current state.");
 
  return queryFVArgCache(_elem_arg_to_value, elem);
}

◆ operator()() [2/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 187 of file MooseFunctor.h.

{
  return evaluate(elem_point, state);
}

◆ operator()() [3/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 185 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem_qp, state);
 
  const auto elem_id = elem_qp.elem->id();
  if (elem_id != _current_qp_map_key)
  {
    _current_qp_map_key = elem_id;
    _current_qp_map_value = &_qp_to_value[elem_id];
  }
  auto & qp_data = *_current_qp_map_value;
  const auto qp = elem_qp.qp;
  const auto * const qrule = elem_qp.qrule;
  mooseAssert(qrule, "qrule must be non-null");
 
  return queryQpCache(qp, *qrule, qp_data, elem_qp, state);
}

◆ operator()() [4/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 186 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem_side_qp, state);
 
  const Elem * const elem = elem_side_qp.elem;
  mooseAssert(elem, "elem must be non-null");
  const auto elem_id = elem->id();
  if (elem_id != _current_side_qp_map_key)
  {
    _current_side_qp_map_key = elem_id;
    _current_side_qp_map_value = &_side_qp_to_value[elem_id];
  }
  auto & side_qp_data = *_current_side_qp_map_value;
  const auto side = elem_side_qp.side;
  const auto qp = elem_side_qp.qp;
  const auto * const qrule = elem_side_qp.qrule;
  mooseAssert(qrule, "qrule must be non-null");
 
  // Check and see whether we even have sized for this side
  if (side >= side_qp_data.size())
    side_qp_data.resize(elem->n_sides());
 
  // Ok we were sized enough for our side
  auto & qp_data = side_qp_data[side];
  return queryQpCache(qp, *qrule, qp_data, elem_side_qp, state);
}

◆ operator()() [5/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 184 of file MooseFunctor.h.

{
  checkFace(face_in);
 
  if (_always_evaluate)
    return evaluate(face_in, state);
 
  mooseAssert(state.state == 0,
              "Cached evaluations are only currently supported for the current state.");
 
  return queryFVArgCache(_face_arg_to_value, face_in);
}

◆ operator()() [6/6]

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::operator()	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 188 of file MooseFunctor.h.

{
  mooseAssert(node.subdomain_ids, "Subdomain IDs must be supplied to the node argument");
  return evaluate(node, state);
}

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

◆ 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 471 of file MooseBase.h.

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

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

◆ paramWarning() [1/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 464 of file MooseBase.h.

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

◆ paramWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

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

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

◆ pointInGrid()

template<bool is_ad>

template PiecewiseMultiInterpolation::ADGridPoint PiecewiseMultiInterpolation::pointInGrid< true >	(	const Moose::GenericType< Real, is_ad > &	t,
		const Moose::GenericType< Point, is_ad > &	p
	)		const

protectedinherited

convert cartesian+time coordinates into grid coordinates

Definition at line 65 of file PiecewiseMultiInterpolation.C.

{
  // convert the inputs to an input to the sample function using _axes
  Moose::GenericType<GridPoint, is_ad> point_in_grid(_dim);
  for (unsigned int i = 0; i < _dim; ++i)
  {
    if (_axes[i] < 3)
      point_in_grid[i] = p(_axes[i]);
    else if (_axes[i] == 3) // the time direction
      point_in_grid[i] = t;
  }
  return point_in_grid;
}

◆ postprocessorsAdded()

bool PostprocessorInterface::postprocessorsAdded ( ) const

privateinherited

Returns: True if all pps have been added (the task associated with adding them is complete)

Definition at line 274 of file PostprocessorInterface.C.

{
  return _ppi_feproblem.getMooseApp().actionWarehouse().isTaskComplete("add_postprocessor");
}

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::hasPostprocessorByName().

◆ queryFVArgCache()

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::queryFVArgCache	(	std::map< SpaceArg, ValueType > &	cache_data,
		const SpaceArg &	space
	)		const

privateinherited

check a finite volume spatial argument cache and if invalid then evaluate

Definition at line 516 of file MooseFunctor.h.

{
  // We don't want to evaluate if the key already exists, so instead we value initialize
  auto [it, inserted] = cache_data.try_emplace(space, ValueType());
  auto & value = it->second;
 
  if (inserted)
    // value not ready to go
    // this function is only called from functions that assert we are in the current time state
    value = evaluate(space, currentState());
 
  return value;
}

◆ 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 413 of file MooseBase.h.

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

Referenced by MFEMExecutedObject::getRequestedItems(), and MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver().

◆ queryQpCache()

FunctorBase< Real >::ValueType Moose::FunctorBase< Real >::queryQpCache	(	unsigned int	qp,
		const libMesh::QBase &	qrule,
		std::vector< std::pair< bool, Real > > &	qp_cache_data,
		const SpaceArg &	space,
		const StateArg &	state
	)		const

privateinherited

check a qp cache and if invalid then evaluate

Definition at line 506 of file MooseFunctor.h.

{
  // Check and see whether we even have sized for this quadrature point. If we haven't then we
  // must evaluate
  if (qp >= qp_cache_data.size())
  {
    qp_cache_data.resize(qrule.n_points(), std::make_pair(false, ValueType()));
    auto & pr = qp_cache_data[qp];
    pr.second = evaluate(space, state);
    pr.first = true;
    return pr.second;
  }
 
  // We've already sized for this qp, so let's see whether we have a valid cache value
  auto & pr = qp_cache_data[qp];
  if (pr.first)
    return pr.second;
 
  // No valid cache value so evaluate
  pr.second = evaluate(space, state);
  pr.first = true;
  return pr.second;
}

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

◆ registerRestartableDataOnApp()

RestartableDataValue & Restartable::registerRestartableDataOnApp	(	std::unique_ptr< RestartableDataValue >	data,
		THREAD_ID	tid
	)		const

privateinherited

Helper function for actually registering the restartable data.

Definition at line 63 of file Restartable.C.

{
  return _restartable_app.registerRestartableData(
      std::move(data), tid, _restartable_read_only, _metaname);
}

Referenced by Restartable::declareRestartableDataHelper().

◆ registerRestartableNameWithFilterOnApp()

void Restartable::registerRestartableNameWithFilterOnApp	(	const std::string &	name,
		Moose::RESTARTABLE_FILTER	filter
	)

privateinherited

Helper function for actually registering the restartable data.

Definition at line 71 of file Restartable.C.

{
  _restartable_app.registerRestartableNameWithFilter(name, filter);
}

Referenced by Restartable::declareRecoverableData().

◆ residualSetup()

void Function::residualSetup ( )

finaloverridevirtualinherited

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

Reimplemented from SetupInterface.

Definition at line 270 of file Function.C.

{
  FunctorBase<Real>::residualSetup();
}

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

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

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

◆ sample() [1/2]

ADReal PiecewiseMultilinear::sample ( const ADGridPoint & pt ) const

overrideprotectedvirtual

Reimplemented from PiecewiseMultiInterpolation.

Definition at line 41 of file PiecewiseMultilinear.C.

{
  return sampleInternal<true>(pt);
}

◆ sample() [2/2]

Real PiecewiseMultilinear::sample ( const GridPoint & pt ) const

overrideprotectedvirtual

This does the core work.

Given a point, pt, defined on the grid (not the MOOSE simulation reference frame), interpolate the gridded data to this point

Implements PiecewiseMultiInterpolation.

Definition at line 35 of file PiecewiseMultilinear.C.

{
  return sampleInternal<false>(pt);
}

Referenced by gradient(), and timeDerivative().

◆ sampleInternal()

template<bool is_ad>

Moose::GenericType< Real, is_ad > PiecewiseMultilinear::sampleInternal ( const Moose::GenericType< GridPoint, is_ad > pt ) const

private

Definition at line 48 of file PiecewiseMultilinear.C.

{
  using std::abs;
  /*
   * left contains the indices of the point to the 'left', 'down', etc, of pt
   * right contains the indices of the point to the 'right', 'up', etc, of pt
   * Hence, left and right define the vertices of the hypercube containing pt
   */
  GridIndex left(_dim);
  GridIndex right(_dim);
  for (unsigned int i = 0; i < _dim; ++i)
    getNeighborIndices(_grid[i], MetaPhysicL::raw_value(pt[i]), left[i], right[i]);
 
  /*
   * The following just loops through all the vertices of the
   * hypercube containing pt, evaluating the function at all
   * those vertices, and weighting the contributions to the
   * final result depending on the distance of pt from the vertex
   */
  Moose::GenericType<Real, is_ad> f = 0;
  Moose::GenericType<Real, is_ad> weight;
  GridIndex arg(_dim);
  // number of points in hypercube = 2^_dim
  for (unsigned int i = 0; i < (1u << _dim); ++i)
  {
    weight = 1;
    for (unsigned int j = 0; j < _dim; ++j)
      // shift i j-bits to the right and see if the result has a 0 as its right-most bit
      if ((i >> j) % 2 == 0)
      {
        arg[j] = left[j];
        if (left[j] != right[j])
          weight *= abs(pt[j] - _grid[j][right[j]]);
        else
          // unusual "end condition" case. weight by 0.5 because we will encounter this twice
          weight *= 0.5;
      }
      else
      {
        arg[j] = right[j];
        if (left[j] != right[j])
          weight *= abs(pt[j] - _grid[j][left[j]]);
        else
          // unusual "end condition" case. weight by 0.5 because we will encounter this twice
          weight *= 0.5;
      }
    f += _gridded_data->evaluateFcn(arg) * weight;
  }
 
  /*
   * finally divide by the volume of the hypercube
   */
  weight = 1;
  for (unsigned int dim = 0; dim < pt.size(); ++dim)
    if (left[dim] != right[dim])
      weight *= _grid[dim][right[dim]] - _grid[dim][left[dim]];
    else
      // unusual "end condition" case. weight by 1 to cancel the two 0.5 encountered previously
      weight *= 1;
 
  return f / weight;
}

◆ setCacheClearanceSchedule()

void Moose::FunctorBase< Real >::setCacheClearanceSchedule ( const std::set< ExecFlagType > & clearance_schedule )

inherited

Set how often to clear the functor evaluation cache.

Definition at line 238 of file MooseFunctor.h.

{
  if (clearance_schedule.count(EXEC_ALWAYS))
    _always_evaluate = true;
 
  _clearance_schedule = clearance_schedule;
}

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

Definition at line 68 of file SetupInterface.C.

69{

70}

◆ supportsElemSideQpArg()

bool Function::supportsElemSideQpArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< Real >.

Definition at line 148 of file Function.h.

148{ return true; }

◆ supportsFaceArg()

bool Function::supportsFaceArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< Real >.

Definition at line 147 of file Function.h.

147{ return true; }

◆ timeDerivative() [1/3]

template<typename U >

auto Function::timeDerivative ( const U & t ) const

inherited

Helpers to call timeDerivative(t,x,y,z)

Definition at line 220 of file Function.h.

{
  static const Moose::GenericType<Point, Moose::IsADType<U>::value> p;
  return timeDerivative(t, p);
}

◆ timeDerivative() [2/3]

template<typename U >

auto Function::timeDerivative	(	const U &	t,
		const U &	x,
		const U &	y = `0`,
		const U &	z = `0`
	)		const

inherited

Definition at line 228 of file Function.h.

{
  Moose::GenericType<Point, Moose::IsADType<U>::value> p(x, y, z);
  return timeDerivative(t, p);
}

◆ timeDerivative() [3/3]

Real PiecewiseMultilinear::timeDerivative	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Get the time derivative of the function.

Parameters

t	The time
p	The point in space (x,y,z)

Returns: The time derivative of the function at the specified time and location

Reimplemented from Function.

Definition at line 132 of file PiecewiseMultilinear.C.

{
  return (sample(pointInGrid<false>(t + _epsilon, p)) - sample(pointInGrid<false>(t, p))) /
         _epsilon;
}

◆ timeIntegral()

Real Function::timeIntegral	(	Real	t1,
		Real	t2,
		const Point &	p
	)		const

virtualinherited

Computes the time integral at a spatial point between two time values.

Parameters

[in]	t1	Beginning time value
[in]	t2	End time value
[in]	p	Spatial point

Reimplemented in ConstantFunction, and PiecewiseLinearBase.

Definition at line 76 of file Function.C.

{
  mooseError("timeIntegral() not implemented.");
}

◆ timestepSetup()

void Function::timestepSetup ( )

overridevirtualinherited

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

Reimplemented from SetupInterface.

Definition at line 264 of file Function.C.

{
  FunctorBase<Real>::timestepSetup();
}

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

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

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

Referenced by MaterialPropertyStorage::addProperty(), FEProblemBase::checkUserObjectNameCollision(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< T >::finalize(), ReporterData::getReporterInfo(), MFEMSamplerBase::initialSetup(), MFEMVariableSamplerBase::initialSetup(), WebServerControl::outputMessage(), and Action::timedAct().

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

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

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

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

◆ userObjectName()

const std::string & UserObjectInterface::userObjectName ( const UserObjectBase & uo ) const

privateinherited

Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface.

Definition at line 149 of file UserObjectInterface.C.

{
  return uo.name();
}

Referenced by UserObjectInterface::castUserObject().

◆ userObjectType()

const std::string & UserObjectInterface::userObjectType ( const UserObjectBase & uo ) const

privateinherited

Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface.

Definition at line 143 of file UserObjectInterface.C.

{
  return uo.type();
}

Referenced by UserObjectInterface::castUserObject().

◆ validateExecutionerType()

void ScalarCoupleable::validateExecutionerType	(	const std::string &	name,
		const std::string &	fn_name
	)		const

privateinherited

Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.

Parameters

name	the name of the variable
fn_name	The name of the function that called this method - used in the error message

Definition at line 354 of file ScalarCoupleable.C.

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

Referenced by ScalarCoupleable::adCoupledScalarDot(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarValueOld(), and ScalarCoupleable::coupledScalarValueOlder().

◆ validParams()

InputParameters PiecewiseMultilinear::validParams ( )

static

Definition at line 16 of file PiecewiseMultilinear.C.

{
  InputParameters params = PiecewiseMultiInterpolation::validParams();
  params.addClassDescription(
      "PiecewiseMultilinear performs linear interpolation on 1D, 2D, 3D or 4D "
      "data.  The data_file specifies the axes directions and the function "
      "values.  If a point lies outside the data range, the appropriate end "
      "value is used.");
  params.addParam<Real>(
      "epsilon", 1e-12, "Finite differencing parameter for gradient and time derivative");
  return params;
}

◆ value() [1/7]

ADReal Function::value	(	const ADReal &	t,
		const ADPoint &	p
	)		const

virtualinherited

Override this to evaluate the scalar function at point (t,x,y,z), using dual numbers by default this uses value, gradient, and timeDerivative to assemble a dual number, although the function can be overridden with a custom computation using dual numbers.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A scalar of the function evaluated at the time and location

Reimplemented from Function.

Definition at line 62 of file Function.C.

{
  const auto rt = MetaPhysicL::raw_value(t);
  const auto rp = MetaPhysicL::raw_value(p);
  const auto grad = gradient(rt, rp);
  ADReal ret = value(rt, rp);
  ret.derivatives() = grad(0) * p(0).derivatives()
#if LIBMESH_DIM > 1
                      + grad(1) * p(1).derivatives()
#endif
#if LIBMESH_DIM > 2
                      + grad(2) * p(2).derivatives()
#endif
                      + timeDerivative(rt, rp) * t.derivatives();
  return ret;
}

◆ value() [2/7]

ADReal PiecewiseMultiInterpolation::value	(	const ADReal &	t,
		const ADPoint &	p
	)		const

overridevirtualinherited

Override this to evaluate the scalar function at point (t,x,y,z), using dual numbers by default this uses value, gradient, and timeDerivative to assemble a dual number, although the function can be overridden with a custom computation using dual numbers.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A scalar of the function evaluated at the time and location

Reimplemented from Function.

Reimplemented in PiecewiseMulticonstant, and PiecewiseMulticonstant.

Definition at line 92 of file PiecewiseMultiInterpolation.C.

{
  return sample(pointInGrid<true>(t, p));
}

◆ value() [3/7]

ChainedReal Function::value ( const ChainedReal & t ) const

inherited

Helpers to call value(t,x,y,z)

Definition at line 65 of file Function.C.

{
  static const Point p;
  return {value(t.value(), p), timeDerivative(t.value(), p) * t.derivatives()};
}

◆ value() [4/7]

template<typename U >

auto Function::value ( const U & t ) const

inherited

Definition at line 67 of file Function.h.

{
  static const Moose::GenericType<Point, Moose::IsADType<U>::value> p;
  return value(t, p);
}

◆ value() [5/7]

template<typename U >

auto Function::value	(	const U &	t,
		const U &	x,
		const U &	y = `0`,
		const U &	z = `0`
	)		const

inherited

Definition at line 69 of file Function.h.

{
  Moose::GenericType<Point, Moose::IsADType<U>::value> p(x, y, z);
  return value(t, p);
}

◆ value() [6/7]

Real Function::value	(	Real	t,
		const Point &	p
	)		const

virtualinherited

Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero, you must override it.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A scalar of the function evaluated at the time and location

Reimplemented from Function.

Definition at line 52 of file Function.C.

{
  mooseError("value method not implemented");
  return 0.0;
}

◆ value() [7/7]

Real PiecewiseMultiInterpolation::value	(	Real	t,
		const Point &	pt
	)		const

overridevirtualinherited

Given t and p, return the interpolated value.

Reimplemented from Function.

Reimplemented in PiecewiseMulticonstant.

Definition at line 86 of file PiecewiseMultiInterpolation.C.

{
  return sample(pointInGrid<false>(t, p));
}

◆ vectorValue()

RealVectorValue Function::vectorValue	(	Real	t,
		const Point &	p
	)		const

virtualinherited

Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

Parameters

t	The time
p	The Point in space (x,y,z)

Returns: A vector of the function evaluated at the time and location

Reimplemented in LinearCombinationFunction, MooseParsedFunction, MooseParsedGradFunction, and MooseParsedVectorFunction.

Definition at line 82 of file Function.C.

{
  mooseError("vectorValue method not implemented");
  return RealVectorValue(0, 0, 0);
}

Referenced by ElementVectorL2Error::computeQpIntegral(), ConservativeAdvectionBC::computeQpJacobian(), VectorCurlPenaltyDirichletBC::computeQpResidual(), VectorDivPenaltyDirichletBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), ADVectorFunctionDirichletBC::computeQpValue(), VectorFunctionAux::computeValue(), and VectorFunctionIC::value().

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

◆ _always_evaluate

bool Moose::FunctorBase< Real >::_always_evaluate

privateinherited

Boolean to check if we always need evaluation.

Definition at line 523 of file MooseFunctor.h.

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 375 of file MooseBase.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), FEProblemBase::acceptInvalidSolution(), FEProblemBase::addAnyRedistributers(), MeshGenerator::addChildMeshGenerator(), FEProblemBase::addMaterialHelper(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addOutput(), MeshGenerator::addParentMeshGenerator(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), DefaultNonlinearConvergence::checkConvergence(), MeshGenerator::checkGetMesh(), FEProblemBase::checkICRestartError(), FEProblemBase::checkProblemIntegrity(), LibmeshPartitioner::clone(), BlockWeightedPartitioner::clone(), CopyMeshPartitioner::clone(), GridPartitioner::clone(), HierarchicalGridPartitioner::clone(), PetscExternalPartitioner::clone(), RandomPartitioner::clone(), SingleRankPartitioner::clone(), ElementPointNeighborLayers::clone(), ElementSideNeighborLayers::clone(), GhostAllPointNeighbors::clone(), GhostBoundary::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), GhostPrimaryFace::clone(), ProxyRelationshipManager::clone(), RedistributeProperties::clone(), SampledOutput::cloneMesh(), FEProblemBase::computeJacobianSys(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualSys(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), Control::Control(), CopyMeshPartitioner::CopyMeshPartitioner(), MultiApp::createApp(), MultiApp::createApps(), FEProblemBase::customSetup(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), MooseMesh::determineUseDistributedMesh(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), PIDTransientControl::execute(), Eigenvalue::execute(), InversePowerMethod::execute(), NonlinearEigen::execute(), SteadyBase::execute(), TransientBase::execute(), MFEMSteady::execute(), PseudoTimestep::execute(), IterationInfo::execute(), EigenProblem::execute(), Executioner::Executioner(), Executioner::Executioner(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), NEML2Assembly::finalize(), ChangeOverFixedPointPostprocessor::finalize(), RadialAverage::finalize(), FixedPointSolve::FixedPointSolve(), FEProblemBase::forceOutput(), FullSolveMultiApp::FullSolveMultiApp(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVAdvection::FVAdvection(), FileMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), MeshGenerator::getCSGBaseByName(), FEProblemBase::getExecutor(), MeshGenerator::getMeshByName(), NumFixedPointIterations::getValue(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), Eigenvalue::init(), InversePowerMethod::init(), NonlinearEigen::init(), TransientBase::init(), MFEMMesh::init(), FEProblemBase::init(), CompositionDT::init(), SubProblem::initialSetup(), PIDTransientControl::initialSetup(), RealFunctionControl::initialSetup(), TimePeriod::initialSetup(), EigenProblemSolve::initialSetup(), FEProblemSolve::initialSetup(), Console::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), EigenProblem::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), FEProblemBase::meshChanged(), MeshGenerator::MeshGenerator(), MFEMProblemSolve::MFEMProblemSolve(), MooseMesh::MooseMesh(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), EigenExecutionerBase::normalizeSolution(), NumFailedTimeSteps::NumFailedTimeSteps(), Checkpoint::output(), Exodus::output(), Nemesis::output(), PerfGraphOutput::output(), Tecplot::output(), MortarNodalGeometryOutput::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), JSONOutput::outputReporters(), Output::outputStep(), SampledOutput::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), JSONOutput::outputSystemInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), MultiApp::parentOutputPositionChanged(), TransientBase::preExecute(), FEProblemBase::projectSolution(), AnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), FileMesh::safeClone(), GeneratedMesh::safeClone(), ImageMesh::safeClone(), MeshGeneratorMesh::safeClone(), PatternedMesh::safeClone(), RinglebMesh::safeClone(), SpiralAnnularMesh::safeClone(), StitchedMesh::safeClone(), TiledMesh::safeClone(), MFEMMesh::safeClone(), MultiApp::setAppOutputFileBase(), FileOutput::setFileBaseInternal(), MeshGenerator::setMeshProperty(), MeshGenerator::setMeshPropertyHelper(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), Output::setWallTimeIntervalFromCommandLineParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), SolutionInvalidityReporter::SolutionInvalidityReporter(), FixedPointSolve::solve(), FEProblemBase::solve(), EigenProblem::solve(), FEProblemBase::solveLinearSystem(), PetscOutput::solveSetup(), FixedPointSolve::solveStep(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), SubProblem::timestepSetup(), PIDTransientControl::timestepSetup(), FEProblemBase::timestepSetup(), TransientBase::TransientBase(), MooseMesh::update(), NEML2FEInterpolation::updateDofMap(), NEML2FEInterpolation::updateGradPhi(), NEML2FEInterpolation::updateInterpolations(), FEProblemBase::updateMortarMesh(), NEML2FEInterpolation::updatePhi(), Console::write(), and FEProblemBase::~FEProblemBase().

◆ _axes

std::vector<int> PiecewiseMultiInterpolation::_axes

protectedinherited

_axes specifies how to embed the grid into the MOOSE coordinate frame if _axes[i] = 0 then the i_th axes of the grid lies along the MOOSE x direction if _axes[i] = 1 then the i_th axes of the grid lies along the MOOSE y direction if _axes[i] = 2 then the i_th axes of the grid lies along the MOOSE z direction if _axes[i] = 3 then the i_th axes of the grid lies along the MOOSE time direction

Definition at line 74 of file PiecewiseMultiInterpolation.h.

Referenced by gradient(), and PiecewiseMultiInterpolation::pointInGrid().

◆ _clearance_schedule

std::set<ExecFlagType> Moose::FunctorBase< Real >::_clearance_schedule

privateinherited

How often to clear the material property cache.

Definition at line 520 of file MooseFunctor.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _coupled_moose_scalar_vars

std::vector<MooseVariableScalar *> ScalarCoupleable::_coupled_moose_scalar_vars

privateinherited

Vector of coupled variables.

Definition at line 304 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getCoupledMooseScalarVars(), and ScalarCoupleable::ScalarCoupleable().

◆ _coupled_scalar_vars

std::unordered_map<std::string, std::vector<MooseVariableScalar *> > ScalarCoupleable::_coupled_scalar_vars

privateinherited

Coupled vars whose values we provide.

Definition at line 295 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarComponents(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), and ScalarCoupleable::ScalarCoupleable().

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

◆ _current_qp_map_key

dof_id_type Moose::FunctorBase< Real >::_current_qp_map_key

mutableprivateinherited

Current key for qp map cache.

Definition at line 529 of file MooseFunctor.h.

◆ _current_qp_map_value

std::vector<std::pair<bool, ValueType> >* Moose::FunctorBase< Real >::_current_qp_map_value

mutableprivateinherited

Current value for qp map cache.

Definition at line 532 of file MooseFunctor.h.

◆ _current_side_qp_map_key

dof_id_type Moose::FunctorBase< Real >::_current_side_qp_map_key

mutableprivateinherited

Current key for side-qp map cache.

Definition at line 545 of file MooseFunctor.h.

◆ _current_side_qp_map_value

std::vector<std::vector<std::pair<bool, ValueType> > >* Moose::FunctorBase< Real >::_current_side_qp_map_value

mutableprivateinherited

Current value for side-qp map cache.

Definition at line 548 of file MooseFunctor.h.

◆ _default_value

std::unordered_map<std::string, std::unique_ptr<VariableValue> > ScalarCoupleable::_default_value

mutableprivateinherited

Will hold the default value for optional coupled scalar variables.

Definition at line 298 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue().

◆ _default_values

std::map<PostprocessorName, std::unique_ptr<PostprocessorValue> > PostprocessorInterface::_default_values

mutableprivateinherited

Holds the default postprocessor values that are requested (key is PostprocessorName)

Definition at line 162 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueInternal().

◆ _dim

unsigned int PiecewiseMultiInterpolation::_dim

protectedinherited

dimension of the grid

Definition at line 65 of file PiecewiseMultiInterpolation.h.

Referenced by PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::pointInGrid(), PiecewiseMulticonstant::sample(), and sampleInternal().

◆ _dt

Real& TransientInterface::_dt

protectedinherited

Time step size.

Definition at line 79 of file TransientInterface.h.

Referenced by InterfaceQpValueUserObject::computeRealValue(), ForcingFunctionAux::computeValue(), PIDTransientControl::execute(), TimeIntegratedPostprocessor::execute(), ChangeOverTimePostprocessor::finalize(), VariableTimeIntegrationAux::getIntegralValue(), and PIDChainControl::updateValues().

◆ _dt_old

Real& TransientInterface::_dt_old

protectedinherited

Size of the old time step.

Definition at line 82 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _dual_default_value

std::unordered_map<std::string, std::unique_ptr<ADVariableValue> > ScalarCoupleable::_dual_default_value

mutableprivateinherited

Will hold the default AD value for optional coupled scalar variables.

Definition at line 301 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getADDefaultValue().

◆ _elem_arg_to_value

std::map<ElemArg, ValueType> Moose::FunctorBase< Real >::_elem_arg_to_value

mutableprivateinherited

Map from element arguments to their cached evaluations.

Definition at line 561 of file MooseFunctor.h.

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum

privateinherited

Empty ExecFlagEnum for the case when the "execute_on" parameter is not included.

This is private because others should not be messing with it.

Definition at line 79 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _epsilon

const Real PiecewiseMultilinear::_epsilon

protected

Definition at line 38 of file PiecewiseMultilinear.h.

Referenced by gradient(), and timeDerivative().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 83 of file SetupInterface.h.

◆ _face_arg_to_value

std::map<FaceArg, ValueType> Moose::FunctorBase< Real >::_face_arg_to_value

mutableprivateinherited

Map from face arguments to their cached evaluations.

Definition at line 564 of file MooseFunctor.h.

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

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

◆ _functor_name

MooseFunctorName Moose::FunctorBase< Real >::_functor_name

privateinherited

name of the functor

Definition at line 570 of file MooseFunctor.h.

◆ _grid

std::vector<std::vector<Real> > PiecewiseMultiInterpolation::_grid

protectedinherited

the grid

Definition at line 77 of file PiecewiseMultiInterpolation.h.

Referenced by PiecewiseMulticonstant::sample(), and sampleInternal().

◆ _gridded_data

std::unique_ptr<GriddedData> PiecewiseMultiInterpolation::_gridded_data

protectedinherited

object to provide function evaluations at points on the grid

Definition at line 63 of file PiecewiseMultiInterpolation.h.

Referenced by PiecewiseMulticonstant::sample(), and sampleInternal().

◆ _is_implicit

bool TransientInterface::_is_implicit

protectedinherited

If the object is using implicit or explicit form.

This does NOT mean time scheme, but which values are going to be used in the object - either from current time or old time. Note that even explicit schemes have implicit form (it is the time derivative "kernel")

Definition at line 67 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), BoundaryIntegralValueConstraint::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), Kernel::computeResidualAndJacobian(), KernelScalarBase::computeResidualAndJacobian(), TransientInterface::determineState(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and TransientInterface::isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient

protectedinherited

Definition at line 85 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _metaname

const RestartableDataMapName Restartable::_metaname

privateinherited

Restartable metadata name.

Definition at line 247 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 381 of file MooseBase.h.

◆ _node_arg_to_value

std::map<NodeArg, ValueType> Moose::FunctorBase< Real >::_node_arg_to_value

mutableprivateinherited

Map from nodal arguments to their cached evaluations.

Definition at line 567 of file MooseFunctor.h.

◆ _parent

const ParallelParamObject& DataFileInterface::_parent

privateinherited

Definition at line 58 of file DataFileInterface.h.

Referenced by DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), and DataFileInterface::getDataFilePath().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 384 of file MooseBase.h.

Referenced by AddAuxKernelAction::act(), AddFVICAction::act(), AddICAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::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(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MultiSystemSolveObject::MultiSystemSolveObject(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseBase::queryParam(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 251 of file ScalarCoupleable.h.

Referenced by FunctionDT::computeDT(), FunctionScalarAux::computeValue(), and FunctionScalarIC::value().

◆ _ppi_feproblem

const FEProblemBase& PostprocessorInterface::_ppi_feproblem

privateinherited

Reference the the FEProblemBase class.

Definition at line 159 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::hasPostprocessorByName(), PostprocessorInterface::isDefaultPostprocessorValueByName(), and PostprocessorInterface::postprocessorsAdded().

◆ _ppi_moose_object

const MooseObject& PostprocessorInterface::_ppi_moose_object

privateinherited

The MooseObject that uses this interface.

Definition at line 153 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::checkParam(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::hasPostprocessorByName().

◆ _ppi_params

const InputParameters& PostprocessorInterface::_ppi_params

privateinherited

PostprocessorInterface Parameters.

Definition at line 156 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::checkParam(), PostprocessorInterface::coupledPostprocessors(), and PostprocessorInterface::getPostprocessorNameInternal().

◆ _qp_to_value

std::unordered_map<dof_id_type, std::vector<std::pair<bool, ValueType> > > Moose::FunctorBase< Real >::_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values should have size corresponding to the number of quadrature points on the element. The vector elements are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 539 of file MooseFunctor.h.

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 245 of file ScalarCoupleable.h.

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 234 of file Restartable.h.

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

◆ _restartable_name

std::string Restartable::_restartable_name

privateinherited

The name of the object.

Definition at line 250 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithObjectNameWithContext(), and Restartable::restartableName().

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

◆ _sc_coupleable_matrix_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_matrix_tags

mutableprivateinherited

The scalar coupleable matrix tags.

Definition at line 312 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue(), and ScalarCoupleable::getScalarVariableCoupleableMatrixTags().

◆ _sc_coupleable_vector_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_vector_tags

mutableprivateinherited

The scalar coupleable vector tags.

Definition at line 310 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledVectorTagScalarValue(), and ScalarCoupleable::getScalarVariableCoupleableVectorTags().

◆ _sc_coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFieldBase *> > ScalarCoupleable::_sc_coupled_vars

privateinherited

Field variables coupled into this object (for error checking)

Definition at line 307 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), and ScalarCoupleable::ScalarCoupleable().

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 239 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledVectorTagScalarValue(), ScalarCoupleable::getADDefaultValue(), ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_is_implicit

const bool ScalarCoupleable::_sc_is_implicit

privateinherited

True if implicit value is required.

Definition at line 292 of file ScalarCoupleable.h.

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

◆ _sc_name

const std::string& ScalarCoupleable::_sc_name

privateinherited

The name of the object this interface is part of.

Definition at line 289 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), ScalarCoupleable::coupledScalarComponents(), ScalarCoupleable::coupledVectorTagScalarValue(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), ScalarCoupleable::ScalarCoupleable(), and ScalarCoupleable::validateExecutionerType().

◆ _sc_parameters

const InputParameters& ScalarCoupleable::_sc_parameters

privateinherited

Definition at line 286 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), ScalarCoupleable::coupledScalarComponents(), ScalarCoupleable::getADDefaultValue(), ScalarCoupleable::getDefaultValue(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), and ScalarCoupleable::ScalarCoupleable().

◆ _sc_tid

const THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 242 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 248 of file ScalarCoupleable.h.

◆ _si_moose_base

const MooseBase& SolutionInvalidInterface::_si_moose_base

privateinherited

The MooseBase that owns this interface.

Definition at line 111 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal(), SolutionInvalidInterface::mooseDeprecated(), SolutionInvalidInterface::mooseWarning(), SolutionInvalidInterface::mooseWarningNonPrefixed(), SolutionInvalidInterface::paramWarning(), and SolutionInvalidInterface::registerInvalidSolutionInternal().

◆ _si_problem

const FEProblemBase* SolutionInvalidInterface::_si_problem

privateinherited

A pointer to FEProblem base.

Definition at line 114 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal().

◆ _side_qp_to_value

std::unordered_map<dof_id_type, std::vector<std::vector<std::pair<bool, ValueType> > > > Moose::FunctorBase< Real >::_side_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values are a multi-dimensional vector (or vector of vectors) with the first index corresponding to the side and the second index corresponding to the quadrature point index. The elements returned after double indexing are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 558 of file MooseFunctor.h.

◆ _t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 70 of file TransientInterface.h.

◆ _t_old

const Real& TransientInterface::_t_old

protectedinherited

Old time.

Definition at line 73 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), and TimedSubdomainModifier::computeSubdomainID().

◆ _t_step

int& TransientInterface::_t_step

protectedinherited

The number of the time step.

Definition at line 76 of file TransientInterface.h.

Referenced by NEML2ModelExecutor::advanceState(), PIDTransientControl::execute(), AccumulateReporter::execute(), IterationInfo::execute(), LeastSquaresFitHistory::execute(), NEML2ModelExecutor::fillInputs(), ChangeOverFixedPointPostprocessor::finalize(), ChangeOverTimePostprocessor::finalize(), and ElementSubdomainModifierBase::timestepSetup().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protectedinherited

Definition at line 59 of file TransientInterface.h.

Referenced by Function::evaluate(), Function::evaluateDotHelper(), Function::evaluateGradientHelper(), Function::evaluateHelper(), PiecewiseConstantFromCSV::initialSetup(), and PiecewiseConstantFromCSV::PiecewiseConstantFromCSV().

◆ _ti_name

const std::string TransientInterface::_ti_name

privateinherited

Definition at line 88 of file TransientInterface.h.

◆ _ti_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 57 of file TransientInterface.h.

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 378 of file MooseBase.h.

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

◆ _uoi_feproblem

const FEProblemBase& UserObjectInterface::_uoi_feproblem

privateinherited

Reference to the FEProblemBase instance.

Definition at line 143 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectFromFEProblem(), and UserObjectInterface::hasUserObjectByName().

◆ _uoi_moose_object

const MooseObject& UserObjectInterface::_uoi_moose_object

privateinherited

Moose object using the interface.

Definition at line 140 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectName(), and UserObjectInterface::mooseObjectError().

◆ _uoi_tid

const THREAD_ID UserObjectInterface::_uoi_tid

privateinherited

Thread ID.

Definition at line 146 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBaseByName().

◆ 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(), ActionFactory::getValidParams(), Factory::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_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(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ 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/functions/PiecewiseMultilinear.h
src/functions/PiecewiseMultilinear.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ADGridPoint

◆ DataFileParameterType

◆ DotType

◆ ElemArg

◆ ElemPointArg

◆ ElemQpArg

◆ ElemSideQpArg

◆ FaceArg

◆ FunctorType

◆ GradientType

◆ GridIndex

◆ GridPoint

◆ NodeArg

◆ ValueType

Constructor & Destructor Documentation

◆ PiecewiseMultilinear()

Member Function Documentation

◆ adCoupledScalarDot()

◆ adCoupledScalarValue()

◆ addPostprocessorDependencyHelper()

◆ addUserObjectDependencyHelper()

◆ average()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ castUserObject()

◆ checkFace()

◆ checkParam()

◆ checkVar()

◆ clearCacheData()

◆ connectControllableParams()

◆ coupledGenericScalarValue() [1/3]

◆ coupledGenericScalarValue() [2/3]

◆ coupledGenericScalarValue() [3/3]

◆ coupledMatrixTagScalarValue()

◆ coupledPostprocessors()

◆ coupledScalar()

◆ coupledScalarComponents()

◆ coupledScalarDot()

◆ coupledScalarDotDot()

◆ coupledScalarDotDotDu()

◆ coupledScalarDotDotOld()

◆ coupledScalarDotDu()

◆ coupledScalarDotOld()

◆ coupledScalarOrder()

◆ coupledScalarValue()

◆ coupledScalarValueOld()

◆ coupledScalarValueOlder()

◆ coupledVectorTagScalarValue()

◆ curl()

◆ customSetup()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataHelper()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ determineState()

◆ div()

◆ dot() [1/6]

◆ dot() [2/6]

◆ dot() [3/6]

◆ dot() [4/6]

◆ dot() [5/6]

◆ dot() [6/6]

◆ enabled()