#include <FVPostprocessorDirichletBC.h>

Inheritance diagram for FVPostprocessorDirichletBC:

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

enum	TEST_TYPE { ALL , ANY }
	A flag changing the behavior of hasBoundary. More...

enum class	ResidualTagType { NonReference , Reference }
	Enumerate whether a (residual) vector tag is to be of a non-reference or reference tag type. More...

Public Member Functions
	FVPostprocessorDirichletBC (const InputParameters &parameters)

ADReal	boundaryValue (const FaceInfo &fi, const Moose::StateArg &state) const override

const SubProblem &	subProblem () const
	Get a reference to the subproblem.

const MooseVariableFV< Real > &	variable () const

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

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 const std::set< BoundaryID > &	boundaryIDs () const
	Return the boundary IDs for this object.

const std::vector< BoundaryName > &	boundaryNames () const
	Return the boundary names for this object.

unsigned int	numBoundaryIDs () const
	Return the number of boundaries for this object.

bool	hasBoundary (const BoundaryName &name) const
	Test if the supplied boundary name is valid for this object.

bool	hasBoundary (const std::vector< BoundaryName > &names) const
	Test if the supplied vector of boundary names are valid for this object.

bool	hasBoundary (const BoundaryID &id) const
	Test if the supplied boundary ids are valid for this object.

bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied vector boundary ids are valid for this object.

bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied set of boundary ids are valid for this object.

bool	isBoundarySubset (const std::set< BoundaryID > &ids) const
	Test if the class boundary ids are a subset of the supplied objects.

bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const

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

virtual bool	boundaryRestricted () const
	Returns true if this object has been restricted to a boundary.

const std::set< BoundaryID > &	meshBoundaryIDs () const
	Returns the set of all boundary ids for the entire mesh.

virtual bool	checkVariableBoundaryIntegrity () const
	Whether integrity/coverage checking should be conducted for moose variables used in this object.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the PenetrationLocator associated with the two sides.

PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the Quadrature PenetrationLocator associated with the two sides.

NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve the PenetrationLocator associated with the two sides.

NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve a Quadrature NearestNodeLocator associated with the two sides.

bool	requiresGeometricSearch () const
	Whether any of this interface's methods have been called, e.g.

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

void	useVectorTag (const TagName &tag_name, VectorTagsKey)

void	useVectorTag (TagID tag_id, VectorTagsKey)

void	useMatrixTag (const TagName &tag_name, MatrixTagsKey)

void	useMatrixTag (TagID tag_id, MatrixTagsKey)

bool	isVectorTagged ()

bool	isMatrixTagged ()

bool	hasVectorTags () const

const std::set< TagID > &	getVectorTags (VectorTagsKey) const

const std::set< TagID > &	getMatrixTags (MatrixTagsKey) const

MooseVariableBase *	mooseVariableBase () const
	Get the variable that this object is using.

MooseVariableField< Real > &	mooseVariableField ()
	Return the `MooseVariableField` object that this interface acts on.

MooseVariableFE< Real > *	mooseVariable () const
	Return the `MooseVariableFE` object that this interface acts on.

MooseVariableFV< Real > *	mooseVariableFV () const
	Return the `MooseVariableFV` object that this interface acts on.

MooseLinearVariableFV< Real > *	mooseLinearVariableFV () const
	Return the `MooseLinearVariableFV` object that this interface acts on.

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

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

virtual std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
	Check whether all of the supplied variables have degree of freedom indices on the supplied node.

std::set< MooseVariableFieldBase * >	checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
	Check whether all of the supplied variables have degree of freedom indices on the supplied element.

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

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

template<>
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)

template<>
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

Moose::FaceArg	makeFace (const FaceInfo &fi, const Moose::FV::LimiterType limiter_type, const bool elem_is_upwind, const bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
	Create a functor face argument from provided component arguments.

Moose::FaceArg	makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) const
	Make a functor face argument with a central differencing limiter, e.g.


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

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


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

template<typename T >
const T &	getDistributionByName (const std::string &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


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	isVectorPostprocessorDistributed (const std::string &param_name) const
	Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED.

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

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

static bool	restricted (const std::set< BoundaryID > &ids)
	Helper for determining if the object is boundary restricted.

static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)
	Helper to look up a functor name through the input parameter keys.

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 Member Functions
Moose::FaceArg	singleSidedFaceArg (const FaceInfo fi=nullptr, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false, const Moose::StateArg state_limiter=nullptr) const
	Determine the single sided face argument when evaluating a functor on a face.

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

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
	A helper method to avoid circular #include problems.

KOKKOS_FUNCTION dof_id_type	numKokkosBoundaryNodes () const
	Get the number of nodes this Kokkos object is operating on.

KOKKOS_FUNCTION dof_id_type	numKokkosBoundarySides () const
	Get the number of sides this Kokkos object is operating on.

KOKKOS_FUNCTION ContiguousNodeID	kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous node ID this Kokkos thread is operating on.

KOKKOS_FUNCTION auto	kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID - side index pair this Kokkos thread is operating on.

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

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

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

void	prepareVectorTag (Assembly &assembly, unsigned int ivar)
	Prepare data for computing element residual according to active tags.

void	prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
	Prepare vector tags in a reference residual problem context.

void	prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
	Prepare data for computing element residual the according to active tags for DG and interface kernels.

void	prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
	Prepare data for computing the residual according to active tags for mortar constraints.

void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
	Prepare data for computing element jacobian according to the active tags.

void	prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const

void	prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
	Prepare data for computing nonlocal element jacobian according to the active tags.

void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
	Prepare data for computing element jacobian according to the active tags for DG and interface kernels.

void	prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const

void	prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
	Prepare data for computing the jacobian according to the active tags for mortar.

void	accumulateTaggedLocalResidual ()
	Local residual blocks will be appended by adding the current local kernel residual.

void	assignTaggedLocalResidual ()
	Local residual blocks will assigned as the current local kernel residual.

void	accumulateTaggedLocalMatrix ()
	Local Jacobian blocks will be appended by adding the current local kernel Jacobian.

void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)

void	accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)

void	accumulateTaggedNonlocalMatrix ()
	Nonlocal Jacobian blocks will be appended by adding the current nonlocal kernel Jacobian.

void	assignTaggedLocalMatrix ()
	Local Jacobian blocks will assigned as the current local kernel Jacobian.

template<typename Residuals , typename Indices >
void	addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided incoming residuals corresponding to the provided dof indices.

template<typename Residuals , typename Indices >
void	addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)

template<typename T , typename Indices >
void	addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided incoming residuals corresponding to the provided dof indices.

void	addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
	Add the provided incoming residuals corresponding to the provided dof indices.

template<typename Residuals , typename Indices >
void	addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

void	addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
	Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

template<typename Residuals , typename Indices >
void	addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided residual derivatives into the Jacobian for the provided dof indices.

template<typename Residuals , typename Indices >
void	addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
	Add the provided residual derivatives into the Jacobian for the provided dof indices.

void	addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
	Add the provided residual derivatives into the Jacobian for the provided dof indices.

void	addJacobian (Assembly &assembly, const DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
	Add a local Jacobian matrix.

template<typename Residuals , typename Indices >
void	addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided incoming residuals corresponding to the provided dof indices.

template<typename Residuals , typename Indices >
void	addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

template<typename Residuals , typename Indices >
void	addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
	Add the provided residual derivatives into the Jacobian for the provided dof indices.

void	addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
	Add into a single Jacobian element.

template<typename T >
void	setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
	Set residual using the variables' insertion API.

void	setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
	Set residual at a specified degree of freedom index.

template<typename SetResidualFunctor >
void	setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
	Set residuals using the provided functor.

virtual const OutputTools< Real >::VariableValue &	value ()
	The value of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on.

virtual const VariableValue &	dotDu ()
	The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.

virtual const VariableValue &	dotDotDu ()
	The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.

virtual const OutputTools< Real >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on.

virtual const OutputTools< Real >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on.

virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on.

virtual const OutputTools< Real >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on.

virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()
	The second derivative of the test function.

virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face.

virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function.

virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face.

std::string	deduceFunctorName (const std::string &name) const
	Small helper to look up a functor name through the input parameter keys.

template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name)
	Retrieves a functor from the subproblem.

template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)
	Retrieves a functor from the subproblem.

template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)
	Retrieves a functor from the passed-in subproblem.

template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem.

bool	isFunctor (const std::string &name) const
	Checks the subproblem for the given functor.

bool	isFunctor (const std::string &name, const SubProblem &subproblem) const
	Checks the passed-in subproblem for the given functor.

Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
	Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.

template<typename T >
void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
	Throws error if the functor does not support the requested side integration.

template<typename T >
const Moose::Functor< T > &	getFunctorByName (const std::string &name)
	Retrieves a functor from the subproblem.

Protected Attributes
const std::pair< unsigned int, unsigned int >	_var_sys_numbers_pair
	A pair keeping track of the variable and system numbers.

MooseVariableFV< Real > &	_var

SubProblem &	_subproblem
	Reference to SubProblem.

FEProblemBase &	_fv_problem
	Reference to the ruling finite volume problem.

SystemBase &	_sys
	Reference to SystemBase.

THREAD_ID	_tid
	Thread id.

Assembly &	_assembly
	Reference to assembly.

MooseMesh &	_mesh
	Mesh this BC is defined on.

const FaceInfo *	_face_info = nullptr
	Holds information for the face we are currently examining.

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

GeometricSearchData &	_geometric_search_data

bool	_requires_geometric_search
	Whether any of this interface's methods have been called, e.g.

FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance.

DenseVector< Number >	_local_re
	Holds local residual entries as they are accumulated by this Kernel.

DenseMatrix< Number >	_local_ke
	Holds local Jacobian entries as they are accumulated by this Kernel.

DenseMatrix< Number >	_nonlocal_ke
	Holds nonlocal Jacobian entries as they are accumulated by this Kernel.

bool	_nodal
	Whether or not this object is acting only at nodes.

MooseVariableFE< Real > *	_variable

MooseVariableFV< Real > *	_fv_variable

MooseLinearVariableFV< Real > *	_linear_fv_variable

MooseVariableField< Real > *	_field_variable

Assembly *	_mvi_assembly

Private Member Functions
void	initializeBoundaryRestrictable ()
	An initialization routine needed for dual constructors.

void	initializeKokkosBoundaryRestrictable ()

const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const
	Helper function to retrieve a Kokkos function.

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.

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 VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
	Helper function for extracting VPP data from ReporterData object.

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
	Helper for getting the VPP context that handles scatter values.

bool	vectorPostprocessorsAdded () const

void	prepareVectorTagInternal (Assembly &assembly, unsigned int ivar, const std::set< TagID > &vector_tags, const std::set< TagID > &absolute_value_vector_tags)
	Prepare data for computing element residual according to the specified tags Residual blocks for different tags will be extracted from Assembly.

void	checkForNans () const
	Checks `_local_re` for NaNs/Infs and returns an error if found.

template<typename DofObjectType >
std::set< MooseVariableFieldBase * >	checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
	Helper method for checking variables for dof indices.

virtual bool	isADObject () const override
	Whether this interface is for an AD object.

template<typename T >
const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem.

template<typename T >
const Moose::Functor< T > *	defaultFunctor (const std::string &name)
	Helper function to parse default functor values.

template<>
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)

template<>
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)


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


void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
	Helpers for "possibly" checking if a vpp exists.

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) 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 PostprocessorValue &	_postprocessor_value
	The value for this BC.

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base
	The MooseBase that owns this interface.

const FEProblemBase *	_si_problem
	A pointer to FEProblem base.

FEProblemBase *	_bnd_feproblem
	Pointer to FEProblemBase.

MooseMesh *	_bnd_mesh
	Point to mesh.

std::set< BoundaryID >	_bnd_ids
	Set of the boundary ids.

std::vector< BoundaryID >	_vec_ids
	Vector of the boundary ids.

std::vector< BoundaryName >	_boundary_names
	Vector the the boundary names.

const bool	_bnd_dual_restrictable
	Flag for allowing dual restriction with BlockRestrictable.

const std::set< SubdomainID >	_empty_block_ids
	An empty set for referencing when block_ids is not included.

const std::set< SubdomainID > &	_block_ids
	Reference to the block_ids, defaults to an empty set if not provided.

THREAD_ID	_bnd_tid
	Thread id for this object.

const MaterialData &	_bnd_material_data
	Pointer to MaterialData for boundary (.

bool	_bnd_nodal
	Whether or not this object is restricted to nodesets.

const MooseObject &	_moose_object
	The moose object that this is an interface for.

Moose::Kokkos::Array< ContiguousNodeID >	_kokkos_node_ids
	List of contiguous node IDs this Kokkos object is operating on.

Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > >	_kokkos_element_side_ids
	List of contiguous element ID - side index pairs this Kokkos object is operating on.

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

const MooseObject &	_fni_object
	Reference to the object.

const InputParameters &	_fni_params
	Parameters of the object with this interface.

FEProblemBase &	_fni_feproblem
	Reference to FEProblemBase instance.

const THREAD_ID	_fni_tid
	Thread ID.

const InputParameters &	_dni_params
	Parameters of the object with this interface.

FEProblemBase &	_dni_feproblem
	Reference to FEProblemBase instance.

const MooseObject *const	_dni_moose_object_ptr
	Pointer to the MooseObject.

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 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 bool	_broadcast_by_default
	Whether or not to force broadcasting by default.

const MooseObject &	_vpi_moose_object
	The MooseObject that uses this interface.

const FEProblemBase &	_vpi_feproblem
	Reference the FEProblemBase class.

const THREAD_ID	_vpi_tid
	Thread ID.

std::set< TagID >	_vector_tags
	The vector tag ids this Kernel will contribute to.

std::set< TagID >	_abs_vector_tags
	The absolute value residual tag ids.

std::set< TagID >	_matrix_tags
	The matrices this Kernel will contribute to.

std::set< TagID >	_non_ref_vector_tags
	A set to hold vector tags excluding the reference residual tag.

std::set< TagID >	_non_ref_abs_vector_tags
	A set to hold absolute value vector tags excluding the reference residual tag.

std::set< TagID >	_ref_vector_tags
	A set of either size 1 or 0.

std::set< TagID >	_ref_abs_vector_tags
	A set of either size 1 or 0.

const InputParameters &	_tag_params
	Parameters from moose object.

std::vector< DenseVector< Number > * >	_re_blocks
	Residual blocks Vectors For each Tag.

std::vector< DenseVector< Number > * >	_absre_blocks
	Residual blocks for absolute value residual tags.

std::vector< DenseMatrix< Number > * >	_ke_blocks
	Kernel blocks Vectors For each Tag.

std::vector< Real >	_absolute_residuals
	A container to hold absolute values of residuals passed into `addResiduals`.

std::set< MooseVariableFieldBase * >	_moose_variable_dependencies

std::vector< libMesh::dof_id_type >	_dof_indices
	A container for holding dof indices in order to avoid constant memory reallocation.

const InputParameters &	_fi_params
	Parameters of the object with this interface.

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

SubProblem *const	_fi_subproblem
	Pointer to subproblem if the subproblem pointer parameter was set.

const THREAD_ID	_fi_tid
	Current threaded it.

std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors
	Storage vector for Moose::Functor<Real> default objects.

std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors
	Storage vector for Moose::Functor<ADReal> default objects.

Detailed Description

Definition at line 14 of file FVPostprocessorDirichletBC.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

Member Enumeration Documentation

◆ ResidualTagType

enum class TaggingInterface::ResidualTagType

stronginherited

Enumerate whether a (residual) vector tag is to be of a non-reference or reference tag type.

Enumerator
NonReference
Reference

Definition at line 118 of file TaggingInterface.h.

  {
    NonReference,
    Reference
  };

◆ TEST_TYPE

enum BoundaryRestrictable::TEST_TYPE

inherited

A flag changing the behavior of hasBoundary.

Enumerator
ALL
ANY

Definition at line 33 of file BoundaryRestrictable.h.

  {
    ALL,
    ANY
  };

Constructor & Destructor Documentation

◆ FVPostprocessorDirichletBC()

FVPostprocessorDirichletBC::FVPostprocessorDirichletBC ( const InputParameters & parameters )

Definition at line 24 of file FVPostprocessorDirichletBC.C.

  : FVDirichletBCBase(parameters), _postprocessor_value(getPostprocessorValue("postprocessor"))
{
}

Member Function Documentation

◆ accumulateTaggedLocalMatrix() [1/3]

void TaggingInterface::accumulateTaggedLocalMatrix ( )

protectedinherited

Local Jacobian blocks will be appended by adding the current local kernel Jacobian.

It should be called after the local element matrix has been computed.

Definition at line 407 of file TaggingInterface.C.

{
  for (auto & ke : _ke_blocks)
    *ke += _local_ke;
}

◆ accumulateTaggedLocalMatrix() [2/3]

void TaggingInterface::accumulateTaggedLocalMatrix	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		const DenseMatrix< Number > &	k
	)

