Get all of the elements that are intersected by a line. More...

#include <ElementsAlongLine.h>

Inheritance diagram for ElementsAlongLine:

Public Member Functions
	ElementsAlongLine (const InputParameters &parameters)

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

virtual void	execute () override
	Find the elements. More...

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

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

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

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

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

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

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

template<typename T >
void	gatherMax (T &value)

template<typename T >
void	gatherMin (T &value)

template<typename T1 , typename T2 >
void	gatherProxyValueMax (T1 &value, T2 &proxy)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const std::vector< ExecFlagType > &	execFlags () const
	(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType More...

ExecFlagType	execBitFlags () const
	(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType More...

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

template<typename T >
const MaterialProperty< T > &	getZeroMaterialProperty (const std::string &prop_name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...

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

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

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

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

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

template<>
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn)

template<>
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn)

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

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

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

bool	isImplicit ()

template<class T >
const T &	getUserObjectTempl (const std::string &name)
	Get an user object with a given parameter name. More...

template<class T >
const T &	getUserObjectByNameTempl (const std::string &name)
	Get an user object with a given name. More...

const UserObject &	getUserObjectBase (const std::string &name)
	Get an user object with a given parameter name. More...

const UserObject &	getUserObjectBaseByName (const std::string &name)
	Get an user object with a given name. More...

virtual VectorPostprocessorValue &	getVector (const std::string &vector_name)
	This will get called to actually grab the final value the VectorPostprocessor has calculated. More...

std::string	PPName ()
	Returns the name of the VectorPostprocessor. More...

bool	containsCompleteHistory () const
	Return whether or not this VectorPostprocessor contains complete history. More...

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

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


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

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


virtual const PostprocessorValue &	getPostprocessorValue (const std::string &name, unsigned int index=0)
	Store dependency among same object types for proper execution order. More...

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name)

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

virtual const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &name, const std::string &vector_name, bool use_broadcast) override
	Retrieve the value of a VectorPostprocessor. More...

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

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


template<typename T >
const MaterialProperty< T > &	getMaterialPropertyTempl (const std::string &name)
	Retrieve reference to material property or one of it's old or older values. More...

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

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

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


template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByNameTempl (const MaterialPropertyName &name)
	Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file. More...

template<typename T >
const ADMaterialPropertyObject< T > &	getADMaterialPropertyByNameTempl (const MaterialPropertyName &name)

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByNameTempl (const MaterialPropertyName &name)

template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByNameTempl (const MaterialPropertyName &name)


MaterialBase &	getMaterial (const std::string &name)
	Return a MaterialBase reference - usable for computing directly. More...

template<ComputeStage >
MaterialBase &	getMaterial (const std::string &name)

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

template<ComputeStage >
MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)


template<typename T >
bool	hasMaterialPropertyTempl (const std::string &name)
	Check if the material property exists. More...

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

Static Public Member Functions
static InputParameters	validParams ()

static ExecFlagEnum	getExecuteOptions ()
	(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...

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

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

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

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

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

template<typename T >
T &	declareRestartableDataTempl (const std::string &data_name)
	Declare a piece of data as "restartable". More...

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

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

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

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

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

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

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

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

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

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

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

std::set< TagID > &	getScalarVariableCoupleableVectorTags ()

std::set< TagID > &	getScalarVariableCoupleableMatrixTags ()

void	addScalarVariableCoupleableVectorTag (TagID tag)

void	addScalarVariableCoupleableMatrixTag (TagID tag)

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

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

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

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

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

template<ComputeStage compute_stage>
const ADVariableValue &	adCoupledScalarValueTempl (const std::string &var_name, unsigned int comp=0)
	Returns AD value of a scalar coupled variable. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

std::string	deducePropertyName (const std::string &name)
	Small helper to look up a material property name through the input parameter keys. More...

template<typename T >
const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...

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

template<typename T >
const ADMaterialPropertyObject< T > *	defaultADMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...

template<>
const ADMaterialPropertyObject< Real > *	defaultADMaterialProperty (const std::string &name)

template<>
const ADMaterialPropertyObject< RealVectorValue > *	defaultADMaterialProperty (const std::string &name)

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

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

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

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

bool	singlePostprocessor (const std::string &name) const
	Checks if there is a single postprocessor coupled by parameter name. More...

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

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

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

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

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

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

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

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

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

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

VectorPostprocessorValue &	declareVector (const std::string &vector_name)
	Register a new vector to fill up. More...


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

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


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

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


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

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


const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name)

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name)


const PostprocessorValue &	getDefaultPostprocessorValue (const std::string &name)
	Return the default postprocessor value. More...

Protected Attributes
Point	_start
	The beginning of the line. More...

Point	_end
	The end of the line. More...

VectorPostprocessorValue &	_elem_ids
	The elements that intersect the line. More...

std::set< std::string >	_depend_vars

std::set< std::string >	_supplied_vars

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

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

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

Assembly &	_assembly

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

const bool	_duplicate_initial_execution

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

MooseApp &	_app
	The MooseApp this object is associated with. More...

const std::string &	_type
	The type of this object (the Class name) More...

const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...

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

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

const std::vector< ExecFlagType >	_exec_flags
	(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType More...

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

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

const InputParameters &	_sc_parameters

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

FEProblemBase &	_sc_fe_problem

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

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

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

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

bool	_sc_is_implicit
	True if implicit value is required. More...

const InputParameters &	_coupleable_params
	Local InputParameters. More...

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

const Real &	_real_zero
	Scalar zero. More...

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

const Point &	_point_zero
	Zero point. More...

const InputParameters *	_pg_params
	Params. More...

PerfGraph &	_perf_graph
	The performance graph to add to. More...

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

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

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

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

std::shared_ptr< MaterialData >	_material_data
	Pointer to the material data class that stores properties. More...

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

const THREAD_ID	_mi_tid
	Current threaded it. More...

bool	_stateful_allowed
	True by default. More...

bool	_get_material_property_called
	Initialized to false. More...

std::vector< std::unique_ptr< MaterialProperty< Real > > >	_default_real_properties
	Storage vector for MaterialProperty<Real> default objects. More...

std::vector< std::unique_ptr< ADMaterialPropertyObject< Real > > >	_default_ad_real_properties
	Storage vector for ADMaterialPropertyObject<Real> default objects. More...

std::vector< std::unique_ptr< ADMaterialPropertyObject< RealVectorValue > > >	_default_ad_real_vector_properties
	Storage vector for ADMaterialPropertyObject<RealVectorValue> default objects. More...

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

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

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

Real &	_t
	Time. More...

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

Real &	_dt
	Time step size. More...

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

bool	_is_transient

std::string	_vpp_name
	The name of the VectorPostprocessor. More...

FEProblemBase *	_vpp_fe_problem
	Pointer to FEProblemBase. More...

Static Protected Attributes
static constexpr auto	FILE_SUFFIX = "_mesh"
	The suffix appended when writing the restartable data file. More...

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

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

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const

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

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

RestartableDataValue &	registerMetaDataOnApp (const std::string &name, std::unique_ptr< RestartableDataValue > data)
	Helper function for actually registering the restartable data. More...

bool	needThreadedCopy (const UserObject &uo) const
	Check if the threaded copy of the user object is needed. More...

Private Attributes
UserObject *	_primary_thread_copy = nullptr

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

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

FEProblemBase &	_fni_feproblem
	Reference to FEProblemBase instance. More...

const THREAD_ID	_fni_tid
	Thread ID. More...

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

FEProblemBase &	_dni_feproblem
	Reference to FEProblemBase instance. More...

const MooseObject *	_dni_moose_object_ptr
	Pointer to the MooseObject. More...

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

std::string	_restartable_name
	The name of the object. More...

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

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

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

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

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const bool	_mi_boundary_restricted
	BoundaryRestricted flag. More...

const std::set< SubdomainID > &	_mi_block_ids
	Storage for the block ids created by BlockRestrictable. More...

const std::set< BoundaryID > &	_mi_boundary_ids
	Storage for the boundary ids created by BoundaryRestrictable. More...

const std::string	_ti_name

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

FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance. More...

THREAD_ID	_uoi_tid
	Thread ID. More...

const InputParameters &	_ppi_params
	PostprocessorInterface Parameters. More...

FEProblemBase &	_pi_feproblem
	Reference the the FEProblemBase class. More...

bool	_broadcast_by_default
	Whether or not to force broadcasting by default. More...

const InputParameters &	_vpi_params
	VectorPostprocessorInterface Parameters. More...

FEProblemBase &	_vpi_feproblem
	Reference the the FEProblemBase class. More...

THREAD_ID	_vpi_tid
	Thread ID. More...

THREAD_ID	_vpp_tid

const bool	_contains_complete_history

const bool	_is_broadcast

std::map< std::string, VectorPostprocessorValue >	_thread_local_vectors

MooseApp &	_oi_moose_app
	Reference the the MooseApp; neede for access to the OutputWarehouse. More...

OutputWarehouse &	_oi_output_warehouse
	Reference to the OutputWarehouse for populating the Output object hide lists. More...

std::set< OutputName >	_oi_outputs
	The set of Output object names listed in the 'outputs' parameter. More...

Detailed Description

Get all of the elements that are intersected by a line.

Definition at line 23 of file ElementsAlongLine.h.

Constructor & Destructor Documentation

◆ ElementsAlongLine()

ElementsAlongLine::ElementsAlongLine ( const InputParameters & parameters )

Definition at line 32 of file ElementsAlongLine.C.

   : GeneralVectorPostprocessor(parameters),
     _start(getParam<Point>("start")),
     _end(getParam<Point>("end")),
     _elem_ids(declareVector("elem_ids"))
 {
   _fe_problem.mesh().errorIfDistributedMesh("ElementsAlongLine");
 }

Member Function Documentation

◆ adCoupledScalarValueTempl()

template<ComputeStage compute_stage>

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

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 138 of file ScalarCoupleable.C.

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

◆ addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID tag )

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

