AuxNodalScalarKernel Class Reference

#include <AuxNodalScalarKernel.h>

Inheritance diagram for AuxNodalScalarKernel:

Public Member Functions
	AuxNodalScalarKernel (const InputParameters &parameters)
virtual void	compute () override
	Evaluate the kernel. More...
MooseVariableScalar &	variable ()
	The variable that this kernel operates on. More...
SubProblem &	subProblem ()
virtual const std::set< std::string > &	getRequestedItems () override
	Return a set containing the names of items requested by the object. More...
virtual const std::set< std::string > &	getSuppliedItems () override
	Return a set containing the names of items owned by the object. More...
virtual bool	isActive ()
	Use this to enable/disable the constraint. More...
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
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 void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. More...
virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...
virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...
virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...
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...
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<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...
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...
bool	isImplicit ()
virtual void	meshChanged ()
	Called on this object when the mesh changes. More...
const std::unordered_map< std::string, std::vector< MooseVariableFEBase * > > &	getCoupledVars ()
	Get the list of coupled variables. More...
const std::vector< MooseVariableFEBase * > &	getCoupledMooseVars () const
	Get the list of all coupled variables. More...
const std::vector< MooseVariable * > &	getCoupledStandardMooseVars () const
	Get the list of standard coupled variables. More...
const std::vector< VectorMooseVariable * > &	getCoupledVectorMooseVars () const
	Get the list of vector coupled variables. More...
const std::vector< ArrayMooseVariable * > &	getCoupledArratMooseVars () const
	Get the list of array coupled variables. More...
void	addFEVariableCoupleableVectorTag (TagID tag)
void	addFEVariableCoupleableMatrixTag (TagID tag)
std::set< TagID > &	getFEVariableCoupleableVectorTags ()
std::set< TagID > &	getFEVariableCoupleableMatrixTags ()
template<ComputeStage compute_stage>
ADVariableValue *	getADDefaultValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default value for Automatic Differentiation for an uncoupled variable. More...
template<ComputeStage compute_stage>
ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default vector value for Automatic Differentiation for an uncoupled variable. More...
template<>
VectorVariableValue *	getADDefaultVectorValue (const std::string &var_name)
template<>
VectorVariableValue *	getADDefaultVectorValue (const std::string &var_name)
template<ComputeStage compute_stage>
ADVariableGradient &	getADDefaultGradient ()
	Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled variable. More...
template<>
VariableGradient &	getADDefaultGradient ()
template<>
VariableGradient &	getADDefaultGradient ()
template<ComputeStage compute_stage>
ADVectorVariableGradient &	getADDefaultVectorGradient ()
	Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled vector variable. More...
template<>
VectorVariableGradient &	getADDefaultVectorGradient ()
template<>
VectorVariableGradient &	getADDefaultVectorGradient ()
template<ComputeStage compute_stage>
ADVariableSecond &	getADDefaultSecond ()
	Helper method to return (and insert if necessary) the default second derivatives for Automatic Differentiation for an uncoupled variable. More...
template<>
VariableSecond &	getADDefaultSecond ()
template<>
VariableSecond &	getADDefaultSecond ()
const std::set< MooseVariableFEBase * > &	getMooseVariableDependencies () const
	Retrieve the set of MooseVariableFEBases that this object depends on. More...
const PostprocessorValue &	getPostprocessorValue (const std::string &name, unsigned int index=0)
	doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values More...
const PostprocessorValue &	getPostprocessorValueOld (const std::string &name, unsigned int index=0)
const PostprocessorValue &	getPostprocessorValueOlder (const std::string &name, unsigned int index=0)
const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name)
	Retrieve the value of the Postprocessor. More...
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...

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
virtual Real	computeValue ()=0
	Compute the value of this kernel. More...
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...
virtual void	coupledCallback (const std::string &, bool)
	A call-back function provided by the derived object for actions before coupling a variable with functions such as coupledValue. More...
virtual bool	isCoupled (const std::string &var_name, unsigned int i=0)
	Returns true if a variables has been coupled as name. More...
unsigned int	coupledComponents (const std::string &var_name)
	Number of coupled components. More...
virtual unsigned int	coupled (const std::string &var_name, unsigned int comp=0)
	Returns the index for a coupled variable by name. More...
virtual const VariableValue &	coupledValue (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled variable. More...
template<ComputeStage compute_stage>
const ADVariableValue &	adCoupledValueTemplate (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled variable for use in Automatic Differentiation. More...
template<ComputeStage compute_stage>
const ADVectorVariableValue &	adCoupledVectorValueTemplate (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled vector variable for use in Automatic Differentiation. More...
virtual const VariableValue &	coupledVectorTagValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a coupled variable for a given tag. More...
virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a coupled variable for a given tag. More...
virtual const VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled vector variable. More...
virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled array variable. More...
virtual VariableValue &	writableCoupledValue (const std::string &var_name, unsigned int comp=0)
	Returns a writable reference to a coupled variable. More...
virtual const VariableValue &	coupledValueOld (const std::string &var_name, unsigned int comp=0)
	Returns an old value from previous time step of a coupled variable. More...
virtual const VariableValue &	coupledValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old value from two time steps previous of a coupled variable. More...
virtual const VariableValue &	coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0)
	Returns value of previous Newton iterate of a coupled variable. More...
virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0)
	Returns an old value from previous time step of a coupled vector variable. More...
virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old value from two time steps previous of a coupled vector variable. More...
virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0)
	Returns an old value from previous time step of a coupled array variable. More...
virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old value from two time steps previous of a coupled array variable. More...
virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled variable. More...
template<ComputeStage compute_stage>
const ADVariableGradient &	adCoupledGradientTemplate (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled variable for use in Automatic Differentation. More...
template<ComputeStage compute_stage>
const ADVectorVariableGradient &	adCoupledVectorGradientTemplate (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled vector variable for use in Automatic Differentation. More...
template<ComputeStage compute_stage>
const ADVariableSecond &	adCoupledSecondTemplate (const std::string &var_name, unsigned int comp=0)
	Returns second derivatives of a coupled variable for use in Automatic Differentation. More...
template<ComputeStage compute_stage>
const ADVectorVariableSecond &	adCoupledVectorSecondTemplate (const std::string &var_name, unsigned int comp=0)
	Returns second derivatives of a coupled vector variable for use in Automatic Differentation. More...
virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from previous time step of a coupled variable. More...
virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from two time steps previous of a coupled variable. More...
virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled variable for previous Newton iterate. More...
virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0)
	Time derivative of the gradient of a coupled variable. More...
virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0)
	Second time derivative of the gradient of a coupled variable. More...
virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled vector variable. More...
virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from previous time step of a coupled vector variable. More...
virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from two time steps previous of a coupled vector variable. More...
virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled array variable. More...
virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from previous time step of a coupled array variable. More...
virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old gradient from two time steps previous of a coupled array variable. More...
virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0)
	Returns curl of a coupled variable. More...
virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0)
	Returns an old curl from previous time step of a coupled variable. More...
virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old curl from two time steps previous of a coupled variable. More...
virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0)
	Returns second derivative of a coupled variable. More...
virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0)
	Returns an old second derivative from previous time step of a coupled variable. More...
virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old second derivative from two time steps previous of a coupled variable. More...
virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0)
	Returns second derivative of a coupled variable for the previous Newton iterate. More...
virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDotDot (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDotOld (const std::string &var_name, unsigned int comp=0)
	Old time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDotDotOld (const std::string &var_name, unsigned int comp=0)
	Old second time derivative of a coupled variable. More...
template<ComputeStage compute_stage>
const ADVariableValue &	adCoupledDotTemplate (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled variable for ad simulations. More...
template<ComputeStage compute_stage>
const ADVectorVariableValue &	adCoupledVectorDotTemplate (const std::string &var_name, unsigned int comp=0)
	Time derivative of a vector coupled variable for ad simulations. More...
virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled vector variable. More...
virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled vector variable. More...
virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0)
	Old time derivative of a coupled vector variable. More...
virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0)
	Old second time derivative of a coupled vector variable. More...
virtual const VariableValue &	coupledVectorDotDu (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled vector variable with respect to the coefficients. More...
virtual const VariableValue &	coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled vector variable with respect to the coefficients. More...
virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled array variable. More...
virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled array variable. More...
virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0)
	Old time derivative of a coupled array variable. More...
virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0)
	Old second time derivative of a coupled array variable. More...
virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0)
	Time derivative of a coupled variable with respect to the coefficients. More...
virtual const VariableValue &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled variable with respect to the coefficients. More...
template<typename T >
const T &	coupledNodalValue (const std::string &var_name, unsigned int comp=0)
	Returns nodal values of a coupled variable. More...
template<typename T , ComputeStage compute_stage>
const Moose::ValueType< T, compute_stage >::type &	adCoupledNodalValueTemplate (const std::string &var_name, unsigned int comp=0)
	Returns AD nodal values of a coupled variable. More...
template<typename T >
const T &	coupledNodalValueOld (const std::string &var_name, unsigned int comp=0)
	Returns an old nodal value from previous time step of a coupled variable. More...
template<typename T >
const T &	coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns an old nodal value from two time steps previous of a coupled variable. More...
template<typename T >
const T &	coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0)
	Returns nodal values of a coupled variable for previous Newton iterate. More...
template<typename T >
const T &	coupledNodalDot (const std::string &var_name, unsigned int comp=0)
	Nodal values of time derivative of a coupled variable. More...
virtual const VariableValue &	coupledNodalDotDot (const std::string &var_name, unsigned int comp=0)
	Nodal values of second time derivative of a coupled variable. More...
virtual const VariableValue &	coupledNodalDotOld (const std::string &var_name, unsigned int comp=0)
	Nodal values of old time derivative of a coupled variable. More...
virtual const VariableValue &	coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0)
	Nodal values of old second time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDofValues (const std::string &var_name, unsigned int comp=0)
	Returns DoFs in the current solution vector of a coupled variable for the local element. More...
virtual const VariableValue &	coupledDofValuesOld (const std::string &var_name, unsigned int comp=0)
	Returns DoFs in the old solution vector of a coupled variable for the local element. More...
virtual const VariableValue &	coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0)
	Returns DoFs in the older solution vector of a coupled variable for the local element. More...
template<ComputeStage compute_stage>
const ADVariableValue &	adZeroValueTemplate ()
	Template method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects. More...
template<>
const VariableValue &	adZeroValueTemplate ()
template<>
const VariableValue &	adZeroValueTemplate ()
template<ComputeStage compute_stage>
const ADVariableGradient &	adZeroGradientTemplate ()
	Template method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects. More...
template<>
const VariableGradient &	adZeroGradientTemplate ()
template<>
const VariableGradient &	adZeroGradientTemplate ()
template<ComputeStage compute_stage>
const ADVariableSecond &	adZeroSecondTemplate ()
	Retrieve a zero second for automatic differentiation. More...
template<>
const VariableSecond &	adZeroSecondTemplate ()
template<>
const VariableSecond &	adZeroSecondTemplate ()
bool	checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0)
	Check that the right kind of variable is being coupled in. More...
MooseVariableFEBase *	getFEVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a base finite element coupled variable. More...
template<typename T >
MooseVariableFE< T > *	getVarHelper (const std::string &var_name, unsigned int comp)
	Helper that segues off to either getVar of getVectorVar depending on template paramter. More...
MooseVariable *	getVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled variable. More...
VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled vector variable. More...
ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a coupled array 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...
void	addMooseVariableDependency (MooseVariableFEBase *var)
	Call this function to add the passed in MooseVariableFEBase as a variable that this object depends on. More...
void	addMooseVariableDependency (std::vector< MooseVariableFEBase * > vars)

Protected Attributes
std::vector< dof_id_type >	_node_ids
	List of node IDs. More...
SubProblem &	_subproblem
SystemBase &	_sys
THREAD_ID	_tid
Assembly &	_assembly
MooseVariableScalar &	_var
MooseMesh &	_mesh
unsigned int	_i
VariableValue &	_u
VariableValue &	_u_old
std::set< std::string >	_depend_vars
	Depend AuxKernels. More...
std::set< std::string >	_supplied_vars
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 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 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...
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
FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance. More...
const InputParameters &	_c_parameters
const std::string &	_c_name
	The name of the object this interface is part of. More...
FEProblemBase &	_c_fe_problem
std::unordered_map< std::string, std::vector< MooseVariableFEBase * > >	_coupled_vars
	Coupled vars whose values we provide. More...
std::vector< MooseVariableFEBase * >	_coupled_moose_vars
	Vector of all coupled variables. More...
std::vector< MooseVariable * >	_coupled_standard_moose_vars
	Vector of standard coupled variables. More...
std::vector< VectorMooseVariable * >	_coupled_vector_moose_vars
	Vector of vector coupled variables. More...
std::vector< ArrayMooseVariable * >	_coupled_array_moose_vars
	Vector of array coupled variables. More...
bool	_c_nodal
	True if we provide coupling to nodal values. More...
bool	_c_is_implicit
	True if implicit value is required. More...
THREAD_ID	_c_tid
	Thread ID of the thread using this object. More...
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value
	Will hold the default value for optional coupled variables. More...
std::unordered_map< std::string, std::unique_ptr< MooseArray< DualReal > > >	_ad_default_value
	Will hold the default value for optional coupled variables for automatic differentiation. More...
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value
	Will hold the default value for optional vector coupled variables. More...
std::map< std::string, ArrayVariableValue * >	_default_array_value
	Will hold the default value for optional array coupled variables. More...
std::unordered_map< std::string, std::unique_ptr< MooseArray< DualRealVectorValue > > >	_ad_default_vector_value
	Will hold the default value for optional vector coupled variables for automatic differentiation. More...
VariableValue	_default_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...
VariableGradient	_default_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...
MooseArray< DualRealVectorValue >	_ad_default_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...
MooseArray< DualRealTensorValue >	_ad_default_vector_gradient
	This will always be zero because the default values for optionally coupled vector variables is always constant. More...
VariableSecond	_default_second
	This will always be zero because the default values for optionally coupled variables is always constant. More...
MooseArray< DualRealTensorValue >	_ad_default_second
	This will always be zero because the default values for optionally coupled variables is always constant. More...