protectedinherited

Definition at line 414 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] = &assembly.jacobianBlock(ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
  mooseAssert(_ke_blocks[0]->m() == k.m() && _ke_blocks[0]->n() == k.n(),
              "Passed-in k must match the blocks we are about to sum into");
  for (auto & ke : _ke_blocks)
    *ke += k;
}

◆ accumulateTaggedLocalMatrix() [3/3]

void TaggingInterface::accumulateTaggedLocalMatrix	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		Moose::DGJacobianType	type,
		const DenseMatrix< Number > &	k
	)

protectedinherited

Definition at line 431 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] =
        &assembly.jacobianBlockNeighbor(type, ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
  mooseAssert(_ke_blocks[0]->m() == k.m() && _ke_blocks[0]->n() == k.n(),
              "Passed-in k must match the blocks we are about to sum into");
  for (auto & ke : _ke_blocks)
    *ke += k;
}

◆ accumulateTaggedLocalResidual()

void TaggingInterface::accumulateTaggedLocalResidual ( )

protectedinherited

Local residual blocks will be appended by adding the current local kernel residual.

It should be called after the local element vector has been computed.

Definition at line 377 of file TaggingInterface.C.

{
#ifndef NDEBUG
  if (_subproblem.checkResidualForNans())
    checkForNans();
#endif
 
  for (auto & re : _re_blocks)
    *re += _local_re;
  for (auto & absre : _absre_blocks)
    for (const auto i : index_range(_local_re))
      (*absre)(i) += std::abs(_local_re(i));
}

◆ accumulateTaggedNonlocalMatrix()

void TaggingInterface::accumulateTaggedNonlocalMatrix ( )

protectedinherited

Nonlocal Jacobian blocks will be appended by adding the current nonlocal kernel Jacobian.

It should be called after the nonlocal element matrix has been computed.

Definition at line 450 of file TaggingInterface.C.

{
  for (auto & ke : _ke_blocks)
    *ke += _nonlocal_ke;
}

Referenced by NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), and NonlocalKernel::computeNonlocalOffDiagJacobian().

◆ addJacobian() [1/4]

void TaggingInterface::addJacobian	(	Assembly &	assembly,
		const ADResidualsPacket &	packet
	)

protectedinherited

Add the provided residual derivatives into the Jacobian for the provided dof indices.

Definition at line 476 of file TaggingInterface.C.

{
  addJacobian(assembly, packet.residuals, packet.dof_indices, packet.scaling_factor);
}

◆ addJacobian() [2/4]

void TaggingInterface::addJacobian	(	Assembly &	assembly,
		const DenseMatrix< Real > &	local_k,
		const std::vector< dof_id_type > &	row_indices,
		const std::vector< dof_id_type > &	column_indices,
		Real	scaling_factor
	)

inlineprotectedinherited

Add a local Jacobian matrix.

Definition at line 650 of file TaggingInterface.h.

{
  assembly.cacheJacobianBlock(
      local_k, row_indices, column_indices, scaling_factor, Assembly::LocalDataKey{}, _matrix_tags);
}

◆ addJacobian() [3/4]

template<typename Residuals , typename Indices >

void TaggingInterface::addJacobian	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		const std::vector< Real > &	scaling_factors
	)

protectedinherited

Add the provided residual derivatives into the Jacobian for the provided dof indices.

This overload is meant for array variables because it takes an array of scaling factors

Definition at line 597 of file TaggingInterface.h.

{
  const auto count = scaling_factors.size();
  mooseAssert(dof_indices.size() % count == 0,
              "The number of dof indices should be divided cleanly by the variable count");
  const auto nshapes = dof_indices.size() / count;
 
  for (const auto j : make_range(count))
    // The Residuals type may not offer operator[] (e.g. eigen vectors) but more commonly it
    // should offer data()
    addJacobian(assembly,
                Moose::makeSpan(residuals, j * nshapes, nshapes),
                Moose::makeSpan(dof_indices, j * nshapes, nshapes),
                scaling_factors[j]);
}

◆ addJacobian() [4/4]

template<typename Residuals , typename Indices >

void TaggingInterface::addJacobian	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided residual derivatives into the Jacobian for the provided dof indices.

Definition at line 586 of file TaggingInterface.h.

{
  assembly.cacheJacobian(
      residuals, dof_indices, scaling_factor, Assembly::LocalDataKey{}, _matrix_tags);
}

Referenced by TaggingInterface::addJacobian(), TaggingInterface::addJacobian(), TaggingInterface::addResidualsAndJacobian(), ADScalarKernel::computeADJacobian(), ADDGKernel::computeElemNeighJacobian(), BoundaryIntegralValueConstraint::computeFieldScalarJacobian(), ADDiracKernel::computeFullJacobian(), DiffusionLHDGDirichletBC::computeJacobian(), DiffusionLHDGPrescribedGradientBC::computeJacobian(), ElementAndTraceScalarHDGBC::computeJacobian(), ADNodeElemConstraint::computeJacobian(), FVElementalKernel::computeJacobian(), DiffusionLHDGKernel::computeJacobian(), ElementAndTraceScalarHDGKernel::computeJacobian(), ADArrayKernel::computeJacobian(), ADArrayNodalKernel::computeJacobian(), ADNodalKernel::computeJacobian(), NodalConstraint::computeJacobian(), DiffusionLHDGKernel::computeJacobianOnSide(), ElementAndTraceScalarHDGKernel::computeJacobianOnSide(), ADDGKernel::computeOffDiagElemNeighJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), BoundaryIntegralValueConstraint::computeScalarFieldJacobian(), BoundaryIntegralValueConstraint::computeScalarJacobian(), MortarScalarBase::computeScalarJacobian(), KernelScalarBase::computeScalarJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobian(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), and KernelScalarBase::computeScalarOffDiagJacobianScalar().

◆ addJacobianElement()

void TaggingInterface::addJacobianElement	(	Assembly &	assembly,
		Real	value,
		dof_id_type	row_index,
		dof_id_type	column_index,
		Real	scaling_factor
	)

inlineprotectedinherited

Add into a single Jacobian element.

Definition at line 639 of file TaggingInterface.h.

{
  assembly.cacheJacobian(
      row_index, column_index, value * scaling_factor, Assembly::LocalDataKey{}, _matrix_tags);
}

Referenced by ArrayNodalBC::computeJacobian(), NodalBC::computeJacobian(), VectorNodalBC::computeJacobian(), NodalKernel::computeJacobian(), NodalConstraint::computeJacobian(), ArrayNodalBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), VectorNodalBC::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), ArrayNodalKernel::setJacobian(), and MortarConstraintBase::zeroInactiveLMDofs().

◆ addJacobianWithoutConstraints()

template<typename Residuals , typename Indices >

void TaggingInterface::addJacobianWithoutConstraints	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided residual derivatives into the Jacobian for the provided dof indices.

This API should only be used if the caller knows that no libMesh-level constraints (hanging nodes or periodic boundary conditions) apply to the provided dof indices

Definition at line 629 of file TaggingInterface.h.

{
  assembly.cacheJacobianWithoutConstraints(
      residuals, dof_indices, scaling_factor, Assembly::LocalDataKey{}, _matrix_tags);
}

Referenced by TaggingInterface::addResidualsAndJacobianWithoutConstraints().

◆ addMooseVariableDependency() [1/2]

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

inlineinherited

Definition at line 98 of file MooseVariableDependencyInterface.h.

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