55 { _sc_coupleable_matrix_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue().

◆ addScalarVariableCoupleableVectorTag()

void ScalarCoupleable::addScalarVariableCoupleableVectorTag ( TagID tag )

inlineinherited

Definition at line 53 of file ScalarCoupleable.h.

53 { _sc_coupleable_vector_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

◆ buildOutputHideVariableList()

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

inherited

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

Parameters

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

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

Definition at line 64 of file OutputInterface.C.

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

Referenced by OutputInterface::OutputInterface().

◆ checkBlockAndBoundaryCompatibility()

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

inherited

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

Error out otherwise.

Definition at line 212 of file MaterialPropertyInterface.C.

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

Referenced by MaterialPropertyInterface::getMaterialByName().

◆ checkExecutionStage()

void MaterialPropertyInterface::checkExecutionStage ( )

protectedinherited

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

Definition at line 290 of file MaterialPropertyInterface.C.

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

Referenced by MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), and TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl().

◆ checkMaterialProperty()

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

protectedinherited

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

Definition at line 180 of file MaterialPropertyInterface.C.

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

Referenced by MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), and TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl().

◆ checkVar()

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

protectedinherited

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

Parameters

var_name The name of the coupled variable

Definition at line 294 of file ScalarCoupleable.C.

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

◆ containsCompleteHistory()

bool VectorPostprocessor::containsCompleteHistory ( ) const

inlineinherited

Return whether or not this VectorPostprocessor contains complete history.

Definition at line 57 of file VectorPostprocessor.h.

57 { return _contains_complete_history; }

Referenced by SamplerBase::initialize().

◆ coupledMatrixTagScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 199 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   addScalarVariableCoupleableMatrixTag(tag);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->matrixTagSln(tag);
 }

◆ coupledPostprocessors()

unsigned int PostprocessorInterface::coupledPostprocessors ( const std::string & name ) const

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

name	The name of the Postprocessor parameter

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

Definition at line 146 of file PostprocessorInterface.C.

 {
   if (singlePostprocessor(name))
     return 1;
   return _ppi_params.get<std::vector<PostprocessorName>>(name).size();
 }

◆ coupledScalar()

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

protectedvirtualinherited

Returns the index for a scalar coupled variable by name.

Parameters

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

Returns: Index of coupled variable

Definition at line 95 of file ScalarCoupleable.C.

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

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarComponents()

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

protectedvirtualinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 341 of file ScalarCoupleable.C.

 {
   return _coupled_scalar_vars[var_name].size();
 }

◆ coupledScalarDot()

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

protectedvirtualinherited

Returns the time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 241 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDot()

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

protectedvirtualinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 250 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 285 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotOld()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 268 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDu()

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

protectedvirtualinherited

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

Parameters

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

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

Definition at line 276 of file ScalarCoupleable.C.

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

◆ coupledScalarDotOld()

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

protectedvirtualinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 259 of file ScalarCoupleable.C.

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

◆ coupledScalarOrder()

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

protectedvirtualinherited

Returns the order for a scalar coupled variable by name.

Parameters

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

Returns: Order of coupled variable

Definition at line 102 of file ScalarCoupleable.C.

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

◆ coupledScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 126 of file ScalarCoupleable.C.

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

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarValueOld()

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

protectedvirtualinherited

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

Parameters

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

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 214 of file ScalarCoupleable.C.

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

◆ coupledScalarValueOlder()

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

protectedvirtualinherited

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

Parameters

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

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 226 of file ScalarCoupleable.C.

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

◆ coupledVectorTagScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 184 of file ScalarCoupleable.C.

 {
   checkVar(var_name);
   if (!isCoupledScalar(var_name, comp))
     return *getDefaultValue(var_name);
  
   addScalarVariableCoupleableVectorTag(tag);
  
   MooseVariableScalar * var = getScalarVar(var_name, comp);
   return var->vectorTagSln(tag);
 }

◆ cyclicDependencyError()

template<typename T >

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

staticinherited

A helper method for cyclic errors.

Definition at line 94 of file DependencyResolverInterface.h.

 {
   std::ostringstream oss;
  
   oss << header << ":\n";
   const typename std::multimap<T, T> & depends = e.getCyclicDependencies();
   for (typename std::multimap<T, T>::const_iterator it = depends.begin(); it != depends.end(); ++it)
     oss << (static_cast<T>(it->first))->name() << " -> " << (static_cast<T>(it->second))->name()
         << "\n";
   mooseError(oss.str());
 }

◆ declareRecoverableData() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "recoverable".

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 295 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
  
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRecoverableData() [2/2]

template<typename T >

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		const T &	init_value
	)

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 306 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
  
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableDataTempl() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 222 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRestartableDataTempl() [2/2]

template<typename T >

T & Restartable::declareRestartableDataTempl	(	const std::string &	data_name,
		const T &	init_value
	)

protectedinherited

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

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

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

Parameters

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

Definition at line 229 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableDataWithContext() [1/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext	(	const std::string &	data_name,
		const T &	init_value,
		void *	context
	)

protectedinherited

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

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 250 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [2/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 236 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  
   // See comment in overloaded version of this function with "init_value"
   auto & restartable_data_ref = static_cast<RestartableData<T> &>(
       registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid));
  
   return restartable_data_ref.get();
 }

◆ declareRestartableDataWithObjectName()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 270 of file Restartable.h.

 {
   return declareRestartableDataWithObjectNameWithContext<T>(data_name, object_name, nullptr);
 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 278 of file Restartable.h.

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

◆ declareRestartableDataWithPrefixOverrideAndContext()

template<typename T >

T& Restartable::declareRestartableDataWithPrefixOverrideAndContext	(	const std::string &	data_name,
		const std::string &	prefix,
		void *	context
	)

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
prefix	The prefix to prepend to the data_name, to retrieve data from another object.
context	Context pointer that will be passed to the load and store functions

◆ declareVector()

VectorPostprocessorValue & VectorPostprocessor::declareVector ( const std::string & vector_name )

protectedinherited

Register a new vector to fill up.

Definition at line 58 of file VectorPostprocessor.C.

 {
   if (_vpp_tid)
     return _thread_local_vectors.emplace(vector_name, VectorPostprocessorValue()).first->second;
   else
     return _vpp_fe_problem->declareVectorPostprocessorVector(
         _vpp_name, vector_name, _contains_complete_history, _is_broadcast);
 }

Referenced by ConstantVectorPostprocessor::ConstantVectorPostprocessor(), SidesetInfoVectorPostprocessor::initialize(), CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), LeastSquaresFit::LeastSquaresFit(), LeastSquaresFitHistory::LeastSquaresFitHistory(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), SamplerBase::setupVariables(), SpatialAverageBase::SpatialAverageBase(), and WorkBalance::WorkBalance().

◆ deducePropertyName()

std::string MaterialPropertyInterface::deducePropertyName ( const std::string & name )

protectedinherited

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

Definition at line 56 of file MaterialPropertyInterface.C.

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

Referenced by Material::getADMaterialPropertyTempl(), MaterialPropertyInterface::getADMaterialPropertyTempl(), Material::getMaterialPropertyOlderTempl(), InterfaceMaterial::getMaterialPropertyOlderTempl(), MaterialPropertyInterface::getMaterialPropertyOlderTempl(), Material::getMaterialPropertyOldTempl(), InterfaceMaterial::getMaterialPropertyOldTempl(), MaterialPropertyInterface::getMaterialPropertyOldTempl(), Material::getMaterialPropertyTempl(), InterfaceMaterial::getMaterialPropertyTempl(), MaterialPropertyInterface::getMaterialPropertyTempl(), TwoMaterialPropertyInterface::getNeighborADMaterialPropertyTempl(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOld(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyOlder(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyTempl(), InterfaceMaterial::getNeighborMaterialPropertyTempl(), and MaterialPropertyInterface::hasMaterialPropertyTempl().

◆ defaultADMaterialProperty() [1/3]

template<typename T >

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

protectedinherited

Helper function to parse default material property values.

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

Definition at line 365 of file MaterialPropertyInterface.h.

 {
   return NULL;
 }

◆ defaultADMaterialProperty() [2/3]

const ADMaterialPropertyObject< RealVectorValue > * MaterialPropertyInterface::defaultADMaterialProperty ( const std::string & name )

protectedinherited

Definition at line 128 of file MaterialPropertyInterface.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_vector_properties.emplace_back(
         libmesh_make_unique<ADMaterialPropertyObject<RealVectorValue>>());
     auto & default_property = _default_ad_real_vector_properties.back();
  
     // resize to accomodate maximum number obf qpoints
     auto nqp = _mi_feproblem.getMaxQps();
     default_property->resize(nqp);
  
     // set values for all qpoints to the given default
     for (decltype(nqp) qp = 0; qp < nqp; ++qp)
       (*default_property)[qp] = real_value;
  
     // return the raw pointer inside the shared pointer
     return default_property.get();
   }
  
   return nullptr;
 }

◆ defaultADMaterialProperty() [3/3]

const ADMaterialPropertyObject< Real > * MaterialPropertyInterface::defaultADMaterialProperty ( const std::string & name )

protectedinherited

Definition at line 94 of file MaterialPropertyInterface.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_properties.emplace_back(
         libmesh_make_unique<ADMaterialPropertyObject<Real>>(true));
     auto & default_property = _default_ad_real_properties.back();
  
     // resize to accomodate maximum number obf qpoints
     auto nqp = _mi_feproblem.getMaxQps();
     default_property->resize(nqp);
  
     // set values for all qpoints to the given default
     for (decltype(nqp) qp = 0; qp < nqp; ++qp)
     {
       // This sets the dual number member of the MooseADWrapper for Jacobian calculations
       (*default_property)[qp] = real_value;
       // This sets the value member of the MooseADWrapper for residual calculations
       default_property->set()[qp].value() = real_value;
     }
  
     // return the raw pointer inside the shared pointer
     return default_property.get();
   }
  
   return nullptr;
 }

◆ defaultMaterialProperty() [1/2]

template<typename T >

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

protectedinherited

Helper function to parse default material property values.

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

Definition at line 357 of file MaterialPropertyInterface.h.

 {
   return NULL;
 }

◆ defaultMaterialProperty() [2/2]

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

protectedinherited

