MaterialStdVectorRealGradientAux Class Reference

AuxKernel for outputting a std::vector material-property component to an AuxVariable. More...

#include <MaterialStdVectorRealGradientAux.h>

Inheritance diagram for MaterialStdVectorRealGradientAux:

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

Public Member Functions
	MaterialStdVectorRealGradientAux (const InputParameters &parameters)
virtual void	compute ()
	Computes the value and stores it in the solution vector. More...
MooseVariable &	variable ()
	Get a reference to a variable this kernel is action on. More...
bool	isNodal ()
	Nodal or elemental kernel? More...
bool	isNodal () const
const std::set< std::string > &	getDependObjects () const
void	coupledCallback (const std::string &var_name, bool is_old) override
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...
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name)
	Override functions from MaterialPropertyInterface for error checking. More...
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)
template<typename T >
const T &	getUserObject (const std::string &name)
template<typename T >
const T &	getUserObjectByName (const UserObjectName &name)
template<class T >
const T &	getUserObjectByName (const std::string &name)
	Get an user object with a given name. More...
const UserObject &	getUserObjectBase (const std::string &name)
virtual const PostprocessorValue &	getPostprocessorValue (const std::string &name)
virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name)
virtual const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &name, const std::string &vector_name) override
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &name, const std::string &vector_name, bool needs_broadcast) override
	Retrieve the value of a VectorPostprocessor. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &, const std::string &vector_name) override
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &, const std::string &vector_name, bool needs_broadcast) override
	Retrieve the value of the VectorPostprocessor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &name, const std::string &vector_name) override
	Return the scatter value for the post processor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const std::string &name, const std::string &vector_name) override
	Return the scatter value for the post processor. More...
const std::string &	type () const
	Get the type of this object. More...
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 &	getParam (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)
	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)
	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)
	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
MooseVariableFE< Real > *	mooseVariable () const
	Get the variable that this object is using. More...
const std::vector< SubdomainName > &	blocks () const
	Return the block names for this object. More...
unsigned int	numBlocks () const
	Return the number of blocks for this object. More...
virtual const std::set< SubdomainID > &	blockIDs () const
	Return the block subdomain ids for this object. More...
bool	hasBlocks (const SubdomainName &name) const
	Test if the supplied block name is valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainName > &names) const
	Test if the supplied vector of block names are valid for this object. More...
bool	hasBlocks (const SubdomainID &id) const
	Test if the supplied block ids are valid for this object. More...
bool	hasBlocks (const std::vector< SubdomainID > &ids) const
	Test if the supplied vector block ids are valid for this object. More...
bool	hasBlocks (const std::set< SubdomainID > &ids) const
	Test if the supplied set of block ids are valid for this object. More...
bool	isBlockSubset (const std::set< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
bool	isBlockSubset (const std::vector< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...
template<typename T >
bool	hasBlockMaterialProperty (const std::string &prop_name)
	Check if a material property is valid for all blocks of this object. More...
const std::set< SubdomainID > &	meshBlockIDs () const
	Return all of the SubdomainIDs for the mesh. More...
virtual bool	blockRestricted () const
	Returns true if this object has been restricted to a boundary. More...
void	checkVariable (const MooseVariableFEBase &variable) const
	Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. More...
virtual const std::set< BoundaryID > &	boundaryIDs () const
	Return the boundary IDs for this object. More...
const std::vector< BoundaryName > &	boundaryNames () const
	Return the boundary names for this object. More...
unsigned int	numBoundaryIDs () const
	Return the number of boundaries for this object. More...
bool	hasBoundary (const BoundaryName &name) const
	Test if the supplied boundary name is valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryName > &names) const
	Test if the supplied vector of boundary names are valid for this object. More...
bool	hasBoundary (const BoundaryID &id) const
	Test if the supplied boundary ids are valid for this object. More...
bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied vector boundary ids are valid for this object. More...
bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
	Test if the supplied set of boundary ids are valid for this object. More...
bool	isBoundarySubset (const std::set< BoundaryID > &ids) const
	Test if the class boundary ids are a subset of the supplied objects. More...
bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const
template<typename T >
bool	hasBoundaryMaterialProperty (const std::string &prop_name) const
	Check if a material property is valid for all boundaries of this object. More...
virtual bool	boundaryRestricted () const
	Returns true if this object has been restricted to a boundary. More...
const std::set< BoundaryID > &	meshBoundaryIDs () const
	Returns the set of all boundary ids for the entire mesh. More...
virtual void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. More...
virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...
virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...
virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...
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 std::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...
void	addFEVariableCoupleableVectorTag (TagID tag)
void	addFEVariableCoupleableMatrixTag (TagID tag)
std::set< TagID > &	getFEVariableCoupleableVectorTags ()
std::set< TagID > &	getFEVariableCoupleableMatrixTags ()
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)
const std::set< MooseVariableFEBase * > &	getMooseVariableDependencies () const
	Retrieve the set of MooseVariableFEBases that this object depends on. More...
Function &	getFunction (const std::string &name)
	Get a function with a given name. More...
Function &	getFunctionByName (const FunctionName &name)
	Get a function with a given name. More...
const UserObject &	getUserObjectBaseByName (const std::string &name)
	Get an user object with a given name. More...
bool	isImplicit ()
template<typename T >
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file. More...
template<typename T >
const MaterialProperty< T > &	getZeroMaterialProperty (const std::string &prop_name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...
std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
	Retrieve the block ids that the material property is defined. More...
std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
	Retrieve the block names that the material property is defined. More...
std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)
	Retrieve the boundary ids that the material property is defined. More...
std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)
	Retrieve the boundary namess that the material property is defined. More...
void	statefulPropertiesAllowed (bool)
	Derived classes can declare whether or not they work with stateful material properties. More...