◆ addMooseVariableDependency() [2/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( MooseVariableFieldBase * var )

inlineinherited

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

Definition at line 94 of file MooseVariableDependencyInterface.h.

  {
    _moose_variable_dependencies.insert(var);
  }

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

◆ addResiduals() [1/4]

void TaggingInterface::addResiduals	(	Assembly &	assembly,
		const ADResidualsPacket &	packet
	)

protectedinherited

Add the provided incoming residuals corresponding to the provided dof indices.

Definition at line 464 of file TaggingInterface.C.

{
  addResiduals(assembly, packet.residuals, packet.dof_indices, packet.scaling_factor);
}

◆ addResiduals() [2/4]

template<typename T , typename Indices >

void TaggingInterface::addResiduals	(	Assembly &	assembly,
		const DenseVector< T > &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided incoming residuals corresponding to the provided dof indices.

Definition at line 542 of file TaggingInterface.h.

{
  addResiduals(assembly, residuals.get_values(), dof_indices, scaling_factor);
}

◆ addResiduals() [3/4]

template<typename Residuals , typename Indices >

void TaggingInterface::addResiduals	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		const std::vector< Real > &	scaling_factors
	)

protectedinherited

Definition at line 521 of file TaggingInterface.h.

{
  const auto count = scaling_factors.size();
  mooseAssert(dof_indices.size() % count == 0,
              "The number of dof indices should be divided cleanly by the variable count");
  const auto nshapes = dof_indices.size() / count;
 
  for (const auto j : make_range(count))
    // The Residuals type may not offer operator[] (e.g. eigen vectors) but more commonly it
    // should offer data()
    addResiduals(assembly,
                 Moose::makeSpan(residuals, j * nshapes, nshapes),
                 Moose::makeSpan(dof_indices, j * nshapes, nshapes),
                 scaling_factors[j]);
}

◆ addResiduals() [4/4]

template<typename Residuals , typename Indices >

void TaggingInterface::addResiduals	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided incoming residuals corresponding to the provided dof indices.

Definition at line 498 of file TaggingInterface.h.

{
  assembly.cacheResiduals(
      residuals, dof_indices, scaling_factor, Assembly::LocalDataKey{}, _vector_tags);
  if (!_abs_vector_tags.empty())
  {
    _absolute_residuals.resize(residuals.size());
    for (const auto i : index_range(residuals))
      _absolute_residuals[i] = std::abs(MetaPhysicL::raw_value(residuals[i]));
 
    assembly.cacheResiduals(_absolute_residuals,
                            dof_indices,
                            scaling_factor,
                            Assembly::LocalDataKey{},
                            _abs_vector_tags);
  }
}

◆ addResidualsAndJacobian() [1/2]

void TaggingInterface::addResidualsAndJacobian	(	Assembly &	assembly,
		const ADResidualsPacket &	packet
	)

protectedinherited

Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

Definition at line 470 of file TaggingInterface.C.

{
  addResidualsAndJacobian(assembly, packet.residuals, packet.dof_indices, packet.scaling_factor);
}

◆ addResidualsAndJacobian() [2/2]

template<typename Residuals , typename Indices >

void TaggingInterface::addResidualsAndJacobian	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

Definition at line 575 of file TaggingInterface.h.

{
  addResiduals(assembly, residuals, dof_indices, scaling_factor);
  addJacobian(assembly, residuals, dof_indices, scaling_factor);
}

Referenced by TaggingInterface::addResidualsAndJacobian(), ADKernelScalarBase::computeJacobian(), FVFluxBC::computeJacobian(), FVInterfaceKernel::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVScalarLagrangeMultiplierInterface::computeJacobian(), ElementAndTraceScalarHDGBC::computeResidualAndJacobian(), ADDiracKernel::computeResidualAndJacobian(), FVElementalKernel::computeResidualAndJacobian(), ElementAndTraceScalarHDGKernel::computeResidualAndJacobian(), ADKernelScalarBase::computeResidualAndJacobian(), FVScalarLagrangeMultiplierConstraint::computeResidualAndJacobian(), and ElementAndTraceScalarHDGKernel::computeResidualAndJacobianOnSide().

◆ addResidualsAndJacobianWithoutConstraints()

template<typename Residuals , typename Indices >

void TaggingInterface::addResidualsAndJacobianWithoutConstraints	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided incoming residuals and derivatives for the Jacobian, corresponding to the provided dof indices.

This API should only be used if the caller knows that no libMesh-level constraints (hanging nodes or periodic boundary conditions) apply to the provided dof indices

Definition at line 618 of file TaggingInterface.h.

{
  addResidualsWithoutConstraints(assembly, residuals, dof_indices, scaling_factor);
  addJacobianWithoutConstraints(assembly, residuals, dof_indices, scaling_factor);
}

Referenced by ADMortarScalarBase::computeJacobian(), and ADMortarConstraint::computeJacobian().

◆ addResidualsWithoutConstraints()

template<typename Residuals , typename Indices >

void TaggingInterface::addResidualsWithoutConstraints	(	Assembly &	assembly,
		const Residuals &	residuals,
		const Indices &	dof_indices,
		Real	scaling_factor
	)

protectedinherited

Add the provided incoming residuals corresponding to the provided dof indices.

This API should only be used if the caller knows that no libMesh-level constraints (hanging nodes or periodic boundary conditions) apply to the provided dof indices

Definition at line 552 of file TaggingInterface.h.

{
  assembly.cacheResidualsWithoutConstraints(
      residuals, dof_indices, scaling_factor, Assembly::LocalDataKey{}, _vector_tags);
  if (!_abs_vector_tags.empty())
  {
    _absolute_residuals.resize(residuals.size());
    for (const auto i : index_range(residuals))
      _absolute_residuals[i] = std::abs(MetaPhysicL::raw_value(residuals[i]));
 
    assembly.cacheResidualsWithoutConstraints(_absolute_residuals,
                                              dof_indices,
                                              scaling_factor,
                                              Assembly::LocalDataKey{},
                                              _abs_vector_tags);
  }
}

Referenced by TaggingInterface::addResidualsAndJacobianWithoutConstraints().

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

◆ addVectorPostprocessorDependencyHelper()

virtual void VectorPostprocessorInterface::addVectorPostprocessorDependencyHelper ( const VectorPostprocessorName & ) const

inlineprotectedvirtualinherited

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

Reimplemented in UserObjectBase, and AuxKernelBase.

Definition at line 319 of file VectorPostprocessorInterface.h.

320 {

321 }

Referenced by VectorPostprocessorInterface::getVectorPostprocessorByNameHelper(), and VectorPostprocessorInterface::getVectorPostprocessorContextByNameHelper().

◆ assignTaggedLocalMatrix()

void TaggingInterface::assignTaggedLocalMatrix ( )

protectedinherited

Local Jacobian blocks will assigned as the current local kernel Jacobian.

It should be called after the local element matrix has been computed.

Definition at line 457 of file TaggingInterface.C.

{
  for (auto & ke : _ke_blocks)
    *ke = _local_ke;
}

Referenced by NodalEqualValueConstraint::computeJacobian().

◆ assignTaggedLocalResidual()

void TaggingInterface::assignTaggedLocalResidual ( )

protectedinherited

Local residual blocks will assigned as the current local kernel residual.

It should be called after the local element vector has been computed.

Definition at line 392 of file TaggingInterface.C.

{
#ifndef NDEBUG
  if (_subproblem.checkResidualForNans())
    checkForNans();
#endif
 
  for (auto & re : _re_blocks)
    *re = _local_re;
  for (auto & absre : _absre_blocks)
    for (const auto i : index_range(_local_re))
      (*absre)(i) = std::abs(_local_re(i));
}

Referenced by NodeFaceConstraint::computeResidual(), and NodalEqualValueConstraint::computeResidual().

◆ boundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::boundaryIDs ( ) const

virtualinherited

Return the boundary IDs for this object.

Returns: A set of all boundary ids for which the object is restricted

Definition at line 224 of file BoundaryRestrictable.C.

{
  return _bnd_ids;
}

Referenced by SideUserObject::checkNoInterfaceMaterialPropertyDependencies(), MaterialBase::getGenericZeroMaterialPropertyByName(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), SidesetInfoVectorPostprocessor::initialize(), BoundaryLinearFVFluxIntegral::initialSetup(), SideFVFluxBCIntegral::initialSetup(), InterfaceQpUserObjectBase::initialSetup(), and MaterialBase::registerPropName().

◆ boundaryNames()

const std::vector< BoundaryName > & BoundaryRestrictable::boundaryNames ( ) const

inherited

Return the boundary names for this object.

Returns: A set of all boundary names for which the object is restricted

Definition at line 230 of file BoundaryRestrictable.C.

{
  return _boundary_names;
}

Referenced by MaterialOutputAction::getParams(), NearestNodeDistanceAux::NearestNodeDistanceAux(), and NearestNodeValueAux::NearestNodeValueAux().

◆ boundaryRestricted()

bool BoundaryRestrictable::boundaryRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 242 of file BoundaryRestrictable.C.

{
  return BoundaryRestrictable::restricted(_bnd_ids);
}

Referenced by Moose::Kokkos::Material::checkMaterialProperty(), Material::checkMaterialProperty(), MaterialOutputAction::getParams(), DerivativeMaterialInterface< T >::haveMaterialProperty(), and NodePositions::initialize().

◆ boundaryValue()

ADReal FVPostprocessorDirichletBC::boundaryValue	(	const FaceInfo &	fi,
		const Moose::StateArg &	state
	)		const

overridevirtual

Implements FVDirichletBCBase.

Definition at line 30 of file FVPostprocessorDirichletBC.C.

{
  return _postprocessor_value;
}

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

◆ checkAllVariables()

template<typename DofObjectType >

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

inherited

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

Parameters

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

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

Definition at line 119 of file MooseVariableDependencyInterface.h.

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

◆ checkForNans()

void TaggingInterface::checkForNans ( ) const

privateinherited

Checks _local_re for NaNs/Infs and returns an error if found.

Definition at line 483 of file TaggingInterface.C.

{
  for (const auto i : index_range(_local_re))
    if (!std::isfinite(_local_re(i)))
    {
      std::stringstream ss;
      ss << "NaN or Inf detected in '" << _moose_object.name() << "'.\n";
      ss << "To further troubleshoot this value in this residual object, add the following lines "
            "before returning the value in the computeQpResidual() (or similar) method in the "
            "source file for the class of '"
         << _moose_object.name() << "':\n\n";
      ss << "  if (!std::isfinite(<return value>))\n";
      ss << "    mooseError(\"Found NaN or Inf\");\n\n";
      ss << "Then you can use a breakpoint in a debugger to troubleshoot the origin of the NaN or "
            "Inf value.";
 
      mooseError(ss.str());
    }
}

Referenced by TaggingInterface::accumulateTaggedLocalResidual(), and TaggingInterface::assignTaggedLocalResidual().

◆ checkFunctorSupportsSideIntegration()

template<typename T >

void FunctorInterface::checkFunctorSupportsSideIntegration	(	const std::string &	name,
		bool	qp_integration
	)

protectedinherited

Throws error if the functor does not support the requested side integration.

Parameters

[in]	name	Name of functor or functor parameter
[in]	qp_integration	True if performing qp integration, false if face info

Definition at line 261 of file FunctorInterface.h.

{
  const std::string functor_name = deduceFunctorName(name);
  const auto & functor = getFunctor<T>(name);
  if (qp_integration)
  {
    if (!functor.supportsElemSideQpArg())
      mooseError("Quadrature point integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
  else
  {
    if (!functor.supportsFaceArg())
      mooseError("Face info integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
}

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

◆ checkVariableBoundaryIntegrity()

virtual bool BoundaryRestrictable::checkVariableBoundaryIntegrity ( ) const

inlinevirtualinherited

Whether integrity/coverage checking should be conducted for moose variables used in this object.

This should return true if variables are only evaluated locally, e.g. on the current node or element. This should return false if evaluation of this object entails non-local variable evaluations

Definition at line 190 of file BoundaryRestrictable.h.

190{ return true; }

◆ checkVariables() [1/2]

std::set< MooseVariableFieldBase * > MooseVariableDependencyInterface::checkVariables	(	const libMesh::Elem &	element,
		const std::set< MooseVariableFieldBase * > &	vars_to_check
	)

inlineinherited

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

Parameters

element	The element that we want to check for existence of variable degrees of freedom on
vars_to_check	the variables to check

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

Definition at line 142 of file MooseVariableDependencyInterface.h.

{
  return checkVariablesHelper(element, vars_to_check);
}

◆ checkVariables() [2/2]

std::set< MooseVariableFieldBase * > MooseVariableDependencyInterface::checkVariables	(	const libMesh::Node &	node,
		const std::set< MooseVariableFieldBase * > &	vars_to_check
	)

inlinevirtualinherited

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

Parameters

node	The node that we want to check for existence of variable degrees of freedom on
vars_to_check	the variables to check

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

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

Definition at line 135 of file MooseVariableDependencyInterface.h.

{
  return checkVariablesHelper(node, vars_to_check);
}

Referenced by MooseVariableDependencyInterface::checkAllVariables(), and AuxKernelTempl< ComputeValueType >::checkVariables().

◆ checkVariablesHelper()

template<typename DofObjectType >

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

privateinherited

Helper method for checking variables for dof indices.

Returns the subset of variables of vars_to_check that do \emph not have dof indices on the provided dof_object

Definition at line 33 of file MooseVariableDependencyInterface.C.

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

Referenced by MooseVariableDependencyInterface::checkVariables(), and MooseVariableDependencyInterface::checkVariables().

◆ connectControllableParams()

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

inherited

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

Parameters

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

Definition at line 77 of file MooseBase.C.

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

◆ coupledPostprocessors()

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

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

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

Definition at line 139 of file PostprocessorInterface.C.

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

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 69 of file SetupInterface.h.

69{}

◆ deduceFunctorName() [1/2]

std::string FunctorInterface::deduceFunctorName ( const std::string & name ) const

protectedinherited

Small helper to look up a functor name through the input parameter keys.

Definition at line 71 of file FunctorInterface.C.

{
  return deduceFunctorName(name, _fi_params);
}

◆ deduceFunctorName() [2/2]

std::string FunctorInterface::deduceFunctorName	(	const std::string &	name,
		const InputParameters &	params
	)

staticinherited

Helper to look up a functor name through the input parameter keys.

Parameters

name	The input parameter name that we are trying to deduce the functor name for
params	The input parameters object that we will be checking for parameters named `name`

Returns: The functor name

Definition at line 39 of file FunctorInterface.C.

{
  if (params.isParamValid(name))
  {
    if (params.have_parameter<MooseFunctorName>(name))
      return params.get<MooseFunctorName>(name);
    // variables, functor material properties, functions, and post-processors are also functors
    else if (params.have_parameter<MaterialPropertyName>(name))
      return params.get<MaterialPropertyName>(name);
    else if (params.have_parameter<VariableName>(name))
      return params.get<VariableName>(name);
    else if (params.have_parameter<std::vector<VariableName>>(name))
    {
      const auto & var_names = params.get<std::vector<VariableName>>(name);
      if (var_names.size() != 1)
        mooseError("We only support a single variable name for retrieving a functor");
      return var_names[0];
    }
    else if (params.have_parameter<NonlinearVariableName>(name))
      return params.get<NonlinearVariableName>(name);
    else if (params.have_parameter<FunctionName>(name))
      return params.get<FunctionName>(name);
    else if (params.have_parameter<PostprocessorName>(name))
      return params.get<PostprocessorName>(name);
    else
      mooseError("Invalid parameter type for retrieving a functor");
  }
  else
    return name;
}

Referenced by FunctorInterface::checkFunctorSupportsSideIntegration(), FunctorInterface::deduceFunctorName(), FunctorInterface::getFunctor(), and FunctorInterface::isFunctor().

◆ defaultFunctor() [1/5]

template<typename T >

const Moose::Functor< T > * FunctorInterface::defaultFunctor ( const std::string & name )

privateinherited

Helper function to parse default functor values.

This is implemented as a specialization for supported types and returns NULL in all other cases.

Definition at line 254 of file FunctorInterface.h.

{
  return nullptr;
}

◆ defaultFunctor() [2/5]

template<>

const Moose::Functor< Real > * FunctorInterface::defaultFunctor ( const std::string & name )

privateinherited

◆ defaultFunctor() [3/5]

template<>

const Moose::Functor< ADReal > * FunctorInterface::defaultFunctor ( const std::string & name )

privateinherited

◆ defaultFunctor() [4/5]

template<>

const Moose::Functor< Real > * FunctorInterface::defaultFunctor ( const std::string & name )

inherited

Definition at line 78 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;
 
  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_real_functors.emplace_back(std::make_unique<Moose::Functor<Real>>(
        std::make_unique<Moose::ConstantFunctor<Real>>(real_value)));
    auto & default_property = _default_real_functors.back();
    return default_property.get();
  }
 
  return nullptr;
}

◆ defaultFunctor() [5/5]

template<>

const Moose::Functor< ADReal > * FunctorInterface::defaultFunctor ( const std::string & name )

inherited

Definition at line 97 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;
 
  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_ad_real_functors.emplace_back(std::make_unique<Moose::Functor<ADReal>>(
        std::make_unique<Moose::ConstantFunctor<ADReal>>(real_value)));
    auto & default_property = _default_ad_real_functors.back();
    return default_property.get();
  }
 
  return nullptr;
}

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

◆ dot()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dot ( )

protectedvirtualinherited

The time derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 103 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDot();
  else
    return _variable->uDot();
}

◆ dotDot()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotDot ( )

protectedvirtualinherited

The second time derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 110 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDot();
  else
    return _variable->uDotDot();
}

◆ dotDotDu()

const VariableValue & MooseVariableInterface< Real >::dotDotDu ( )

protectedvirtualinherited

The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dotdot

Returns: The reference to be stored off and used later.

Definition at line 144 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDotDu();
  else
    return _variable->duDotDotDu();
}

◆ dotDotOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotDotOld ( )

protectedvirtualinherited

The old second time derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 124 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDotOld();
  else
    return _variable->uDotDotOld();
}

◆ dotDu()

const VariableValue & MooseVariableInterface< Real >::dotDu ( )

protectedvirtualinherited

The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dot

Returns: The reference to be stored off and used later.

Definition at line 134 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDu();
  else
    return _variable->duDotDu();
}

◆ dotOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::dotOld ( )

protectedvirtualinherited

The old time derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 117 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotOld();
  else
    return _variable->uDotOld();
}

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

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

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

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

◆ getDistribution() [1/2]

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

inherited

Get a distribution with a given name.

Parameters

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

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

Definition at line 41 of file DistributionInterface.C.

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

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

◆ getDistribution() [2/2]

template<typename T >

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

inherited

Definition at line 77 of file DistributionInterface.h.

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

◆ getDistributionByName() [1/2]

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

inherited

Get a distribution with a given name.

Parameters

name	The name of the distribution to retrieve

Returns: The distribution with name 'name'

Definition at line 48 of file DistributionInterface.C.

{
  return _dni_feproblem.getDistribution(name);
}

Referenced by RandomIC::RandomIC().

◆ getDistributionByName() [2/2]

template<typename T >

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

inherited

Definition at line 97 of file DistributionInterface.h.

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

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 73 of file SetupInterface.C.

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

◆ getFunction()

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

inherited

Get a function with a given name.

Parameters

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

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

Definition at line 34 of file FunctionInterface.C.

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

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

◆ getFunctionByName()

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

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 40 of file FunctionInterface.C.

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

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

◆ getFunctor() [1/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string & name )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file

Returns: The functor

Definition at line 217 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, _fi_tid);
}

Referenced by GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), and ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl().