const VariableValue &	_zero
	Zero value of a variable. More...
const MooseArray< DualReal > &	_ad_zero
const VariableGradient &	_grad_zero
	Zero gradient of a variable. More...
const MooseArray< DualRealVectorValue > &	_ad_grad_zero
const VariableSecond &	_second_zero
	Zero second derivative of a variable. More...
const MooseArray< DualRealTensorValue > &	_ad_second_zero
const VariablePhiSecond &	_second_phi_zero
	Zero second derivative of a test function. More...
const VectorVariableValue &	_vector_zero
	Zero value of a vector variable. More...
const VectorVariableCurl &	_vector_curl_zero
	Zero value of the curl of a vector variable. More...
VectorVariableValue	_default_vector_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...
VectorVariableGradient	_default_vector_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...
VectorVariableCurl	_default_vector_curl
	This will always be zero because the default values for optionally coupled variables is always constant. More...
ArrayVariableValue	_default_array_value_zero
	This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info. More...
ArrayVariableGradient	_default_array_gradient
	This will always be zero because the default values for optionally coupled variables is always constant. More...
ArrayVariableCurl	_default_array_curl
	This will always be zero because the default values for optionally coupled variables is always constant. More...
bool	_coupleable_neighbor
	Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values. More...

Private Types
enum	FuncAge { FuncAge::Curr, FuncAge::Old, FuncAge::Older }
enum	VarType { VarType::Ignore, VarType::Gradient, VarType::GradientDot, VarType::Dot }

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const
bool	needThreadedCopy (const UserObject &uo) const
	Check if the threaded copy of the user object is needed. More...
void	checkFuncType (const std::string var_name, VarType t, FuncAge age)
VectorVariableValue *	getDefaultVectorValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default value for an uncoupled vector variable. More...
ArrayVariableValue *	getDefaultArrayValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default value for an uncoupled array variable. More...
template<typename T >
const T &	getDefaultNodalValue (const std::string &var_name, unsigned int comp=0)
	Get nodal default value. More...
template<>
const RealVectorValue &	getDefaultNodalValue (const std::string &var_name, unsigned int)
template<>
const RealEigenVector &	getDefaultNodalValue (const std::string &var_name, unsigned int)

Private Attributes
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
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 &	_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...
const std::string	_ti_name
unsigned int	_coupleable_max_qps
	Maximum qps for any element in this system. More...
std::unordered_map< std::string, std::vector< unsigned int > >	_optional_var_index
	Unique indices for optionally coupled vars that weren't provided. More...
std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_c_coupled_scalar_vars
	Scalar variables coupled into this object (for error checking) More...
std::set< TagID >	_fe_coupleable_vector_tags
std::set< TagID >	_fe_coupleable_matrix_tags
const MooseObject *	_obj
std::set< MooseVariableFEBase * >	_moose_variable_dependencies

Detailed Description

Definition at line 25 of file AuxNodalScalarKernel.h.

Member Enumeration Documentation

FuncAge

enum Coupleable::FuncAge

strongprivateinherited

Enumerator
Curr
Old
Older

Definition at line 971 of file Coupleable.h.

  {
    Curr,
    Old,
    Older,
  };

VarType

enum Coupleable::VarType

strongprivateinherited

Enumerator
Ignore
Gradient
GradientDot
Dot

Definition at line 978 of file Coupleable.h.

  {
    Ignore,
    Gradient,
    GradientDot,
    Dot,
  };

Constructor & Destructor Documentation

AuxNodalScalarKernel()

AuxNodalScalarKernel::AuxNodalScalarKernel

(

const InputParameters &

parameters

)

Definition at line 23 of file AuxNodalScalarKernel.C.

  : AuxScalarKernel(parameters),
    Coupleable(this, true),
    MooseVariableDependencyInterface(),
    _node_ids(getParam<std::vector<dof_id_type>>("nodes"))
{
  // Fill in the MooseVariable dependencies
  const std::vector<MooseVariableFEBase *> & coupled_vars = getCoupledMooseVars();
  for (const auto & var : coupled_vars)
    addMooseVariableDependency(var);
}

Member Function Documentation

adCoupledDotTemplate()

template<ComputeStage compute_stage>

const ADVariableValue & Coupleable::adCoupledDotTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Time derivative of a coupled variable for ad simulations.

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

See also

Kernel::dot

Definition at line 1196 of file Coupleable.h.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getADDefaultValue<compute_stage>(var_name);
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (_c_nodal)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adUDot<compute_stage>();
  return var->adUDotNeighbor<compute_stage>();
}

adCoupledGradientTemplate()

template<ComputeStage compute_stage>

const ADVariableGradient & Coupleable::adCoupledGradientTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns gradient of a coupled variable for use in Automatic Differentation.

Parameters

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

Returns

Reference to a VariableGradient containing the gradient of the coupled variable

See also

Kernel::gradient

Definition at line 1153 of file Coupleable.h.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return getADDefaultGradient<compute_stage>();
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_c_is_implicit)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adGradSln<compute_stage>();
  return var->adGradSlnNeighbor<compute_stage>();
}

adCoupledNodalValueTemplate()

template<typename T , ComputeStage compute_stage>

const template libMesh::VectorValue< DualReal > & Coupleable::adCoupledNodalValueTemplate< RealVectorValue, JACOBIAN > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns AD nodal values of a 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 1406 of file Coupleable.C.

{
  static const typename Moose::ValueType<T, compute_stage>::type zero = 0;
  if (!isCoupled(var_name))
    return zero;
 
  if (!_c_nodal)
    mooseError("The adCoupledNodalValue method should only be called for nodal computing objects");
  if (_coupleable_neighbor)
    mooseError(
        "The adCoupledNodalValue method shouldn't be called for neighbor computing objects. I "
        "don't even know what that would mean, although maybe someone could explain it to me.");
  if (!_c_is_implicit)
    mooseError("If you're going to use an explicit scheme, then use coupledNodalValue instead of "
               "adCoupledNodalValue");
 
  coupledCallback(var_name, false);
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
 
  return var->template adNodalValue<compute_stage>();
}

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

adCoupledSecondTemplate()

template<ComputeStage compute_stage>

const ADVariableSecond & Coupleable::adCoupledSecondTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns second derivatives of a coupled variable for use in Automatic Differentation.

Parameters

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

Returns

Reference to a VariableSecond containing the second derivatives of the coupled variable

Definition at line 1170 of file Coupleable.h.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return getADDefaultSecond<compute_stage>();
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_c_is_implicit)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adSecondSln<compute_stage>();
  else
    return var->adSecondSlnNeighbor<compute_stage>();
}

adCoupledValueTemplate()

template<ComputeStage compute_stage>

const ADVariableValue & Coupleable::adCoupledValueTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns value of a coupled variable for use in Automatic Differentiation.

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

See also

Kernel::value

Definition at line 1134 of file Coupleable.h.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getADDefaultValue<compute_stage>(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (_c_nodal)
    mooseError("Not implemented");
  if (!_c_is_implicit)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adSln<compute_stage>();
  return var->adSlnNeighbor<compute_stage>();
}

adCoupledVectorDotTemplate()

template<ComputeStage compute_stage>

const ADVectorVariableValue & Coupleable::adCoupledVectorDotTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Time derivative of a vector coupled variable for ad simulations.

Parameters

var_name	Name of vector coupled variable
comp	Component number

Returns

Reference to a VectorVariableValue containing the time derivative of the coupled variable

See also

Kernel::dot

Definition at line 1213 of file Coupleable.h.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return *getADDefaultVectorValue<compute_stage>(var_name);
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (_c_nodal)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adUDot<compute_stage>();
  return var->adUDotNeighbor<compute_stage>();
}

adCoupledVectorGradientTemplate()

template<ComputeStage compute_stage>

const ADVectorVariableGradient & Coupleable::adCoupledVectorGradientTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns gradient of a coupled vector variable for use in Automatic Differentation.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the gradient of the coupled variable

See also

Kernel::gradient

Definition at line 1249 of file Coupleable.h.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return getADDefaultVectorGradient<compute_stage>();
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_c_is_implicit)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adGradSln<compute_stage>();
  return var->adGradSlnNeighbor<compute_stage>();
}

adCoupledVectorSecondTemplate()

template<ComputeStage compute_stage>

const ADVectorVariableSecond& Coupleable::adCoupledVectorSecondTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns second derivatives of a coupled vector variable for use in Automatic Differentation.

Parameters

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

Returns

Reference to a VectorVariableSecond containing the second derivatives of the coupled variable

adCoupledVectorValueTemplate()

template<ComputeStage compute_stage>

const ADVectorVariableValue & Coupleable::adCoupledVectorValueTemplate ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns value of a coupled vector variable for use in Automatic Differentiation.

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

See also

Kernel::value

Definition at line 1230 of file Coupleable.h.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return *getADDefaultVectorValue<compute_stage>(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (_c_nodal)
    mooseError("Not implemented");
  if (!_c_is_implicit)
    mooseError("Not implemented");
 
  if (!_coupleable_neighbor)
    return var->adSln<compute_stage>();
  return var->adSlnNeighbor<compute_stage>();
}

addFEVariableCoupleableMatrixTag()

void Coupleable::addFEVariableCoupleableMatrixTag ( TagID  tag )

inlineinherited

Definition at line 119 of file Coupleable.h.

{ _fe_coupleable_matrix_tags.insert(tag); }

Referenced by Coupleable::coupledMatrixTagValue().

addFEVariableCoupleableVectorTag()

void Coupleable::addFEVariableCoupleableVectorTag ( TagID  tag )

inlineinherited

Definition at line 117 of file Coupleable.h.

{ _fe_coupleable_vector_tags.insert(tag); }

Referenced by Coupleable::coupledVectorTagValue().

addMooseVariableDependency() [1/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( MooseVariableFEBase *  var )

inlineprotectedinherited

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

Definition at line 36 of file MooseVariableDependencyInterface.h.

  {
    _moose_variable_dependencies.insert(var);
  }

Referenced by ADDGKernel< compute_stage >::ADDGKernel(), ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ADNodalBCTempl< T, compute_stage >::ADNodalBCTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), ArrayNodalBC::ArrayNodalBC(), AuxKernelTempl< ComputeValueType >::AuxKernelTempl(), AuxNodalScalarKernel(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), DGKernel::DGKernel(), DiracKernel::DiracKernel(), ElemElemConstraint::ElemElemConstraint(), ElementIndicator::ElementIndicator(), ElementIntegralArrayVariablePostprocessor::ElementIntegralArrayVariablePostprocessor(), ElementIntegralVariablePostprocessor::ElementIntegralVariablePostprocessor(), ElementIntegralVariableUserObject::ElementIntegralVariableUserObject(), ElementUserObject::ElementUserObject(), ElementVariablePostprocessor::ElementVariablePostprocessor(), IntegratedBC::IntegratedBC(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceMaterial::InterfaceMaterial(), InterfaceUserObject::InterfaceUserObject(), InternalSideIndicator::InternalSideIndicator(), InternalSideUserObject::InternalSideUserObject(), Kernel::Kernel(), Marker::Marker(), Material::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalBC::NodalBC(), NodalConstraint::NodalConstraint(), NodalKernel::NodalKernel(), NodalScalarKernel::NodalScalarKernel(), NodalUserObject::NodalUserObject(), NodeElemConstraint::NodeElemConstraint(), NodeFaceConstraint::NodeFaceConstraint(), PointSamplerBase::PointSamplerBase(), QuadraturePointMarker::QuadraturePointMarker(), SideIntegralVariablePostprocessor::SideIntegralVariablePostprocessor(), SideIntegralVariableUserObject::SideIntegralVariableUserObject(), SideUserObject::SideUserObject(), VectorIntegratedBC::VectorIntegratedBC(), VectorKernel::VectorKernel(), and VectorNodalBC::VectorNodalBC().

addMooseVariableDependency() [2/2]

void MooseVariableDependencyInterface::addMooseVariableDependency ( std::vector< MooseVariableFEBase * >  vars )

inlineprotectedinherited

Definition at line 40 of file MooseVariableDependencyInterface.h.

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

addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID  tag )

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

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