bool	getMaterialPropertyCalled () const
	Returns true if getMaterialProperty() has been called, false otherwise. More...
const std::set< unsigned int > &	getMatPropDependencies () const
	Retrieve the set of material properties that this object depends on. More...
template<>
const MaterialProperty< Real > *	defaultMaterialProperty (const std::string &name)
template<>
const ADMaterialPropertyObject< Real > *	defaultADMaterialProperty (const std::string &name)
bool	hasPostprocessor (const std::string &name) const
	Determine if the Postprocessor exists. More...
bool	hasPostprocessorByName (const PostprocessorName &name)
	Determine if the Postprocessor exists. More...
void	setRandomResetFrequency (ExecFlagType exec_flag)
	This interface should be called from a derived class to enable random number generation in this object. More...
unsigned long	getRandomLong () const
	Returns the next random number (long) from the generator tied to this object (elem/node). More...
Real	getRandomReal () const
	Returns the next random number (Real) from the generator tied to this object (elem/node). More...
unsigned int	getSeed (std::size_t id)
	Get the seed for the passed in elem/node id. More...
unsigned int	getMasterSeed () const
ExecFlagType	getResetOnTime () const
void	setRandomDataPointer (RandomData *random_data)
virtual void	meshChanged ()
	Called on this object when the mesh changes. More...
template<typename T >
const ADMaterialPropertyObject< T > &	getADMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name)
	Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file. More...
template<typename T >
const ADMaterialPropertyObject< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)
Material &	getMaterial (const std::string &name)
	Return a Material reference - usable for computing directly. More...
Material &	getMaterialByName (const std::string &name, bool no_warn=false)
template<typename T >
bool	hasMaterialProperty (const std::string &name)
	Check if the material property exists. More...
template<typename T >
bool	hasMaterialPropertyByName (const std::string &name)
const PostprocessorValue &	getPostprocessorValueOld (const std::string &name)
const PostprocessorValue &	getPostprocessorValueOlder (const std::string &name)
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 bool	restricted (const std::set< BoundaryID > &ids)
	Helper for determining if the object is boundary restricted. More...
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	getRealValue () override
	Returns material property values at quadrature points. More...
virtual Real	computeValue () override
virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) override
	Time derivative of a coupled variable. More...
virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) override
	Time derivative of a coupled variable with respect to the coefficients. More...
virtual void	precalculateValue ()
	This callback is used for AuxKernels that need to perform a per-element calculation. More...
virtual const OutputTools< Real >::VariableValue &	value ()
	The value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on. More...
virtual const VariableValue &	dotDu ()
	The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
virtual const VariableValue &	dotDotDu ()
	The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
virtual const OutputTools< Real >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on. More...
virtual const OutputTools< Real >::VariableTestSecond &	secondTest ()
	The second derivative of the test function. More...
virtual const OutputTools< Real >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face. More...
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function. More...
virtual const OutputTools< Real >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face. More...
virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
	A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...
void	initializeBlockRestrictable (const MooseObject *moose_object)
	An initialization routine needed for dual constructors. More...
Moose::CoordinateSystemType	getBlockCoordSystem ()
	Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...
bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
	A helper method to avoid circular #include problems. 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 VariableValueType< compute_stage >::type &	adCoupledValueTemplate (const std::string &var_name, unsigned int comp=0)
	Returns value of a coupled 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 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 VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled variable. More...
template<ComputeStage compute_stage>
const VariableGradientType< compute_stage >::type &	adCoupledGradientTemplate (const std::string &var_name, unsigned int comp=0)
	Returns gradient of a coupled 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 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 &	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...
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 &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a coupled variable with respect to the coefficients. More...
virtual const VariableValue &	coupledNodalValue (const std::string &var_name, unsigned int comp=0)
	Returns nodal values of a coupled variable. More...
virtual const VariableValue &	coupledNodalValueOld (const std::string &var_name, unsigned int comp=0)
	Returns an old nodal value from previous time step of a coupled variable. More...
virtual const VariableValue &	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...
virtual const VariableValue &	coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0)
	Returns nodal values of a coupled variable for previous Newton iterate. More...
virtual const VariableValue &	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 DenseVector< Number > &	coupledSolutionDoFs (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 DenseVector< Number > &	coupledSolutionDoFsOld (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 DenseVector< Number > &	coupledSolutionDoFsOlder (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 VariableValueType< compute_stage >::type &	adZeroTemplate ()
	Template method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects. More...
template<>
const VariableValueType< JACOBIAN >::type &	adZeroTemplate ()
template<>
const VariableValueType< JACOBIAN >::type &	adZeroTemplate ()
template<ComputeStage compute_stage>
const VariableGradientType< compute_stage >::type &	adGradZeroTemplate ()
	Template method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing objects. More...
template<>
const VariableGradientType< JACOBIAN >::type &	adGradZeroTemplate ()
template<>
const VariableGradientType< JACOBIAN >::type &	adGradZeroTemplate ()
void	checkVar (const std::string &var_name)
	Check that the right kind of variable is being coupled in. More...
void	checkVar (const std::string &var_name)
	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...
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...
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	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...
VariableValue *	getDefaultValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the default value for an uncoupled variable. 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...
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...
MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp)
	Extract pointer to a scalar coupled variable. 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)
void	checkMaterialProperty (const std::string &name)
	A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method. More...
void	markMatPropRequested (const std::string &)
	A proxy method for _mi_feproblem.markMatPropRequested(name) More...
std::string	deducePropertyName (const std::string &name)
	Small helper to look up a material property name through the input parameter keys. More...
template<typename T >
const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...
template<typename T >
const ADMaterialPropertyObject< T > *	defaultADMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...
PenetrationLocator &	getPenetrationLocator (const BoundaryName &master, const BoundaryName &slave, Order order)
	Retrieve the PentrationLocator associated with the two sides. More...
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &master, const BoundaryName &slave, Order order)
	Retrieve the Quadrature PentrationLocator associated with the two sides. More...