◆ getFunctor() [2/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor	(	const std::string &	name,
		SubProblem &	subproblem
	)

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns: The functor

Definition at line 202 of file FunctorInterface.h.

{
  return getFunctor<T>(name, subproblem, _fi_tid);
}

◆ getFunctor() [3/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor	(	const std::string &	name,
		SubProblem &	subproblem,
		THREAD_ID	tid
	)

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the `subproblem`

Returns: The functor

Definition at line 193 of file FunctorInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
  return getFunctorByName<T>(functor_name, subproblem, tid);
}

◆ getFunctor() [4/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor	(	const std::string &	name,
		THREAD_ID	tid
	)

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
tid	The thread ID used to retrieve the functor from this interface's subproblem

Returns: The functor

Definition at line 209 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, tid);
}

◆ getFunctorByName() [1/2]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctorByName ( const std::string & name )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the actual name of the functor created in the input file

Returns: The functor

Definition at line 225 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctorByName<T>(name, *_fi_subproblem, _fi_tid);
}

◆ getFunctorByName() [2/2]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctorByName	(	const std::string &	name,
		SubProblem &	subproblem,
		THREAD_ID	tid
	)

privateinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The actual name of the functor to retrieve instead of the parameter name
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the `subproblem`

Returns: The functor

Definition at line 233 of file FunctorInterface.h.

{
  // Check if it's just a constant
  const auto * const default_functor = defaultFunctor<T>(name);
  if (default_functor)
    return *default_functor;
 
  return subproblem.getFunctor<T>(name, tid, _fi_name, isADObject());
}

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

◆ getKokkosFunction() [1/2]

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

inherited

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

Parameters

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

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

◆ getKokkosFunction() [2/2]

template<typename T >

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

inherited

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

Template Parameters

T	The Kokkos function type

Parameters

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

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

Definition at line 165 of file FunctionInterface.h.

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

◆ getKokkosFunctionByName() [1/2]

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

inherited

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

Parameters

name	The name of the Kokkos function to retrieve

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

◆ getKokkosFunctionByName() [2/2]

template<typename T >

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

inherited

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

Template Parameters

T	The Kokkos function type

Parameters

name	The name of the Kokkos function to retrieve

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

Definition at line 172 of file FunctionInterface.h.

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

◆ getKokkosFunctionByNameHelper()

const Moose::FunctionBase * FunctionInterface::getKokkosFunctionByNameHelper ( const FunctionName & name ) const

privateinherited

Helper function to retrieve a Kokkos function.

Referenced by FunctionInterface::getKokkosFunctionByName().

◆ getMatrixTags()

const std::set< TagID > & TaggingInterface::getMatrixTags ( MatrixTagsKey ) const

inlineinherited

Definition at line 140 of file TaggingInterface.h.

140{ return _matrix_tags; }

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

◆ getMooseVariableDependencies()

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

inlineinherited

Retrieve the set of MooseVariableFieldBase that this object depends on.

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

Definition at line 45 of file MooseVariableDependencyInterface.h.

  {
    return _moose_variable_dependencies;
  }

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

◆ getNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getNearestNodeLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary
	)

inherited

Retrieve the PenetrationLocator associated with the two sides.

Definition at line 85 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getNearestNodeLocator(primary, secondary);
}

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

◆ getPenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getPenetrationLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary,
		Order	order
	)

inherited

Retrieve the PenetrationLocator associated with the two sides.

Definition at line 67 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getPenetrationLocator(primary, secondary, order);
}

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

◆ getQuadratureNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getQuadratureNearestNodeLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary
	)

inherited

Retrieve a Quadrature NearestNodeLocator associated with the two sides.

A "Quadrature" version means that it's going to find the nearest nodes to each quadrature point on this boundary

Definition at line 93 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadratureNearestNodeLocator(primary, secondary);
}

◆ getQuadraturePenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getQuadraturePenetrationLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary,
		Order	order
	)

inherited

Retrieve the Quadrature PenetrationLocator associated with the two sides.

A "Quadrature" version means that it's going to find the penetration of each quadrature point on this boundary

Definition at line 76 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadraturePenetrationLocator(primary, secondary, order);
}

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

◆ getScatterVectorPostprocessorValue()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 119 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueByName()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 128 of file VectorPostprocessorInterface.C.

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

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

◆ getScatterVectorPostprocessorValueOld()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 135 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueOldByName()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 144 of file VectorPostprocessorInterface.C.

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

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

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

◆ getVectorPostprocessorByNameHelper()

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorByNameHelper	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name,
		bool	broadcast,
		std::size_t	t_index
	)		const

privateinherited

Helper function for extracting VPP data from ReporterData object.

Definition at line 282 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessorByName(name, vector_name);
  addVectorPostprocessorDependencyHelper(name);
 
  const ReporterMode mode = broadcast ? REPORTER_MODE_REPLICATED : REPORTER_MODE_ROOT;
  return _vpi_feproblem.getReporterData().getReporterValue<VectorPostprocessorValue>(
      VectorPostprocessorReporterName(name, vector_name), _vpi_moose_object, mode, t_index);
}

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueByName(), VectorPostprocessorInterface::getVectorPostprocessorValueByName(), VectorPostprocessorInterface::getVectorPostprocessorValueOldByName(), and VectorPostprocessorInterface::getVectorPostprocessorValueOldByName().

◆ getVectorPostprocessorContextByNameHelper()

const VectorPostprocessorContext< VectorPostprocessorValue > & VectorPostprocessorInterface::getVectorPostprocessorContextByNameHelper	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

privateinherited

Helper for getting the VPP context that handles scatter values.

Definition at line 297 of file VectorPostprocessorInterface.C.

{
  possiblyCheckHasVectorPostprocessorByName(name, vector_name);
  addVectorPostprocessorDependencyHelper(name);
 
  // The complete name of the store Reporter value
  const VectorPostprocessorReporterName r_name(name, vector_name);
 
  // Indicate the scatter value is desired, so the the VectorPostprocessorContext will do scatter
  _vpi_feproblem.getReporterData().getReporterValue<VectorPostprocessorValue>(
      r_name, _vpi_moose_object, REPORTER_MODE_VPP_SCATTER, 0);
 
  // Retrieve the VectorPostprocessorContext which contains the scattered value to be referenced
  const auto & context = _vpi_feproblem.getReporterData().getReporterContextBase(r_name);
  auto vpp_context_ptr =
      dynamic_cast<const VectorPostprocessorContext<VectorPostprocessorValue> *>(&context);
  mooseAssert(vpp_context_ptr, "Failed to get the VectorPostprocessorContext");
  return *vpp_context_ptr;
}

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueByName(), and VectorPostprocessorInterface::getScatterVectorPostprocessorValueOldByName().

◆ getVectorPostprocessorName()

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

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name The name of the VectorPostprocessor parameter

Returns: The name of the given VectorPostprocessor

Definition at line 216 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValue() [1/2]

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

inherited

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

Retrieve the value of a VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 49 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValue() [2/2]

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

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 79 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueByName() [1/2]

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

inherited

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

Retrieve the value of the VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 57 of file VectorPostprocessorInterface.C.

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

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

◆ getVectorPostprocessorValueByName() [2/2]

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

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 89 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 64 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 99 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOldByName() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 72 of file VectorPostprocessorInterface.C.

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

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld(), and VectorPostprocessorInterface::getVectorPostprocessorValueOld().

◆ getVectorPostprocessorValueOldByName() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 109 of file VectorPostprocessorInterface.C.

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

◆ getVectorTags()

const std::set< TagID > & TaggingInterface::getVectorTags ( VectorTagsKey ) const

inlineinherited

Definition at line 138 of file TaggingInterface.h.

138{ return _vector_tags; }

◆ gradient()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradient ( )

protectedvirtualinherited

The gradient of the variable this object is operating on.

This is computed by default and should already be available as _grad_u

Returns: The reference to be stored off and used later.

Definition at line 153 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSln();
}

◆ gradientOld()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradientOld ( )

protectedvirtualinherited

The old gradient of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 160 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOld();
}

◆ gradientOlder()

const OutputTools< Real >::VariableGradient & MooseVariableInterface< Real >::gradientOlder ( )

protectedvirtualinherited

The older gradient of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 167 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOlder();
}

◆ 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

◆ hasBoundary() [1/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryID & id ) const

inherited

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

Parameters

id	A BoundaryID to check

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

Definition at line 268 of file BoundaryRestrictable.C.

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

◆ hasBoundary() [2/5]

bool BoundaryRestrictable::hasBoundary ( const BoundaryName & name ) const

inherited

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

Parameters

name	A BoundaryName to check

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

Definition at line 254 of file BoundaryRestrictable.C.

{
  // Create a vector and utilize the getBoundaryIDs function, which
  // handles the ANY_BOUNDARY_ID (getBoundaryID does not)
  return hasBoundary(_bnd_mesh->getBoundaryIDs({name}));
}

Referenced by BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), NodePositions::initialize(), and AuxKernelBase::initialSetup().

◆ hasBoundary() [3/5]

bool BoundaryRestrictable::hasBoundary	(	const std::set< BoundaryID > &	ids,
		TEST_TYPE	type = `ALL`
	)		const

inherited

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

Parameters

ids	A std::set of BoundaryIDs to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

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

See also: isSubset

Definition at line 284 of file BoundaryRestrictable.C.

{
  // An empty input is assumed to be ANY_BOUNDARY_ID
  if (ids.empty() || ids.find(Moose::ANY_BOUNDARY_ID) != ids.end())
    return true;
 
  // All supplied IDs must match those of the object
  else if (type == ALL)
  {
    if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) != _bnd_ids.end())
      return true;
    else
      return std::includes(_bnd_ids.begin(), _bnd_ids.end(), ids.begin(), ids.end());
  }
  // Any of the supplied IDs must match those of the object
  else
  {
    // Loop through the supplied ids
    for (const auto & id : ids)
    {
      // Test the current supplied id
      bool test = hasBoundary(id);
 
      // If the id exists in the stored ids, then return true, otherwise
      if (test)
        return true;
    }
    return false;
  }
}

◆ hasBoundary() [4/5]

bool BoundaryRestrictable::hasBoundary	(	const std::vector< BoundaryID > &	ids,
		TEST_TYPE	type = `ALL`
	)		const

inherited

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

Parameters

ids	A vector of BoundaryIDs ids to check
type	A flag for the type of matching to perform: ALL requires that all supplied ids must match those of the object; ANY requires that any one of the supplied ids must match those of the object

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

Definition at line 277 of file BoundaryRestrictable.C.

{
  std::set<BoundaryID> ids_set(ids.begin(), ids.end());
  return hasBoundary(ids_set, type);
}

◆ hasBoundary() [5/5]

bool BoundaryRestrictable::hasBoundary ( const std::vector< BoundaryName > & names ) const

inherited

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

Parameters

names A vector of BoundaryNames to check

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

Definition at line 262 of file BoundaryRestrictable.C.

{
  return hasBoundary(_bnd_mesh->getBoundaryIDs(names));
}

◆ hasBoundaryMaterialProperty()

template<typename T , bool is_ad>

bool BoundaryRestrictable::hasBoundaryMaterialProperty ( const std::string & prop_name ) const

inherited

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

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

Template Parameters

T	The type of material property

Parameters

prop_name the name of the property to query

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

Definition at line 295 of file BoundaryRestrictable.h.

{
  // If you get here the supplied property is defined on all boundaries, but is still subject
  // existence in the MateialData class
  return hasBoundaryMaterialPropertyHelper(prop_name) &&
         _bnd_material_data.haveGenericProperty<T, is_ad>(prop_name);
}

◆ hasBoundaryMaterialPropertyHelper()

bool BoundaryRestrictable::hasBoundaryMaterialPropertyHelper ( const std::string & prop_name ) const

protectedinherited

A helper method to avoid circular #include problems.

See also: hasBoundaryMaterialProperty

Definition at line 345 of file BoundaryRestrictable.C.

{
  // Reference to MaterialWarehouse for testing and retrieving boundary ids
  const MaterialWarehouse & warehouse = _bnd_feproblem->getMaterialWarehouse();
 
  // Complete set of BoundaryIDs that this object is defined
  const std::set<BoundaryID> & ids =
      hasBoundary(Moose::ANY_BOUNDARY_ID) ? meshBoundaryIDs() : boundaryIDs();
 
  // Loop over each BoundaryID for this object
  for (const auto & id : ids)
  {
    // Storage of material properties that have been DECLARED on this BoundaryID
    std::set<std::string> declared_props;
 
    // If boundary materials exist, populated the set of properties that were declared
    if (warehouse.hasActiveBoundaryObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats =
          warehouse.getActiveBoundaryObjects(id);
      for (const auto & mat : mats)
      {
        const std::set<std::string> & mat_props = mat->getSuppliedItems();
        declared_props.insert(mat_props.begin(), mat_props.end());
      }
    }
 
    // If the supplied property is not in the list of properties on the current id, return false
    if (declared_props.find(prop_name) == declared_props.end())
      return false;
  }
 
  // If you get here the supplied property is defined on all boundaries
  return true;
}

Referenced by BoundaryRestrictable::hasBoundaryMaterialProperty().

◆ hasFaceSide()

bool FVBoundaryCondition::hasFaceSide	(	const FaceInfo &	fi,
		bool	fi_elem_side
	)		const

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 99 of file FVBoundaryCondition.C.

{
  const auto ft = fi.faceType(std::make_pair(_var.number(), _var.sys().number()));
  if (fi_elem_side)
    return ft == FaceInfo::VarFaceNeighbors::ELEM || ft == FaceInfo::VarFaceNeighbors::BOTH;
  else
    return ft == FaceInfo::VarFaceNeighbors::NEIGHBOR || ft == FaceInfo::VarFaceNeighbors::BOTH;
}

◆ hasFunction()

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

inherited

Determine if the function exists.

Parameters

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

Returns: True if the function exists

Definition at line 46 of file FunctionInterface.C.

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

◆ hasFunctionByName()

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

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 52 of file FunctionInterface.C.

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

Referenced by FunctionInterface::hasFunction().

◆ hasKokkosFunction()

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

inherited

Determine if the Kokkos function exists.

Parameters

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

Returns: True if the Kokkos function exists

◆ hasKokkosFunctionByName()

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

inherited

Determine if the Kokkos function exists.

Parameters

name	The name of the Kokkos function

Returns: True if the Kokkos function exists

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

◆ hasVectorPostprocessor() [1/2]

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

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

Definition at line 175 of file VectorPostprocessorInterface.C.

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

◆ hasVectorPostprocessor() [2/2]

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

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 151 of file VectorPostprocessorInterface.C.

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

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

◆ hasVectorPostprocessorByName() [1/2]

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

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