{ _sc_coupleable_vector_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

adZeroGradientTemplate() [1/3]

template<ComputeStage compute_stage>

const ADVariableGradient & Coupleable::adZeroGradientTemplate ( )

protectedinherited

Template method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects.

Definition at line 1342 of file Coupleable.h.

{
  return _ad_grad_zero;
}

adZeroGradientTemplate() [2/3]

template<>

const VariableGradient& Coupleable::adZeroGradientTemplate ( )

protectedinherited

adZeroGradientTemplate() [3/3]

template<>

const VariableGradient& Coupleable::adZeroGradientTemplate ( )

protectedinherited

Definition at line 1392 of file Coupleable.C.

{
  return _grad_zero;
}

adZeroSecondTemplate() [1/3]

template<ComputeStage compute_stage>

const ADVariableSecond & Coupleable::adZeroSecondTemplate ( )

protectedinherited

Retrieve a zero second for automatic differentiation.

Definition at line 1349 of file Coupleable.h.

{
  return _ad_second_zero;
}

adZeroSecondTemplate() [2/3]

template<>

const VariableSecond& Coupleable::adZeroSecondTemplate ( )

protectedinherited

adZeroSecondTemplate() [3/3]

template<>

const VariableSecond& Coupleable::adZeroSecondTemplate ( )

protectedinherited

Definition at line 1399 of file Coupleable.C.

{
  return _second_zero;
}

adZeroValueTemplate() [1/3]

template<ComputeStage compute_stage>

const ADVariableValue & Coupleable::adZeroValueTemplate ( )

protectedinherited

Template method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects.

Definition at line 1335 of file Coupleable.h.

{
  return _ad_zero;
}

adZeroValueTemplate() [2/3]

template<>

const VariableValue& Coupleable::adZeroValueTemplate ( )

protectedinherited

adZeroValueTemplate() [3/3]

template<>

const VariableValue& Coupleable::adZeroValueTemplate ( )

protectedinherited

Definition at line 1385 of file Coupleable.C.

{
  return _zero;
}

checkFuncType()

void Coupleable::checkFuncType ( const std::string  var_name, VarType  t, FuncAge  age  )

privateinherited

Definition at line 156 of file Coupleable.C.

{
  if (t == VarType::Gradient && _c_nodal)
    mooseError(_c_name, ": nodal variables do not have gradients");
 
  if (age == FuncAge::Old || age == FuncAge::Older || t == VarType::GradientDot ||
      t == VarType::Dot)
    validateExecutionerType(var_name, "coupled[Vector][Gradient/Dot]Old[er]");
  if (age == FuncAge::Older && !_c_is_implicit)
    mooseError("object '",
               _c_name,
               "' uses older variable values that are unavailable with explicit schemes");
 
  // this goes at end after all error checks
  coupledCallback(var_name, age == FuncAge::Old || age == FuncAge::Older);
}

Referenced by Coupleable::adCoupledDotTemplate(), Coupleable::adCoupledGradientTemplate(), Coupleable::adCoupledSecondTemplate(), Coupleable::adCoupledValueTemplate(), Coupleable::adCoupledVectorDotTemplate(), Coupleable::adCoupledVectorGradientTemplate(), Coupleable::adCoupledVectorValueTemplate(), Coupleable::coupled(), Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), Coupleable::coupledArrayGradientOlder(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledCurlOlder(), Coupleable::coupledDofValues(), Coupleable::coupledDofValuesOld(), Coupleable::coupledDofValuesOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledGradient(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), Coupleable::coupledGradientPreviousNL(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledNodalDot(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledNodalValueOlder(), Coupleable::coupledNodalValuePreviousNL(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), Coupleable::coupledSecondPreviousNL(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotDu(), Coupleable::coupledVectorDotDotOld(), Coupleable::coupledVectorDotDu(), Coupleable::coupledVectorDotOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), Coupleable::coupledVectorTagValue(), Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), and Coupleable::coupledVectorValueOlder().

checkVar() [1/2]

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
}

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalar(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

checkVar() [2/2]

bool Coupleable::checkVar ( const std::string &  var_name, unsigned int  comp = 0, unsigned int  comp_bound = 0  )

protectedinherited

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

Parameters

var_name

The name of the coupled variable

Definition at line 174 of file Coupleable.C.

{
  auto it = _c_coupled_scalar_vars.find(var_name);
  if (it != _c_coupled_scalar_vars.end())
  {
    std::string cvars;
    for (auto jt : it->second)
      cvars += " " + jt->name();
 
    _obj->paramError(var_name,
                     "cannot couple '",
                     var_name,
                     "' to a scalar variable (",
                     cvars,
                     ") where field variable is expected");
  }
 
  if (!isCoupled(var_name, comp))
    return false; // return false since variable is *not* coupled
 
  auto bound = comp_bound ? comp_bound : _coupled_vars[var_name].size();
  checkComponent(_obj, comp, bound, var_name);
 
  if (!(_coupled_vars[var_name][comp])->isNodal() && _c_nodal)
    mooseError(_c_name, ": cannot couple elemental variables into nodal objects");
 
  return true;
}

Referenced by Coupleable::getFEVar(), and Coupleable::getVarHelper().

compute()

void AuxNodalScalarKernel::compute ( )

overridevirtual

Evaluate the kernel.

Reimplemented from AuxScalarKernel.

Definition at line 36 of file AuxNodalScalarKernel.C.

{
  _subproblem.reinitNodes(_node_ids, _tid); // compute variables at nodes
  AuxScalarKernel::compute();
}

computeValue()

virtual Real AuxScalarKernel::computeValue ( )

protectedpure virtualinherited

Compute the value of this kernel.

Each kernel must implement this.

Returns

The computed value

Implemented in SolutionScalarAux, QuotientScalarAux, ScalarTagMatrixAux, ScalarTagVectorAux, FunctionScalarAux, and ConstantScalarAux.

Referenced by AuxScalarKernel::compute().

coupled()

unsigned int Coupleable::coupled ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns the index for a coupled variable by name.

Parameters

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

Returns

Index of coupled variable, if this is an optionally coupled variable that wasn't provided this will return a unique "invalid" index.

Reimplemented in ShapeUserObject< ElementUserObject >, and ShapeUserObject< SideUserObject >.

Definition at line 364 of file Coupleable.C.

{
  MooseVariableFEBase * var = getFEVar(var_name, comp);
  if (!var)
  {
    // make sure we don't try to access default var ids that were not provided
    checkComponent(_obj, comp, _optional_var_index[var_name].size(), var_name);
    return _optional_var_index[var_name][comp];
  }
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  switch (var->kind())
  {
    case Moose::VAR_NONLINEAR:
      return var->number();
    case Moose::VAR_AUXILIARY:
      return std::numeric_limits<unsigned int>::max() - var->number();
    default:
      mooseError(_c_name, ": Unknown variable kind. Corrupted binary?");
  }
}

Referenced by FunctionMaterialBase::FunctionMaterialBase(), KernelBase::KernelBase(), and NodalEqualValueConstraint::NodalEqualValueConstraint().

coupledArrayDot()

const ArrayVariableValue & Coupleable::coupledArrayDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Time derivative of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 786 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDot();
    return var->uDot();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotNeighbor();
    return var->uDotNeighbor();
  }
}

coupledArrayDotDot()

const ArrayVariableValue & Coupleable::coupledArrayDotDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Second time derivative of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 808 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDot();
    return var->uDotDot();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotNeighbor();
    return var->uDotDotNeighbor();
  }
}

coupledArrayDotDotOld()

const ArrayVariableValue & Coupleable::coupledArrayDotDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old second time derivative of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 852 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDotOld();
    return var->uDotDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotOldNeighbor();
    return var->uDotDotOldNeighbor();
  }
}

coupledArrayDotOld()

const ArrayVariableValue & Coupleable::coupledArrayDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old time derivative of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the time derivative of the coupled variable

Definition at line 830 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotOld();
    return var->uDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotOldNeighbor();
    return var->uDotOldNeighbor();
  }
}

coupledArrayGradient()

const ArrayVariableGradient & Coupleable::coupledArrayGradient ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns gradient of a coupled array variable.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the gradient of the coupled array variable

Definition at line 1036 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
  return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
}

coupledArrayGradientOld()

const ArrayVariableGradient & Coupleable::coupledArrayGradientOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from previous time step of a coupled array variable.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the old gradient of the coupled array variable

Definition at line 1049 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
  return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
}

coupledArrayGradientOlder()

const ArrayVariableGradient & Coupleable::coupledArrayGradientOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from two time steps previous of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableGradient containing the older gradient of the coupled array variable

Definition at line 1062 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return _default_array_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->gradSlnOlder();
  return var->gradSlnOlderNeighbor();
}

coupledArrayValue()

const ArrayVariableValue & Coupleable::coupledArrayValue ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue for the coupled vector variable

See also

ArrayKernel::_u

Definition at line 455 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return *getDefaultArrayValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
    return (_c_is_implicit) ? var->sln() : var->slnOld();
  }
  else
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
    return (_c_is_implicit) ? var->slnNeighbor() : var->slnOldNeighbor();
  }
}

coupledArrayValueOld()

const ArrayVariableValue & Coupleable::coupledArrayValueOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from previous time step of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the old value of the coupled variable

See also

ArrayKernel::_u_old

Definition at line 576 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return *getDefaultArrayValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
    return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
  }
  else
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
    return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
  }
}

coupledArrayValueOlder()

const ArrayVariableValue & Coupleable::coupledArrayValueOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from two time steps previous of a coupled array variable.

Parameters

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

Returns

Reference to a ArrayVariableValue containing the older value of the coupled variable

See also

ArrayKernel::_u_older

Definition at line 598 of file Coupleable.C.

{
  ArrayMooseVariable * var = getArrayVar(var_name, comp);
  if (!var)
    return *getDefaultArrayValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesOlder();
    return var->slnOlder();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesOlderNeighbor();
    return var->slnOlderNeighbor();
  }
}

coupledCallback()

virtual void Coupleable::coupledCallback ( const std::string &  , bool    )

inlineprotectedvirtualinherited

A call-back function provided by the derived object for actions before coupling a variable with functions such as coupledValue.

Reimplemented in AuxKernelTempl< ComputeValueType >.

Definition at line 130 of file Coupleable.h.

{}

Referenced by Coupleable::adCoupledNodalValueTemplate(), and Coupleable::checkFuncType().

coupledComponents()

unsigned int Coupleable::coupledComponents ( const std::string &  var_name )

protectedinherited

Number of coupled components.

Parameters

var_name

Name of the variable

Returns

number of components this variable has (usually 1)

Definition at line 128 of file Coupleable.C.

{
  if (isCoupled(var_name))
    return _coupled_vars[var_name].size();
  else
  {
    if (_c_parameters.hasDefaultCoupledValue(var_name))
      return _c_parameters.numberDefaultCoupledValues(var_name);
    else
      return 0;
  }
}

Referenced by KernelBase::KernelBase(), NodalEqualValueConstraint::NodalEqualValueConstraint(), SpatialAverageBase::SpatialAverageBase(), and VolumeHistogram::VolumeHistogram().

coupledCurl()

const VectorVariableCurl & Coupleable::coupledCurl ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns curl of a coupled variable.

Parameters

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

Returns

Reference to a VectorVariableCurl containing the curl of the coupled variable

See also

Kernel::_curl_u

Definition at line 1075 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_curl;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->curlSln() : var->curlSlnOld();
  return (_c_is_implicit) ? var->curlSlnNeighbor() : var->curlSlnOldNeighbor();
}

coupledCurlOld()

const VectorVariableCurl & Coupleable::coupledCurlOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old curl from previous time step of a coupled variable.

Parameters

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

Returns

Reference to a VectorVariableCurl containing the old curl of the coupled variable

See also

Kernel::_curl_u_old

Definition at line 1088 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_curl;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->curlSlnOld() : var->curlSlnOlder();
  return (_c_is_implicit) ? var->curlSlnOldNeighbor() : var->curlSlnOlderNeighbor();
}

coupledCurlOlder()

const VectorVariableCurl & Coupleable::coupledCurlOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old curl from two time steps previous of a coupled variable.

Parameters

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

Returns

Reference to a VectorVariableCurl containing the older curl of the coupled variable

See also

Kernel::_curl_u_older

Definition at line 1101 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_curl;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->curlSlnOlder();
  return var->curlSlnOlderNeighbor();
}

coupledDofValues()

const VariableValue & Coupleable::coupledDofValues ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns DoFs in the current solution vector of a coupled variable for the local element.

Parameters

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

Returns

Reference to a VariableValue for the DoFs of the coupled variable

Definition at line 1297 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
  return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
}

coupledDofValuesOld()

const VariableValue & Coupleable::coupledDofValuesOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns DoFs in the old solution vector of a coupled variable for the local element.

Parameters

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

Returns

Reference to a VariableValue for the old DoFs of the coupled variable

Definition at line 1310 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
  return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
}

coupledDofValuesOlder()

const VariableValue & Coupleable::coupledDofValuesOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns DoFs in the older solution vector of a coupled variable for the local element.

Parameters

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

Returns

Reference to a VariableValue for the older DoFs of the coupled variable

Definition at line 1323 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->dofValuesOlder();
  return var->dofValuesOlderNeighbor();
}

coupledDot()

const VariableValue & Coupleable::coupledDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Time derivative of a coupled variable.

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

Reimplemented in AuxKernelTempl< ComputeValueType >.

Definition at line 620 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDot();
    return var->uDot();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotNeighbor();
    return var->uDotNeighbor();
  }
}

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

coupledDotDot()

const VariableValue & Coupleable::coupledDotDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Second time derivative of a coupled variable.

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

Definition at line 642 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDot();
    return var->uDotDot();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotNeighbor();
    return var->uDotDotNeighbor();
  }
}

coupledDotDotDu()

const VariableValue & Coupleable::coupledDotDotDu ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Second time derivative of a 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 896 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDuDotDotDu();
    return var->duDotDotDu();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDuDotDotDuNeighbor();
    return var->duDotDotDuNeighbor();
  }
}

coupledDotDotOld()

const VariableValue & Coupleable::coupledDotDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old second time derivative of a coupled variable.

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

Definition at line 686 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDotOld();
    return var->uDotDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotOldNeighbor();
    return var->uDotDotOldNeighbor();
  }
}

coupledDotDu()

const VariableValue & Coupleable::coupledDotDu ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Time derivative of a 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

Reimplemented in AuxKernelTempl< ComputeValueType >.

Definition at line 874 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDuDotDu();
    return var->duDotDu();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDuDotDuNeighbor();
    return var->duDotDuNeighbor();
  }
}

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

coupledDotOld()

const VariableValue & Coupleable::coupledDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old time derivative of a coupled variable.

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

Definition at line 664 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotOld();
    return var->uDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotOldNeighbor();
    return var->uDotOldNeighbor();
  }
}

coupledGradient()

const VariableGradient & Coupleable::coupledGradient ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns gradient of a coupled variable.

Parameters

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

Returns

Reference to a VariableGradient containing the gradient of the coupled variable

See also

Kernel::gradient

Definition at line 918 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
  return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
}

Referenced by NodeElemConstraint::coupledSlaveGradient(), and NodeFaceConstraint::coupledSlaveGradient().

coupledGradientDot()

const VariableGradient & Coupleable::coupledGradientDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Time derivative of the gradient of a coupled variable.

Parameters

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

Returns

Reference to a VariableGradient containing the time derivative of the gradient of a coupled variable

Definition at line 971 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::GradientDot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->gradSlnDot();
  return var->gradSlnNeighborDot();
}

coupledGradientDotDot()

const VariableGradient & Coupleable::coupledGradientDotDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Second time derivative of the gradient of a coupled variable.

Parameters

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

Returns

Reference to a VariableGradient containing the time derivative of the gradient of a coupled variable

Definition at line 984 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::GradientDot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->gradSlnDotDot();
  return var->gradSlnNeighborDotDot();
}

coupledGradientOld()

const VariableGradient & Coupleable::coupledGradientOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from previous time step of a coupled variable.

Parameters

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

Returns

Reference to a VariableGradient containing the old gradient of the coupled variable

See also

Kernel::gradientOld

Definition at line 931 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
  return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
}

Referenced by NodeElemConstraint::coupledSlaveGradientOld(), and NodeFaceConstraint::coupledSlaveGradientOld().