PenetrationLocator &	getMortarPenetrationLocator (const BoundaryName &master, const BoundaryName &slave, Moose::ConstraintType side_type, Order order)
	Retrieve the mortar PentrationLocator associated with the two sides. More...
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &master, const BoundaryName &slave)
	Retrieve the PentrationLocator associated with the two sides. More...
NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &master, const BoundaryName &slave)
	Retrieve a Quadrature NearestNodeLocator associated with the two sides. More...
NearestNodeLocator &	getMortarNearestNodeLocator (const BoundaryName &master, const BoundaryName &slave, Moose::ConstraintType side_type)
	Retrieve a mortar NearestNodeLocator associated with the two sides. More...
template<typename T >
T &	declareRestartableData (std::string data_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, void *context)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, const T &init_value, void *context)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRecoverableData (std::string data_name)
	Declare a piece of data as "recoverable". More...
template<typename T >
T &	declareRecoverableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithObjectName (std::string data_name, std::string object_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithObjectNameWithContext (std::string data_name, std::string object_name, void *context)
	Declare a piece of data as "restartable". More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name)
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name, bool needs_broadcast)
	Retrieve the old value of a VectorPostprocessor. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name)
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast)
	Retrieve the old value of a VectorPostprocessor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name)
	Return the old scatter value for the post processor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const std::string &name, const std::string &vector_name)
	Return the old scatter value for the post processor. More...
bool	hasVectorPostprocessor (const std::string &name) const
	Determine if the VectorPostprocessor exists. More...
bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
	Determine if the VectorPostprocessor exists. More...

Protected Attributes
unsigned int	_component
	component of the real gradient to be extracted More...
unsigned int	_index
	index of the vecor element More...
const MaterialProperty< std::vector< RealGradient > > &	_prop
	Reference to the material property for this AuxKernel. More...
SubProblem &	_subproblem
	Subproblem this kernel is part of. More...
SystemBase &	_sys
	System this kernel is part of. More...
SystemBase &	_nl_sys
AuxiliarySystem &	_aux_sys
THREAD_ID	_tid
	Thread ID. More...
Assembly &	_assembly
	Assembly class. More...
MooseVariable &	_var
	Variable this kernel is acting on. More...
bool	_nodal
	true if the kernel is nodal, false if it is elemental More...
bool	_bnd
	true if the kernel is boundary kernel, false if it is interior kernels More...
MooseMesh &	_mesh
	Mesh this kernel is active on. More...
const MooseArray< Point > &	_q_point
	Dimension of the problem being solved. More...
QBase *&	_qrule
	Quadrature rule being used. More...
const MooseArray< Real > &	_JxW
	Transformed Jacobian weights. More...
const MooseArray< Real > &	_coord
const VariableValue &	_u
	Holds the solution at current quadrature points. More...
const VariableValue &	_u_old
	Holds the previous solution at the current quadrature point. More...
const VariableValue &	_u_older
	Holds the t-2 solution at the current quadrature point. More...
const VariableTestValue &	_test
	holds the the test functions More...
const Elem *&	_current_elem
	Current element (valid only for elemental kernels) More...
unsigned int &	_current_side
	current side of the current element More...
const Real &	_current_elem_volume
	Volume of the current element. More...
const Real &	_current_side_volume
	Volume of the current side. More...
const Node *&	_current_node
	Current node (valid only for nodal kernels) More...
NumericVector< Number > &	_solution
	reference to the solution vector of auxiliary system More...
unsigned int	_qp
	Quadrature point index. More...
std::set< std::string >	_depend_vars
	Depend AuxKernels. More...
std::set< std::string >	_supplied_vars
std::set< std::string >	_depend_uo
	Depend UserObjects. More...
unsigned int	_n_local_dofs
	number of local dofs for elemental variables More...
DenseVector< Number >	_local_re
	for holding local load More...
DenseVector< Number >	_local_sol
	for holding local solution More...
DenseMatrix< Number >	_local_ke
	for holding local mass matrix More...
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...
MooseVariableFE< Real > *	_variable
	The variable this object is acting on. More...
Assembly *	_mvi_assembly
std::shared_ptr< MaterialData >	_blk_material_data
	Pointer to the MaterialData class for this object. 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 &	_c_parameters
const std::string &	_c_name
	The name of the object this interface is part of. More...
FEProblemBase &	_c_fe_problem
std::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...
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::map< std::string, std::vector< VariableValue * > >	_default_value
	Will hold the default value for optional coupled variables. More...
std::map< std::string, VariableValue * >	_default_value
	Will hold the default value for optional coupled scalar variables. More...
std::map< std::string, MooseArray< ADReal > * >	_ad_default_value
	Will hold the default value for optional coupled variables for automatic differentiation. More...
std::map< std::string, VectorVariableValue * >	_default_vector_value
	Will hold the default value for optional vector coupled variables. 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< ADRealGradient >	_ad_default_gradient
	This will always be zero because the default values for optionally coupled 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< ADRealTensor >	_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< ADReal > &	_ad_zero
const VariableGradient &	_grad_zero
	Zero gradient of a variable. More...
const MooseArray< ADRealGradient > &	_ad_grad_zero
const VariableSecond &	_second_zero
	Zero second derivative of a variable. More...
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...
bool	_coupleable_neighbor
	Whether or not this object is a "neighbor" object: ie all of it's coupled values should be neighbor values. 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::map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
	Coupled vars whose values we provide. More...
std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars
	Vector of coupled variables. More...
bool	_sc_is_implicit
	True if implicit value is required. More...
const InputParameters &	_coupleable_params
	Local InputParameters. More...
THREAD_ID	_sc_tid
	Thread ID of the thread using this object. More...