Definition at line 185 of file VectorPostprocessorInterface.C.

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

◆ hasVectorPostprocessorByName() [2/2]

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

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 162 of file VectorPostprocessorInterface.C.

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

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

◆ hasVectorTags()

bool TaggingInterface::hasVectorTags ( ) const

inlineinherited

Definition at line 136 of file TaggingInterface.h.

136{ return !_vector_tags.empty(); }

Referenced by Kernel::computeResidual().

◆ initializeBoundaryRestrictable()

void BoundaryRestrictable::initializeBoundaryRestrictable ( )

privateinherited

An initialization routine needed for dual constructors.

Definition at line 84 of file BoundaryRestrictable.C.

{
  // The name and id of the object
  const std::string & name = _moose_object.name();
 
  // If the mesh pointer is not defined, but FEProblemBase is, get it from there
  if (_bnd_feproblem != NULL && _bnd_mesh == NULL)
    _bnd_mesh = &_bnd_feproblem->mesh();
 
  // Check that the mesh pointer was defined, it is required for this class to operate
  if (_bnd_mesh == NULL)
    mooseError("The input parameters must contain a pointer to FEProblemBase via '_fe_problem' or "
               "a pointer to the MooseMesh via '_mesh'");
 
  // If the user supplies boundary IDs
  if (_moose_object.isParamValid("boundary"))
  {
    // Extract the blocks from the input
    _boundary_names = _moose_object.getParam<std::vector<BoundaryName>>("boundary");
 
    // Get the IDs from the supplied names
    _vec_ids = _bnd_mesh->getBoundaryIDs(_boundary_names, true);
 
    // Store the IDs, handling ANY_BOUNDARY_ID if supplied
    if (std::find(_boundary_names.begin(), _boundary_names.end(), "ANY_BOUNDARY_ID") !=
        _boundary_names.end())
      _bnd_ids.insert(Moose::ANY_BOUNDARY_ID);
    else
      _bnd_ids.insert(_vec_ids.begin(), _vec_ids.end());
  }
 
  // Produce error if the object is not allowed to be both block and boundary restricted
  if (!_bnd_dual_restrictable && !_bnd_ids.empty() && !_block_ids.empty())
    if (!_block_ids.empty() && _block_ids.find(Moose::ANY_BLOCK_ID) == _block_ids.end())
      _moose_object.paramError("boundary",
                               "Attempted to restrict the object '",
                               name,
                               "' to a boundary, but the object is already restricted by block(s)");
 
  // Store ANY_BOUNDARY_ID if empty
  if (_bnd_ids.empty())
  {
    _bnd_ids.insert(Moose::ANY_BOUNDARY_ID);
    _boundary_names = {"ANY_BOUNDARY_ID"};
  }
 
  // If this object is block restricted, check that defined blocks exist on the mesh
  if (_bnd_ids.find(Moose::ANY_BOUNDARY_ID) == _bnd_ids.end())
  {
    const std::set<BoundaryID> * valid_ids;
    const char * message_ptr = nullptr;
 
    if (_bnd_nodal)
    {
      valid_ids = &_bnd_mesh->meshNodesetIds();
      message_ptr = "node sets";
    }
    else
    {
      valid_ids = &_bnd_mesh->meshSidesetIds();
      message_ptr = "side sets";
    }
 
    std::vector<BoundaryID> diff;
 
    std::set_difference(_bnd_ids.begin(),
                        _bnd_ids.end(),
                        valid_ids->begin(),
                        valid_ids->end(),
                        std::back_inserter(diff));
 
    if (!diff.empty())
    {
      std::ostringstream msg;
      auto sep = " ";
      msg << "the following " << message_ptr << " (ids) do not exist on the mesh:";
      for (const auto & id : diff)
      {
        if (_boundary_names.size() > 0)
        {
          auto & name = _boundary_names.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) -
                                           _vec_ids.begin());
          if (std::to_string(id) != name)
            msg << sep << name << " (" << id << ")";
          else
            msg << sep << id;
        }
        else
          msg << sep << id;
        sep = ", ";
      }
 
      const auto & other_ids =
          _bnd_nodal ? _bnd_mesh->meshSidesetIds() : _bnd_mesh->meshNodesetIds();
      std::vector<BoundaryID> other_boundary_ids;
      std::set_intersection(diff.begin(),
                            diff.end(),
                            other_ids.begin(),
                            other_ids.end(),
                            std::back_inserter(other_boundary_ids));
      if (!other_boundary_ids.empty())
      {
        msg << "\n\nThe following boundary ";
        if (other_boundary_ids.size() == 1)
          msg << "id exists";
        else
          msg << "ids exist";
        if (other_boundary_ids.size() == 1)
          msg << " as " << (_bnd_nodal ? "a side set" : "a node set")
              << " but is being requested as " << (_bnd_nodal ? "a node set" : "a side set") << ":";
        else
          msg << " as " << (_bnd_nodal ? "side sets" : "node sets")
              << " but are being requested as " << (_bnd_nodal ? "node sets" : "side sets") << ":";
 
        sep = " ";
        for (const auto id : other_boundary_ids)
        {
          msg << sep << id;
          sep = ", ";
        }
 
        if (!_bnd_nodal)
          msg << "\n\nTry setting Mesh/construct_side_list_from_node_list=true if you want side "
                 "sets constructed from node sets.";
      }
 
      _moose_object.paramError("boundary", msg.str());
    }
  }
 
#ifdef MOOSE_KOKKOS_ENABLED
  if (_moose_object.isKokkosObject())
    _bnd_feproblem->addKokkosMeshInitializationHook(
        std::bind(&BoundaryRestrictable::initializeKokkosBoundaryRestrictable, this));
#endif
}

Referenced by BoundaryRestrictable::BoundaryRestrictable(), and BoundaryRestrictable::BoundaryRestrictable().

◆ initializeKokkosBoundaryRestrictable()

void BoundaryRestrictable::initializeKokkosBoundaryRestrictable ( )

privateinherited

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

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

◆ isADObject()

virtual bool ADFunctorInterface::isADObject ( ) const

inlineoverrideprivatevirtualinherited

Whether this interface is for an AD object.

Implements FunctorInterface.

Definition at line 34 of file ADFunctorInterface.h.

34{ return true; }

◆ isBoundarySubset() [1/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::set< BoundaryID > & ids ) const

inherited

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

Parameters

ids	A std::set of boundaries to check

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

See also: hasBoundary

Definition at line 316 of file BoundaryRestrictable.C.

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

Referenced by BoundaryRestrictable::isBoundarySubset().

◆ isBoundarySubset() [2/2]

bool BoundaryRestrictable::isBoundarySubset ( const std::vector< BoundaryID > & ids ) const

inherited

Definition at line 332 of file BoundaryRestrictable.C.

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

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

◆ isFunctor() [1/2]

bool FunctorInterface::isFunctor ( const std::string & name ) const

protectedinherited

Checks the subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, \emph not the actual name of the functor created in the input file

Returns: Whether the subproblem has the specified functor

Definition at line 124 of file FunctorInterface.C.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return isFunctor(name, *_fi_subproblem);
}

Referenced by FunctorInterface::isFunctor().

◆ isFunctor() [2/2]

bool FunctorInterface::isFunctor	(	const std::string &	name,
		const SubProblem &	subproblem
	)		const

protectedinherited

Checks the passed-in subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns: Whether the subproblem has the specified functor

Definition at line 115 of file FunctorInterface.C.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
 
  return subproblem.hasFunctor(functor_name, _fi_tid);
}

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

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

◆ isMatrixTagged()

bool TaggingInterface::isMatrixTagged ( )

inlineinherited

Definition at line 134 of file TaggingInterface.h.

134{ return _matrix_tags.size() > 0; }

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

◆ isVectorPostprocessorDistributed()

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

inherited

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

Definition at line 203 of file VectorPostprocessorInterface.C.

{
  return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
}

◆ isVectorPostprocessorDistributedByName()

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

inherited

Definition at line 209 of file VectorPostprocessorInterface.C.

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

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

◆ isVectorTagged()

bool TaggingInterface::isVectorTagged ( )

inlineinherited

Definition at line 132 of file TaggingInterface.h.

132{ return _vector_tags.size() > 0; }

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

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

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

Definition at line 58 of file SetupInterface.C.

59{

60}

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

◆ kokkosBoundaryElementSideID()

KOKKOS_FUNCTION auto BoundaryRestrictable::kokkosBoundaryElementSideID ( Moose::Kokkos::ThreadID tid ) const

inlineprotectedinherited

Get the contiguous element ID - side index pair this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns: The contiguous element ID - side index pair

Definition at line 273 of file BoundaryRestrictable.h.

  {
    return _kokkos_element_side_ids[tid];
  }

◆ kokkosBoundaryNodeID()

KOKKOS_FUNCTION ContiguousNodeID BoundaryRestrictable::kokkosBoundaryNodeID ( Moose::Kokkos::ThreadID tid ) const

inlineprotectedinherited

Get the contiguous node ID this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns: The contiguous node ID

Definition at line 264 of file BoundaryRestrictable.h.

  {
    return _kokkos_node_ids[tid];
  }

◆ makeCDFace()

Moose::FaceArg FaceArgProducerInterface::makeCDFace	(	const FaceInfo &	fi,
		const bool	correct_skewness = `false`
	)		const

inlineinherited

Make a functor face argument with a central differencing limiter, e.g.

compose a face argument that will tell functors to perform (possibly skew-corrected) linear interpolations from cell center values to faces

Parameters

fi	the face information
correct_skewness	whether to apply skew correction

Returns: a face argument for functors

Definition at line 62 of file FaceArgInterface.h.

{
  return makeFace(fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness);
}

Referenced by LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), LinearFVAnisotropicDiffusion::faceDiffusionTensor(), and LinearFVDiffusion::faceDiffusivity().

◆ makeElemArg()

Moose::ElemArg FunctorInterface::makeElemArg	(	const Elem *	elem,
		bool	correct_skewnewss = `false`
	)		const

protectedinherited

Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.

Definition at line 131 of file FunctorInterface.C.

{
  return {elem, correct_skewness};
}

Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVReaction::computeMatrixContribution(), LinearFVTimeDerivative::computeMatrixContribution(), FVCoupledForce::computeQpResidual(), FVFunctorTimeKernel::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), LinearFVSource::computeRightHandSideContribution(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), LinearFVAnisotropicDiffusion::faceDiffusionTensor(), FunctorTimes::initialize(), and LinearFVTimeDerivative::setCurrentElemInfo().

◆ makeFace()

Moose::FaceArg FaceArgProducerInterface::makeFace	(	const FaceInfo &	fi,
		const Moose::FV::LimiterType	limiter_type,
		const bool	elem_is_upwind,
		const bool	correct_skewness = `false`,
		const Moose::StateArg *	state_limiter = `nullptr`
	)		const

inherited

Create a functor face argument from provided component arguments.

Parameters

fi	the face information object
limiter_type	the limiter that defines how to perform interpolations to the faces
elem_is_upwind	whether the face information element is the upwind element (the value of this doesn't matter when the limiter type is CentralDifference)
correct_skewness	whether to apply skew correction

Returns: the functor face argument

Definition at line 13 of file FaceArgInterface.C.

{
  const bool defined_on_elem_side = hasFaceSide(fi, true);
  const bool defined_on_neighbor_side = hasFaceSide(fi, false);
  const Elem * const elem = defined_on_elem_side && defined_on_neighbor_side
                                ? nullptr
                                : (defined_on_elem_side ? &fi.elem() : fi.neighborPtr());
 
  if (!defined_on_elem_side && !defined_on_neighbor_side)
    mooseError("No definition on either side");
 
  return {&fi, limiter_type, elem_is_upwind, correct_skewness, elem, state_limiter};
}

Referenced by FVAdvection::computeQpResidual(), FVDivergence::computeQpResidual(), FVMatAdvection::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FaceArgProducerInterface::makeCDFace(), LinearFVBoundaryCondition::singleSidedFaceArg(), LinearFVFluxKernel::singleSidedFaceArg(), FVBoundaryCondition::singleSidedFaceArg(), and FVFluxKernel::singleSidedFaceArg().

◆ meshBoundaryIDs()

const std::set< BoundaryID > & BoundaryRestrictable::meshBoundaryIDs ( ) const

inherited

Returns the set of all boundary ids for the entire mesh.

Returns: A const reference the the boundary ids for the entire mesh

Definition at line 339 of file BoundaryRestrictable.C.

{
  return _bnd_mesh->getBoundaryIDs();
}

Referenced by BoundaryRestrictable::hasBoundaryMaterialPropertyHelper().

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

◆ mooseLinearVariableFV()

MooseLinearVariableFV< Real > * MooseVariableInterface< Real >::mooseLinearVariableFV ( ) const

inherited

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 70 of file MooseVariableInterface.C.

{
  if (!_linear_fv_variable)
    mooseError(
        "The variable defined in ", _moose_object.name(), " is not a MooseLinearVariableFV!");
  return _linear_fv_variable;
}

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

◆ mooseVariable()

MooseVariableFE< Real > * MooseVariableInterface< Real >::mooseVariable ( ) const

inherited

Return the MooseVariableFE object that this interface acts on.

Definition at line 60 of file MooseVariableInterface.C.

{
  if (!_variable)
    mooseError(
        "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
  return _variable;
}

◆ mooseVariableBase()

MooseVariableBase * MooseVariableInterface< Real >::mooseVariableBase ( ) const

inlineinherited

Get the variable that this object is using.

Returns: The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

50{ return _var; };

MooseVariableInterface< Real >::_var

MooseVariableBase * _var

The variable this object is acting on.

Definition MooseVariableInterface.h:226

◆ mooseVariableField()

MooseVariableField< Real > & MooseVariableInterface< Real >::mooseVariableField ( )

inherited

Return the MooseVariableField object that this interface acts on.

Definition at line 55 of file MooseVariableInterface.C.

{
  return *_field_variable;
}

◆ mooseVariableFV()

MooseVariableFV< Real > * MooseVariableInterface< Real >::mooseVariableFV ( ) const

inherited

Return the MooseVariableFV object that this interface acts on.

Definition at line 65 of file MooseVariableInterface.C.

{
  if (!_fv_variable)
    mooseError("_fv_variable is null in ",
               _moose_object.name(),
               ". Did you forget to set fv = true in the Variables block?");
  return _fv_variable;
}

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

◆ numBoundaryIDs()

unsigned int BoundaryRestrictable::numBoundaryIDs ( ) const

inherited

Return the number of boundaries for this object.

Returns: The number of boundary ids

Definition at line 236 of file BoundaryRestrictable.C.

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

Referenced by SidesetInfoVectorPostprocessor::initialize().

◆ numKokkosBoundaryNodes()

KOKKOS_FUNCTION dof_id_type BoundaryRestrictable::numKokkosBoundaryNodes ( ) const

inlineprotectedinherited

Get the number of nodes this Kokkos object is operating on.

Returns: The number of nodes local to this process

Definition at line 250 of file BoundaryRestrictable.h.

250{ return _kokkos_node_ids.size(); }

Moose::Kokkos::ArrayBase::size

KOKKOS_FUNCTION index_type size() const

Get the total array size.

Definition KokkosArray.h:294

Referenced by Moose::Kokkos::NodalReducer::numReducerThreads(), and Moose::Kokkos::NodalUserObject::numUserObjectThreads().

◆ numKokkosBoundarySides()

KOKKOS_FUNCTION dof_id_type BoundaryRestrictable::numKokkosBoundarySides ( ) const

inlineprotectedinherited

Get the number of sides this Kokkos object is operating on.

Returns: The number of sides local to this process

Definition at line 255 of file BoundaryRestrictable.h.

  {
    return _kokkos_element_side_ids.size();
  }

Referenced by Moose::Kokkos::SideReducer::numReducerThreads(), and Moose::Kokkos::SideUserObject::numUserObjectThreads().

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

◆ possiblyCheckHasVectorPostprocessor()

void VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

privateinherited

Helpers for "possibly" checking if a vpp exists.

This is only able to check for existance after all vpps have been added (after the task creating them has been called). If called before said task, this will do nothing, hence the "possibly". This allows us to have errors reported directly by the object requesting the vpp instead of through a system with less context.

Definition at line 241 of file VectorPostprocessorInterface.C.

{
  // Can't do checking if vpps have not been added
  if (!vectorPostprocessorsAdded())
    return;
 
  if (!hasVectorPostprocessor(param_name))
    _vpi_moose_object.paramError(param_name,
                                 "A VectorPostprocessor with the name \"",
                                 getVectorPostprocessorName(param_name),
                                 "\" was not found.");
  if (!hasVectorPostprocessor(param_name, vector_name))
    _vpi_moose_object.paramError(param_name,
                                 "The VectorPostprocessor \"",
                                 getVectorPostprocessorName(param_name),
                                 "\" does not have a vector named \"",
                                 vector_name,
                                 "\".");
}

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

◆ possiblyCheckHasVectorPostprocessorByName()

void VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

privateinherited

Definition at line 263 of file VectorPostprocessorInterface.C.

{
  // Can't do checking if vpps have not been added
  if (!vectorPostprocessorsAdded())
    return;
 
  if (!hasVectorPostprocessorByName(name))
    _vpi_moose_object.mooseError(
        "A VectorPostprocessor with the name \"", name, "\" was not found.");
  if (!hasVectorPostprocessorByName(name, vector_name))
    _vpi_moose_object.mooseError("The VectorPostprocessor \"",
                                 name,
                                 "\" does not have a vector named \"",
                                 vector_name,
                                 "\".");
}

Referenced by VectorPostprocessorInterface::getVectorPostprocessorByNameHelper(), and VectorPostprocessorInterface::getVectorPostprocessorContextByNameHelper().

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

◆ prepareMatrixTag() [1/2]

void TaggingInterface::prepareMatrixTag	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar
	)

protectedinherited

Prepare data for computing element jacobian according to the active tags.

Jacobian blocks for different tags will be extracted from Assembly. A local Jacobian will be zeroed. It should be called right before the local element matrix is computed.

Definition at line 293 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] = &assembly.jacobianBlock(ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
 
  _local_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
}