Definition at line 66 of file MaterialPropertyInterface.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_properties.emplace_back(libmesh_make_unique<MaterialProperty<Real>>());
     auto & default_property = _default_real_properties.back();
  
     // resize to accomodate maximum number obf qpoints
     auto nqp = _mi_feproblem.getMaxQps();
     default_property->resize(nqp);
  
     // set values for all qpoints to the given default
     for (decltype(nqp) qp = 0; qp < nqp; ++qp)
       (*default_property)[qp] = real_value;
  
     // return the raw pointer inside the shared pointer
     return default_property.get();
   }
  
   return nullptr;
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const

inherited

(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType

Definition at line 87 of file SetupInterface.C.

 {
   // TODO: ExecFlagType
   mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
                   "ExecFlagEnum for execute flags. This method maintains the behavior of the "
                   "original method but the use of this method should be removed from your "
                   "application. The ExecFlagEnum should be inspected directly via the "
                   "getExecuteOnEnum() method.");
  
   unsigned int exec_bit_field = EXEC_NONE;
   for (const auto & flag : _exec_flags)
     exec_bit_field |= flag.id();
   return ExecFlagType("deprecated", exec_bit_field);
 }

◆ execFlags()

const std::vector< ExecFlagType > & SetupInterface::execFlags ( ) const

virtualinherited

(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType

Reimplemented in MultiAppTransfer.

Definition at line 75 of file SetupInterface.C.

 {
   // TODO: ExecFlagType
   mooseDeprecated("The execFlags() method is being removed because MOOSE has been updated to use a "
                   "ExecFlagEnum for execute flags. The current flags should be retrieved from "
                   "the \"exeucte_on\" parameters of your object or by using the \"_execute_enum\" "
                   "reference to the parameter or the getExecuteOnEnum() method.");
  
   return _exec_flags;
 }

◆ execute()

void ElementsAlongLine::execute ( )

overridevirtual

Find the elements.

Implements UserObject.

Definition at line 48 of file ElementsAlongLine.C.

 {
   std::vector<Elem *> intersected_elems;
   std::vector<LineSegment> segments;
  
   std::unique_ptr<PointLocatorBase> pl = _fe_problem.mesh().getPointLocator();
   Moose::elementsIntersectedByLine(
       _start, _end, _fe_problem.mesh(), *pl, intersected_elems, segments);
  
   unsigned int num_elems = intersected_elems.size();
  
   _elem_ids.resize(num_elems);
  
   for (unsigned int i = 0; i < num_elems; i++)
     _elem_ids[i] = intersected_elems[i]->id();
 }

◆ finalize()

virtual void GeneralVectorPostprocessor::finalize ( )

inlineoverridevirtualinherited

Finalize.

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

Implements UserObject.

Reimplemented in LineMaterialSamplerBase< T >, LineMaterialSamplerBase< Real >, WorkBalance, HistogramVectorPostprocessor, VectorMemoryUsage, StatisticsVectorPostprocessor, LineFunctionSampler, PiecewiseFunctionTabulate, and PointSamplerBase.

Definition at line 39 of file GeneralVectorPostprocessor.h.

39 {}

◆ gatherMax()

template<typename T >

void UserObject::gatherMax ( T & value )

inlineinherited

Definition at line 113 of file UserObject.h.

   {
     _communicator.max(value);
   }

Referenced by SidesetInfoVectorPostprocessor::finalize(), MemoryUsage::finalize(), NodalMaxValue::getValue(), NodalExtremeValue::getValue(), and ElementExtremeValue::getValue().

◆ gatherMin()

template<typename T >

void UserObject::gatherMin ( T & value )

inlineinherited

Definition at line 119 of file UserObject.h.

   {
     _communicator.min(value);
   }

Referenced by PointValue::execute(), SidesetInfoVectorPostprocessor::finalize(), MemoryUsage::finalize(), ScalarVariable::getValue(), NodalExtremeValue::getValue(), and ElementExtremeValue::getValue().

◆ gatherProxyValueMax()

template<typename T1 , typename T2 >

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

inlineinherited

Definition at line 125 of file UserObject.h.

   {
     unsigned int rank;
     _communicator.maxloc(value, rank);
     _communicator.broadcast(proxy, rank);
   }

Referenced by ElementVariablesDifferenceMax::finalize(), and NodalProxyMaxValue::getValue().

◆ gatherSum()

template<typename T >

void UserObject::gatherSum ( T & value )

inlineinherited

Gather the parallel sum of the variable passed in.

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

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

Definition at line 107 of file UserObject.h.

   {
     _communicator.sum(value);
   }

Referenced by GreaterThanLessThanPostprocessor::execute(), AverageNodalVariableValue::finalize(), SidesetInfoVectorPostprocessor::finalize(), SpatialAverageBase::finalize(), LayeredAverage::finalize(), VolumeHistogram::finalize(), LayeredSideAverage::finalize(), MemoryUsage::finalize(), SideFluxAverage::getValue(), NodalL2Error::getValue(), NodalSum::getValue(), AverageElementSize::getValue(), InterfaceIntegralPostprocessor::getValue(), NodalL2Norm::getValue(), SideIntegralPostprocessor::getValue(), ElementAverageValue::getValue(), SideAverageValue::getValue(), ElementalVariableValue::getValue(), ElementIntegralPostprocessor::getValue(), NodalVariableValue::getValue(), SideIntegralUserObject::getValue(), ElementIntegralUserObject::getValue(), and InterfacePostprocessor::getValue().

◆ getADDefaultValue()

template<ComputeStage compute_stage>

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

protectedinherited

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

Parameters

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

Returns: ADVariableValue * a pointer to the associated ADVariableValue.

◆ getADMaterialPropertyByNameTempl()

template<typename T >

const ADMaterialPropertyObject< T > & MaterialPropertyInterface::getADMaterialPropertyByNameTempl ( const MaterialPropertyName & name )

inherited

Definition at line 403 of file MaterialPropertyInterface.h.

 {
   _mi_feproblem.usingADMatProps(true);
  
   checkExecutionStage();
   checkMaterialProperty(name);
  
   // mark property as requested
   markMatPropRequested(name);
  
   // Update the boolean flag.
   _get_material_property_called = true;
  
   _material_property_dependencies.insert(_material_data->getPropertyId(name));
  
   return _material_data->getADProperty<T>(name);
 }

◆ getADMaterialPropertyTempl()

template<typename T >

const ADMaterialPropertyObject< T > & MaterialPropertyInterface::getADMaterialPropertyTempl ( const std::string & name )

inherited

Definition at line 299 of file MaterialPropertyInterface.h.

 {
   // Check if the supplied parameter is a valid input parameter key
   std::string prop_name = deducePropertyName(name);
  
   // Check if it's just a constant
   const ADMaterialPropertyObject<T> * default_property = defaultADMaterialProperty<T>(prop_name);
   if (default_property)
     return *default_property;
  
   return getADMaterialPropertyByName<T>(prop_name);
 }

◆ getBlockMaterialProperty()

template<typename T >

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

inherited

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

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

Parameters

name	The name of the material property to retrieve

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

Definition at line 459 of file MaterialPropertyInterface.h.

 {
   if (_mi_block_ids.empty())
     mooseError("getBlockMaterialProperty must be called by a block restrictable object");
  
   if (!hasMaterialPropertyByName<T>(name))
     return std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>(NULL,
                                                                          std::set<SubdomainID>());
  
   _material_property_dependencies.insert(_material_data->getPropertyId(name));
  
   return std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>(
       &_material_data->getProperty<T>(name), _mi_feproblem.getMaterialPropertyBlocks(name));
 }

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

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 91 of file MooseObject.h.

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

◆ getCoupledMooseScalarVars()

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

inherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 68 of file ScalarCoupleable.C.

 {
   return _coupled_moose_scalar_vars;
 }

Referenced by AuxScalarKernel::AuxScalarKernel(), and ScalarInitialCondition::ScalarInitialCondition().

◆ getDefaultPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getDefaultPostprocessorValue ( const std::string & name )

inherited

Return the default postprocessor value.

Parameters

name	The name of the postprocessor parameter

Returns: A const reference to the default value

Definition at line 166 of file PostprocessorInterface.C.

 {
   return _ppi_params.getDefaultPostprocessorValue(name);
 }

Referenced by EigenKernel::EigenKernel().

◆ getDefaultValue()

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

protectedinherited

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

Parameters

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

Returns: VariableValue * a pointer to the associated VarirableValue.

Definition at line 112 of file ScalarCoupleable.C.

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

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

◆ 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 32 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 73 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 39 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 93 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 69 of file SetupInterface.C.

 {
   return _execute_enum;
 }

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and MultiAppTransfer::checkMultiAppExecuteOn().

◆ getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )

staticinherited

(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType

Returns: A MooseEnum with the available 'execute_on' options, the default is 'residual'

Definition at line 103 of file SetupInterface.C.

 {
   // TODO: ExecFlagType
   ::mooseDeprecated("The 'getExecuteOptions' was replaced by the ExecFlagEnum class because MOOSE "
                     "was updated to use this for the execute flags and the new function provides "
                     "additional arguments for modification of the enum.");
   return MooseUtils::getDefaultExecFlagEnum();
 }

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

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

Referenced by FunctionDT::FunctionDT().

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

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

Referenced by ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterial::GenericFunctionMaterial(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

◆ getMaterial() [1/2]

template MaterialBase & MaterialPropertyInterface::getMaterial< JACOBIAN > ( const std::string & name )

inherited

Return a MaterialBase reference - usable for computing directly.

Parameters

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

Definition at line 206 of file MaterialPropertyInterface.C.

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

◆ getMaterial() [2/2]

template<ComputeStage compute_stage>

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

inherited

Definition at line 265 of file MaterialPropertyInterface.C.

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

◆ getMaterialByName() [1/4]

template<>

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

inherited

Definition at line 272 of file MaterialPropertyInterface.C.

 {
   const std::string new_name = name + "_residual";
   return getMaterialByName(new_name, no_warn);
 }

◆ getMaterialByName() [2/4]

template<>

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

inherited

Definition at line 280 of file MaterialPropertyInterface.C.

 {
   const std::string new_name = name + "_jacobian";
   return getMaterialByName(new_name, no_warn);
 }

◆ getMaterialByName() [3/4]

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

inherited

Definition at line 254 of file MaterialPropertyInterface.C.

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

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

◆ getMaterialByName() [4/4]

template<ComputeStage >

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

inherited

◆ getMaterialPropertyBlockNames()

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

inherited

Retrieve the block names that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the block names for the property

Definition at line 162 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBlockNames(name);
 }

◆ getMaterialPropertyBlocks()

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

inherited

Retrieve the block ids that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the block ids for the property

Definition at line 156 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBlocks(name);
 }