const Real &	_real_zero
	Scalar zero. More...
const VariableValue &	_scalar_zero
	Zero value of a scalar variable. More...
const Point &	_point_zero
	Zero point. More...
const InputParameters &	_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
const InputParameters &	_mi_params
	Parameters of the object with this interface. More...
const std::string	_mi_name
	The name of the object that this interface belongs to. More...
Moose::MaterialDataType	_material_data_type
	The type of data. More...
std::shared_ptr< MaterialData >	_material_data
	Pointer to the material data class that stores properties. More...
FEProblemBase &	_mi_feproblem
	Reference to the FEProblemBase class. More...
const THREAD_ID	_mi_tid
	Current threaded it. More...
bool	_stateful_allowed
	True by default. More...
bool	_get_material_property_called
	Initialized to false. More...
std::vector< std::unique_ptr< MaterialProperty< Real > > >	_default_real_properties
	Storage vector for MaterialProperty<Real> default objects. More...
std::vector< std::unique_ptr< ADMaterialPropertyObject< Real > > >	_default_ad_real_properties
	Storage vector for ADMaterialPropertyObject<Real> default objects. More...
std::set< unsigned int >	_material_property_dependencies
	The set of material properties (as given by their IDs) that this object depends on. More...
GeometricSearchData &	_geometric_search_data
FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance. More...

Detailed Description

AuxKernel for outputting a std::vector material-property component to an AuxVariable.

Definition at line 25 of file MaterialStdVectorRealGradientAux.h.

Member Enumeration Documentation

TEST_TYPE

enum BoundaryRestrictable::TEST_TYPE

inherited

A flag changing the behavior of hasBoundary.

Enumerator
ALL
ANY

Definition at line 35 of file BoundaryRestrictable.h.

  {
    ALL,
    ANY
  };

Constructor & Destructor Documentation

MaterialStdVectorRealGradientAux()

MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux

(

const InputParameters &

parameters

)

Definition at line 27 of file MaterialStdVectorRealGradientAux.C.

  : MaterialStdVectorAuxBase<RealGradient>(parameters),
    _component(getParam<unsigned int>("component"))
{
  if (_component > LIBMESH_DIM)
    mooseError(
        "The component ", _component, " does not exist for ", LIBMESH_DIM, " dimensional problems");
}

Member Function Documentation

adCoupledGradientTemplate()

template<ComputeStage compute_stage>

const VariableGradientType< compute_stage >::type & 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 831 of file Coupleable.h.

{
  if (!isCoupled(var_name)) // Return default 0
    return getADDefaultGradient<compute_stage>();

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError("Nodal variables do not have gradients");

  MooseVariable * var = getVar(var_name, comp);

  if (!_coupleable_neighbor)
  {
    if (_c_is_implicit)
      return var->adGradSln<compute_stage>();
    else
      mooseError("Not implemented");
  }
  else
  {
    if (_c_is_implicit)
      return var->adGradSlnNeighbor<compute_stage>();
    else
      mooseError("Not implemented");
  }
}

adCoupledValueTemplate()

template<ComputeStage compute_stage>

const VariableValueType< compute_stage >::type & 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 795 of file Coupleable.h.

{
  if (!isCoupled(var_name))
    return *getADDefaultValue<compute_stage>(var_name);

  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Not implemented");
    else
    {
      if (_c_is_implicit)
        return var->adSln<compute_stage>();
      else
        mooseError("Not implemented");
    }
  }
  else
  {
    if (_c_nodal)
      mooseError("Not implemented");
    else
    {
      if (_c_is_implicit)
        return var->adSlnNeighbor<compute_stage>();
      else
        mooseError("Not implemented");
    }
  }
}

addFEVariableCoupleableMatrixTag()

void Coupleable::addFEVariableCoupleableMatrixTag ( TagID  tag )

inlineinherited

Definition at line 91 of file Coupleable.h.

Referenced by Coupleable::coupledMatrixTagValue().

{ _fe_coupleable_matrix_tags.insert(tag); }

addFEVariableCoupleableVectorTag()

void Coupleable::addFEVariableCoupleableVectorTag ( TagID  tag )

inlineinherited

Definition at line 89 of file Coupleable.h.

Referenced by Coupleable::coupledVectorTagValue().

{ _fe_coupleable_vector_tags.insert(tag); }

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 37 of file MooseVariableDependencyInterface.h.

Referenced by ADKernel< compute_stage >::ADKernel(), AuxKernel::AuxKernel(), AuxNodalScalarKernel::AuxNodalScalarKernel(), CoupleableMooseVariableDependencyIntermediateInterface::CoupleableMooseVariableDependencyIntermediateInterface(), DGKernel::DGKernel(), DiracKernel::DiracKernel(), ElemElemConstraint::ElemElemConstraint(), ElementIndicator::ElementIndicator(), ElementIntegralVariablePostprocessor::ElementIntegralVariablePostprocessor(), ElementIntegralVariableUserObject::ElementIntegralVariableUserObject(), ElementUserObject::ElementUserObject(), ElementVariablePostprocessor::ElementVariablePostprocessor(), IntegratedBC::IntegratedBC(), InterfaceKernel::InterfaceKernel(), 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().

  {
    _moose_variable_dependencies.insert(var);
  }

addMooseVariableDependency() [2/2]

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

inlineprotectedinherited

Definition at line 41 of file MooseVariableDependencyInterface.h.

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

addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID  tag )

inlineinherited

Definition at line 59 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue().

{ _sc_coupleable_matrix_tags.insert(tag); }

addScalarVariableCoupleableVectorTag()

void ScalarCoupleable::addScalarVariableCoupleableVectorTag ( TagID  tag )

inlineinherited

Definition at line 57 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

{ _sc_coupleable_vector_tags.insert(tag); }