coupledGradientOlder()

const VariableGradient & Coupleable::coupledGradientOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from two time steps previous of a coupled variable.

Parameters

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

Returns

Reference to a VariableGradient containing the older gradient of the coupled variable

See also

Kernel::gradientOlder

Definition at line 944 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->gradSlnOlder();
  return var->gradSlnOlderNeighbor();
}

Referenced by NodeElemConstraint::coupledSlaveGradientOlder(), and NodeFaceConstraint::coupledSlaveGradientOlder().

coupledGradientPreviousNL()

const VariableGradient & Coupleable::coupledGradientPreviousNL ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns gradient of a coupled variable for previous Newton iterate.

Parameters

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

Returns

Reference to a VariableGradient containing the gradient of the coupled variable

Definition at line 957 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  _c_fe_problem.needsPreviousNewtonIteration(true);
  if (!var)
    return _default_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->gradSlnPreviousNL();
  return var->gradSlnPreviousNLNeighbor();
}

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

coupledMatrixTagValue()

const VariableValue & Coupleable::coupledMatrixTagValue ( const std::string &  var_name, TagID  tag, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of a coupled variable for a given tag.

This couples the diag vector of matrix

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

See also

Kernel::_u

Definition at line 427 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    mooseError(var_name, ": invalid variable name for coupledMatrixTagValue");
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  addFEVariableCoupleableMatrixTag(tag);
 
  if (_c_nodal)
    return var->nodalMatrixTagValue(tag);
  return var->matrixTagValue(tag);
}

coupledNodalDot()

template<typename T >

const template RealVectorValue & Coupleable::coupledNodalDot< RealVectorValue > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Nodal values of time derivative of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the nodal values of time derivative of the coupled variable

Definition at line 1244 of file Coupleable.C.

{
  static const T zero = 0;
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
  if (!var)
    return zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->nodalValueDot();
  mooseError("Neighbor version not implemented");
}

coupledNodalDotDot()

const VariableValue & Coupleable::coupledNodalDotDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Nodal values of second time derivative of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the nodal values of second time derivative of the coupled variable

Definition at line 1258 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->dofValuesDotDot();
  return var->dofValuesDotDotNeighbor();
}

coupledNodalDotDotOld()

const VariableValue & Coupleable::coupledNodalDotDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Nodal values of old second time derivative of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the nodal values of second time derivative of the coupled variable

Definition at line 1284 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return var->dofValuesDotDotOld();
  return var->dofValuesDotDotOldNeighbor();
}

coupledNodalDotOld()

const VariableValue & Coupleable::coupledNodalDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Nodal values of old time derivative of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the nodal values of time derivative of the coupled variable

Definition at line 1271 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return var->dofValuesDotOld();
  return var->dofValuesDotOldNeighbor();
}

coupledNodalValue()

template<typename T >

const template RealVectorValue & Coupleable::coupledNodalValue< RealVectorValue > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns nodal values of a 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 1168 of file Coupleable.C.

{
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
  if (!var)
    return getDefaultNodalValue<T>(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (!var->isNodal())
    mooseError(_c_name,
               ": Trying to get nodal values of variable '",
               var->name(),
               "', but it is not nodal.");
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->nodalValue() : var->nodalValueOld();
  return (_c_is_implicit) ? var->nodalValueNeighbor() : var->nodalValueOldNeighbor();
}

coupledNodalValueOld()

template<typename T >

const template RealVectorValue & Coupleable::coupledNodalValueOld< RealVectorValue > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns an old nodal value from previous time step of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the old value of the coupled variable

Definition at line 1188 of file Coupleable.C.

{
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
  if (!var)
    return getDefaultNodalValue<T>(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
  if (!var->isNodal())
    mooseError(_c_name,
               ": Trying to get old nodal values of variable '",
               var->name(),
               "', but it is not nodal.");
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->nodalValueOld() : var->nodalValueOlder();
  return (_c_is_implicit) ? var->nodalValueOldNeighbor() : var->nodalValueOlderNeighbor();
}

coupledNodalValueOlder()

template<typename T >

const template RealVectorValue & Coupleable::coupledNodalValueOlder< RealVectorValue > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns an old nodal value from two time steps previous of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the older value of the coupled variable

Definition at line 1208 of file Coupleable.C.

{
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
  if (!var)
    return getDefaultNodalValue<T>(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
  if (!var->isNodal())
    mooseError(_c_name,
               ": Trying to get older nodal values of variable '",
               var->name(),
               "', but it is not nodal.");
 
  if (!_coupleable_neighbor)
    return var->nodalValueOlder();
  return var->nodalValueOlderNeighbor();
}

coupledNodalValuePreviousNL()

template<typename T >

const template RealVectorValue & Coupleable::coupledNodalValuePreviousNL< RealVectorValue > ( const std::string &  var_name, unsigned int  comp = 0  )

protectedinherited

Returns nodal values of a coupled variable for previous Newton iterate.

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 1228 of file Coupleable.C.

{
  MooseVariableFE<T> * var = getVarHelper<T>(var_name, comp);
  if (!var)
    return getDefaultNodalValue<T>(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  _c_fe_problem.needsPreviousNewtonIteration(true);
 
  if (!_coupleable_neighbor)
    return var->nodalValuePreviousNL();
  return var->nodalValuePreviousNLNeighbor();
}

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

coupledSecond()

const VariableSecond & Coupleable::coupledSecond ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns second derivative of a coupled variable.

Parameters

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

Returns

Reference to a VariableSecond containing the second derivative of the coupled variable

See also

Kernel::second

Definition at line 1114 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_second;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->secondSln() : var->secondSlnOlder();
  return (_c_is_implicit) ? var->secondSlnNeighbor() : var->secondSlnOlderNeighbor();
}

Referenced by NodeElemConstraint::coupledSlaveSecond(), and NodeFaceConstraint::coupledSlaveSecond().

coupledSecondOld()

const VariableSecond & Coupleable::coupledSecondOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old second derivative from previous time step of a coupled variable.

Parameters

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

Returns

Reference to a VariableSecond containing the old second derivative of the coupled variable

See also

Kernel::secondOld

Definition at line 1127 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_second;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->secondSlnOld() : var->secondSlnOlder();
  return (_c_is_implicit) ? var->secondSlnOldNeighbor() : var->secondSlnOlderNeighbor();
}

coupledSecondOlder()

const VariableSecond & Coupleable::coupledSecondOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old second derivative from two time steps previous of a coupled variable.

Parameters

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

Returns

Reference to a VariableSecond containing the older second derivative of the coupled variable

See also

Kernel::secondOlder

Definition at line 1140 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return _default_second;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->secondSlnOlder();
  return var->secondSlnOlderNeighbor();
}

coupledSecondPreviousNL()

const VariableSecond & Coupleable::coupledSecondPreviousNL ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns second derivative of a coupled variable for the previous Newton iterate.

Parameters

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

Returns

Reference to a VariableSecond containing the second derivative of the coupled variable

Definition at line 1153 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  _c_fe_problem.needsPreviousNewtonIteration(true);
  if (!var)
    return _default_second;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->secondSlnPreviousNL();
  return var->secondSlnPreviousNLNeighbor();
}

coupledValue()

const VariableValue & Coupleable::coupledValue ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of a 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

See also

Kernel::_u

Definition at line 387 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValues() : var->dofValuesOld();
    else
      return (_c_is_implicit) ? var->sln() : var->slnOld();
  }
  else
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
    else
      return (_c_is_implicit) ? var->slnNeighbor() : var->slnOldNeighbor();
  }
}

Referenced by NodeElemConstraint::coupledSlaveValue(), NodeFaceConstraint::coupledSlaveValue(), FunctionMaterialBase::FunctionMaterialBase(), NodalEqualValueConstraint::NodalEqualValueConstraint(), ParsedAux::ParsedAux(), SpatialAverageBase::SpatialAverageBase(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), and Coupleable::writableCoupledValue().

coupledValueOld()

const VariableValue & Coupleable::coupledValueOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from previous time step of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the old value of the coupled variable

See also

Kernel::valueOld

Definition at line 483 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
    return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
  }
  else
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
    return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
  }
}

Referenced by NodeElemConstraint::coupledSlaveValueOld(), NodeFaceConstraint::coupledSlaveValueOld(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().

coupledValueOlder()

const VariableValue & Coupleable::coupledValueOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from two time steps previous of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the older value of the coupled variable

See also

Kernel::valueOlder

Definition at line 505 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesOlder();
    return var->slnOlder();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesOlderNeighbor();
    return var->slnOlderNeighbor();
  }
}

Referenced by NodeElemConstraint::coupledSlaveValueOlder(), NodeFaceConstraint::coupledSlaveValueOlder(), and VariableTimeIntegrationAux::VariableTimeIntegrationAux().

coupledValuePreviousNL()

const VariableValue & Coupleable::coupledValuePreviousNL ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of previous Newton iterate of a coupled variable.

Parameters

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

Returns

Reference to a VariableValue containing the older value of the coupled variable

Definition at line 527 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    return *getDefaultValue(var_name, comp);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  _c_fe_problem.needsPreviousNewtonIteration(true);
  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesPreviousNL();
    return var->slnPreviousNL();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesPreviousNLNeighbor();
    return var->slnPreviousNLNeighbor();
  }
}

coupledVectorDot()

const VectorVariableValue & Coupleable::coupledVectorDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Time derivative of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 708 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->uDot();
  return var->uDotNeighbor();
}

coupledVectorDotDot()

const VectorVariableValue & Coupleable::coupledVectorDotDot ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Second time derivative of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 721 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->uDotDot();
  return var->uDotDotNeighbor();
}

coupledVectorDotDotDu()

const VariableValue & Coupleable::coupledVectorDotDotDu ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

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

Parameters

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

Returns

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

Definition at line 773 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->duDotDotDu();
  return var->duDotDotDuNeighbor();
}

coupledVectorDotDotOld()

const VectorVariableValue & Coupleable::coupledVectorDotDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old second time derivative of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 747 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return var->uDotDotOld();
  return var->uDotDotOldNeighbor();
}

coupledVectorDotDu()

const VariableValue & Coupleable::coupledVectorDotDu ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

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

Parameters

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

Returns

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

Definition at line 760 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return var->duDotDu();
  return var->duDotDuNeighbor();
}

coupledVectorDotOld()

const VectorVariableValue & Coupleable::coupledVectorDotOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Old time derivative of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the time derivative of the coupled variable

Definition at line 734 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_value_zero;
  checkFuncType(var_name, VarType::Dot, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return var->uDotOld();
  return var->uDotOldNeighbor();
}

coupledVectorGradient()

const VectorVariableGradient & Coupleable::coupledVectorGradient ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns gradient of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the gradient of the coupled vector variable

Definition at line 997 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
  return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
}

coupledVectorGradientOld()

const VectorVariableGradient & Coupleable::coupledVectorGradientOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from previous time step of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the old gradient of the coupled vector variable

Definition at line 1010 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
  return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
}

coupledVectorGradientOlder()

const VectorVariableGradient & Coupleable::coupledVectorGradientOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old gradient from two time steps previous of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableGradient containing the older gradient of the coupled vector variable

Definition at line 1023 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return _default_vector_gradient;
  checkFuncType(var_name, VarType::Gradient, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->gradSlnOlder();
  return var->gradSlnOlderNeighbor();
}

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

coupledVectorTagValue()

const VariableValue & Coupleable::coupledVectorTagValue ( const std::string &  var_name, TagID  tag, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of a coupled variable for a given tag.

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

See also

Kernel::_u

Definition at line 411 of file Coupleable.C.

{
  MooseVariable * var = getVar(var_name, comp);
  if (!var)
    mooseError(var_name, ": invalid variable name for coupledVectorTagValue");
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  addFEVariableCoupleableVectorTag(tag);
 
  if (_c_nodal)
    return var->nodalVectorTagValue(tag);
  else
    return var->vectorTagValue(tag);
}

coupledVectorValue()

const VectorVariableValue & Coupleable::coupledVectorValue ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns value of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue for the coupled vector variable

See also

VectorKernel::_u

Definition at line 442 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return *getDefaultVectorValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Curr);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->sln() : var->slnOld();
  return (_c_is_implicit) ? var->slnNeighbor() : var->slnOldNeighbor();
}

coupledVectorValueOld()

const VectorVariableValue & Coupleable::coupledVectorValueOld ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from previous time step of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the old value of the coupled variable

See also

VectorKernel::_u_old

Definition at line 550 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return *getDefaultVectorValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Old);
 
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
  return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
}

coupledVectorValueOlder()

const VectorVariableValue & Coupleable::coupledVectorValueOlder ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns an old value from two time steps previous of a coupled vector variable.

Parameters

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

Returns

Reference to a VectorVariableValue containing the older value of the coupled variable

See also

VectorKernel::_u_older

Definition at line 563 of file Coupleable.C.

{
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (!var)
    return *getDefaultVectorValue(var_name);
  checkFuncType(var_name, VarType::Ignore, FuncAge::Older);
 
  if (!_coupleable_neighbor)
    return var->slnOlder();
  return var->slnOlderNeighbor();
}

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

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.

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

getADDefaultGradient() [1/3]

template<ComputeStage compute_stage>

ADVariableGradient & Coupleable::getADDefaultGradient ( )

inherited

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

Parameters

var_name

the name of the variable for which to retrieve a default gradient

Returns

VariableGradient * a pointer to the associated VariableGradient.

Definition at line 1305 of file Coupleable.h.

{
  return _ad_default_gradient;
}

getADDefaultGradient() [2/3]

template<>

VariableGradient& Coupleable::getADDefaultGradient ( )

inherited

getADDefaultGradient() [3/3]

template<>

VariableGradient& Coupleable::getADDefaultGradient ( )

inherited

Definition at line 1364 of file Coupleable.C.

{
  return _default_gradient;
}

getADDefaultSecond() [1/3]

template<ComputeStage compute_stage>

ADVariableSecond & Coupleable::getADDefaultSecond ( )

inherited

Helper method to return (and insert if necessary) the default second derivatives for Automatic Differentiation for an uncoupled variable.

Parameters

var_name

the name of the variable for which to retrieve a default second derivative

Returns

VariableSecond * a pointer to the associated VariableSecond.

Definition at line 1325 of file Coupleable.h.