◆ getMaterialPropertyBoundaryIDs()

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

inherited

Retrieve the boundary ids that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the boundary ids for the property

Definition at line 168 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBoundaryIDs(name);
 }

◆ getMaterialPropertyBoundaryNames()

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

inherited

Retrieve the boundary namess that the material property is defined.

Parameters

name	The name of the material property

Returns: A vector the the boundary names for the property

Definition at line 174 of file MaterialPropertyInterface.C.

 {
   return _mi_feproblem.getMaterialPropertyBoundaryNames(name);
 }

◆ getMaterialPropertyByNameTempl()

template<typename T >

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

inherited

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

Parameters

name	The name of the material property to retrieve

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

Definition at line 385 of file MaterialPropertyInterface.h.

 {
   checkExecutionStage();
   checkMaterialProperty(name);
  
   // mark property as requested
   markMatPropRequested(name);
  
   // Update the boolean flag.
   _get_material_property_called = true;
  
   _material_property_dependencies.insert(_material_data->getPropertyId(name));
  
   return _material_data->getProperty<T>(name);
 }

◆ getMaterialPropertyCalled()

bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlineinherited

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

Definition at line 179 of file MaterialPropertyInterface.h.

179 { return _get_material_property_called; }

◆ getMaterialPropertyOldByNameTempl()

template<typename T >

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

inherited

Definition at line 423 of file MaterialPropertyInterface.h.

 {
   if (!_stateful_allowed)
     mooseError("Stateful material properties not allowed for this object."
                " Old property for \"",
                name,
                "\" was requested.");
  
   // mark property as requested
   markMatPropRequested(name);
  
   _material_property_dependencies.insert(_material_data->getPropertyId(name));
  
   return _material_data->getPropertyOld<T>(name);
 }

◆ getMaterialPropertyOlderByNameTempl()

template<typename T >

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

inherited

Definition at line 441 of file MaterialPropertyInterface.h.

 {
   if (!_stateful_allowed)
     mooseError("Stateful material properties not allowed for this object."
                " Older property for \"",
                name,
                "\" was requested.");
  
   // mark property as requested
   markMatPropRequested(name);
  
   _material_property_dependencies.insert(_material_data->getPropertyId(name));
  
   return _material_data->getPropertyOlder<T>(name);
 }

◆ getMaterialPropertyOlderTempl()

template<typename T >

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

inherited

Definition at line 335 of file MaterialPropertyInterface.h.

 {
   if (!_stateful_allowed)
     mooseError("Stateful material properties not allowed for this object."
                " Older property for \"",
                name,
                "\" was requested.");
  
   // Check if the supplied parameter is a valid input parameter key
   std::string prop_name = deducePropertyName(name);
  
   // Check if it's just a constant
   const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
   if (default_property)
     return *default_property;
  
   return getMaterialPropertyOlderByName<T>(prop_name);
 }

◆ getMaterialPropertyOldTempl()

template<typename T >

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

inherited

Definition at line 314 of file MaterialPropertyInterface.h.

 {
   if (!_stateful_allowed)
     mooseError("Stateful material properties not allowed for this object."
                " Old property for \"",
                name,
                "\" was requested.");
  
   // Check if the supplied parameter is a valid input parameter key
   std::string prop_name = deducePropertyName(name);
  
   // Check if it's just a constant
   const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
   if (default_property)
     return *default_property;
  
   return getMaterialPropertyOldByName<T>(prop_name);
 }

◆ getMaterialPropertyTempl()

template<typename T >

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

inherited

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

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

Parameters

name	The name of the parameter key of the material property to retrieve

Returns: Reference to the desired material property

Definition at line 284 of file MaterialPropertyInterface.h.

 {
   // Check if the supplied parameter is a valid input parameter key
   std::string prop_name = deducePropertyName(name);
  
   // Check if it's just a constant
   const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
   if (default_property)
     return *default_property;
  
   return getMaterialPropertyByName<T>(prop_name);
 }

◆ getMatPropDependencies()

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

inlineinherited

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

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

Definition at line 187 of file MaterialPropertyInterface.h.

   {
     return _material_property_dependencies;
   }

Referenced by Material::getMatPropDependencies(), InterfaceMaterial::getMatPropDependencies(), and NodalPatchRecovery::reinitPatch().

◆ getMeshProperty()

template<typename T >

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

protectedinherited

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

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

Definition at line 72 of file MeshMetaDataInterface.h.

 {
   std::string full_name = std::string(SYSTEM) + "/" + prefix + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, nullptr);
  
   // Here we will create the RestartableData even though we may not use this instance.
   // If it's already in use, the App will return a reference to the existing instance and we'll
   // return that one instead. We might refactor this to have the app create the RestartableData
   // at a later date.
   auto & restartable_data_ref =
       static_cast<RestartableData<T> &>(registerMetaDataOnApp(full_name, std::move(data_ptr)));
  
   return restartable_data_ref.get();
 }

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getOutputs()

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

inherited

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

Returns: A set of OutputNames

Definition at line 97 of file OutputInterface.C.

 {
   return _oi_outputs;
 }

◆ getParamTempl()

template<typename T >

const T & MooseObject::getParamTempl ( 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 208 of file MooseObject.h.

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

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), EigenKernel::EigenKernel(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), ConsoleUtils::outputExecutionInformation(), and TimePeriod::TimePeriod().

◆ getPostprocessorValue()

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

virtualinherited

Store dependency among same object types for proper execution order.

Definition at line 50 of file GeneralUserObject.C.

 {
   // is this a vector of pp names, we use the number of default entries
   // to figure that out
   if (_pars.isSinglePostprocessor(name))
     _depend_vars.insert(_pars.get<PostprocessorName>(name));
   else
     _depend_vars.insert(_pars.get<std::vector<PostprocessorName>>(name)[index]);
   return PostprocessorInterface::getPostprocessorValue(name, index);
 }

Referenced by LinearCombinationPostprocessor::LinearCombinationPostprocessor().

◆ getPostprocessorValueByName()

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

virtualinherited

Definition at line 62 of file GeneralUserObject.C.

 {
   _depend_vars.insert(name);
   return PostprocessorInterface::getPostprocessorValueByName(name);
 }

Referenced by Terminator::Terminator(), and VectorOfPostprocessors::VectorOfPostprocessors().

◆ getPostprocessorValueOld()

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

inherited

Definition at line 55 of file PostprocessorInterface.C.

 {
   if (singlePostprocessor(name) && index > 0)
     mooseError("Postprocessor requested with index ",
                index,
                " when only a single postprocessor is coupled.");
  
   // Return the default if the Postprocessor does not exist and a default does, otherwise
   // continue as usual
   if (!hasPostprocessor(name, index) && _ppi_params.hasDefaultPostprocessorValue(name, index))
     return _ppi_params.getDefaultPostprocessorValue(name, false, index);
   else
   {
     if (singlePostprocessor(name))
       return _pi_feproblem.getPostprocessorValueOld(_ppi_params.get<PostprocessorName>(name));
  
     // check size of parameter array here
     if (index >= _ppi_params.get<std::vector<PostprocessorName>>(name).size())
       mooseError("Postprocessor requested with index ",
                  index,
                  " but parameter ",
                  name,
                  " has only ",
                  _ppi_params.get<std::vector<PostprocessorName>>(name).size(),
                  " entries.");
  
     return _pi_feproblem.getPostprocessorValueOld(
         _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
   }
 }

◆ getPostprocessorValueOldByName()

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

inherited

Definition at line 125 of file PostprocessorInterface.C.

 {
   return _pi_feproblem.getPostprocessorValueOld(name);
 }

Referenced by EigenKernel::EigenKernel().

◆ getPostprocessorValueOlder()

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

inherited

Definition at line 87 of file PostprocessorInterface.C.

 {
   if (singlePostprocessor(name) && index > 0)
     mooseError("Postprocessor requested with index ",
                index,
                " when only a single postprocessor is coupled.");
  
   // Return the default if the Postprocessor does not exist and a default does, otherwise
   // continue as usual
   if (!hasPostprocessor(name, index) && _ppi_params.hasDefaultPostprocessorValue(name, index))
     return _ppi_params.getDefaultPostprocessorValue(name, false, index);
   else
   {
     if (singlePostprocessor(name))
       return _pi_feproblem.getPostprocessorValueOlder(_ppi_params.get<PostprocessorName>(name));
  
     // check size of parameter array here
     if (index >= _ppi_params.get<std::vector<PostprocessorName>>(name).size())
       mooseError("Postprocessor requested with index ",
                  index,
                  " but parameter ",
                  name,
                  " has only ",
                  _ppi_params.get<std::vector<PostprocessorName>>(name).size(),
                  " entries.");
  
     return _pi_feproblem.getPostprocessorValueOlder(
         _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
   }
 }

◆ getPostprocessorValueOlderByName()

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

inherited

Definition at line 131 of file PostprocessorInterface.C.

 {
   return _pi_feproblem.getPostprocessorValueOlder(name);
 }

◆ getRequestedItems()

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

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 38 of file GeneralUserObject.C.

 {
   return _depend_vars;
 }

◆ getScalarVar()

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

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

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

Returns: Pointer to the desired variable

Definition at line 313 of file ScalarCoupleable.C.

 {
   if (_coupled_scalar_vars.find(var_name) != _coupled_scalar_vars.end())
   {
     if (comp < _coupled_scalar_vars[var_name].size())
       return _coupled_scalar_vars[var_name][comp];
     else
       mooseError(_sc_name, ": Trying to get a non-existent component of variable '", var_name, "'");
   }
   else
     mooseError(_sc_name, ": Trying to get a non-existent variable '", var_name, "'");
 }

◆ getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 51 of file ScalarCoupleable.h.

51 { return _sc_coupleable_matrix_tags; }

◆ getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 49 of file ScalarCoupleable.h.

49 { return _sc_coupleable_vector_tags; }

◆ getScatterVectorPostprocessorValue()

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

virtualinherited

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 parameter holding the vpp name
vector_name	The name of the vector

Returns: The reference to the current scatter value

Reimplemented in AuxKernelTempl< ComputeValueType >.

Definition at line 92 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getScatterVectorPostprocessorValue(
       _vpi_params.get<VectorPostprocessorName>(name), vector_name);
 }

Referenced by AuxKernelTempl< ComputeValueType >::getScatterVectorPostprocessorValue().

◆ getScatterVectorPostprocessorValueByName()

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

virtualinherited

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

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

Returns: The reference to the current scatter value

Reimplemented in AuxKernelTempl< ComputeValueType >.

Definition at line 100 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getScatterVectorPostprocessorValue(name, vector_name);
 }