adGradZeroTemplate() [1/3]

template<ComputeStage compute_stage>

const VariableGradientType< compute_stage >::type & Coupleable::adGradZeroTemplate ( )

protectedinherited

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

Definition at line 899 of file Coupleable.h.

{
  return _grad_zero;
}

adGradZeroTemplate() [2/3]

template<>

const VariableGradientType<JACOBIAN>::type& Coupleable::adGradZeroTemplate ( )

protectedinherited

adGradZeroTemplate() [3/3]

template<>

const VariableGradientType<JACOBIAN>::type& Coupleable::adGradZeroTemplate ( )

protectedinherited

Definition at line 1503 of file Coupleable.C.

{
  return _ad_grad_zero;
}

adZeroTemplate() [1/3]

template<ComputeStage compute_stage>

const VariableValueType< compute_stage >::type & Coupleable::adZeroTemplate ( )

protectedinherited

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

Definition at line 889 of file Coupleable.h.

{
  return _zero;
}

adZeroTemplate() [2/3]

template<>

const VariableValueType<JACOBIAN>::type& Coupleable::adZeroTemplate ( )

protectedinherited

adZeroTemplate() [3/3]

template<>

const VariableValueType<JACOBIAN>::type& Coupleable::adZeroTemplate ( )

protectedinherited

Definition at line 1496 of file Coupleable.C.

{
  return _ad_zero;
}

blockIDs()

const std::set< SubdomainID > & BlockRestrictable::blockIDs ( ) const

virtualinherited

Return the block subdomain ids for this object.

Returns

a set of SudomainIDs that are valid for this object

Definition at line 167 of file BlockRestrictable.C.

Referenced by BlockRestrictable::getBlockCoordSystem(), Material::getZeroMaterialProperty(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and Material::registerPropName().

{
  return _blk_ids;
}

blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also

MooseObject

Definition at line 155 of file BlockRestrictable.C.

Referenced by MooseObjectWarehouseBase< Indicator >::addObject(), BlockRestrictable::checkVariable(), BlockRestrictable::getBlockCoordSystem(), and BlockRestrictable::hasBlockMaterialPropertyHelper().

{
  return _blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end();
}

blocks()

const std::vector< SubdomainName > & BlockRestrictable::blocks ( ) const

inherited

Return the block names for this object.

Note, if the 'blocks' input parameter was not utilized this will return an empty vector.

Returns

vector of SubdomainNames that are valid for this object

Definition at line 161 of file BlockRestrictable.C.

Referenced by MaterialOutputAction::getParams().

{
  return _blocks;
}

boundaryIDs()

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

virtualinherited

Return the boundary IDs for this object.

Returns

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

Definition at line 148 of file BoundaryRestrictable.C.

Referenced by NonlinearSystemBase::addBoundaryCondition(), NonlinearSystemBase::addInterfaceKernel(), AutoPositionsMultiApp::fillPositions(), Material::getZeroMaterialProperty(), BoundaryRestrictable::hasBoundaryMaterialPropertyHelper(), and Material::registerPropName().

{
  return _bnd_ids;
}

boundaryNames()

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

inherited

Return the boundary names for this object.

Returns

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

Definition at line 154 of file BoundaryRestrictable.C.

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

{
  return _boundary_names;
}

boundaryRestricted()

bool BoundaryRestrictable::boundaryRestricted ( ) const

virtualinherited

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

See also

MooseObject

Definition at line 166 of file BoundaryRestrictable.C.

Referenced by MaterialOutputAction::getParams(), and DerivativeMaterialInterface< Material >::haveMaterialProperty().

{
  return BoundaryRestrictable::restricted(_bnd_ids);
}

checkMaterialProperty()

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

protectedinherited

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

Definition at line 144 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByName(), and MaterialPropertyInterface::getMaterialPropertyByName().

{
  // If the material property is boundary restrictable, add to the list of materials to check
  if (_mi_boundary_restricted)
    for (const auto & bnd_id : _mi_boundary_ids)
      _mi_feproblem.storeBoundaryDelayedCheckMatProp(_mi_name, bnd_id, name);

  // The default is to assume block restrictions
  else
    for (const auto & blk_ids : _mi_block_ids)
      _mi_feproblem.storeSubdomainDelayedCheckMatProp(_mi_name, blk_ids, name);
}

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 257 of file ScalarCoupleable.C.

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

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

checkVar() [2/2]

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

Referenced by Coupleable::coupled(), 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::coupledSolutionDoFs(), Coupleable::coupledSolutionDoFsOld(), Coupleable::coupledSolutionDoFsOlder(), Coupleable::coupledValue(), Coupleable::coupledValueOld(), Coupleable::coupledValueOlder(), Coupleable::coupledValuePreviousNL(), Coupleable::coupledVectorDot(), Coupleable::coupledVectorDotDot(), Coupleable::coupledVectorDotDotOld(), Coupleable::coupledVectorDotOld(), Coupleable::coupledVectorGradient(), Coupleable::coupledVectorGradientOld(), Coupleable::coupledVectorGradientOlder(), and Coupleable::coupledVectorTagValue().

{
  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();
    mooseError(_c_name,
               ": Trying to couple a scalar variable where field variable is expected, '",
               var_name,
               " =",
               cvars,
               "'");
  }
  // NOTE: non-existent variables are handled in the constructor
}

checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableFEBase &  variable ) const

inherited

Helper for checking that the ids for this object are in agreement with the variables on the supplied variable.

Parameters

variable

The variable to check against.

Definition at line 307 of file BlockRestrictable.C.

{
  if (!isBlockSubset(variable.activeSubdomains()))
  {
    std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
    std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
    mooseError("The 'block' parameter of the object '",
               _blk_name,
               "' must be a subset of the 'block' parameter of the variable '",
               variable.name(),
               "':\n    Object '",
               _blk_name,
               "': ",
               obj_ids,
               "\n    Variable '",
               variable.name(),
               "': ",
               var_ids);
  }
}