{
  return _ad_default_second;
}

getADDefaultSecond() [2/3]

template<>

VariableSecond& Coupleable::getADDefaultSecond ( )

inherited

getADDefaultSecond() [3/3]

template<>

VariableSecond& Coupleable::getADDefaultSecond ( )

inherited

Definition at line 1378 of file Coupleable.C.

{
  return _default_second;
}

getADDefaultValue() [1/2]

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.

getADDefaultValue() [2/2]

template<ComputeStage compute_stage>

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

inherited

Helper method to return (and insert if necessary) the default value for Automatic Differentiation 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 1266 of file Coupleable.h.

{
  auto default_value_it = _ad_default_value.find(var_name);
  if (default_value_it == _ad_default_value.end())
  {
    auto value = libmesh_make_unique<ADVariableValue>(_coupleable_max_qps,
                                                      _c_parameters.defaultCoupledValue(var_name));
    default_value_it = _ad_default_value.insert(std::make_pair(var_name, std::move(value))).first;
  }
 
  return default_value_it->second.get();
}

getADDefaultVectorGradient() [1/3]

template<ComputeStage compute_stage>

ADVectorVariableGradient & Coupleable::getADDefaultVectorGradient ( )

inherited

Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation for an uncoupled vector variable.

Parameters

var_name

the name of the vector variable for which to retrieve a default gradient

Returns

VariableGradient * a pointer to the associated VectorVariableGradient.

Definition at line 1315 of file Coupleable.h.

{
  return _ad_default_vector_gradient;
}

getADDefaultVectorGradient() [2/3]

template<>

VectorVariableGradient& Coupleable::getADDefaultVectorGradient ( )

inherited

getADDefaultVectorGradient() [3/3]

template<>

VectorVariableGradient& Coupleable::getADDefaultVectorGradient ( )

inherited

Definition at line 1371 of file Coupleable.C.

{
  return _default_vector_gradient;
}

getADDefaultVectorValue() [1/3]

template<ComputeStage compute_stage>

ADVectorVariableValue * Coupleable::getADDefaultVectorValue ( const std::string &  var_name )

inherited

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

Parameters

var_name

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

Returns

VariableVectorValue * a pointer to the associated VarirableVectorValue.

Definition at line 1284 of file Coupleable.h.

{
  auto default_value_it = _ad_default_vector_value.find(var_name);
  if (default_value_it == _ad_default_vector_value.end())
  {
    RealVectorValue default_vec;
    for (unsigned int i = 0; i < _c_parameters.numberDefaultCoupledValues(var_name); ++i)
      default_vec(i) = _c_parameters.defaultCoupledValue(var_name, i);
    auto value = libmesh_make_unique<ADVectorVariableValue>(_coupleable_max_qps, default_vec);
    default_value_it =
        _ad_default_vector_value.insert(std::make_pair(var_name, std::move(value))).first;
  }
 
  return default_value_it->second.get();
}

getADDefaultVectorValue() [2/3]

template<>

VectorVariableValue* Coupleable::getADDefaultVectorValue ( const std::string &  var_name )

inherited

getADDefaultVectorValue() [3/3]

template<>

VectorVariableValue* Coupleable::getADDefaultVectorValue ( const std::string &  var_name )

inherited

Definition at line 1357 of file Coupleable.C.

{
  return getDefaultVectorValue(var_name);
}

getArrayVar()

ArrayMooseVariable * Coupleable::getArrayVar ( const std::string &  var_name, unsigned int  comp  )

protectedinherited

Extract pointer to a coupled array variable.

Parameters

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

Returns

Pointer to the desired variable

Definition at line 258 of file Coupleable.C.

{
  return getVarHelper<RealEigenVector>(var_name, comp);
}

Referenced by Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), Coupleable::coupledArrayGradientOlder(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), and Coupleable::coupledArrayValueOlder().

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

getCoupledArratMooseVars()

const std::vector<ArrayMooseVariable *>& Coupleable::getCoupledArratMooseVars ( ) const

inlineinherited

Get the list of array coupled variables.

Returns

The list of array coupled variables

Definition at line 112 of file Coupleable.h.

  {
    return _coupled_array_moose_vars;
  }

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

getCoupledMooseVars()

const std::vector<MooseVariableFEBase *>& Coupleable::getCoupledMooseVars ( ) const

inlineinherited

Get the list of all coupled variables.

Returns

The list of all coupled variables

Definition at line 85 of file Coupleable.h.

  {
    return _coupled_moose_vars;
  }

Referenced by AuxNodalScalarKernel(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), ElementIndicator::ElementIndicator(), ElementUserObject::ElementUserObject(), InterfaceMaterial::InterfaceMaterial(), InterfaceUserObject::InterfaceUserObject(), InternalSideIndicator::InternalSideIndicator(), InternalSideUserObject::InternalSideUserObject(), Material::Material(), NeighborCoupleableMooseVariableDependencyIntermediateInterface::NeighborCoupleableMooseVariableDependencyIntermediateInterface(), NodalScalarKernel::NodalScalarKernel(), NodalUserObject::NodalUserObject(), and SideUserObject::SideUserObject().

getCoupledStandardMooseVars()

const std::vector<MooseVariable *>& Coupleable::getCoupledStandardMooseVars ( ) const

inlineinherited

Get the list of standard coupled variables.

Returns

The list of standard coupled variables

Definition at line 94 of file Coupleable.h.

  {
    return _coupled_standard_moose_vars;
  }

getCoupledVars()

const std::unordered_map<std::string, std::vector<MooseVariableFEBase *> >& Coupleable::getCoupledVars ( )

inlineinherited

Get the list of coupled variables.

Returns

The list of coupled variables

Definition at line 76 of file Coupleable.h.

  {
    return _coupled_vars;
  }

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

getCoupledVectorMooseVars()

const std::vector<VectorMooseVariable *>& Coupleable::getCoupledVectorMooseVars ( ) const

inlineinherited

Get the list of vector coupled variables.

Returns

The list of vector coupled variables

Definition at line 103 of file Coupleable.h.

  {
    return _coupled_vector_moose_vars;
  }

getDefaultArrayValue()

ArrayVariableValue * Coupleable::getDefaultArrayValue ( const std::string &  var_name )

privateinherited

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

Parameters

var_name

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

Returns

a pointer to the associated VectorVariableValue.

Definition at line 319 of file Coupleable.C.

{
  std::map<std::string, ArrayVariableValue *>::iterator default_value_it =
      _default_array_value.find(var_name);
  if (default_value_it == _default_array_value.end())
  {
    ArrayVariableValue * value = new ArrayVariableValue(_coupleable_max_qps);
    for (unsigned int qp = 0; qp < _coupleable_max_qps; ++qp)
    {
      auto n = _c_parameters.numberDefaultCoupledValues(var_name);
      (*value)[qp].resize(n);
      for (unsigned int i = 0; i < n; ++i)
        (*value)[qp](i) = _c_parameters.defaultCoupledValue(var_name, i);
    }
    default_value_it = _default_array_value.insert(std::make_pair(var_name, value)).first;
  }
 
  return default_value_it->second;
}

Referenced by Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), and Coupleable::getDefaultNodalValue().

getDefaultNodalValue() [1/3]

template<typename T >

const T & Coupleable::getDefaultNodalValue ( const std::string &  var_name, unsigned int  comp = 0  )

privateinherited

Get nodal default value.

Definition at line 341 of file Coupleable.C.

{
  auto && default_variable_value = getDefaultValue(var_name, comp);
  return *default_variable_value->data();
}

getDefaultNodalValue() [2/3]

template<>

const RealVectorValue& Coupleable::getDefaultNodalValue ( const std::string &  var_name, unsigned int    )

privateinherited

Definition at line 349 of file Coupleable.C.

{
  auto && default_variable_value = getDefaultVectorValue(var_name);
  return *default_variable_value->data();
}

getDefaultNodalValue() [3/3]

template<>

const RealEigenVector& Coupleable::getDefaultNodalValue ( const std::string &  var_name, unsigned int    )

privateinherited

Definition at line 357 of file Coupleable.C.

{
  auto && default_variable_value = getDefaultArrayValue(var_name);
  return *default_variable_value->data();
}

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

getDefaultVectorValue()

VectorVariableValue * Coupleable::getDefaultVectorValue ( const std::string &  var_name )

privateinherited

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

Parameters

var_name

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

Returns

a pointer to the associated VectorVariableValue.

Definition at line 284 of file Coupleable.C.

{
  auto default_value_it = _default_vector_value.find(var_name);
  if (default_value_it == _default_vector_value.end())
  {
    auto value = libmesh_make_unique<VectorVariableValue>(_coupleable_max_qps, 0);
    bool already_warned = false;
    for (unsigned int qp = 0; qp < _coupleable_max_qps; ++qp)
      for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
      {
        try
        {
          (*value)[qp](i) = _c_parameters.defaultCoupledValue(var_name, i);
        }
        catch (const std::out_of_range &)
        {
          if (!already_warned)
            mooseWarning(
                "You supplied less than 3 arguments for the default vector value for variable ",
                var_name,
                ". Did you accidently leave something off? We are going to assign 0s, assuming "
                "this "
                "was intentional.");
          already_warned = true;
          (*value)[qp](i) = 0;
        }
      }
    default_value_it =
        _default_vector_value.insert(std::make_pair(var_name, std::move(value))).first;
  }
 
  return default_value_it->second.get();
}

Referenced by Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), Coupleable::coupledVectorValueOlder(), Coupleable::getADDefaultVectorValue(), and Coupleable::getDefaultNodalValue().

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

getFEVar()

MooseVariableFEBase * Coupleable::getFEVar ( const std::string &  var_name, unsigned int  comp  )

protectedinherited

Extract pointer to a base finite element 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 204 of file Coupleable.C.

{
  if (!checkVar(var_name, comp, 0))
    return nullptr;
  return _coupled_vars[var_name][comp];
}

Referenced by Coupleable::coupled().

getFEVariableCoupleableMatrixTags()

std::set<TagID>& Coupleable::getFEVariableCoupleableMatrixTags ( )

inlineinherited

Definition at line 123 of file Coupleable.h.

{ return _fe_coupleable_matrix_tags; }

getFEVariableCoupleableVectorTags()

std::set<TagID>& Coupleable::getFEVariableCoupleableVectorTags ( )

inlineinherited

Definition at line 121 of file Coupleable.h.

{ return _fe_coupleable_vector_tags; }

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

getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

{ return _app; }

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

getMooseVariableDependencies()

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

inlineinherited

Retrieve the set of MooseVariableFEBases that this object depends on.

Returns

The MooseVariableFEBases that MUST be reinited before evaluating this object

Definition at line 26 of file MooseVariableDependencyInterface.h.

  {
    return _moose_variable_dependencies;
  }

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 & PostprocessorInterface::getPostprocessorValue ( const std::string &  name, unsigned int  index = 0  )

inherited

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

Parameters

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

Returns

A reference to the desired value

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

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 23 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.getPostprocessorValue(_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.getPostprocessorValue(
        _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
  }
}

Referenced by GeneralUserObject::getPostprocessorValue(), and AuxKernelTempl< ComputeValueType >::getPostprocessorValue().

getPostprocessorValueByName()

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

inherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns

A reference to the desired value

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

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 119 of file PostprocessorInterface.C.

{
  return _pi_feproblem.getPostprocessorValue(name);
}

Referenced by EigenKernel::EigenKernel(), GeneralUserObject::getPostprocessorValueByName(), AuxKernelTempl< ComputeValueType >::getPostprocessorValueByName(), EigenExecutionerBase::inversePowerIteration(), and ParsedODEKernel::ParsedODEKernel().

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 > & AuxScalarKernel::getRequestedItems ( )

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 92 of file AuxScalarKernel.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, "'");
}

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalar(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), ScalarCoupleable::coupledVectorTagScalarValue(), and ParsedODEKernel::ParsedODEKernel().

getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 51 of file ScalarCoupleable.h.

{ return _sc_coupleable_matrix_tags; }

getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 49 of file ScalarCoupleable.h.

{ return _sc_coupleable_vector_tags; }

getSuppliedItems()

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

overridevirtualinherited

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

Implements DependencyResolverInterface.

Definition at line 98 of file AuxScalarKernel.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);
}

getVar()

MooseVariable * Coupleable::getVar ( const std::string &  var_name, unsigned int  comp  )

protectedinherited

Extract pointer to a 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 240 of file Coupleable.C.

{
  return getVarHelper<Real>(var_name, comp);
}