◆ prepareMatrixTag() [2/2]

void TaggingInterface::prepareMatrixTag	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		DenseMatrix< Number > &	k
	)		const

protectedinherited

Definition at line 305 of file TaggingInterface.C.

{
  mooseAssert(!_matrix_tags.empty(), "No matrix tags exist");
  const auto & ij_mat =
      assembly.jacobianBlock(ivar, jvar, Assembly::LocalDataKey{}, *_matrix_tags.begin());
  k.resize(ij_mat.m(), ij_mat.n());
}

◆ prepareMatrixTagLower()

void TaggingInterface::prepareMatrixTagLower	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		Moose::ConstraintJacobianType	type
	)

protectedinherited

Prepare data for computing the jacobian according to the active tags for mortar.

Jacobian blocks for different tags will be extracted from Assembly. A local Jacobian will be zeroed. It should be called right before the local element matrix is computed.

Definition at line 361 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] =
        &assembly.jacobianBlockMortar(type, ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
 
  _local_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
}

Referenced by MortarConstraint::computeJacobian(), ArrayDGLowerDKernel::computeLowerDJacobian(), DGLowerDKernel::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDJacobian(), LowerDIntegratedBC::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), and DGLowerDKernel::computeOffDiagLowerDJacobian().

◆ prepareMatrixTagNeighbor() [1/2]

void TaggingInterface::prepareMatrixTagNeighbor	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		Moose::DGJacobianType	type
	)

protectedinherited

Prepare data for computing element jacobian according to the active tags for DG and interface kernels.

Jacobian blocks for different tags will be extracted from Assembly. A local Jacobian will be zeroed. It should be called right before the local element matrix is computed.

Definition at line 332 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] =
        &assembly.jacobianBlockNeighbor(type, ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
 
  _local_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
}

Referenced by ElemElemConstraint::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), NodeElemConstraint::computeJacobian(), NodeFaceConstraint::computeJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), NodeElemConstraint::computeOffDiagJacobian(), and NodeFaceConstraint::computeOffDiagJacobian().

◆ prepareMatrixTagNeighbor() [2/2]

void TaggingInterface::prepareMatrixTagNeighbor	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar,
		Moose::DGJacobianType	type,
		DenseMatrix< Number > &	k
	)		const

protectedinherited

Definition at line 348 of file TaggingInterface.C.

{
  mooseAssert(!_matrix_tags.empty(), "No matrix tags exist");
  const auto & ij_mat = assembly.jacobianBlockNeighbor(
      type, ivar, jvar, Assembly::LocalDataKey{}, *_matrix_tags.begin());
  k.resize(ij_mat.m(), ij_mat.n());
}

◆ prepareMatrixTagNonlocal()

void TaggingInterface::prepareMatrixTagNonlocal	(	Assembly &	assembly,
		unsigned int	ivar,
		unsigned int	jvar
	)

protectedinherited

Prepare data for computing nonlocal element jacobian according to the active tags.

Jacobian blocks for different tags will be extracted from Assembly. A nonlocal Jacobian will be zeroed. It should be called right before the nonlocal element matrix is computed.

Definition at line 317 of file TaggingInterface.C.

{
  _ke_blocks.resize(_matrix_tags.size());
  mooseAssert(_matrix_tags.size() >= 1, "we need at least one active tag");
  auto mat_vector = _matrix_tags.begin();
  for (MooseIndex(_matrix_tags) i = 0; i < _matrix_tags.size(); i++, ++mat_vector)
    _ke_blocks[i] =
        &assembly.jacobianBlockNonlocal(ivar, jvar, Assembly::LocalDataKey{}, *mat_vector);
 
  _nonlocal_ke.resize(_ke_blocks[0]->m(), _ke_blocks[0]->n());
}

Referenced by NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), and NonlocalKernel::computeNonlocalOffDiagJacobian().

◆ prepareVectorTag() [1/2]

void TaggingInterface::prepareVectorTag	(	Assembly &	assembly,
		unsigned int	ivar
	)

protectedinherited

Prepare data for computing element residual according to active tags.

Residual blocks for different tags will be extracted from Assembly. A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 206 of file TaggingInterface.C.

{
  prepareVectorTagInternal(assembly, ivar, _vector_tags, _abs_vector_tags);
}

◆ prepareVectorTag() [2/2]

void TaggingInterface::prepareVectorTag	(	Assembly &	assembly,
		unsigned int	ivar,
		ResidualTagType	tag_type
	)

protectedinherited

Prepare vector tags in a reference residual problem context.

Parameters

Assembly	The assembly object that we obtain the local residual blocks from
ivar	The variable which we are retrieving the local residual blocks for
ref_problem	A pointer to a reference residual problem. This can be a nullptr
tag_type	What type of tags to prepare

Definition at line 212 of file TaggingInterface.C.

{
  if (tag_type == ResidualTagType::NonReference)
    prepareVectorTagInternal(assembly, ivar, _non_ref_vector_tags, _non_ref_abs_vector_tags);
  else
    prepareVectorTagInternal(assembly, ivar, _ref_vector_tags, _ref_abs_vector_tags);
}

◆ prepareVectorTagInternal()

void TaggingInterface::prepareVectorTagInternal	(	Assembly &	assembly,
		unsigned int	ivar,
		const std::set< TagID > &	vector_tags,
		const std::set< TagID > &	absolute_value_vector_tags
	)

privateinherited

Prepare data for computing element residual according to the specified tags Residual blocks for different tags will be extracted from Assembly.

A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 223 of file TaggingInterface.C.

{
  auto prepare = [this, ivar, &assembly](auto & re_blocks, const auto & tags)
  {
    re_blocks.clear();
    re_blocks.reserve(tags.size());
    for (const auto tag_id : tags)
    {
      const auto & tag = _subproblem.getVectorTag(tag_id);
      re_blocks.push_back(&assembly.residualBlock(ivar, Assembly::LocalDataKey{}, tag._type_id));
    }
  };
 
  prepare(_re_blocks, vector_tags);
  prepare(_absre_blocks, absolute_value_vector_tags);
 
  _local_re.resize(_re_blocks.empty()
                       ? (_absre_blocks.empty() ? std::size_t(0) : _absre_blocks[0]->size())
                       : _re_blocks[0]->size());
}

Referenced by TaggingInterface::prepareVectorTag(), and TaggingInterface::prepareVectorTag().

◆ prepareVectorTagLower()

void TaggingInterface::prepareVectorTagLower	(	Assembly &	assembly,
		unsigned int	ivar
	)

protectedinherited

Prepare data for computing the residual according to active tags for mortar constraints.

Residual blocks for different tags will be extracted from Assembly. A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 271 of file TaggingInterface.C.

{
  _re_blocks.resize(_vector_tags.size());
  mooseAssert(_vector_tags.size() >= 1, "we need at least one active tag");
  auto vector_tag = _vector_tags.begin();
  for (MooseIndex(_vector_tags) i = 0; i < _vector_tags.size(); i++, ++vector_tag)
  {
    const VectorTag & tag = _subproblem.getVectorTag(*vector_tag);
    _re_blocks[i] = &assembly.residualBlockLower(ivar, Assembly::LocalDataKey{}, tag._type_id);
  }
  _local_re.resize(_re_blocks[0]->size());
 
  _absre_blocks.resize(_abs_vector_tags.size());
  vector_tag = _abs_vector_tags.begin();
  for (MooseIndex(_abs_vector_tags) i = 0; i < _abs_vector_tags.size(); i++, ++vector_tag)
  {
    const VectorTag & tag = _subproblem.getVectorTag(*vector_tag);
    _absre_blocks[i] = &assembly.residualBlockLower(ivar, Assembly::LocalDataKey{}, tag._type_id);
  }
}

Referenced by ArrayDGLowerDKernel::computeLowerDResidual(), DGLowerDKernel::computeLowerDResidual(), ArrayLowerDIntegratedBC::computeResidual(), LowerDIntegratedBC::computeResidual(), ADMortarConstraint::computeResidual(), and MortarConstraint::computeResidual().

◆ prepareVectorTagNeighbor()

void TaggingInterface::prepareVectorTagNeighbor	(	Assembly &	assembly,
		unsigned int	ivar
	)

protectedinherited

Prepare data for computing element residual the according to active tags for DG and interface kernels.

Residual blocks for different tags will be extracted from Assembly. A local residual will be zeroed. It should be called right before the local element vector is computed.

Definition at line 248 of file TaggingInterface.C.

{
  _re_blocks.resize(_vector_tags.size());
  mooseAssert(_vector_tags.size() >= 1, "we need at least one active tag");
  auto vector_tag = _vector_tags.begin();
  for (MooseIndex(_vector_tags) i = 0; i < _vector_tags.size(); i++, ++vector_tag)
  {
    const VectorTag & tag = _subproblem.getVectorTag(*vector_tag);
    _re_blocks[i] = &assembly.residualBlockNeighbor(ivar, Assembly::LocalDataKey{}, tag._type_id);
  }
  _local_re.resize(_re_blocks[0]->size());
 
  _absre_blocks.resize(_abs_vector_tags.size());
  vector_tag = _abs_vector_tags.begin();
  for (MooseIndex(_abs_vector_tags) i = 0; i < _abs_vector_tags.size(); i++, ++vector_tag)
  {
    const VectorTag & tag = _subproblem.getVectorTag(*vector_tag);
    _absre_blocks[i] =
        &assembly.residualBlockNeighbor(ivar, Assembly::LocalDataKey{}, tag._type_id);
  }
}

Referenced by FVInterfaceKernel::addResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), ADDGKernel::computeElemNeighResidual(), NodeElemConstraint::computeResidual(), NodeFaceConstraint::computeResidual(), FVFluxBC::computeResidual(), FVFluxKernel::computeResidual(), ADMortarConstraint::computeResidual(), and MortarConstraint::computeResidual().

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

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

◆ requiresGeometricSearch()

bool GeometricSearchInterface::requiresGeometricSearch ( ) const

inlineinherited

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 73 of file GeometricSearchInterface.h.

73{ return _requires_geometric_search; }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

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

Definition at line 63 of file SetupInterface.C.

64{

65}

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

◆ restricted()

bool BoundaryRestrictable::restricted ( const std::set< BoundaryID > & ids )

staticinherited

Helper for determining if the object is boundary restricted.

This is needed for the MaterialPropertyInterface.

Definition at line 248 of file BoundaryRestrictable.C.

{
  return ids.find(Moose::ANY_BOUNDARY_ID) == ids.end();
}

Referenced by BoundaryRestrictable::boundaryRestricted(), and moose::internal::boundaryRestricted().

◆ second()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::second ( )

protectedvirtualinherited

The second derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 174 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSln();
}

◆ secondOld()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::secondOld ( )

protectedvirtualinherited

The old second derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 181 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOld();
}

◆ secondOlder()

const OutputTools< Real >::VariableSecond & MooseVariableInterface< Real >::secondOlder ( )

protectedvirtualinherited

The older second derivative of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 188 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOlder();
}

◆ secondPhi()

const OutputTools< Real >::VariablePhiSecond & MooseVariableInterface< Real >::secondPhi ( )

protectedvirtualinherited

The second derivative of the trial function.

Returns: The reference to be stored off and used later.

Definition at line 211 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhi(*_variable);
}

◆ secondPhiFace()