compute()

void AuxKernel::compute ( )

virtualinherited

Computes the value and stores it in the solution vector.

Reimplemented in NodalPatchRecovery, ElementH1ErrorFunctionAux, and ElementLpNormAux.

Definition at line 229 of file AuxKernel.C.

Referenced by NodalPatchRecovery::compute().

{
  precalculateValue();

  if (isNodal()) /* nodal variables */
  {
    if (_var.isNodalDefined())
    {
      _qp = 0;
      Real value = computeValue();
      // update variable data, which is referenced by other kernels, so the value is up-to-date
      _var.setNodalValue(value);
    }
  }
  else /* elemental variables */
  {
    _n_local_dofs = _var.numberOfDofs();

    if (_n_local_dofs == 1) /* p0 */
    {
      Real value = 0;
      for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        value += _JxW[_qp] * _coord[_qp] * computeValue();
      value /= (_bnd ? _current_side_volume : _current_elem_volume);
      // update the variable data refernced by other kernels.
      // Note that this will update the values at the quadrature points too
      // (because this is an Elemental variable)
      _var.setNodalValue(value);
    }
    else /* high-order */
    {
      _local_re.resize(_n_local_dofs);
      _local_re.zero();
      _local_ke.resize(_n_local_dofs, _n_local_dofs);
      _local_ke.zero();

      // assemble the local mass matrix and the load
      for (unsigned int i = 0; i < _test.size(); i++)
        for (_qp = 0; _qp < _qrule->n_points(); _qp++)
        {
          Real t = _JxW[_qp] * _coord[_qp] * _test[i][_qp];
          _local_re(i) += t * computeValue();
          for (unsigned int j = 0; j < _test.size(); j++)
            _local_ke(i, j) += t * _test[j][_qp];
        }

      // mass matrix is always SPD
      _local_sol.resize(_n_local_dofs);
      _local_ke.cholesky_solve(_local_re, _local_sol);

      _var.setNodalValue(_local_sol);
    }
  }
}

computeValue()

Real MaterialStdVectorAuxBase< RealGradient >::computeValue ( )

overrideprotectedvirtualinherited

Reimplemented from MaterialAuxBase< std::vector< RealGradient > >.

Definition at line 52 of file MaterialStdVectorAuxBase.h.

{
  mooseAssert(_prop[_qp].size() > _index,
              "MaterialStdVectorRealGradientAux: You chose to extract component "
                  << _index
                  << " but your Material property only has size "
                  << _prop[_qp].size());
  return MaterialAuxBase<std::vector<T>>::computeValue();
}

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

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

{
  checkVar(var_name);

  if (!isCoupled(var_name))
  {
    // make sure we don't try to access default var ids that were not provided
    if (comp + 1 > _optional_var_index[var_name].size())
      mooseError(_c_name,
                 ": Requested component ",
                 comp,
                 " of coupled value ",
                 var_name,
                 " is out of range.");
    return _optional_var_index[var_name][comp];
  }

  MooseVariableFEBase * var = getFEVar(var_name, comp);
  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?");
  }
}

coupledCallback()

void AuxKernel::coupledCallback ( const std::string &  var_name, bool  is_old  )

overridevirtualinherited

Reimplemented from Coupleable.

Definition at line 218 of file AuxKernel.C.

{
  if (is_old)
  {
    std::vector<VariableName> var_names = getParam<std::vector<VariableName>>(var_name);
    for (const auto & name : var_names)
      _depend_vars.erase(name);
  }
}

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

Referenced by NodalEqualValueConstraint::NodalEqualValueConstraint(), SphericalAverage::SphericalAverage(), and VolumeHistogram::VolumeHistogram().

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

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

{
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_curl;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError("Nodal variables do not have curls");

  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding scalar field variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->curlSln() : var->curlSlnOld();
  else
    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 1097 of file Coupleable.C.

{
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_curl;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError("Nodal variables do not have curls");

  validateExecutionerType(var_name, "coupledCurlOld");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding scalar field variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->curlSlnOld() : var->curlSlnOlder();
  else
    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 1118 of file Coupleable.C.

{
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_curl;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError("Nodal variables do not have curls");

  validateExecutionerType(var_name, "coupledCurlOlder");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding scalar field variable method");

  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->curlSlnOlder();
    else
      return var->curlSlnOlderNeighbor();
  }
  else
    mooseError("Older values not available for explicit schemes");
}

coupledDot()

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

overrideprotectedvirtualinherited

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 from Coupleable.

Definition at line 285 of file AuxKernel.C.

{
  MooseVariableFEBase * var = getVar(var_name, comp);
  if (var->kind() == Moose::VAR_AUXILIARY)
    mooseError(
        name(),
        ": Unable to couple time derivative of an auxiliary variable into the auxiliary system.");

  return Coupleable::coupledDot(var_name, comp);
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledDotDot");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDot();
    else
      return var->uDotDot();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotNeighbor();
    else
      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 845 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledDotDotDu");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDuDotDotDu();
    else
      return var->duDotDotDu();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDuDotDotDuNeighbor();
    else
      return var->duDotDotDu();
  }
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledDotDotOld");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotDotOld();
    else
      return var->uDotDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotDotOldNeighbor();
    else
      return var->uDotDotOldNeighbor();
  }
}

coupledDotDu()

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

overrideprotectedvirtualinherited

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 from Coupleable.

Definition at line 297 of file AuxKernel.C.