Referenced by AuxKernelTempl< ComputeValueType >::getScatterVectorPostprocessorValueByName().

◆ getScatterVectorPostprocessorValueOld()

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

virtualinherited

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

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 107 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getScatterVectorPostprocessorValueOld(
       _vpi_params.get<VectorPostprocessorName>(name), vector_name);
 }

◆ getScatterVectorPostprocessorValueOldByName()

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

virtualinherited

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

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

Returns: The reference to the old scatter value

Definition at line 115 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getScatterVectorPostprocessorValueOld(name, vector_name);
 }

◆ getSubProblem()

SubProblem& UserObject::getSubProblem ( ) const

inlineinherited

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

Definition at line 74 of file UserObject.h.

74 { return _subproblem; }

◆ getSuppliedItems()

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

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 44 of file GeneralUserObject.C.

 {
   return _supplied_vars;
 }

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase ( const std::string & name )

inherited

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

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

Definition at line 24 of file UserObjectInterface.C.

 {
   return _uoi_feproblem.getUserObjectBase(_uoi_params.get<UserObjectName>(name));
 }

Referenced by InitialConditionBase::getUserObjectBase(), AuxKernelTempl< ComputeValueType >::getUserObjectBase(), and UserObjectInterface::getUserObjectTempl().

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName ( const std::string & name )

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns: The user object with the name

Definition at line 30 of file UserObjectInterface.C.

 {
   return _uoi_feproblem.getUserObjectBase(name);
 }

Referenced by UserObjectInterface::getUserObjectByNameTempl().

◆ getUserObjectByNameTempl()

template<class T >

const T & UserObjectInterface::getUserObjectByNameTempl ( const std::string & name )

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns: The user object with the name

Definition at line 93 of file UserObjectInterface.h.

 {
   unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectTempl<T>(name, tid);
 }

◆ getUserObjectTempl()

template<class T >

const T & UserObjectInterface::getUserObjectTempl ( const std::string & name )

inherited

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

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

Definition at line 85 of file UserObjectInterface.h.

 {
   unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectTempl<T>(_uoi_params.get<UserObjectName>(name), tid);
 }

◆ getVector()

VectorPostprocessorValue & VectorPostprocessor::getVector ( const std::string & vector_name )

virtualinherited

This will get called to actually grab the final value the VectorPostprocessor has calculated.

Definition at line 52 of file VectorPostprocessor.C.

 {
   return _vpp_fe_problem->getVectorPostprocessorValue(_vpp_name, vector_name);
 }

◆ getVectorPostprocessorValue() [1/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValue	(	const std::string &	name,
		const std::string &	vector_name
	)

overridevirtualinherited

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

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 69 of file GeneralUserObject.C.

 {
   _depend_vars.insert(_pars.get<VectorPostprocessorName>(name));
   return VectorPostprocessorInterface::getVectorPostprocessorValue(name, vector_name);
 }

◆ getVectorPostprocessorValue() [2/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValue	(	const std::string &	name,
		const std::string &	vector_name,
		bool	needs_broadcast
	)

overridevirtualinherited

Retrieve the value of a VectorPostprocessor.

Parameters

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 85 of file GeneralUserObject.C.

 {
   _depend_vars.insert(_pars.get<VectorPostprocessorName>(name));
   return VectorPostprocessorInterface::getVectorPostprocessorValue(
       name, vector_name, use_broadcast);
 }

◆ getVectorPostprocessorValueByName() [1/2]

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

overridevirtualinherited

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 77 of file GeneralUserObject.C.

 {
   _depend_vars.insert(name);
   return VectorPostprocessorInterface::getVectorPostprocessorValueByName(name, vector_name);
 }

◆ getVectorPostprocessorValueByName() [2/2]

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

overridevirtualinherited

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

Reimplemented from VectorPostprocessorInterface.

Definition at line 95 of file GeneralUserObject.C.

 {
   _depend_vars.insert(name);
   return VectorPostprocessorInterface::getVectorPostprocessorValueByName(
       name, vector_name, use_broadcast);
 }

◆ getVectorPostprocessorValueOld() [1/2]

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

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 parameter
vector_name	The name of the particular vector you want.

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 40 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getVectorPostprocessorValueOld(
       _vpi_params.get<VectorPostprocessorName>(name), vector_name, _broadcast_by_default);
 }

◆ getVectorPostprocessorValueOld() [2/2]

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

virtualinherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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 73 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getVectorPostprocessorValueOld(
       _vpi_params.get<VectorPostprocessorName>(name),
       vector_name,
       needs_broadcast || _broadcast_by_default);
 }

◆ getVectorPostprocessorValueOldByName() [1/2]

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

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 48 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getVectorPostprocessorValueOld(name, vector_name, _broadcast_by_default);
 }

◆ getVectorPostprocessorValueOldByName() [2/2]

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

virtualinherited

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 84 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.getVectorPostprocessorValueOld(
       name, vector_name, needs_broadcast || _broadcast_by_default);
 }

◆ getZeroMaterialProperty()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getZeroMaterialProperty ( const std::string & prop_name )

inherited

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

Definition at line 492 of file MaterialPropertyInterface.h.

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

◆ hasMaterialPropertyByNameTempl()

template<typename T >

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

inherited

Definition at line 485 of file MaterialPropertyInterface.h.

 {
   return _material_data->haveProperty<T>(name);
 }

◆ hasMaterialPropertyTempl()

template<typename T >

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

inherited

Check if the material property exists.

Parameters

name	the name of the property to query

Returns: true if the property exists, otherwise false

Definition at line 476 of file MaterialPropertyInterface.h.

 {
   // Check if the supplied parameter is a valid input parameter key
   std::string prop_name = deducePropertyName(name);
   return hasMaterialPropertyByName<T>(prop_name);
 }

◆ hasPostprocessor()

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

inherited

Determine if the Postprocessor exists.

Parameters

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

 {
   if (singlePostprocessor(name))
     return _pi_feproblem.hasPostprocessor(_ppi_params.get<PostprocessorName>(name));
   return _pi_feproblem.hasPostprocessor(
       _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
 }

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

◆ hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName & name )

inherited

Determine if the Postprocessor exists.

Parameters

name	The name of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessor getPostprocessorValueByName

Definition at line 160 of file PostprocessorInterface.C.

 {
   return _pi_feproblem.hasPostprocessor(name);
 }

Referenced by VectorOfPostprocessors::VectorOfPostprocessors().

◆ hasVectorPostprocessor()

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

inherited

Determine if the VectorPostprocessor exists.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 122 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.hasVectorPostprocessor(_vpi_params.get<VectorPostprocessorName>(name));
 }

◆ hasVectorPostprocessorByName()

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

inherited

Determine if the VectorPostprocessor exists.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 128 of file VectorPostprocessorInterface.C.

 {
   return _vpi_feproblem.hasVectorPostprocessor(name);
 }

◆ initialize()

void ElementsAlongLine::initialize ( )

overridevirtual

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

Implements UserObject.

Definition at line 42 of file ElementsAlongLine.C.

 {
   _elem_ids.clear();
 }

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

Reimplemented in SolutionUserObject, MultiApp, MooseParsedFunction, MooseParsedGradFunction, SolutionFunction, Exodus, CSV, Receiver, OversampleOutput, Nemesis, Axisymmetric2D3DSolutionFunction, ImageFunction, Console, MooseParsedVectorFunction, TimePeriod, TransientMultiApp, GhostingUserObject, SolutionAux, MultiAppProjectionTransfer, SolutionScalarAux, MultiAppVariableValueSampleTransfer, FullSolveMultiApp, MultiAppConservativeTransfer, PiecewiseLinearBase, AdvancedOutput, Output, Transfer, DerivativeFunctionMaterialBase, MultiAppFieldTransfer, MatDiffusionBase< T >, MatDiffusionBase< Real >, and DerivativeSumMaterial.

Definition at line 44 of file SetupInterface.C.

45 {

46 }

◆ isCoupledScalar()

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

protectedvirtualinherited

Returns true if a variables has been coupled_as name.

Parameters

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

Definition at line 74 of file ScalarCoupleable.C.

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

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

◆ isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 42 of file TransientInterface.h.

42 { return _is_implicit; }

◆ isParamValid()

bool MooseObject::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 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

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

Definition at line 54 of file SetupInterface.C.

55 {

56 }

◆ markMatPropRequested()

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

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 194 of file MaterialPropertyInterface.C.

 {
   _mi_feproblem.markMatPropRequested(name);
 }

Referenced by MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOldByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOlderByNameTempl(), and TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl().

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in DiracKernel, Console, Exodus, Nemesis, OversampleOutput, GhostingUserObject, ExplicitTimeIntegrator, EqualValueBoundaryConstraint, and GeometryBase.

Definition at line 39 of file MeshChangedInterface.h.

39 {}

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

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

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 of file MooseObject.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
     callMooseErrorRaw(msg, &_app);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 162 of file MooseObject.h.

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