const OutputTools< Real >::VariablePhiSecond & MooseVariableInterface< Real >::secondPhiFace ( )

protectedvirtualinherited

The second derivative of the trial function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the trial function function on the boundary.

Returns: The reference to be stored off and used later.

Definition at line 220 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhiFace(*_variable);
}

◆ secondTest()

const OutputTools< Real >::VariableTestSecond & MooseVariableInterface< Real >::secondTest ( )

protectedvirtualinherited

The second derivative of the test function.

Returns: The reference to be stored off and used later.

Definition at line 195 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhi();
}

◆ secondTestFace()

const OutputTools< Real >::VariableTestSecond & MooseVariableInterface< Real >::secondTestFace ( )

protectedvirtualinherited

The second derivative of the test function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the test function function on the boundary.

Returns: The reference to be stored off and used later.

Definition at line 204 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhiFace();
}

◆ setResidual() [1/3]

template<typename T >

void TaggingInterface::setResidual	(	SystemBase &	sys,
		const T &	residual,
		MooseVariableFE< T > &	var
	)

protectedinherited

Set residual using the variables' insertion API.

Definition at line 662 of file TaggingInterface.h.

{
  for (const auto tag_id : _vector_tags)
    if (sys.hasVector(tag_id))
      var.insertNodalValue(sys.getVector(tag_id), residual);
}

Referenced by ArrayNodalBC::computeResidual(), NodalBC::computeResidual(), and VectorNodalBC::computeResidual().

◆ setResidual() [2/3]

void TaggingInterface::setResidual	(	SystemBase &	sys,
		Real	residual,
		dof_id_type	dof_index
	)

inlineprotectedinherited

Set residual at a specified degree of freedom index.

Definition at line 670 of file TaggingInterface.h.

{
  for (const auto tag_id : _vector_tags)
    if (sys.hasVector(tag_id))
      sys.getVector(tag_id).set(dof_index, residual);
}

◆ setResidual() [3/3]

template<typename SetResidualFunctor >

void TaggingInterface::setResidual	(	SystemBase &	sys,
		SetResidualFunctor	set_residual_functor
	)

protectedinherited

Set residuals using the provided functor.

Definition at line 679 of file TaggingInterface.h.

{
  for (const auto tag_id : _vector_tags)
    if (sys.hasVector(tag_id))
      set_residual_functor(sys.getVector(tag_id));
}

◆ singleSidedFaceArg()

Moose::FaceArg FVBoundaryCondition::singleSidedFaceArg	(	const FaceInfo *	fi = `nullptr`,
		Moose::FV::LimiterType	limiter_type = `Moose::FV::LimiterType::CentralDifference`,
		bool	correct_skewness = `false`,
		const Moose::StateArg *	state_limiter = `nullptr`
	)		const

protectedinherited

Determine the single sided face argument when evaluating a functor on a face.

This is used to perform evaluations of material properties with the actual face values of their dependences, rather than interpolate the material property to the boundary.

Parameters

fi	the FaceInfo for this face
limiter_type	the limiter type, to be specified if more than the default average interpolation is required for the parameters of the functor
correct_skewness	whether to perform skew correction at the face

Definition at line 87 of file FVBoundaryCondition.C.

{
  if (!fi)
    fi = _face_info;
 
  return makeFace(*fi, limiter_type, true, correct_skewness, state_limiter);
}

Referenced by FVConstantScalarOutflowBC::computeQpResidual(), and FVFunctorNeumannBC::computeQpResidual().

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

◆ subProblem()

const SubProblem & FVBoundaryCondition::subProblem ( ) const

inlineinherited

Get a reference to the subproblem.

Returns: Reference to SubProblem

Definition at line 77 of file FVBoundaryCondition.h.

77{ return _subproblem; }

FVBoundaryCondition::_subproblem

SubProblem & _subproblem

Reference to SubProblem.

Definition FVBoundaryCondition.h:102

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

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

Definition at line 53 of file SetupInterface.C.

54{

55}

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< OutputType >::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);
}

◆ useMatrixTag() [1/2]

void TaggingInterface::useMatrixTag	(	const TagName &	tag_name,
		MatrixTagsKey
	)

inherited

Definition at line 179 of file TaggingInterface.C.

{
  if (!_subproblem.matrixTagExists(tag_name))
    mooseError("Matrix tag ", tag_name, " does not exist in system");
 
  _matrix_tags.insert(_subproblem.getMatrixTagID(tag_name));
}

◆ useMatrixTag() [2/2]

void TaggingInterface::useMatrixTag	(	TagID	tag_id,
		MatrixTagsKey
	)

inherited

Definition at line 197 of file TaggingInterface.C.

{
  if (!_subproblem.matrixTagExists(tag_id))
    mooseError("Matrix tag ", tag_id, " does not exist in system");
 
  _matrix_tags.insert(tag_id);
}

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

◆ useVectorTag() [1/2]

void TaggingInterface::useVectorTag	(	const TagName &	tag_name,
		VectorTagsKey
	)

inherited

Definition at line 170 of file TaggingInterface.C.

{
  if (!_subproblem.vectorTagExists(tag_name))
    mooseError("Vector tag ", tag_name, " does not exist in system");
 
  _vector_tags.insert(_subproblem.getVectorTagID(tag_name));
}

◆ useVectorTag() [2/2]

void TaggingInterface::useVectorTag	(	TagID	tag_id,
		VectorTagsKey
	)

inherited

Definition at line 188 of file TaggingInterface.C.

{
  if (!_subproblem.vectorTagExists(tag_id))
    mooseError("Vector tag ", tag_id, " does not exist in system");
 
  _vector_tags.insert(tag_id);
}

◆ validParams()

InputParameters FVPostprocessorDirichletBC::validParams ( )

static

Definition at line 15 of file FVPostprocessorDirichletBC.C.

{
  InputParameters params = FVDirichletBCBase::validParams();
  params.addClassDescription("Defines a Dirichlet boundary condition for finite volume method.");
  params.addRequiredParam<PostprocessorName>(
      "postprocessor", "The postprocessor to set the value to on the boundary.");
  return params;
}

◆ value()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::value ( )

protectedvirtualinherited

The value of the variable this object is operating on.

This is computed by default and should already be available as _u

Returns: The reference to be stored off and used later.

Definition at line 82 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValues();
  else
    return _variable->sln();
}

◆ valueOld()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::valueOld ( )

protectedvirtualinherited

The old value of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 89 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOld();
  else
    return _variable->slnOld();
}

◆ valueOlder()

const OutputTools< Real >::VariableValue & MooseVariableInterface< Real >::valueOlder ( )

protectedvirtualinherited

The older value of the variable this object is operating on.

Returns: The reference to be stored off and used later.

Definition at line 96 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOlder();
  else
    return _variable->slnOlder();
}

◆ variable()

const MooseVariableFV< Real > & FVBoundaryCondition::variable ( ) const

inlineinherited

Definition at line 79 of file FVBoundaryCondition.h.

79{ return _var; }

◆ vectorPostprocessorsAdded()

bool VectorPostprocessorInterface::vectorPostprocessorsAdded ( ) const

privateinherited

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

Definition at line 319 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getMooseApp().actionWarehouse().isTaskComplete("add_vector_postprocessor");
}

Referenced by VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::hasVectorPostprocessorByName(), VectorPostprocessorInterface::hasVectorPostprocessorByName(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName().

Member Data Documentation

◆ _abs_vector_tags

std::set<TagID> TaggingInterface::_abs_vector_tags

privateinherited

The absolute value residual tag ids.

Definition at line 438 of file TaggingInterface.h.

Referenced by TaggingInterface::addResiduals(), TaggingInterface::addResidualsWithoutConstraints(), TaggingInterface::prepareVectorTag(), TaggingInterface::prepareVectorTagLower(), TaggingInterface::prepareVectorTagNeighbor(), and TaggingInterface::TaggingInterface().

◆ _absolute_residuals

std::vector<Real> TaggingInterface::_absolute_residuals

privateinherited

A container to hold absolute values of residuals passed into addResiduals.

We maintain this data member to avoid constant dynamic heap allocations

Definition at line 478 of file TaggingInterface.h.

Referenced by TaggingInterface::addResiduals(), and TaggingInterface::addResidualsWithoutConstraints().

◆ _absre_blocks

std::vector<DenseVector<Number> *> TaggingInterface::_absre_blocks

privateinherited

Residual blocks for absolute value residual tags.

Definition at line 471 of file TaggingInterface.h.

Referenced by TaggingInterface::accumulateTaggedLocalResidual(), TaggingInterface::assignTaggedLocalResidual(), TaggingInterface::prepareVectorTagInternal(), TaggingInterface::prepareVectorTagLower(), TaggingInterface::prepareVectorTagNeighbor(), and TaggingInterface::TaggingInterface().

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

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

◆ _assembly

Assembly& FVBoundaryCondition::_assembly

protectedinherited

Reference to assembly.

Definition at line 114 of file FVBoundaryCondition.h.

Referenced by FVFluxBC::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeResidual(), and FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual().

◆ _block_ids

const std::set<SubdomainID>& BoundaryRestrictable::_block_ids

privateinherited

Reference to the block_ids, defaults to an empty set if not provided.

Definition at line 215 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _bnd_dual_restrictable

const bool BoundaryRestrictable::_bnd_dual_restrictable

privateinherited

Flag for allowing dual restriction with BlockRestrictable.

Definition at line 209 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _bnd_feproblem

FEProblemBase* BoundaryRestrictable::_bnd_feproblem

privateinherited

Pointer to FEProblemBase.

Definition at line 194 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), and BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _bnd_ids

std::set<BoundaryID> BoundaryRestrictable::_bnd_ids

privateinherited

Set of the boundary ids.

Definition at line 200 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::boundaryIDs(), BoundaryRestrictable::boundaryRestricted(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::initializeBoundaryRestrictable(), BoundaryRestrictable::isBoundarySubset(), and BoundaryRestrictable::numBoundaryIDs().

◆ _bnd_material_data

const MaterialData& BoundaryRestrictable::_bnd_material_data

privateinherited

Pointer to MaterialData for boundary (.

See also: hasBoundaryMaterialProperty)

Definition at line 221 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::hasBoundaryMaterialProperty().

◆ _bnd_mesh

MooseMesh* BoundaryRestrictable::_bnd_mesh

privateinherited

Point to mesh.

Definition at line 197 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::hasBoundary(), BoundaryRestrictable::initializeBoundaryRestrictable(), BoundaryRestrictable::isBoundarySubset(), and BoundaryRestrictable::meshBoundaryIDs().

◆ _bnd_nodal

bool BoundaryRestrictable::_bnd_nodal

privateinherited

Whether or not this object is restricted to nodesets.

Definition at line 224 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _bnd_tid

THREAD_ID BoundaryRestrictable::_bnd_tid

privateinherited

Thread id for this object.

Definition at line 218 of file BoundaryRestrictable.h.

◆ _boundary_names

std::vector<BoundaryName> BoundaryRestrictable::_boundary_names

privateinherited

Vector the the boundary names.

Definition at line 206 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::boundaryNames(), and BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _broadcast_by_default

const bool VectorPostprocessorInterface::_broadcast_by_default

privateinherited

Whether or not to force broadcasting by default.

Definition at line 360 of file VectorPostprocessorInterface.h.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueByName(), VectorPostprocessorInterface::getVectorPostprocessorValueByName(), VectorPostprocessorInterface::getVectorPostprocessorValueOldByName(), and VectorPostprocessorInterface::getVectorPostprocessorValueOldByName().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 86 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _default_ad_real_functors

std::vector<std::unique_ptr<Moose::Functor<ADReal> > > FunctorInterface::_default_ad_real_functors

privateinherited

Storage vector for Moose::Functor<ADReal> default objects.

Definition at line 188 of file FunctorInterface.h.

Referenced by FunctorInterface::defaultFunctor().

◆ _default_real_functors

std::vector<std::unique_ptr<Moose::Functor<Real> > > FunctorInterface::_default_real_functors

privateinherited

Storage vector for Moose::Functor<Real> default objects.

Definition at line 185 of file FunctorInterface.h.

Referenced by FunctorInterface::defaultFunctor().

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

◆ _dni_feproblem

FEProblemBase& DistributionInterface::_dni_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 69 of file DistributionInterface.h.

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

◆ _dni_moose_object_ptr

const MooseObject* const DistributionInterface::_dni_moose_object_ptr

privateinherited

Pointer to the MooseObject.

Definition at line 72 of file DistributionInterface.h.

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

◆ _dni_params

const InputParameters& DistributionInterface::_dni_params

privateinherited

Parameters of the object with this interface.

Definition at line 66 of file DistributionInterface.h.

Referenced by DistributionInterface::getDistribution().

◆ _dof_indices

std::vector<libMesh::dof_id_type> MooseVariableDependencyInterface::_dof_indices

privateinherited

A container for holding dof indices in order to avoid constant memory reallocation.

Definition at line 114 of file MooseVariableDependencyInterface.h.

Referenced by MooseVariableDependencyInterface::checkVariablesHelper().

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

◆ _empty_block_ids

const std::set<SubdomainID> BoundaryRestrictable::_empty_block_ids

privateinherited

An empty set for referencing when block_ids is not included.

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

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 83 of file SetupInterface.h.

◆ _face_info

const FaceInfo* FVBoundaryCondition::_face_info = nullptr

protectedinherited

Holds information for the face we are currently examining.

Definition at line 120 of file FVBoundaryCondition.h.

Referenced by FVFluxBC::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFunctionNeumannBC::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxBC::elemArg(), FVFluxBC::neighborArg(), FVBoundaryCondition::singleSidedFaceArg(), FVQpFluxBC::uOnGhost(), FVQpFluxBC::uOnUSub(), and FVFluxBC::updateCurrentFace().

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

◆ _fi_name

const std::string FunctorInterface::_fi_name

privateinherited

The name of the object that this interface belongs to.

Definition at line 176 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctorByName().

◆ _fi_params

const InputParameters& FunctorInterface::_fi_params

privateinherited

Parameters of the object with this interface.

Definition at line 173 of file FunctorInterface.h.

Referenced by FunctorInterface::deduceFunctorName().

◆ _fi_subproblem

SubProblem* const FunctorInterface::_fi_subproblem

privateinherited

Pointer to subproblem if the subproblem pointer parameter was set.

Definition at line 179 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctor(), FunctorInterface::getFunctor(), FunctorInterface::getFunctorByName(), and FunctorInterface::isFunctor().

◆ _fi_tid

const THREAD_ID FunctorInterface::_fi_tid

privateinherited

Current threaded it.

Definition at line 182 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctor(), FunctorInterface::getFunctor(), FunctorInterface::getFunctorByName(), and FunctorInterface::isFunctor().

◆ _field_variable

MooseVariableField<Real >* MooseVariableInterface< Real >::_field_variable

protectedinherited

Definition at line 230 of file MooseVariableInterface.h.

◆ _fni_feproblem

FEProblemBase& FunctionInterface::_fni_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 156 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunctionByName(), and FunctionInterface::hasFunctionByName().

◆ _fni_object

const MooseObject& FunctionInterface::_fni_object

privateinherited

Reference to the object.

Definition at line 149 of file FunctionInterface.h.

Referenced by FunctionInterface::getKokkosFunctionByName().

◆ _fni_params

const InputParameters& FunctionInterface::_fni_params

privateinherited

Parameters of the object with this interface.

Definition at line 153 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), FunctionInterface::getKokkosFunction(), and FunctionInterface::hasFunction().