{
  MooseVariableFEBase * var = getVar(var_name, comp);
  if (var->kind() == Moose::VAR_AUXILIARY)
    mooseError(
        name(),
        ": Unable to couple time derivative of an auxiliary variable into the auxiliary system.");

  return Coupleable::coupledDotDu(var_name, comp);
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledDotOld");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesDotOld();
    else
      return var->uDotOld();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesDotOldNeighbor();
    else
      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 873 of file Coupleable.C.

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have gradients");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
  else
    return (_c_is_implicit) ? var->gradSlnNeighbor() : var->gradSlnOldNeighbor();
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have gradients");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->gradSlnDot();
  else
    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 986 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have gradients");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->gradSlnDotDot();
  else
    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 894 of file Coupleable.C.

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal compute objects do not support gradients");

  validateExecutionerType(var_name, "coupledGradientOld");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
  else
    return (_c_is_implicit) ? var->gradSlnOldNeighbor() : var->gradSlnOlderNeighbor();
}

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

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal compute objects do not support gradients");

  validateExecutionerType(var_name, "coupledGradientOlder");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->gradSlnOlder();
    else
      return var->gradSlnOlderNeighbor();
  }
  else
    mooseError(_c_name, ": Older values not available for explicit schemes");
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_gradient;

  _c_fe_problem.needsPreviousNewtonIteration(true);
  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal compute objects do not support gradients");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->gradSlnPreviousNL();
  else
    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 162 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 353 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    mooseError(var_name, ": invalid variable name for coupledMatrixTagValue");

  addFEVariableCoupleableMatrixTag(tag);

  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledVectorValue for coupled vector variables");

  if (_c_nodal)
    return var->nodalMatrixTagValue(tag);
  else
    return var->matrixTagValue(tag);
}

coupledNodalDot()

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

protectedvirtualinherited

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledNodalDot");
  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->dofValuesDot();
  else
    return var->dofValuesDotNeighbor();
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledNodalDotDot");
  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->dofValuesDotDot();
  else
    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 1384 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledNodalDotDotOld");
  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->dofValuesDotDotOld();
  else
    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 1365 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_value_zero;

  validateExecutionerType(var_name, "coupledNodalDotOld");
  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->dofValuesDotOld();
  else
    return var->dofValuesDotOldNeighbor();
}

coupledNodalValue()

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

protectedvirtualinherited

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  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->dofValues() : var->dofValuesOld();
  else
    return (_c_is_implicit) ? var->dofValuesNeighbor() : var->dofValuesOldNeighbor();
}

coupledNodalValueOld()

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

protectedvirtualinherited

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  validateExecutionerType(var_name, "coupledNodalValueOld");
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  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->dofValuesOld() : var->dofValuesOlder();
  else
    return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
}

coupledNodalValueOlder()

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

protectedvirtualinherited

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  validateExecutionerType(var_name, "coupledNodalValueOlder");
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  if (!var->isNodal())
    mooseError(_c_name,
               ": Trying to get older nodal values of variable '",
               var->name(),
               "', but it is not nodal.");
  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->dofValuesOlder();
    else
      return var->dofValuesOlderNeighbor();
  }
  else
    mooseError(_c_name, ": Older values not available for explicit schemes");
}

coupledNodalValuePreviousNL()

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

protectedvirtualinherited

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  _c_fe_problem.needsPreviousNewtonIteration(true);
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return var->dofValuesPreviousNL();
  else
    return var->dofValuesPreviousNLNeighbor();
}

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 105 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

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

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 304 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 204 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 213 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 248 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 231 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 239 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 222 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 112 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 136 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

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

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 177 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 189 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 1144 of file Coupleable.C.

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_second;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have second derivatives");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->secondSln() : var->secondSlnOlder();
  else
    return (_c_is_implicit) ? var->secondSlnNeighbor() : var->secondSlnOlderNeighbor();
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_second;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have second derivatives");

  validateExecutionerType(var_name, "coupledSecondOld");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->secondSlnOld() : var->secondSlnOlder();
  else
    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 1186 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_second;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have second derivatives");

  validateExecutionerType(var_name, "coupledSecondOlder");
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->secondSlnOlder();
    else
      return var->secondSlnOlderNeighbor();
  }
  else
    mooseError(_c_name, ": Older values not available for explicit schemes");
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_second;

  _c_fe_problem.needsPreviousNewtonIteration(true);
  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Nodal variables do not have second derivatives");

  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");
  if (!_coupleable_neighbor)
    return var->secondSlnPreviousNL();
  else
    return var->secondSlnPreviousNLNeighbor();
}

coupledSolutionDoFs()