Referenced by AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MooseObject::paramInfo(), DerivativeParsedMaterialHelper::recurseDerivative(), ReferenceResidualProblem::ReferenceResidualProblem(), and FEProblemBase::setRestartFile().

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

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

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkMultiAppExecuteOn(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), ReferenceResidualProblem::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), MaterialBase::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

◆ name()

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

inlinevirtualinherited

Get the name of the object.

Returns: The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ needThreadedCopy()

bool UserObjectInterface::needThreadedCopy ( const UserObject & uo ) const

privateinherited

Check if the threaded copy of the user object is needed.

Definition at line 36 of file UserObjectInterface.C.

 {
   return (dynamic_cast<const DiscreteElementUserObject *>(&uo) != NULL) ||
          (dynamic_cast<const ThreadedGeneralUserObject *>(&uo) != NULL);
 }

Referenced by UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ paramError()

template<typename... Args>

void MooseObject::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 215 of file MooseObject.h.

 {
   Moose::show_trace = false;
   mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
   Moose::show_trace = true;
 }

◆ paramErrorMsg()

template<typename... Args>

std::string MooseObject::paramErrorMsg	(	const std::string &	param,
		Args...	args
	)		const

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

   {
     auto prefix = paramErrorPrefix(_pars, param);
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
  
     // Wrap error message to a separate line from prefix if it is about to
     // blow past 100 chars.  But only wrap if the prefix is long enough (12
     // chars) for the wrap to buy us much extra length.
     if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
         msg.find("\n") != std::string::npos)
     {
       if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
         prefix += ":";
       return prefix + "\n    " + MooseUtils::replaceAll(msg, "\n", "\n    ");
     }
     return prefix + " " + msg;
   }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseObject::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 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

void MooseObject::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 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ PPName()

std::string VectorPostprocessor::PPName ( )

inlineinherited

Returns the name of the VectorPostprocessor.

Definition at line 52 of file VectorPostprocessor.h.

52 { return _vpp_name; }

◆ primaryThreadCopy()

UserObject* UserObject::primaryThreadCopy ( )

inlineinherited

Definition at line 138 of file UserObject.h.

138 { return _primary_thread_copy; }

◆ registerMetaDataOnApp()

RestartableDataValue & MeshMetaDataInterface::registerMetaDataOnApp	(	const std::string &	name,
		std::unique_ptr< RestartableDataValue >	data
	)

privateinherited

Helper function for actually registering the restartable data.

Definition at line 23 of file MeshMetaDataInterface.C.

 {
   return _meta_data_app.registerRestartableData(name, std::move(data), 0, true, true);
 }

Referenced by MeshMetaDataInterface::getMeshProperty().

◆ registerRestartableDataOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 48 of file Restartable.C.

 {
   return _restartable_app.registerRestartableData(name, std::move(data), tid, false, false);
 }

Referenced by Restartable::declareRestartableDataWithContext().

◆ registerRestartableNameWithFilterOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 56 of file Restartable.C.

 {
   _restartable_app.registerRestartableNameWithFilter(name, filter);
 }

Referenced by Restartable::declareRecoverableData().

◆ registerTimedSection()

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

protectedinherited

Call to register a named section for timing.

Parameters

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

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

Definition at line 51 of file PerfGraphInterface.C.

 {
   if (_prefix != "")
     return _perf_graph.registerSection(_prefix + "::" + section_name, level);
   else
     return _perf_graph.registerSection(section_name, level);
 }

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

Definition at line 59 of file SetupInterface.C.

60 {

61 }

◆ setPrimaryThreadCopy()

void UserObject::setPrimaryThreadCopy ( UserObject * primary )

inlineinherited

Definition at line 132 of file UserObject.h.

   {
     if (!_primary_thread_copy && primary != this)
       _primary_thread_copy = primary;
   }

Referenced by FEProblemBase::addUserObject().

◆ shouldDuplicateInitialExecution()

bool UserObject::shouldDuplicateInitialExecution ( ) const

inlineinherited

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

Definition at line 80 of file UserObject.h.

80 { return _duplicate_initial_execution; }

◆ singlePostprocessor()

bool PostprocessorInterface::singlePostprocessor ( const std::string & name ) const

inherited

Checks if there is a single postprocessor coupled by parameter name.

Parameters

name	The name of the Postprocessor parameter

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

Definition at line 154 of file PostprocessorInterface.C.

 {
   return _ppi_params.isSinglePostprocessor(name);
 }

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

◆ sort()

template<typename T >

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

staticinherited

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

Definition at line 57 of file DependencyResolverInterface.h.

 {
   DependencyResolver<T> resolver;
  
   typename std::vector<T>::iterator start = vector.begin();
   typename std::vector<T>::iterator end = vector.end();
  
   for (typename std::vector<T>::iterator iter = start; iter != end; ++iter)
   {
     const std::set<std::string> & requested_items = (*iter)->getRequestedItems();
  
     for (typename std::vector<T>::iterator iter2 = start; iter2 != end; ++iter2)
     {
       if (iter == iter2)
         continue;
  
       const std::set<std::string> & supplied_items = (*iter2)->getSuppliedItems();
  
       std::set<std::string> intersect;
       std::set_intersection(requested_items.begin(),
                             requested_items.end(),
                             supplied_items.begin(),
                             supplied_items.end(),
                             std::inserter(intersect, intersect.end()));
  
       // If the intersection isn't empty then there is a dependency here
       if (!intersect.empty())
         resolver.insertDependency(*iter, *iter2);
     }
   }
  
   // Sort based on dependencies
   std::stable_sort(start, end, resolver);
 }

Referenced by TheWarehouse::prepare().

◆ spatialValue()

virtual Real UserObject::spatialValue ( const Point & ) const

inlinevirtualinherited

Optional interface function for "evaluating" a UserObject at a spatial position.

If a UserObject overrides this function that UserObject can then be used in a Transfer to transfer information from one domain to another.

Reimplemented in NearestPointIntegralVariablePostprocessor, NearestPointBase< ElementIntegralVariablePostprocessor, ElementVariableVectorPostprocessor >, NearestPointBase< LayeredAverage, ElementIntegralVariableUserObject >, NearestPointBase< LayeredSideAverage, SideIntegralVariableUserObject >, LineValueSampler, LayeredSideIntegral, and LayeredIntegral.

Definition at line 87 of file UserObject.h.

   {
     mooseError(name(), " does not satisfy the Spatial UserObject interface!");
   }

Referenced by SpatialUserObjectAux::computeValue(), and MultiAppUserObjectTransfer::execute().

◆ statefulPropertiesAllowed()

void MaterialPropertyInterface::statefulPropertiesAllowed ( bool stateful_allowed )

inherited

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

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

Definition at line 200 of file MaterialPropertyInterface.C.

 {
   _stateful_allowed = stateful_allowed;
 }

Referenced by DiracKernel::DiracKernel().

◆ subdomainSetup()

void GeneralUserObject::subdomainSetup ( )

overridevirtualinherited