Referenced by Coupleable::adCoupledDotTemplate(), Coupleable::adCoupledGradientTemplate(), Coupleable::adCoupledSecondTemplate(), Coupleable::adCoupledValueTemplate(), ShapeUserObject< SideUserObject >::coupled(), Coupleable::coupledDofValues(), Coupleable::coupledDofValuesOld(), Coupleable::coupledDofValuesOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledGradient(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), Coupleable::coupledGradientPreviousNL(), Coupleable::coupledMatrixTagValue(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradient(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValue(), NeighborCoupleable::coupledNeighborValueDot(), NeighborCoupleable::coupledNeighborValueDotDu(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), Coupleable::coupledSecondPreviousNL(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorTagValue(), ParsedAux::ParsedAux(), and SpatialAverageBase::SpatialAverageBase().

getVarHelper()

template<typename T >

template MooseVariableFE< RealVectorValue > * Coupleable::getVarHelper< RealVectorValue > ( const std::string &  var_name, unsigned int  comp  )

protectedinherited

Helper that segues off to either getVar of getVectorVar depending on template paramter.

Definition at line 213 of file Coupleable.C.

{
  if (!checkVar(var_name, comp, 0))
    return nullptr;
 
  if (auto * coupled_var = dynamic_cast<MooseVariableFE<T> *>(_coupled_vars[var_name][comp]))
    return coupled_var;
  else
  {
    for (auto & var : _coupled_standard_moose_vars)
      if (var->name() == var_name)
        mooseError("The named variable is a standard variable, try a "
                   "'coupled[Value/Gradient/Dot/etc]...' function instead");
    for (auto & var : _coupled_vector_moose_vars)
      if (var->name() == var_name)
        mooseError("The named variable is a vector variable, try a "
                   "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
    for (auto & var : _coupled_array_moose_vars)
      if (var->name() == var_name)
        mooseError("The named variable is an array variable, try a "
                   "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
    mooseError(
        "Variable '", var_name, "' is of a different C++ type than you tried to fetch it as.");
  }
}

getVectorVar()

VectorMooseVariable * Coupleable::getVectorVar ( const std::string &  var_name, unsigned int  comp  )

protectedinherited

Extract pointer to a coupled vector variable.

Parameters

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

Returns

Pointer to the desired variable

Definition at line 246 of file Coupleable.C.

{
  if (_c_nodal)
    mooseError("Nodal object '",
               _c_name,
               "' uses vector variables which are not required to be continuous. Don't use vector "
               "variables"
               "with nodal compute objects.");
  return getVarHelper<RealVectorValue>(var_name, comp);
}

Referenced by Coupleable::adCoupledVectorDotTemplate(), Coupleable::adCoupledVectorGradientTemplate(), Coupleable::adCoupledVectorValueTemplate(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledCurlOlder(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotDu(), Coupleable::coupledVectorDotDotOld(), Coupleable::coupledVectorDotDu(), Coupleable::coupledVectorDotOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), and Coupleable::coupledVectorValueOlder().

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

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.

{
}

isActive()

bool AuxScalarKernel::isActive ( )

virtualinherited

Use this to enable/disable the constraint.

Returns

true if the constrain is active

Definition at line 104 of file AuxScalarKernel.C.

{
  return true;
}

isCoupled()

bool Coupleable::isCoupled ( const std::string &  var_name, unsigned int  i = 0  )

protectedvirtualinherited

Returns true if a variables has been coupled as name.

Parameters

var_name	The name the kernel wants to refer to the variable as.
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Returns

True if a coupled variable has the supplied name

Definition at line 107 of file Coupleable.C.

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

Referenced by Coupleable::adCoupledNodalValueTemplate(), Coupleable::checkVar(), Coupleable::coupledComponents(), and MatDiffusionBase< Real >::MatDiffusionBase().

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.

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

{ return _pars.isParamValid(name); }

Referenced by AdvancedOutput::AdvancedOutput(), BicubicSplineFunction::BicubicSplineFunction(), GeneratedMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), CSVReader::CSVReader(), DGKernelBase::DGKernelBase(), MultiAppNearestNodeTransfer::execute(), Executioner::Executioner(), Exodus::Exodus(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), ExtraNodesetGenerator::generate(), RenameBoundaryGenerator::generate(), RenameBlockGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementSubdomainIDGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MeshSideSetGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainMeshGenerator::generate(), MeshExtruderGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MultiAppNearestNodeTransfer::getLocalEntities(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), MeshGenerator::getMesh(), MultiAppNearestNodeTransfer::getNearestNode(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), MooseParsedVectorFunction::initialSetup(), Console::initialSetup(), Receiver::initialSetup(), SolutionFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), MatDiffusionBase< Real >::MatDiffusionBase(), MeshGeneratorMesh::MeshGeneratorMesh(), BreakBoundaryOnSubdomain::modify(), MeshExtruder::modify(), MeshSideSet::modify(), LowerDBlockFromSideset::modify(), AssignElementSubdomainID::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), SubdomainBoundingBox::modify(), MooseMesh::MooseMesh(), EigenExecutionerBase::normalizeSolution(), Output::Output(), PetscOutput::PetscOutput(), PiecewiseBase::PiecewiseBase(), SolutionUserObject::readExodusII(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), SolutionUserObject::SolutionUserObject(), and TimePeriod::TimePeriod().

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.

{
}

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.

{}

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

Referenced by GridPartitioner::_do_partition(), PetscExternalPartitioner::_do_partition(), FEProblemBase::addConstraint(), ADDGKernel< compute_stage >::ADDGKernel(), FEProblemBase::addInitialCondition(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), FEProblemBase::addOutput(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), MultiAppConservativeTransfer::adjustTransferedSolution(), MultiAppConservativeTransfer::adjustTransferedSolutionNearestPoint(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), Output::advancedExecuteOn(), MooseVariableBase::allDofIndices(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayConstantIC::ArrayConstantIC(), ArrayDGKernel::ArrayDGKernel(), ArrayDiffusion::ArrayDiffusion(), ArrayFunctionIC::ArrayFunctionIC(), ArrayReaction::ArrayReaction(), ArrayTimeDerivative::ArrayTimeDerivative(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction::BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), TiledMesh::buildMesh(), FileMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), ImageMeshGenerator::buildMesh3D(), ImageMesh::buildMesh3D(), MooseMesh::buildMeshBaseObject(), MooseMesh::buildRefinementMap(), MooseMesh::buildSideList(), CartesianMeshGenerator::CartesianMeshGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), SubProblem::checkBoundaryMatProps(), FEProblemBase::checkCoordinateSystems(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), MaterialBase::checkExecutionStage(), BreakMeshByBlockBase::checkInputParameter(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), ExplicitTimeIntegrator::checkLinearConvergence(), FEProblemBase::checkProblemIntegrity(), MaterialBase::checkStatefulSanity(), FEProblemBase::checkUserObjects(), MultiAppTransfer::checkVariable(), LibmeshPartitioner::clone(), MooseMesh::clone(), ComparisonPostprocessor::comparisonIsTrue(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), KernelBase::computeADOffDiagJacobian(), BlockWeightedPartitioner::computeElementWeight(), ArrayDGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighResidual(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), HistogramVectorPostprocessor::computeHistogram(), ArrayKernel::computeJacobian(), ArrayIntegratedBC::computeJacobian(), ArrayIntegratedBC::computeJacobianBlock(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), ArrayKernel::computeOffDiagJacobian(), MaterialBase::computeProperties(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), KernelValue::computeQpResidual(), ArrayKernel::computeResidual(), ArrayIntegratedBC::computeResidual(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualType(), StatisticsVectorPostprocessor::computeStatValue(), MaterialBase::computeSubdomainProperties(), ActuallyExplicitEuler::computeTimeDerivatives(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), ConditionalEnableControl::ConditionalEnableControl(), TimeStepper::constrainStep(), CoupledForce::CoupledForce(), CoupledForceNodalKernel::CoupledForceNodalKernel(), SidesetInfoVectorPostprocessor::dataHelper(), DebugResidualAux::DebugResidualAux(), FunctorRelationshipManager::delete_remote_elements(), BicubicSplineFunction::derivative(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), FunctorRelationshipManager::dofmap_reinit(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementIntegerAux::ElementIntegerAux(), ElementQualityAux::ElementQualityAux(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ElementQualityChecker::execute(), NodalValueSampler::execute(), GreaterThanLessThanPostprocessor::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), InterfaceQpValueUserObject::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), TimeExtremeValue::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFit::execute(), LeastSquaresFitHistory::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus::Exodus(), ExplicitSSPRungeKutta::ExplicitSSPRungeKutta(), FileOutput::FileOutput(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), NearestPointIntegralVariablePostprocessor::finalize(), Transfer::find_sys(), BreakMeshByBlockBase::findFreeBoundaryId(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), WorkBalance::gather(), ExtraNodesetGenerator::generate(), RenameBoundaryGenerator::generate(), RenameBlockGenerator::generate(), ElementSubdomainIDGenerator::generate(), GeneratedMeshGenerator::generate(), CombinerGenerator::generate(), SideSetsFromBoundingBoxGenerator::generate(), MeshExtruderGenerator::generate(), StackGenerator::generate(), SpiralAnnularMeshGenerator::generate(), PatternedMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), RandomICBase::generateRandom(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), DisplacedProblem::getArrayVariable(), FEProblemBase::getArrayVariable(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), MooseMesh::getCoarseningMap(), Control::getControllableParameterByName(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), GhostingUserObject::getElementalValue(), ElementGenerator::getElemType(), MultiApp::getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), DistributedGeneratedMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), AnnularMesh::getMinInDimension(), DistributedGeneratedMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMesh::GetPixelInfo(), ImageMeshGenerator::GetPixelInfo(), InterfaceQpValueUserObject::getQpValue(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObjectBase(), FEProblemBase::getUserObjectTempl(), NumRelationshipManagers::getValue(), PerformanceData::getValue(), Residual::getValue(), PerfGraphData::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), GhostingAux::GhostingAux(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), Transient::init(), MooseMesh::init(), Sampler::init(), FEProblemBase::init(), NumPicardIterations::initialize(), PiecewiseLinearBase::initialSetup(), ReferenceResidualProblem::initialSetup(), MultiAppConservativeTransfer::initialSetup(), FullSolveMultiApp::initialSetup(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), Exodus::initialSetup(), SolutionFunction::initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), MaterialBase::initStatefulProperties(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceTimeKernel::InterfaceTimeKernel(), AugmentSparsityOnInterface::internalInit(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredSideIntegral::LayeredSideIntegral(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), LowerBoundNodalKernel::LowerBoundNodalKernel(), PNGOutput::makePNG(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), FunctorRelationshipManager::mesh_reinit(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshSideSetGenerator::MeshSideSetGenerator(), SideSetsFromNormals::modify(), SideSetsFromPoints::modify(), AddExtraNodeset::modify(), BreakMeshByBlockBase::modify(), MeshExtruder::modify(), AssignElementSubdomainID::modify(), SmoothMesh::modify(), AddAllSideSetsByNormals::modify(), ElementDeleterBase::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), AddSideSetsFromBoundingBox::modify(), SubdomainBoundingBox::modify(), MooseGhostPointNeighbors::MooseGhostPointNeighbors(), MooseMesh::MooseMesh(), MooseVariableBase::MooseVariableBase(), MortarConstraintBase::MortarConstraintBase(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), RenameBlockGenerator::newBlockID(), RenameBlock::newBlockID(), RenameBlockGenerator::newBlockName(), RenameBlock::newBlockName(), NewmarkBeta::NewmarkBeta(), NodalConstraint::NodalConstraint(), NodalScalarKernel::NodalScalarKernel(), NodalVariableValue::NodalVariableValue(), NumDOFs::NumDOFs(), NumNonlinearIterations::NumNonlinearIterations(), NumVars::NumVars(), FunctorRelationshipManager::operator()(), RelationshipManager::operator==(), XDA::output(), SolutionHistory::output(), Exodus::output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), Console::outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), MooseObject::paramError(), PiecewiseBilinear::parse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), ExplicitTimeIntegrator::performExplicitSolve(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), Eigenvalue::postSolve(), Predictor::Predictor(), Transient::preExecute(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), DerivativeParsedMaterialHelper::recurseDerivative(), FunctorRelationshipManager::redistribute(), ReferenceResidualProblem::ReferenceResidualProblem(), EqualValueEmbeddedConstraint::reinitConstraint(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), ScalarComponentIC::ScalarComponentIC(), BicubicSplineFunction::secondDerivative(), FEProblemBase::setCoordSystem(), PiecewiseBase::setData(), EigenProblem::setEigenproblemType(), FEProblemSolve::setInnerSolve(), Sampler::setNumberOfCols(), Sampler::setNumberOfRandomSeeds(), Sampler::setNumberOfRows(), Exodus::setOutputDimensionInExodusWriter(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SideSetsFromNormals::SideSetsFromNormals(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPoints::SideSetsFromPoints(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), SolutionUserObject::SolutionUserObject(), PicardSolve::solve(), FullSolveMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), NearestPointIntegralVariablePostprocessor::spatialValue(), UserObject::spatialValue(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), MaterialBase::subdomainSetup(), Console::systemInfoFlags(), TagMatrixAux::TagMatrixAux(), TagVectorAux::TagVectorAux(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), TiledMeshGenerator::TiledMeshGenerator(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppFieldTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), MooseVariableScalar::uDot(), MooseVariableScalar::uDotDot(), MooseVariableScalar::uDotDotOld(), FEProblemBase::uDotDotOldRequested(), MooseVariableScalar::uDotOld(), FEProblemBase::uDotOldRequested(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), UpperBoundNodalKernel::UpperBoundNodalKernel(), NearestPointIntegralVariablePostprocessor::userObjectValue(), BoundingBoxIC::value(), Axisymmetric2D3DSolutionFunction::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), MultiAppTransfer::variableIntegrityCheck(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), VectorNodalBC::VectorNodalBC(), VectorOfPostprocessors::VectorOfPostprocessors(), VectorPostprocessorFunction::VectorPostprocessorFunction(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), VolumeHistogram::VolumeHistogram(), VTKOutput::VTKOutput(), DOFMapOutput::writeStreamToFile(), and Console::writeStreamToFile().

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.

{ return _name; }