const DenseVector< Number > & Coupleable::coupledSolutionDoFs ( 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 DenseVector for the DoFs of the coupled variable

Definition at line 1402 of file Coupleable.C.

{
  checkVar(var_name);
  // default coupling is not available for elemental solutions
  if (!isCoupled(var_name))
    mooseError(_c_name, ": invalid variable name for coupledSolutionDoFs");

  if (_c_nodal)
    mooseError(_c_name, ": nodal objects should not call coupledSolutionDoFs");

  coupledCallback(var_name, false);
  MooseVariableFEBase * var = getFEVar(var_name, comp);

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->solutionDoFs() : var->solutionDoFsOld();
  else
    return (_c_is_implicit) ? var->solutionDoFsNeighbor() : var->solutionDoFsOldNeighbor();
}

coupledSolutionDoFsOld()

const DenseVector< Number > & Coupleable::coupledSolutionDoFsOld ( 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 DenseVector for the old DoFs of the coupled variable

Definition at line 1422 of file Coupleable.C.

{
  checkVar(var_name);
  // default coupling is not available for elemental solutions
  if (!isCoupled(var_name))
    mooseError(_c_name, ": invalid variable name for coupledSolutionDoFsOld");

  if (_c_nodal)
    mooseError(_c_name, ": nodal objects should not call coupledSolutionDoFsOld");

  validateExecutionerType(var_name, "coupledSolutionDoFsOld");
  coupledCallback(var_name, true);
  MooseVariableFEBase * var = getFEVar(var_name, comp);

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->solutionDoFsOld() : var->solutionDoFsOlder();
  else
    return (_c_is_implicit) ? var->solutionDoFsOldNeighbor() : var->solutionDoFsOlderNeighbor();
}

coupledSolutionDoFsOlder()

const DenseVector< Number > & Coupleable::coupledSolutionDoFsOlder ( 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 DenseVector for the older DoFs of the coupled variable

Definition at line 1443 of file Coupleable.C.

{
  checkVar(var_name);
  // default coupling is not available for elemental solutions
  if (!isCoupled(var_name))
    mooseError(_c_name, ": invalid variable name for coupledSolutionDoFsOlder");

  if (_c_nodal)
    mooseError(_c_name, ": nodal objects should not call coupledSolutionDoFsOlder");

  validateExecutionerType(var_name, "coupledSolutionDoFsOlder");
  coupledCallback(var_name, true);
  MooseVariableFEBase * var = getFEVar(var_name, comp);
  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->solutionDoFsOlder();
    else
      return var->solutionDoFsOlderNeighbor();
  }
  else
    mooseError(_c_name, ": Older values not available for explicit schemes");
}

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

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledVectorValue for coupled vector variables");

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

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

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  validateExecutionerType(var_name, "coupledValueOld");
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledVectorValueOld for coupled vector variables");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOld() : var->dofValuesOlder();
    else
      return (_c_is_implicit) ? var->slnOld() : var->slnOlder();
  }
  else
  {
    if (_c_nodal)
      return (_c_is_implicit) ? var->dofValuesOldNeighbor() : var->dofValuesOlderNeighbor();
    else
      return (_c_is_implicit) ? var->slnOldNeighbor() : var->slnOlderNeighbor();
  }
}

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

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  validateExecutionerType(var_name, "coupledValueOlder");
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledVectorValueOlder for coupled vector variables");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
    {
      if (_c_is_implicit)
        return var->dofValuesOlder();
      else
        mooseError(_c_name, ": Older values not available for explicit schemes");
    }
    else
    {
      if (_c_is_implicit)
        return var->slnOlder();
      else
        mooseError(_c_name, ": Older values not available for explicit schemes");
    }
  }
  else
  {
    if (_c_nodal)
    {
      if (_c_is_implicit)
        return var->dofValuesOlderNeighbor();
      else
        mooseError(_c_name, ": Older values not available for explicit schemes");
    }
    else
    {
      if (_c_is_implicit)
        return var->slnOlderNeighbor();
      else
        mooseError(_c_name, ": Older values not available for explicit schemes");
    }
  }
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    return *getDefaultValue(var_name, comp);

  _c_fe_problem.needsPreviousNewtonIteration(true);
  coupledCallback(var_name, true);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding vector variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      return var->dofValuesPreviousNL();
    else
      return var->slnPreviousNL();
  }
  else
  {
    if (_c_nodal)
      return var->dofValuesPreviousNLNeighbor();
    else
      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 697 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_value_zero;

  validateExecutionerType(var_name, "coupledVectorDot");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDot();
  }
  else
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      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 727 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_value_zero;

  validateExecutionerType(var_name, "coupledVectorDotDot");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDotDot();
  }
  else
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDotDotNeighbor();
  }
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_value_zero;

  validateExecutionerType(var_name, "coupledVectorDotDotOld");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDotDotOld();
  }
  else
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDotDotOldNeighbor();
  }
}

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

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_value_zero;

  validateExecutionerType(var_name, "coupledVectorDotOld");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return var->uDotOld();
  }
  else
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      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 1007 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_gradient;

  coupledCallback(var_name, false);
  if (_c_nodal)
    mooseError(_c_name, ": Gradients are non-sensical with nodal compute objects");

  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSln() : var->gradSlnOld();
  else
    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 1028 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_gradient;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Gradients are non-sensical with nodal compute objects");

  validateExecutionerType(var_name, "coupledGradientOld");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (!_coupleable_neighbor)
    return (_c_is_implicit) ? var->gradSlnOld() : var->gradSlnOlder();
  else
    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 1050 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name)) // Return default 0
    return _default_vector_gradient;

  coupledCallback(var_name, true);
  if (_c_nodal)
    mooseError(_c_name, ": Gradients are non-sensical with nodal compute objects");

  validateExecutionerType(var_name, "coupledGradientOlder");
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call corresponding standard variable method");

  if (_c_is_implicit)
  {
    if (!_coupleable_neighbor)
      return var->gradSlnOlder();
    else
      return var->gradSlnOlderNeighbor();
  }
  else
    mooseError(_c_name, ": Older values not available for explicit schemes");
}

coupledVectorTagScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns

Reference to a VariableValue for the coupled variable

Definition at line 147 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 333 of file Coupleable.C.

{
  checkVar(var_name);
  if (!isCoupled(var_name))
    mooseError(var_name, ": invalid variable name for coupledVectorTagValue");

  addFEVariableCoupleableVectorTag(tag);

  coupledCallback(var_name, false);
  MooseVariable * var = getVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledVectorValue for coupled vector variables");

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

{
  if (!isCoupled(var_name))
    return *getVectorDefaultValue(var_name);

  coupledCallback(var_name, false);
  VectorMooseVariable * var = getVectorVar(var_name, comp);
  if (var == NULL)
    mooseError("Call coupledValue for coupled regular variables");

  if (!_coupleable_neighbor)
  {
    if (_c_nodal)
      mooseError("Vector variables are not required to be continuous and so should not be used "
                 "with nodal compute objects");
    else
      return (_c_is_implicit) ? var->sln() : var->slnOld();
  }
  else
  {
    if (_c_nodal)