Gets called when the subdomain changes (i.e.

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

Reimplemented from SetupInterface.

Reimplemented in ThreadedGeneralUserObject.

Definition at line 112 of file GeneralUserObject.C.

 {
   mooseError("GeneralUserObjects do not execute subdomainSetup method, this function does nothing "
              "and should not be used.");
 }

◆ threadJoin()

void GeneralUserObject::threadJoin ( const UserObject & )

overridevirtualinherited

This method is not used and should not be used in a custom GeneralUserObject.

Implements UserObject.

Reimplemented in ThreadedGeneralUserObject.

Definition at line 105 of file GeneralUserObject.C.

 {
   mooseError("GeneralUserObjects do not execute using threads, this function does nothing and "
              "should not be used.");
 }

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, EqualValueEmbeddedConstraint, VectorMemoryUsage, and MemoryUsage.

Definition at line 49 of file SetupInterface.C.

50 {

51 }

◆ type()

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

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ validateExecutionerType()

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

protectedinherited

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

Parameters

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

Definition at line 327 of file ScalarCoupleable.C.

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

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

◆ validParams()

InputParameters ElementsAlongLine::validParams ( )

static

Definition at line 22 of file ElementsAlongLine.C.

 {
   InputParameters params = GeneralVectorPostprocessor::validParams();
  
   params.addRequiredParam<Point>("start", "The beginning of the line");
   params.addRequiredParam<Point>("end", "The end of the line");
   params.addClassDescription("Outputs the IDs of every element intersected by a user-defined line");
   return params;
 }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Eigenvalue::postSolve(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _assembly

Assembly& UserObject::_assembly

protectedinherited

Definition at line 149 of file UserObject.h.

Referenced by InternalSideUserObject::getNeighborElemVolume(), and InterfaceUserObject::getNeighborElemVolume().

◆ _broadcast_by_default

bool VectorPostprocessorInterface::_broadcast_by_default

privateinherited

Whether or not to force broadcasting by default.

Definition at line 258 of file VectorPostprocessorInterface.h.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValue(), VectorPostprocessorInterface::getVectorPostprocessorValueByName(), VectorPostprocessorInterface::getVectorPostprocessorValueOld(), 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.

◆ _contains_complete_history

const bool VectorPostprocessor::_contains_complete_history

privateinherited

Definition at line 76 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::containsCompleteHistory(), and VectorPostprocessor::declareVector().

◆ _coord_sys

const Moose::CoordinateSystemType& UserObject::_coord_sys

protectedinherited

Coordinate system.

Definition at line 152 of file UserObject.h.

◆ _coupleable_params

const InputParameters& ScalarCoupleable::_coupleable_params

protectedinherited

Local InputParameters.

Definition at line 220 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::isCoupledScalar().

◆ _coupled_moose_scalar_vars

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

protectedinherited

Vector of coupled variables.

Definition at line 214 of file ScalarCoupleable.h.

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

◆ _coupled_scalar_vars

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

protectedinherited

Coupled vars whose values we provide.

Definition at line 205 of file ScalarCoupleable.h.

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

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 99 of file SetupInterface.h.

◆ _default_ad_real_properties

std::vector<std::unique_ptr<ADMaterialPropertyObject<Real> > > MaterialPropertyInterface::_default_ad_real_properties

protectedinherited

Storage vector for ADMaterialPropertyObject<Real> default objects.

Definition at line 263 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultADMaterialProperty().

◆ _default_ad_real_vector_properties

std::vector<std::unique_ptr<ADMaterialPropertyObject<RealVectorValue> > > MaterialPropertyInterface::_default_ad_real_vector_properties

protectedinherited

Storage vector for ADMaterialPropertyObject<RealVectorValue> default objects.

Definition at line 266 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultADMaterialProperty().

◆ _default_real_properties

std::vector<std::unique_ptr<MaterialProperty<Real> > > MaterialPropertyInterface::_default_real_properties

protectedinherited

Storage vector for MaterialProperty<Real> default objects.

Definition at line 261 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultMaterialProperty().

◆ _default_value

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

protectedinherited

Will hold the default value for optional coupled scalar variables.

Definition at line 208 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue().

◆ _depend_vars

std::set<std::string> GeneralUserObject::_depend_vars

protectedinherited

Definition at line 78 of file GeneralUserObject.h.

Referenced by GeneralUserObject::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), GeneralUserObject::getRequestedItems(), GeneralUserObject::getVectorPostprocessorValue(), and GeneralUserObject::getVectorPostprocessorValueByName().

◆ _dni_feproblem

FEProblemBase& DistributionInterface::_dni_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 65 of file DistributionInterface.h.

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

◆ _dni_moose_object_ptr

const MooseObject* DistributionInterface::_dni_moose_object_ptr

privateinherited

Pointer to the MooseObject.

Definition at line 68 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 62 of file DistributionInterface.h.

Referenced by DistributionInterface::getDistribution().

◆ _dt

Real& TransientInterface::_dt

protectedinherited

Time step size.

Definition at line 64 of file TransientInterface.h.

Referenced by TotalVariableValue::execute(), and VariableTimeIntegrationAux::getIntegralValue().

◆ _dt_old

Real& TransientInterface::_dt_old

protectedinherited

Size of the old time step.

Definition at line 67 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _dual_default_value

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

protectedinherited

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

Definition at line 211 of file ScalarCoupleable.h.

◆ _duplicate_initial_execution

const bool UserObject::_duplicate_initial_execution

protectedinherited

Definition at line 154 of file UserObject.h.

Referenced by UserObject::shouldDuplicateInitialExecution().

◆ _elem_ids

VectorPostprocessorValue& ElementsAlongLine::_elem_ids

protected

The elements that intersect the line.

Definition at line 45 of file ElementsAlongLine.h.

Referenced by execute(), and initialize().

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

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end

Point ElementsAlongLine::_end

protected

The end of the line.

Definition at line 42 of file ElementsAlongLine.h.

Referenced by execute().

◆ _exec_flags

const std::vector<ExecFlagType> SetupInterface::_exec_flags

protectedinherited

(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType

Definition at line 96 of file SetupInterface.h.

Referenced by SetupInterface::execBitFlags(), MultiAppTransfer::execFlags(), and SetupInterface::execFlags().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this oejct.

Definition at line 93 of file SetupInterface.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and SetupInterface::getExecuteOnEnum().

◆ _fe_problem

FEProblemBase& UserObject::_fe_problem

protectedinherited

Reference to the FEProblemBase for this user object.

Definition at line 145 of file UserObject.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), ElementsAlongLine(), ElementsAlongPlane::ElementsAlongPlane(), VariableResidual::execute(), NodalNormalsEvaluator::execute(), StatisticsVectorPostprocessor::execute(), NodalNormalsCorner::execute(), GreaterThanLessThanPostprocessor::execute(), ElementsAlongPlane::execute(), IntersectionPointsAlongLine::execute(), execute(), HistogramVectorPostprocessor::execute(), NodalNormalsPreprocessor::execute(), WorkBalance::execute(), Terminator::execute(), NumResidualEvaluations::getValue(), ElementalVariableValue::getValue(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), Receiver::initialSetup(), IntersectionPointsAlongLine::IntersectionPointsAlongLine(), SolutionUserObject::pointValueGradientWrapper(), and SolutionUserObject::pointValueWrapper().

◆ _fni_feproblem

FEProblemBase& FunctionInterface::_fni_feproblem

privateinherited

Reference to FEProblemBase instance.

Definition at line 70 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _fni_params

const InputParameters& FunctionInterface::_fni_params

privateinherited

Parameters of the object with this interface.

Definition at line 67 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction().

◆ _fni_tid

const THREAD_ID FunctionInterface::_fni_tid

privateinherited

Thread ID.

Definition at line 73 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _get_material_property_called

bool MaterialPropertyInterface::_get_material_property_called

protectedinherited

Initialized to false.

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

Definition at line 258 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyCalled(), and TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl().

◆ _is_broadcast

const bool VectorPostprocessor::_is_broadcast

privateinherited

Definition at line 78 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::declareVector().

◆ _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 55 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and TransientInterface::isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient

protectedinherited

Definition at line 70 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _material_data

std::shared_ptr<MaterialData> MaterialPropertyInterface::_material_data

protectedinherited

Pointer to the material data class that stores properties.

Definition at line 203 of file MaterialPropertyInterface.h.

Referenced by Material::computeProperties(), MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOldByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOlderByNameTempl(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl(), MaterialPropertyInterface::hasMaterialPropertyByNameTempl(), Material::materialData(), InterfaceMaterial::materialData(), and MaterialPropertyInterface::MaterialPropertyInterface().

◆ _material_data_type

Moose::MaterialDataType MaterialPropertyInterface::_material_data_type

protectedinherited

The type of data.

Definition at line 200 of file MaterialPropertyInterface.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), MaterialPropertyInterface::getMaterialByName(), and MaterialPropertyInterface::MaterialPropertyInterface().

◆ _material_property_dependencies

std::set<unsigned int> MaterialPropertyInterface::_material_property_dependencies

protectedinherited

The set of material properties (as given by their IDs) that this object depends on.

Definition at line 269 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByNameTempl(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getMaterialPropertyByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOldByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOlderByNameTempl(), MaterialPropertyInterface::getMatPropDependencies(), and TwoMaterialPropertyInterface::getNeighborMaterialPropertyByNameTempl().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 43 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _meta_data_app

MooseApp& MeshMetaDataInterface::_meta_data_app

privateinherited

Reference to the application.

Definition at line 67 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::registerMetaDataOnApp().

◆ _mi_block_ids

const std::set<SubdomainID>& MaterialPropertyInterface::_mi_block_ids

privateinherited

Storage for the block ids created by BlockRestrictable.

Definition at line 276 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), MaterialPropertyInterface::checkMaterialProperty(), and MaterialPropertyInterface::getBlockMaterialProperty().

◆ _mi_boundary_ids

const std::set<BoundaryID>& MaterialPropertyInterface::_mi_boundary_ids

privateinherited

Storage for the boundary ids created by BoundaryRestrictable.

Definition at line 279 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), and MaterialPropertyInterface::checkMaterialProperty().

◆ _mi_boundary_restricted

const bool MaterialPropertyInterface::_mi_boundary_restricted

privateinherited

BoundaryRestricted flag.

Definition at line 273 of file MaterialPropertyInterface.h.

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

◆ _mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 206 of file MaterialPropertyInterface.h.

◆ _mi_name

const std::string MaterialPropertyInterface::_mi_name

protectedinherited

The name of the object that this interface belongs to.

Definition at line 197 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkMaterialProperty().

◆ _mi_params

const InputParameters& MaterialPropertyInterface::_mi_params

protectedinherited

Parameters of the object with this interface.

Definition at line 194 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), MaterialPropertyInterface::deducePropertyName(), MaterialPropertyInterface::getMaterial(), and MaterialPropertyInterface::MaterialPropertyInterface().

◆ _mi_tid

const THREAD_ID MaterialPropertyInterface::_mi_tid

protectedinherited

Current threaded it.

Definition at line 209 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getMaterialByName().