Referenced by GridPartitioner::_do_partition(), FEProblemBase::addADJacobianInterfaceMaterial(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADKernel(), FEProblemBase::addADResidualInterfaceMaterial(), FEProblemBase::addADResidualMaterial(), Executioner::addAttributeReporter(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), ADDGKernel< compute_stage >::ADDGKernel(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), Output::advancedExecuteOn(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayDGKernel::ArrayDGKernel(), DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), Function::average(), MultiApp::backup(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), MaterialBase::checkStatefulSanity(), CoarsenedPiecewiseLinear::CoarsenedPiecewiseLinear(), CompositeFunction::CompositeFunction(), MaterialBase::computeProperties(), MaterialBase::computeSubdomainProperties(), FEProblemBase::computeUserObjectByName(), VectorPostprocessorVisualizationAux::computeValue(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), FEProblemBase::declareVectorPostprocessorVector(), DOFMapOutput::demangle(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DumpObjectsProblem::dumpObjectHelper(), ElementValueSampler::ElementValueSampler(), MooseMesh::errorIfDistributedMesh(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), StatisticsVectorPostprocessor::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), PointValue::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppNearestNodeTransfer::execute(), HistogramVectorPostprocessor::execute(), MultiAppProjectionTransfer::execute(), Exodus::Exodus(), FancyExtruderGenerator::FancyExtruderGenerator(), MultiApp::fillPositions(), PointSamplerBase::finalize(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), GeneralUserObject::GeneralUserObject(), LowerDBlockFromSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), StitchedMeshGenerator::generate(), Material::getADMaterialPropertyTempl(), MultiApp::getBoundingBox(), MooseObject::getCheckedPointerParam(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), MultiApp::getExecutioner(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), FEProblemBase::getInterfaceMaterial(), SolutionUserObject::getLocalVarIndex(), Marker::getMarkerValue(), FEProblemBase::getMaterial(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), Material::getMaterialPropertyOlderTempl(), InterfaceMaterial::getMaterialPropertyOlderTempl(), NodalPatchRecovery::getMaterialPropertyOlderTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOlderTempl(), Material::getMaterialPropertyOldTempl(), InterfaceMaterial::getMaterialPropertyOldTempl(), NodalPatchRecovery::getMaterialPropertyOldTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOldTempl(), Material::getMaterialPropertyTempl(), InterfaceMaterial::getMaterialPropertyTempl(), NodalPatchRecovery::getMaterialPropertyTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyTempl(), MeshGenerator::getMesh(), InterfaceMaterial::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), InterfaceMaterial::getNeighborMaterialPropertyTempl(), OutputWarehouse::getOutput(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), FEProblemBase::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), FEProblemBase::getPostprocessorValueOld(), FEProblemBase::getPostprocessorValueOlder(), FEProblemBase::getSampler(), FEProblemBase::getScatterVectorPostprocessorValue(), FEProblemBase::getScatterVectorPostprocessorValueOld(), Transient::getTimeStepperName(), InitialConditionBase::getUserObjectBase(), FEProblemBase::getUserObjectBase(), InitialConditionBase::getUserObjectByNameTempl(), InitialConditionBase::getUserObjectTempl(), FEProblemBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValue(), GeneralUserObject::getVectorPostprocessorValueByName(), FEProblemBase::getVectorPostprocessorValueOld(), FEProblemBase::hasFunction(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasUserObject(), FEProblemBase::hasVectorPostprocessor(), FEProblemBase::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), SolutionScalarAux::initialSetup(), MultiAppProjectionTransfer::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), MultiApp::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPostprocessorData(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), FEProblemBase::initVectorPostprocessorData(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), Registry::isADObj(), MooseObject::isParamValid(), Registry::isRegisteredObj(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), MaterialOutputAction::materialOutputHelper(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshSideSetGenerator::MeshSideSetGenerator(), ElementDeleterBase::modify(), MooseVariableInterface< Real >::MooseVariableInterface(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), Registry::objData(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), ConsoleUtils::outputExecutionInformation(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), OversampleOutput::outputStep(), Output::outputStep(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), MultiAppConservativeTransfer::postExecute(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), MaterialBase::resetQpProperties(), MultiApp::restore(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), UserObject::spatialValue(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), SubProblem::storeSubdomainZeroMatProp(), MaterialBase::subdomainSetup(), TaggingInterface::TaggingInterface(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), Function::timeDerivative(), VectorPostprocessorVisualizationAux::timestepSetup(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), and AdvancedOutput::wantOutput().

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

Referenced by ADDGKernel< compute_stage >::ADDGKernel(), ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ADVectorFunctionDirichletBC< compute_stage >::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), BlockWeightedPartitioner::BlockWeightedPartitioner(), checkComponent(), Coupleable::checkVar(), MultiAppTransfer::checkVariable(), CombinerGenerator::CombinerGenerator(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), Coupleable::Coupleable(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), Eigenvalue::Eigenvalue(), ElementValueSampler::ElementValueSampler(), Executioner::Executioner(), FancyExtruderGenerator::FancyExtruderGenerator(), RenameBoundaryGenerator::generate(), MeshCollectionGenerator::generate(), StackGenerator::generate(), StitchedMeshGenerator::generate(), CombinerGenerator::generate(), Sampler::getGlobalSamples(), Sampler::getLocalSamples(), Sampler::getNextLocalRow(), MultiApp::init(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), IntegratedBC::IntegratedBC(), InversePowerMethod::InversePowerMethod(), Kernel::Kernel(), PNGOutput::makeMeshFunc(), MeshCollectionGenerator::MeshCollectionGenerator(), MultiAppConservativeTransfer::MultiAppConservativeTransfer(), MultiAppInterpolationTransfer::MultiAppInterpolationTransfer(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorToAuxScalarTransfer::MultiAppPostprocessorToAuxScalarTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppProjectionTransfer::MultiAppProjectionTransfer(), MultiAppScalarToAuxScalarTransfer::MultiAppScalarToAuxScalarTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiAppVectorPostprocessorTransfer::MultiAppVectorPostprocessorTransfer(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), PatchMeshGenerator::PatchMeshGenerator(), PatternedMeshGenerator::PatternedMeshGenerator(), PiecewiseFunctionTabulate::PiecewiseFunctionTabulate(), PlaneDeletionGenerator::PlaneDeletionGenerator(), RandomIC::RandomIC(), MooseMesh::setPartitioner(), MultiAppFieldTransfer::transfer(), Transfer::Transfer(), TransientMultiApp::TransientMultiApp(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), and VectorFunctionIC::VectorFunctionIC().

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.

{ return _pars; }

Referenced by FEProblemBase::addADJacobianInterfaceMaterial(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADKernel(), FEProblemBase::addADResidualInterfaceMaterial(), FEProblemBase::addADResidualMaterial(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addOutput(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), AdvancedOutput::AdvancedOutput(), ADVectorFunctionDirichletBC< compute_stage >::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), assemble_l2(), Moose::assemble_matrix(), AuxKernelTempl< ComputeValueType >::AuxKernelTempl(), AuxScalarKernel::AuxScalarKernel(), BoundsAux::BoundsAux(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), Console::Console(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), Exodus::Exodus(), FEProblem::FEProblem(), GapValueAux::GapValueAux(), MooseObject::getCheckedPointerParam(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), BlockRestrictable::initializeBlockRestrictable(), FEProblemBase::initNullSpaceVectors(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), isValid(), LayeredSideIntegral::LayeredSideIntegral(), MooseVariableInterface< Real >::MooseVariableInterface(), NodeFaceConstraint::NodeFaceConstraint(), PatchMeshGenerator::PatchMeshGenerator(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), MultiAppProjectionTransfer::projectSolution(), RandomIC::RandomIC(), InputParameterWarehouse::removeInputParameters(), EigenProblem::scaleEigenvector(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), DumpObjectsProblem::stringifyParameters(), Transient::Transient(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), and VectorFunctionIC::VectorFunctionIC().

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

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.

{
}

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

subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 64 of file SetupInterface.C.

{
}

subProblem()

SubProblem& AuxScalarKernel::subProblem ( )

inlineinherited

Definition at line 62 of file AuxScalarKernel.h.

{ return _subproblem; }

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.

{
}

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.

{ return _type; }

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), DumpObjectsProblem::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), DumpObjectsProblem::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), DumpObjectsProblem::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), DumpObjectsProblem::addKernel(), DumpObjectsProblem::addMaterial(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarVariable(), PhysicsBasedPreconditioner::addSystem(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addVariable(), FEProblemBase::advanceMultiApps(), FEProblemBase::backupMultiApps(), MooseMesh::buildRefinementAndCoarseningMaps(), FEProblemBase::computeAuxiliaryKernels(), DGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), FEProblemBase::computeMultiAppsDT(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGConvection::computeQpJacobian(), ArrayDGDiffusion::computeQpJacobian(), InterfaceReaction::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), DGConvection::computeQpResidual(), ArrayDGDiffusion::computeQpResidual(), InterfaceReaction::computeQpResidual(), TiedValueConstraint::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeUserObjectByName(), FEProblemBase::computeUserObjects(), FEProblemBase::computeUserObjectsInternal(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finishMultiAppStep(), ElementSubdomainIDGenerator::generate(), ElementGenerator::getElemType(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getTransfers(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), AssignElementSubdomainID::modify(), ControlOutput::output(), Gnuplot::output(), CSV::output(), Exodus::output(), Console::output(), Nemesis::output(), AdvancedOutput::output(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), FEProblemBase::restoreMultiApps(), FEProblemBase::setCoupling(), PerfGraphOutput::shouldOutput(), FileOutput::shouldOutput(), Output::shouldOutput(), AdvancedOutput::shouldOutput(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), and AdvancedOutput::wantOutput().

validateExecutionerType() [1/2]

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

validateExecutionerType() [2/2]

void Coupleable::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 1336 of file Coupleable.C.

{
  if (!_c_fe_problem.isTransient())
    mooseError(_c_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 Coupleable::checkFuncType(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), NeighborCoupleable::coupledVectorNeighborGradientOld(), and NeighborCoupleable::coupledVectorNeighborGradientOlder().

validParams()

InputParameters AuxNodalScalarKernel::validParams ( )

static

Definition at line 16 of file AuxNodalScalarKernel.C.

{
  InputParameters params = AuxScalarKernel::validParams();
  params.addRequiredParam<std::vector<dof_id_type>>("nodes", "Node ids");
  return params;
}

variable()

MooseVariableScalar& AuxScalarKernel::variable ( )

inlineinherited

The variable that this kernel operates on.

Definition at line 60 of file AuxScalarKernel.h.

{ return _var; }

writableCoupledValue()

VariableValue & Coupleable::writableCoupledValue ( const std::string &  var_name, unsigned int  comp = 0  )

protectedvirtualinherited

Returns a writable reference to a coupled variable.

Note: you should not have to use this very often (use coupledValue() instead) but there are situations, such as writing to multiple AuxVariables from a single AuxKernel, where it is required.

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

See also

Kernel::value

Definition at line 477 of file Coupleable.C.

{
  return const_cast<VariableValue &>(coupledValue(var_name, comp));
}

Member Data Documentation

_ad_default_gradient

MooseArray<DualRealVectorValue> Coupleable::_ad_default_gradient

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 910 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), and Coupleable::getADDefaultGradient().

_ad_default_second

MooseArray<DualRealTensorValue> Coupleable::_ad_default_second

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 919 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), and Coupleable::getADDefaultSecond().

_ad_default_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<DualReal> > > Coupleable::_ad_default_value

protectedinherited

Will hold the default value for optional coupled variables for automatic differentiation.

Definition at line 888 of file Coupleable.h.

Referenced by Coupleable::getADDefaultValue().

_ad_default_vector_gradient

MooseArray<DualRealTensorValue> Coupleable::_ad_default_vector_gradient

protectedinherited

This will always be zero because the default values for optionally coupled vector variables is always constant.

Definition at line 913 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), and Coupleable::getADDefaultVectorGradient().

_ad_default_vector_value

std::unordered_map<std::string, std::unique_ptr<MooseArray<DualRealVectorValue> > > Coupleable::_ad_default_vector_value

protectedinherited

Will hold the default value for optional vector coupled variables for automatic differentiation.

Definition at line 898 of file Coupleable.h.

Referenced by Coupleable::getADDefaultVectorValue().

_ad_grad_zero

const MooseArray<DualRealVectorValue>& Coupleable::_ad_grad_zero

protectedinherited

Definition at line 927 of file Coupleable.h.

Referenced by Coupleable::adZeroGradientTemplate().

_ad_second_zero

const MooseArray<DualRealTensorValue>& Coupleable::_ad_second_zero

protectedinherited

Definition at line 931 of file Coupleable.h.

Referenced by Coupleable::adZeroSecondTemplate().

_ad_zero

const MooseArray<DualReal>& Coupleable::_ad_zero

protectedinherited

Definition at line 923 of file Coupleable.h.

Referenced by Coupleable::adZeroValueTemplate().

_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& AuxScalarKernel::_assembly

protectedinherited

Definition at line 80 of file AuxScalarKernel.h.

_c_coupled_scalar_vars

std::unordered_map<std::string, std::vector<MooseVariableScalar *> > Coupleable::_c_coupled_scalar_vars

privateinherited

Scalar variables coupled into this object (for error checking)

Definition at line 1122 of file Coupleable.h.

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

_c_fe_problem

FEProblemBase& Coupleable::_c_fe_problem

protectedinherited

Definition at line 858 of file Coupleable.h.

Referenced by Coupleable::coupledGradientPreviousNL(), Coupleable::coupledNodalValuePreviousNL(), Coupleable::coupledSecondPreviousNL(), Coupleable::coupledValuePreviousNL(), and Coupleable::validateExecutionerType().

_c_is_implicit

bool Coupleable::_c_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 879 of file Coupleable.h.

Referenced by Coupleable::adCoupledGradientTemplate(), Coupleable::adCoupledNodalValueTemplate(), Coupleable::adCoupledSecondTemplate(), Coupleable::adCoupledValueTemplate(), Coupleable::adCoupledVectorGradientTemplate(), Coupleable::adCoupledVectorValueTemplate(), Coupleable::checkFuncType(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), NeighborCoupleable::coupledArrayNeighborGradient(), NeighborCoupleable::coupledArrayNeighborGradientOld(), NeighborCoupleable::coupledArrayNeighborGradientOlder(), NeighborCoupleable::coupledArrayNeighborValue(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledDofValues(), Coupleable::coupledDofValuesOld(), Coupleable::coupledGradient(), Coupleable::coupledGradientOld(), NeighborCoupleable::coupledNeighborDofValues(), NeighborCoupleable::coupledNeighborDofValuesOld(), NeighborCoupleable::coupledNeighborDofValuesOlder(), NeighborCoupleable::coupledNeighborGradient(), NeighborCoupleable::coupledNeighborGradientOld(), NeighborCoupleable::coupledNeighborGradientOlder(), NeighborCoupleable::coupledNeighborSecond(), NeighborCoupleable::coupledNeighborValue(), NeighborCoupleable::coupledNeighborValueOld(), NeighborCoupleable::coupledNeighborValueOlder(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), NeighborCoupleable::coupledVectorNeighborGradient(), NeighborCoupleable::coupledVectorNeighborGradientOld(), NeighborCoupleable::coupledVectorNeighborGradientOlder(), Coupleable::coupledVectorValue(), and Coupleable::coupledVectorValueOld().

_c_name

const std::string& Coupleable::_c_name

protectedinherited

The name of the object this interface is part of.

Definition at line 855 of file Coupleable.h.

Referenced by Coupleable::checkFuncType(), Coupleable::checkVar(), Coupleable::coupled(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledNodalValueOlder(), Coupleable::getVectorVar(), Coupleable::isCoupled(), and Coupleable::validateExecutionerType().

_c_nodal

bool Coupleable::_c_nodal

protectedinherited

True if we provide coupling to nodal values.

Definition at line 876 of file Coupleable.h.

Referenced by Coupleable::adCoupledDotTemplate(), Coupleable::adCoupledNodalValueTemplate(), Coupleable::adCoupledValueTemplate(), Coupleable::adCoupledVectorDotTemplate(), Coupleable::adCoupledVectorValueTemplate(), Coupleable::checkFuncType(), Coupleable::checkVar(), Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledMatrixTagValue(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorTagValue(), and Coupleable::getVectorVar().

_c_parameters

const InputParameters& Coupleable::_c_parameters

protectedinherited

Definition at line 852 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledComponents(), Coupleable::getADDefaultValue(), Coupleable::getADDefaultVectorValue(), Coupleable::getDefaultArrayValue(), Coupleable::getDefaultValue(), Coupleable::getDefaultVectorValue(), and Coupleable::isCoupled().

_c_tid

THREAD_ID Coupleable::_c_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 882 of file Coupleable.h.

Referenced by Coupleable::Coupleable().

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

Referenced by IterationAdaptiveDT::acceptStep(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), MultiApp::backup(), FEProblemBase::backupMultiApps(), ReferenceResidualProblem::checkNonlinearConvergence(), FEProblemBase::checkProblemIntegrity(), CoarsenedPiecewiseLinear::CoarsenedPiecewiseLinear(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), NonlinearSystem::computeScaling(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), Steady::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), MultiAppConservativeTransfer::postExecute(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), AutomaticMortarGeneration::projectMasterNodesSinglePair(), AutomaticMortarGeneration::projectSlaveNodesSinglePair(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), PicardSolve::solve(), NonlinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Transient::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

_coupleable_max_qps

unsigned int Coupleable::_coupleable_max_qps

privateinherited

Maximum qps for any element in this system.

Definition at line 1116 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getADDefaultValue(), Coupleable::getADDefaultVectorValue(), Coupleable::getDefaultArrayValue(), Coupleable::getDefaultValue(), and Coupleable::getDefaultVectorValue().

_coupleable_neighbor

bool Coupleable::_coupleable_neighbor

protectedinherited

Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values.

Definition at line 1036 of file Coupleable.h.

Referenced by Coupleable::adCoupledDotTemplate(), Coupleable::adCoupledGradientTemplate(), Coupleable::adCoupledNodalValueTemplate(), Coupleable::adCoupledSecondTemplate(), Coupleable::adCoupledValueTemplate(), Coupleable::adCoupledVectorDotTemplate(), Coupleable::adCoupledVectorGradientTemplate(), Coupleable::adCoupledVectorValueTemplate(), Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), Coupleable::coupledArrayDotOld(), Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), Coupleable::coupledArrayGradientOlder(), Coupleable::coupledArrayValue(), Coupleable::coupledArrayValueOld(), Coupleable::coupledArrayValueOlder(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), Coupleable::coupledCurlOlder(), Coupleable::coupledDofValues(), Coupleable::coupledDofValuesOld(), Coupleable::coupledDofValuesOlder(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledGradient(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), Coupleable::coupledGradientPreviousNL(), Coupleable::coupledNodalDot(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledNodalValue(), Coupleable::coupledNodalValueOld(), Coupleable::coupledNodalValueOlder(), Coupleable::coupledNodalValuePreviousNL(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), Coupleable::coupledSecondPreviousNL(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotDu(), Coupleable::coupledVectorDotDotOld(), Coupleable::coupledVectorDotDu(), Coupleable::coupledVectorDotOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), Coupleable::coupledVectorValue(), Coupleable::coupledVectorValueOld(), and Coupleable::coupledVectorValueOlder().

_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_array_moose_vars

std::vector<ArrayMooseVariable *> Coupleable::_coupled_array_moose_vars

protectedinherited

Vector of array coupled variables.

Definition at line 873 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getCoupledArratMooseVars(), and Coupleable::getVarHelper().

_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_moose_vars

std::vector<MooseVariableFEBase *> Coupleable::_coupled_moose_vars

protectedinherited

Vector of all coupled variables.

Definition at line 864 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), ElementValueSampler::ElementValueSampler(), SideValueSampler::execute(), ElementValueSampler::execute(), PointSamplerBase::execute(), Coupleable::getCoupledMooseVars(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), NodalValueSampler::NodalValueSampler(), PointSamplerBase::PointSamplerBase(), and SideValueSampler::SideValueSampler().

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

_coupled_standard_moose_vars

std::vector<MooseVariable *> Coupleable::_coupled_standard_moose_vars

protectedinherited

Vector of standard coupled variables.

Definition at line 867 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), ElementValueSampler::execute(), NodalValueSampler::execute(), Coupleable::getCoupledStandardMooseVars(), and Coupleable::getVarHelper().

_coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFEBase *> > Coupleable::_coupled_vars

protectedinherited

Coupled vars whose values we provide.

Definition at line 861 of file Coupleable.h.

Referenced by Coupleable::checkVar(), Coupleable::Coupleable(), Coupleable::coupledComponents(), FunctionMaterialBase::FunctionMaterialBase(), Coupleable::getCoupledVars(), Coupleable::getFEVar(), Coupleable::getVarHelper(), and Coupleable::isCoupled().

_coupled_vector_moose_vars

std::vector<VectorMooseVariable *> Coupleable::_coupled_vector_moose_vars

protectedinherited

Vector of vector coupled variables.

Definition at line 870 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::getCoupledVectorMooseVars(), and Coupleable::getVarHelper().

_current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 99 of file SetupInterface.h.

_default_array_curl

ArrayVariableCurl Coupleable::_default_array_curl

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 961 of file Coupleable.h.

_default_array_gradient

ArrayVariableGradient Coupleable::_default_array_gradient

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 958 of file Coupleable.h.

Referenced by Coupleable::coupledArrayGradient(), Coupleable::coupledArrayGradientOld(), and Coupleable::coupledArrayGradientOlder().

_default_array_value

std::map<std::string, ArrayVariableValue *> Coupleable::_default_array_value

protectedinherited

Will hold the default value for optional array coupled variables.

Definition at line 894 of file Coupleable.h.

Referenced by Coupleable::getDefaultArrayValue().

_default_array_value_zero

ArrayVariableValue Coupleable::_default_array_value_zero

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 955 of file Coupleable.h.

Referenced by Coupleable::coupledArrayDot(), Coupleable::coupledArrayDotDot(), Coupleable::coupledArrayDotDotOld(), and Coupleable::coupledArrayDotOld().

_default_gradient

VariableGradient Coupleable::_default_gradient

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 907 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledGradient(), Coupleable::coupledGradientDot(), Coupleable::coupledGradientDotDot(), Coupleable::coupledGradientOld(), Coupleable::coupledGradientOlder(), Coupleable::coupledGradientPreviousNL(), and Coupleable::getADDefaultGradient().

_default_second

VariableSecond Coupleable::_default_second

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 916 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledSecond(), Coupleable::coupledSecondOld(), Coupleable::coupledSecondOlder(), Coupleable::coupledSecondPreviousNL(), and Coupleable::getADDefaultSecond().

_default_value [1/2]

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

_default_value [2/2]

std::unordered_map<std::string, std::vector<std::unique_ptr<VariableValue> > > Coupleable::_default_value

protectedinherited

Will hold the default value for optional coupled variables.

Definition at line 885 of file Coupleable.h.

Referenced by Coupleable::getDefaultValue().

_default_value_zero

VariableValue Coupleable::_default_value_zero

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 904 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledDot(), Coupleable::coupledDotDot(), Coupleable::coupledDotDotDu(), Coupleable::coupledDotDotOld(), Coupleable::coupledDotDu(), Coupleable::coupledDotOld(), Coupleable::coupledNodalDotDot(), Coupleable::coupledNodalDotDotOld(), Coupleable::coupledNodalDotOld(), Coupleable::coupledVectorDotDotDu(), and Coupleable::coupledVectorDotDu().

_default_vector_curl

VectorVariableCurl Coupleable::_default_vector_curl

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 949 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledCurl(), Coupleable::coupledCurlOld(), and Coupleable::coupledCurlOlder().

_default_vector_gradient

VectorVariableGradient Coupleable::_default_vector_gradient

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant.

Definition at line 946 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), and Coupleable::getADDefaultVectorGradient().

_default_vector_value

std::unordered_map<std::string, std::unique_ptr<VectorVariableValue> > Coupleable::_default_vector_value

protectedinherited

Will hold the default value for optional vector coupled variables.

Definition at line 891 of file Coupleable.h.

Referenced by Coupleable::getDefaultVectorValue().

_default_vector_value_zero

VectorVariableValue Coupleable::_default_vector_value_zero

protectedinherited

This will always be zero because the default values for optionally coupled variables is always constant and this is used for time derivative info.

Definition at line 943 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotOld(), and Coupleable::coupledVectorDotOld().

_depend_vars

std::set<std::string> AuxScalarKernel::_depend_vars

protectedinherited

Depend AuxKernels.

Definition at line 90 of file AuxScalarKernel.h.

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

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

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

_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_coupleable_matrix_tags

std::set<TagID> Coupleable::_fe_coupleable_matrix_tags

privateinherited

Definition at line 1126 of file Coupleable.h.

Referenced by Coupleable::addFEVariableCoupleableMatrixTag(), and Coupleable::getFEVariableCoupleableMatrixTags().

_fe_coupleable_vector_tags

std::set<TagID> Coupleable::_fe_coupleable_vector_tags

privateinherited

Definition at line 1124 of file Coupleable.h.

Referenced by Coupleable::addFEVariableCoupleableVectorTag(), and Coupleable::getFEVariableCoupleableVectorTags().

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

_grad_zero

const VariableGradient& Coupleable::_grad_zero

protectedinherited

Zero gradient of a variable.

Definition at line 926 of file Coupleable.h.

Referenced by Coupleable::adZeroGradientTemplate().

_i

unsigned int AuxScalarKernel::_i

protectedinherited

Definition at line 84 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::compute(), and FunctionScalarAux::computeValue().

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

_mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 43 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

_mesh

MooseMesh& AuxScalarKernel::_mesh

protectedinherited

Definition at line 82 of file AuxScalarKernel.h.

_moose_variable_dependencies

std::set<MooseVariableFEBase *> MooseVariableDependencyInterface::_moose_variable_dependencies

privateinherited

Definition at line 46 of file MooseVariableDependencyInterface.h.

Referenced by MooseVariableDependencyInterface::addMooseVariableDependency(), and MooseVariableDependencyInterface::getMooseVariableDependencies().

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

_node_ids

std::vector<dof_id_type> AuxNodalScalarKernel::_node_ids

protected

List of node IDs.

Definition at line 38 of file AuxNodalScalarKernel.h.

Referenced by compute().

_obj

const MooseObject* Coupleable::_obj

privateinherited

Definition at line 1129 of file Coupleable.h.

Referenced by Coupleable::checkVar(), Coupleable::Coupleable(), Coupleable::coupled(), and Coupleable::getDefaultValue().

_optional_var_index

std::unordered_map<std::string, std::vector<unsigned int> > Coupleable::_optional_var_index

privateinherited

Unique indices for optionally coupled vars that weren't provided.

Definition at line 1119 of file Coupleable.h.

Referenced by Coupleable::Coupleable(), and Coupleable::coupled().

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

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

_real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 226 of file ScalarCoupleable.h.

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

_second_phi_zero

const VariablePhiSecond& Coupleable::_second_phi_zero

protectedinherited

Zero second derivative of a test function.

Definition at line 933 of file Coupleable.h.

_second_zero

const VariableSecond& Coupleable::_second_zero

protectedinherited

Zero second derivative of a variable.

Definition at line 930 of file Coupleable.h.

Referenced by Coupleable::adZeroSecondTemplate().

_subproblem

SubProblem& AuxScalarKernel::_subproblem

protectedinherited

Definition at line 75 of file AuxScalarKernel.h.

Referenced by compute(), and AuxScalarKernel::subProblem().

_supplied_vars

std::set<std::string> AuxScalarKernel::_supplied_vars

protectedinherited

Definition at line 91 of file AuxScalarKernel.h.

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

_sys

SystemBase& AuxScalarKernel::_sys

protectedinherited

Definition at line 76 of file AuxScalarKernel.h.

_t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 58 of file TransientInterface.h.

Referenced by GenericFunctionMaterial::computeQpFunctions(), AnalyticalIndicator::computeQpIntegral(), FunctionElementIntegral::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementL2Error::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), ConvectiveFluxBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), FunctionGradientNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), FunctionNeumannBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), BodyForce::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), SinDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), FunctionDirichletBC::computeQpValue(), FunctionScalarAux::computeValue(), FunctionAux::computeValue(), SolutionScalarAux::computeValue(), VectorFunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), ConditionalFunctionEnableControl::conditionMet(), TimePeriod::conditionMet(), NodalL2Error::execute(), LineFunctionSampler::execute(), RealFunctionControl::execute(), LeastSquaresFitHistory::execute(), UserForcingFunction::f(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), and SolutionUserObject::timestepSetup().

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