◆ _fni_tid

const THREAD_ID FunctionInterface::_fni_tid

privateinherited

Thread ID.

Definition at line 159 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunctionByName(), and FunctionInterface::hasFunctionByName().

◆ _fv_problem

FEProblemBase& FVBoundaryCondition::_fv_problem

protectedinherited

Reference to the ruling finite volume problem.

Definition at line 105 of file FVBoundaryCondition.h.

◆ _fv_variable

MooseVariableFV<Real >* MooseVariableInterface< Real >::_fv_variable

protectedinherited

Definition at line 228 of file MooseVariableInterface.h.

◆ _geometric_search_data

GeometricSearchData& GeometricSearchInterface::_geometric_search_data

protectedinherited

Definition at line 76 of file GeometricSearchInterface.h.

Referenced by GeometricSearchInterface::GeometricSearchInterface(), GeometricSearchInterface::getNearestNodeLocator(), GeometricSearchInterface::getPenetrationLocator(), GeometricSearchInterface::getQuadratureNearestNodeLocator(), and GeometricSearchInterface::getQuadraturePenetrationLocator().

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

◆ _ke_blocks

std::vector<DenseMatrix<Number> *> TaggingInterface::_ke_blocks

privateinherited

Kernel blocks Vectors For each Tag.

Definition at line 474 of file TaggingInterface.h.

Referenced by TaggingInterface::accumulateTaggedLocalMatrix(), TaggingInterface::accumulateTaggedLocalMatrix(), TaggingInterface::accumulateTaggedLocalMatrix(), TaggingInterface::accumulateTaggedNonlocalMatrix(), FVInterfaceKernel::addJacobian(), TaggingInterface::assignTaggedLocalMatrix(), TaggingInterface::prepareMatrixTag(), TaggingInterface::prepareMatrixTagLower(), TaggingInterface::prepareMatrixTagNonlocal(), and TaggingInterface::TaggingInterface().

◆ _kokkos_element_side_ids

Moose::Kokkos::Array<Moose::Kokkos::Pair<ContiguousElementID, unsigned int> > BoundaryRestrictable::_kokkos_element_side_ids

privateinherited

List of contiguous element ID - side index pairs this Kokkos object is operating on.

Definition at line 289 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::kokkosBoundaryElementSideID(), and BoundaryRestrictable::numKokkosBoundarySides().

◆ _kokkos_node_ids

Moose::Kokkos::Array<ContiguousNodeID> BoundaryRestrictable::_kokkos_node_ids

privateinherited

List of contiguous node IDs this Kokkos object is operating on.

Definition at line 284 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::kokkosBoundaryNodeID(), and BoundaryRestrictable::numKokkosBoundaryNodes().

◆ _linear_fv_variable

MooseLinearVariableFV<Real >* MooseVariableInterface< Real >::_linear_fv_variable

protectedinherited

Definition at line 229 of file MooseVariableInterface.h.

◆ _local_ke

DenseMatrix<Number> TaggingInterface::_local_ke

protectedinherited

Holds local Jacobian entries as they are accumulated by this Kernel.

Definition at line 410 of file TaggingInterface.h.

◆ _local_re

DenseVector<Number> TaggingInterface::_local_re

protectedinherited

Holds local residual entries as they are accumulated by this Kernel.

Definition at line 407 of file TaggingInterface.h.

◆ _matrix_tags

std::set<TagID> TaggingInterface::_matrix_tags

privateinherited

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& FVBoundaryCondition::_mesh

protectedinherited

Mesh this BC is defined on.

Definition at line 117 of file FVBoundaryCondition.h.

◆ _moose_object

const MooseObject& BoundaryRestrictable::_moose_object

privateinherited

The moose object that this is an interface for.

Definition at line 227 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _moose_variable_dependencies

std::set<MooseVariableFieldBase *> MooseVariableDependencyInterface::_moose_variable_dependencies

privateinherited

Definition at line 111 of file MooseVariableDependencyInterface.h.

Referenced by MooseVariableDependencyInterface::addMooseVariableDependency(), MooseVariableDependencyInterface::addMooseVariableDependency(), MooseVariableDependencyInterface::checkAllVariables(), and MooseVariableDependencyInterface::getMooseVariableDependencies().

◆ _mvi_assembly

Assembly* MooseVariableInterface< Real >::_mvi_assembly

protectedinherited

Definition at line 233 of file MooseVariableInterface.h.

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 381 of file MooseBase.h.

◆ _nodal

bool MooseVariableInterface< Real >::_nodal

protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 223 of file MooseVariableInterface.h.

◆ _non_ref_abs_vector_tags

std::set<TagID> TaggingInterface::_non_ref_abs_vector_tags

privateinherited

A set to hold absolute value vector tags excluding the reference residual tag.

If there is no reference residual problem, this container is the same as _abs_vector_tags;

Definition at line 449 of file TaggingInterface.h.

Referenced by TaggingInterface::prepareVectorTag(), and TaggingInterface::TaggingInterface().

◆ _non_ref_vector_tags

std::set<TagID> TaggingInterface::_non_ref_vector_tags

privateinherited

A set to hold vector tags excluding the reference residual tag.

If there is no reference residual problem, this container is the same as _vector_tags;

Definition at line 445 of file TaggingInterface.h.

Referenced by TaggingInterface::prepareVectorTag(), and TaggingInterface::TaggingInterface().

◆ _nonlocal_ke

DenseMatrix<Number> TaggingInterface::_nonlocal_ke

protectedinherited

Holds nonlocal Jacobian entries as they are accumulated by this Kernel.

Definition at line 413 of file TaggingInterface.h.

Referenced by TaggingInterface::accumulateTaggedNonlocalMatrix(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), and TaggingInterface::prepareMatrixTagNonlocal().

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

◆ _postprocessor_value

const PostprocessorValue& FVPostprocessorDirichletBC::_postprocessor_value

private

The value for this BC.

Definition at line 25 of file FVPostprocessorDirichletBC.h.

Referenced by boundaryValue().

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

◆ _re_blocks

std::vector<DenseVector<Number> *> TaggingInterface::_re_blocks

privateinherited

Residual blocks Vectors For each Tag.

Definition at line 468 of file TaggingInterface.h.

Referenced by TaggingInterface::accumulateTaggedLocalResidual(), TaggingInterface::assignTaggedLocalResidual(), TaggingInterface::prepareVectorTagInternal(), TaggingInterface::prepareVectorTagLower(), TaggingInterface::prepareVectorTagNeighbor(), and TaggingInterface::TaggingInterface().

◆ _ref_abs_vector_tags

std::set<TagID> TaggingInterface::_ref_abs_vector_tags

privateinherited

A set of either size 1 or 0.

If we have a reference residual problem and _abs_vector_tags holds the reference vector tag, then this set holds the reference vector tags, otherwise it holds nothing

Definition at line 459 of file TaggingInterface.h.

Referenced by TaggingInterface::prepareVectorTag(), and TaggingInterface::TaggingInterface().

◆ _ref_vector_tags

std::set<TagID> TaggingInterface::_ref_vector_tags

privateinherited

A set of either size 1 or 0.

If we have a reference residual problem and _vector_tags holds the reference vector tag, then this set holds the reference vector tags, otherwise it holds nothing

Definition at line 454 of file TaggingInterface.h.

Referenced by TaggingInterface::prepareVectorTag(), and TaggingInterface::TaggingInterface().

◆ _requires_geometric_search

bool GeometricSearchInterface::_requires_geometric_search

protectedinherited

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 80 of file GeometricSearchInterface.h.

Referenced by GeometricSearchInterface::getNearestNodeLocator(), GeometricSearchInterface::getPenetrationLocator(), GeometricSearchInterface::getQuadratureNearestNodeLocator(), GeometricSearchInterface::getQuadraturePenetrationLocator(), and GeometricSearchInterface::requiresGeometricSearch().

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

◆ _subproblem

SubProblem& FVBoundaryCondition::_subproblem

protectedinherited

Reference to SubProblem.

Definition at line 102 of file FVBoundaryCondition.h.

Referenced by FVBoundaryCondition::FVBoundaryCondition(), and FVBoundaryCondition::subProblem().

◆ _sys

SystemBase& FVBoundaryCondition::_sys

protectedinherited

Reference to SystemBase.

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

◆ _tag_params

const InputParameters& TaggingInterface::_tag_params

privateinherited

Parameters from moose object.

Definition at line 465 of file TaggingInterface.h.

Referenced by TaggingInterface::TaggingInterface().

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

◆ _tid

THREAD_ID FVBoundaryCondition::_tid

protectedinherited

Thread id.

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

◆ _var

MooseVariableFV<Real>& FVBoundaryCondition::_var

protectedinherited

Definition at line 99 of file FVBoundaryCondition.h.

Referenced by FVFluxBC::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVConstantScalarOutflowBC::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FVFluxBC::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVBoundaryCondition::FVBoundaryCondition(), FVFluxBC::FVFluxBC(), FVBoundaryCondition::hasFaceSide(), FVQpFluxBC::uOnGhost(), FVQpFluxBC::uOnUSub(), FVFluxBC::updateCurrentFace(), and FVBoundaryCondition::variable().

◆ _var_sys_numbers_pair

const std::pair<unsigned int, unsigned int> FVDirichletBCBase::_var_sys_numbers_pair

protectedinherited

A pair keeping track of the variable and system numbers.

Definition at line 30 of file FVDirichletBCBase.h.

◆ _variable

MooseVariableFE<Real >* MooseVariableInterface< Real >::_variable

protectedinherited

Definition at line 227 of file MooseVariableInterface.h.

◆ _vec_ids

std::vector<BoundaryID> BoundaryRestrictable::_vec_ids

privateinherited

Vector of the boundary ids.

Definition at line 203 of file BoundaryRestrictable.h.

Referenced by BoundaryRestrictable::initializeBoundaryRestrictable().

◆ _vector_tags

std::set<TagID> TaggingInterface::_vector_tags

privateinherited

The vector tag ids this Kernel will contribute to.

Definition at line 435 of file TaggingInterface.h.

Referenced by TaggingInterface::addResiduals(), TaggingInterface::addResidualsWithoutConstraints(), TaggingInterface::getVectorTags(), TaggingInterface::hasVectorTags(), TaggingInterface::isVectorTagged(), TaggingInterface::prepareVectorTag(), TaggingInterface::prepareVectorTagLower(), TaggingInterface::prepareVectorTagNeighbor(), TaggingInterface::setResidual(), TaggingInterface::setResidual(), TaggingInterface::setResidual(), TaggingInterface::TaggingInterface(), TaggingInterface::useVectorTag(), and TaggingInterface::useVectorTag().

◆ _vpi_feproblem

const FEProblemBase& VectorPostprocessorInterface::_vpi_feproblem

privateinherited

Reference the FEProblemBase class.

Definition at line 366 of file VectorPostprocessorInterface.h.

◆ _vpi_moose_object

const MooseObject& VectorPostprocessorInterface::_vpi_moose_object

privateinherited

The MooseObject that uses this interface.

Definition at line 363 of file VectorPostprocessorInterface.h.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorByNameHelper(), VectorPostprocessorInterface::getVectorPostprocessorContextByNameHelper(), VectorPostprocessorInterface::getVectorPostprocessorName(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName().

◆ _vpi_tid

const THREAD_ID VectorPostprocessorInterface::_vpi_tid

privateinherited

Thread ID.

Definition at line 369 of file VectorPostprocessorInterface.h.

◆ 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/fvbcs/FVPostprocessorDirichletBC.h
src/fvbcs/FVPostprocessorDirichletBC.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Member Enumeration Documentation

◆ ResidualTagType

◆ TEST_TYPE

Constructor & Destructor Documentation

◆ FVPostprocessorDirichletBC()

Member Function Documentation

◆ accumulateTaggedLocalMatrix() [1/3]

◆ accumulateTaggedLocalMatrix() [2/3]

◆ accumulateTaggedLocalMatrix() [3/3]

◆ accumulateTaggedLocalResidual()

◆ accumulateTaggedNonlocalMatrix()

◆ addJacobian() [1/4]

◆ addJacobian() [2/4]

◆ addJacobian() [3/4]

◆ addJacobian() [4/4]

◆ addJacobianElement()

◆ addJacobianWithoutConstraints()

◆ addMooseVariableDependency() [1/2]

◆ addMooseVariableDependency() [2/2]

◆ addPostprocessorDependencyHelper()

◆ addResiduals() [1/4]

◆ addResiduals() [2/4]

◆ addResiduals() [3/4]

◆ addResiduals() [4/4]

◆ addResidualsAndJacobian() [1/2]

◆ addResidualsAndJacobian() [2/2]

◆ addResidualsAndJacobianWithoutConstraints()

◆ addResidualsWithoutConstraints()

◆ addUserObjectDependencyHelper()

◆ addVectorPostprocessorDependencyHelper()

◆ assignTaggedLocalMatrix()

◆ assignTaggedLocalResidual()

◆ boundaryIDs()

◆ boundaryNames()

◆ boundaryRestricted()

◆ boundaryValue()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ castUserObject()

◆ checkAllVariables()

◆ checkForNans()

◆ checkFunctorSupportsSideIntegration()

◆ checkParam()

◆ checkVariableBoundaryIntegrity()

◆ checkVariables() [1/2]

◆ checkVariables() [2/2]

◆ checkVariablesHelper()

◆ connectControllableParams()

◆ coupledPostprocessors()

◆ customSetup()

◆ deduceFunctorName() [1/2]

◆ deduceFunctorName() [2/2]

◆ defaultFunctor() [1/5]

◆ defaultFunctor() [2/5]

◆ defaultFunctor() [3/5]

◆ defaultFunctor() [4/5]

◆ defaultFunctor() [5/5]

◆ determineState()

◆ dot()

◆ dotDot()

◆ dotDotDu()

◆ dotDotOld()

◆ dotDu()

◆ dotOld()

◆ enabled()

◆ errorPrefix()

◆ flagInvalidSolutionInternal()