◆ _name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 178 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), MooseObject::name(), PiecewiseBilinear::parse(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::recurseDerivative(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _oi_moose_app

MooseApp& OutputInterface::_oi_moose_app

privateinherited

Reference the the MooseApp; neede for access to the OutputWarehouse.

Definition at line 70 of file OutputInterface.h.

◆ _oi_output_warehouse

OutputWarehouse& OutputInterface::_oi_output_warehouse

privateinherited

Reference to the OutputWarehouse for populating the Output object hide lists.

Definition at line 73 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList().

◆ _oi_outputs

std::set<OutputName> OutputInterface::_oi_outputs

privateinherited

The set of Output object names listed in the 'outputs' parameter.

Definition at line 76 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList(), and OutputInterface::getOutputs().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

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

Definition at line 169 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PNGOutput::calculateRescalingValues(), BreakMeshByBlockBase::checkInputParameter(), RandomPartitioner::clone(), PetscExternalPartitioner::clone(), BlockWeightedPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::execute(), Executioner::Executioner(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObjectBase(), InitialConditionBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramErrorMsg(), MooseObject::parameters(), MooseMesh::setPartitionerHelper(), and Transient::setupTimeIntegrator().

◆ _perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 67 of file PerfGraphInterface.h.

Referenced by PerfGraphData::getValue(), and PerfGraphInterface::registerTimedSection().

◆ _pg_params

const InputParameters* PerfGraphInterface::_pg_params

protectedinherited

Params.

Definition at line 64 of file PerfGraphInterface.h.

◆ _pi_feproblem

FEProblemBase& PostprocessorInterface::_pi_feproblem

privateinherited

Reference the the FEProblemBase class.

Definition at line 131 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueByName(), PostprocessorInterface::getPostprocessorValueOld(), PostprocessorInterface::getPostprocessorValueOldByName(), PostprocessorInterface::getPostprocessorValueOlder(), PostprocessorInterface::getPostprocessorValueOlderByName(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::hasPostprocessorByName().

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 232 of file ScalarCoupleable.h.

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

◆ _ppi_params

const InputParameters& PostprocessorInterface::_ppi_params

privateinherited

PostprocessorInterface Parameters.

Definition at line 128 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::coupledPostprocessors(), PostprocessorInterface::getDefaultPostprocessorValue(), PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), PostprocessorInterface::getPostprocessorValueOlder(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::singlePostprocessor().

◆ _prefix

std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 70 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::registerTimedSection().

◆ _primary_thread_copy

UserObject* UserObject::_primary_thread_copy = nullptr

privateinherited

Definition at line 157 of file UserObject.h.

Referenced by UserObject::primaryThreadCopy(), and UserObject::setPrimaryThreadCopy().

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 226 of file ScalarCoupleable.h.

◆ _restartable_app

MooseApp& Restartable::_restartable_app

privateinherited

Reference to the application.

Definition at line 208 of file Restartable.h.

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

◆ _restartable_name

std::string Restartable::_restartable_name

privateinherited

The name of the object.

Definition at line 211 of file Restartable.h.

Referenced by Restartable::declareRecoverableData(), Restartable::declareRestartableDataWithContext(), and Restartable::declareRestartableDataWithObjectNameWithContext().

◆ _restartable_system_name

std::string Restartable::_restartable_system_name

privateinherited

The system name this object is in.

Definition at line 214 of file Restartable.h.

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

◆ _restartable_tid

THREAD_ID Restartable::_restartable_tid

privateinherited

The thread ID for this object.

Definition at line 217 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithContext().

◆ _sc_coupleable_matrix_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_matrix_tags

privateinherited

Definition at line 280 of file ScalarCoupleable.h.

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

◆ _sc_coupleable_vector_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_vector_tags

privateinherited

Definition at line 278 of file ScalarCoupleable.h.

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

◆ _sc_coupled_vars

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

privateinherited

Field variables coupled into this object (for error checking)

Definition at line 276 of file ScalarCoupleable.h.

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

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 202 of file ScalarCoupleable.h.

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

◆ _sc_is_implicit

bool ScalarCoupleable::_sc_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 217 of file ScalarCoupleable.h.

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

◆ _sc_name

const std::string& ScalarCoupleable::_sc_name

protectedinherited

The name of the object this interface is part of.

Definition at line 62 of file ScalarCoupleable.h.

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

◆ _sc_parameters

const InputParameters& ScalarCoupleable::_sc_parameters

protectedinherited

Definition at line 59 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _sc_tid

THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 223 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 229 of file ScalarCoupleable.h.

◆ _start

Point ElementsAlongLine::_start

protected

The beginning of the line.

Definition at line 39 of file ElementsAlongLine.h.

Referenced by execute().

◆ _stateful_allowed

bool MaterialPropertyInterface::_stateful_allowed

protectedinherited

True by default.

If false, this class throws an error if any of the stateful material properties interfaces are used.

Definition at line 251 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getMaterialPropertyOldByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOlderByNameTempl(), MaterialPropertyInterface::getMaterialPropertyOlderTempl(), MaterialPropertyInterface::getMaterialPropertyOldTempl(), and MaterialPropertyInterface::statefulPropertiesAllowed().

◆ _subproblem

SubProblem& UserObject::_subproblem

protectedinherited

Reference to the Subproblem for this user object.

Definition at line 142 of file UserObject.h.

Referenced by PointValue::execute(), PointSamplerBase::execute(), VerifyNodalUniqueID::finalize(), VerifyElementUniqueID::finalize(), UserObject::getSubProblem(), NumLinearIterations::getValue(), Residual::getValue(), ElementalVariableValue::getValue(), NodalVariableValue::getValue(), NumNonlinearIterations::getValue(), FindValueOnLine::getValueAtPoint(), VerifyNodalUniqueID::initialize(), VerifyElementUniqueID::initialize(), NumDOFs::NumDOFs(), and NumVars::NumVars().

◆ _supplied_vars

std::set<std::string> GeneralUserObject::_supplied_vars

protectedinherited

Definition at line 79 of file GeneralUserObject.h.

Referenced by GeneralUserObject::GeneralUserObject(), and GeneralUserObject::getSuppliedItems().

◆ _t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 58 of file TransientInterface.h.

◆ _t_step

int& TransientInterface::_t_step

protectedinherited

The number of the time step.

Definition at line 61 of file TransientInterface.h.

Referenced by ChangeOverTimePostprocessor::getValue().

◆ _thread_local_vectors

std::map<std::string, VectorPostprocessorValue> VectorPostprocessor::_thread_local_vectors

privateinherited

Definition at line 80 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::declareVector().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protectedinherited

Definition at line 47 of file TransientInterface.h.

Referenced by SolutionFunction::SolutionFunction().

◆ _ti_name

const std::string TransientInterface::_ti_name

privateinherited

Definition at line 73 of file TransientInterface.h.

◆ _ti_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 45 of file TransientInterface.h.

◆ _tid

THREAD_ID UserObject::_tid

protectedinherited

Thread ID of this postprocessor.

Definition at line 148 of file UserObject.h.

Referenced by NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), NodalNormalsPreprocessor::execute(), ElementalVariableValue::getValue(), NodalVariableValue::getValue(), NodalNormalsPreprocessor::initialize(), and SolutionUserObject::pointValueWrapper().

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _uoi_feproblem

FEProblemBase& UserObjectInterface::_uoi_feproblem

privateinherited

Reference to the FEProblemBase instance.

Definition at line 74 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ _uoi_params

const InputParameters& UserObjectInterface::_uoi_params

privateinherited

Parameters of the object with this interface.

Definition at line 71 of file UserObjectInterface.h.

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

◆ _uoi_tid

THREAD_ID UserObjectInterface::_uoi_tid

privateinherited

Thread ID.

Definition at line 77 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ _vpi_feproblem

FEProblemBase& VectorPostprocessorInterface::_vpi_feproblem

privateinherited

Reference the the FEProblemBase class.

Definition at line 264 of file VectorPostprocessorInterface.h.

◆ _vpi_params

const InputParameters& VectorPostprocessorInterface::_vpi_params

privateinherited

VectorPostprocessorInterface Parameters.

Definition at line 261 of file VectorPostprocessorInterface.h.

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

◆ _vpi_tid

THREAD_ID VectorPostprocessorInterface::_vpi_tid

privateinherited

Thread ID.

Definition at line 267 of file VectorPostprocessorInterface.h.

◆ _vpp_fe_problem

FEProblemBase* VectorPostprocessor::_vpp_fe_problem

protectedinherited

Pointer to FEProblemBase.

Definition at line 69 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::declareVector(), LineValueSampler::getValue(), and VectorPostprocessor::getVector().

◆ _vpp_name

std::string VectorPostprocessor::_vpp_name

protectedinherited

The name of the VectorPostprocessor.

Definition at line 66 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::declareVector(), LineValueSampler::getValue(), VectorPostprocessor::getVector(), and VectorPostprocessor::PPName().

◆ _vpp_tid

THREAD_ID VectorPostprocessor::_vpp_tid

privateinherited

Definition at line 74 of file VectorPostprocessor.h.

Referenced by VectorPostprocessor::declareVector().

◆ FILE_SUFFIX

constexpr auto MeshMetaDataInterface::FILE_SUFFIX = "_mesh"

staticconstexprinherited

The suffix appended when writing the restartable data file.

Definition at line 32 of file MeshMetaDataInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), and Checkpoint::output().

◆ NAME

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

staticconstexprinherited

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

Definition at line 38 of file MeshMetaDataInterface.h.

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticconstexprinherited

The system name used when initializing the Restartable interface.

Definition at line 35 of file MeshMetaDataInterface.h.

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

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

include/vectorpostprocessors/ElementsAlongLine.h
src/vectorpostprocessors/ElementsAlongLine.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ElementsAlongLine()

Member Function Documentation

◆ adCoupledScalarValueTempl()

◆ addScalarVariableCoupleableMatrixTag()

◆ addScalarVariableCoupleableVectorTag()

◆ buildOutputHideVariableList()

◆ checkBlockAndBoundaryCompatibility()

◆ checkExecutionStage()

◆ checkMaterialProperty()

◆ checkVar()

◆ containsCompleteHistory()

◆ coupledMatrixTagScalarValue()

◆ coupledPostprocessors()

◆ coupledScalar()

◆ coupledScalarComponents()

◆ coupledScalarDot()

◆ coupledScalarDotDot()

◆ coupledScalarDotDotDu()

◆ coupledScalarDotDotOld()

◆ coupledScalarDotDu()

◆ coupledScalarDotOld()

◆ coupledScalarOrder()

◆ coupledScalarValue()

◆ coupledScalarValueOld()

◆ coupledScalarValueOlder()

◆ coupledVectorTagScalarValue()

◆ cyclicDependencyError()

◆ declareRecoverableData() [1/2]

◆ declareRecoverableData() [2/2]

◆ declareRestartableDataTempl() [1/2]

◆ declareRestartableDataTempl() [2/2]

◆ declareRestartableDataWithContext() [1/2]

◆ declareRestartableDataWithContext() [2/2]

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ declareRestartableDataWithPrefixOverrideAndContext()

◆ declareVector()

◆ deducePropertyName()

◆ defaultADMaterialProperty() [1/3]

◆ defaultADMaterialProperty() [2/3]

◆ defaultADMaterialProperty() [3/3]

◆ defaultMaterialProperty() [1/2]

◆ defaultMaterialProperty() [2/2]

◆ enabled()

◆ execBitFlags()

◆ execFlags()

◆ execute()

◆ finalize()

◆ gatherMax()

◆ gatherMin()

◆ gatherProxyValueMax()

◆ gatherSum()

◆ getADDefaultValue()

◆ getADMaterialPropertyByNameTempl()

◆ getADMaterialPropertyTempl()

◆ getBlockMaterialProperty()

◆ getCheckedPointerParam()

◆ getCoupledMooseScalarVars()

◆ getDefaultPostprocessorValue()

◆ getDefaultValue()

◆ getDistribution() [1/2]

◆ getDistribution() [2/2]

◆ getDistributionByName() [1/2]

◆ getDistributionByName() [2/2]

◆ getExecuteOnEnum()

◆ getExecuteOptions()

◆ getFunction()

◆ getFunctionByName()

◆ getMaterial() [1/2]

◆ getMaterial() [2/2]