_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 AuxScalarKernel::_tid

protectedinherited

Definition at line 78 of file AuxScalarKernel.h.

Referenced by compute().

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

_u

VariableValue& AuxScalarKernel::_u

protectedinherited

Definition at line 86 of file AuxScalarKernel.h.

_u_old

VariableValue& AuxScalarKernel::_u_old

protectedinherited

Definition at line 87 of file AuxScalarKernel.h.

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

_var

MooseVariableScalar& AuxScalarKernel::_var

protectedinherited

Definition at line 81 of file AuxScalarKernel.h.

Referenced by AuxScalarKernel::compute(), FunctionScalarAux::FunctionScalarAux(), and AuxScalarKernel::variable().

_vector_curl_zero

const VectorVariableCurl& Coupleable::_vector_curl_zero

protectedinherited

Zero value of the curl of a vector variable.

Definition at line 937 of file Coupleable.h.

_vector_zero

const VectorVariableValue& Coupleable::_vector_zero

protectedinherited

Zero value of a vector variable.

Definition at line 935 of file Coupleable.h.

_zero

const VariableValue& Coupleable::_zero

protectedinherited

Zero value of a variable.

Definition at line 922 of file Coupleable.h.

Referenced by Coupleable::adZeroValueTemplate().

---

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

• include/auxkernels/AuxNodalScalarKernel.h
• src/auxkernels/AuxNodalScalarKernel.C