#include <ADScalarTimeDerivative.h>

Inheritance diagram for ADScalarTimeDerivative:

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

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

Public Member Functions
	ADScalarTimeDerivative (const InputParameters &parameters)

virtual void	reinit () override
	Reinitialization method called before each call to computeResidual() More...

virtual void	computeResidual () override
	Compute this object's contribution to the residual. More...

virtual void	computeJacobian () override
	Compute this object's contribution to the diagonal Jacobian entries. More...

virtual void	computeOffDiagJacobian (unsigned int jvar) override
	Computes this object's contribution to off-diagonal blocks of the system Jacobian matrix. More...

virtual void	computeOffDiagJacobianScalar (unsigned int jvar) override
	Computes jacobian block with respect to a scalar variable. More...

virtual const MooseVariableScalar &	variable () const override
	The variable that this kernel operates on. More...

virtual bool	isActive ()
	Use this to enable/disable the scalar kernel. More...

const VariableValue &	uOld () const
	Retrieves the old value of the variable that this ScalarKernelBase operates on. More...

virtual void	computeResidualAndJacobian ()
	Compute this object's contribution to the residual and Jacobian simultaneously. More...

virtual void	computeNonlocalJacobian ()
	Compute this object's contribution to the diagonal Jacobian entries corresponding to nonlocal dofs of the variable. More...

virtual void	computeNonlocalOffDiagJacobian (unsigned int)
	Computes Jacobian entries corresponding to nonlocal dofs of the jvar. More...

const SubProblem &	subProblem () const
	Returns a reference to the SubProblem for which this Kernel is active. More...

virtual void	prepareShapes (unsigned int var_num)
	Prepare shape functions. More...

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

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

std::shared_ptr< const MooseObject >	getSharedPtr () const

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix) const
	Calls moose error with the message `msg`. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
	The unique parameter name of a valid parameter of this object for accessing parameter controls. More...

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

MooseObjectName	uniqueName () const
	The unique name for accessing input parameters of this object in the InputParameterWarehouse. More...

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

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed 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...

bool	isParamSetByUser (const std::string &nm) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

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

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

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

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type. More...

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
	Emits a documented error with object name and type. More...

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

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

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

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. 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...

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

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

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

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

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

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

UserObjectName	getUserObjectName (const std::string &param_name) const

template<class T >
const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`. More...

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

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

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

bool	isImplicit ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const
	Get the name of a VectorPostprocessor associated with a parameter. 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

bool	isNodal () const

ExecFlagType	getResetOnTime () const

void	setRandomDataPointer (RandomData *random_data)

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

void	useVectorTag (const TagName &tag_name, VectorTagsKey)

void	useVectorTag (TagID tag_id, VectorTagsKey)

void	useMatrixTag (const TagName &tag_name, MatrixTagsKey)

void	useMatrixTag (TagID tag_id, MatrixTagsKey)

bool	isVectorTagged ()

bool	isMatrixTagged ()

bool	hasVectorTags () const

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

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

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

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

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


bool	hasUserObject (const std::string &param_name) const

template<class T >
bool	hasUserObject (const std::string &param_name) const


bool	hasUserObjectByName (const UserObjectName &object_name) const

template<class T >
bool	hasUserObjectByName (const UserObjectName &object_name) const


const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
	doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values More...

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

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


virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const
	Retrieve the value of the Postprocessor. More...

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const


bool	isVectorPostprocessorDistributed (const std::string &param_name) const
	Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED. More...

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Member Functions
virtual ADReal	computeQpResidual () override

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int)

const MooseVariableFieldBase &	getVariable (unsigned int jvar_num) const
	Retrieve the variable object from our system associated with `jvar_num`. More...

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

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

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

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

template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it. More...

template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to `declareRestartableData` but returns a const reference to the object. More...

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

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

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

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

std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
const ADVariableValue &	_u_dot
	Time derivative of the kernel variable. More...

const ADVariableValue &	_u
	The current solution. More...

std::vector< ADReal >	_residuals
	Residuals for each order. More...

MooseVariableScalar &	_var
	Scalar variable. More...

unsigned int	_i

unsigned int	_j

SubProblem &	_subproblem
	Reference to this kernel's SubProblem. More...

FEProblemBase &	_fe_problem
	Reference to this kernel's FEProblemBase. More...

SystemBase &	_sys
	Reference to the EquationSystem object. More...

THREAD_ID	_tid
	The thread ID for this kernel. More...

Assembly &	_assembly
	Reference to this Kernel's assembly object. More...

MooseMesh &	_mesh
	Reference to this Kernel's mesh object. More...

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

MooseApp &	_app
	The MOOSE application this is associated with. More...

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

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

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

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const Parallel::Communicator &	_communicator

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

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

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

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

Real &	_t
	Time. More...

const Real &	_t_old
	Old 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

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

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

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

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

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

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

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

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

FEProblemBase &	_sc_fe_problem

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

Detailed Description

Definition at line 14 of file ADScalarTimeDerivative.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

Member Enumeration Documentation

◆ ResidualTagType

enum TaggingInterface::ResidualTagType

stronginherited

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

Enumerator
NonReference
Reference

Definition at line 74 of file TaggingInterface.h.

   {
     NonReference,
     Reference
   };

Constructor & Destructor Documentation

◆ ADScalarTimeDerivative()

ADScalarTimeDerivative::ADScalarTimeDerivative ( const InputParameters & parameters )

Definition at line 23 of file ADScalarTimeDerivative.C.

   : ADScalarTimeKernel(parameters)
 {
 }

Member Function Documentation

◆ accumulateTaggedLocalMatrix() [1/3]

void TaggingInterface::accumulateTaggedLocalMatrix ( )

protectedinherited

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

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

Definition at line 386 of file TaggingInterface.C.

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

◆ accumulateTaggedLocalMatrix() [2/3]

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

protectedinherited

Definition at line 393 of file TaggingInterface.C.

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

◆ accumulateTaggedLocalMatrix() [3/3]

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

protectedinherited

Definition at line 410 of file TaggingInterface.C.

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

◆ accumulateTaggedLocalResidual()

void TaggingInterface::accumulateTaggedLocalResidual ( )

protectedinherited

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

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

Definition at line 366 of file TaggingInterface.C.

 {
   for (auto & re : _re_blocks)
     *re += _local_re;
   for (auto & absre : _absre_blocks)
     for (const auto i : index_range(_local_re))
       (*absre)(i) += std::abs(_local_re(i));
 }

◆ accumulateTaggedNonlocalMatrix()

void TaggingInterface::accumulateTaggedNonlocalMatrix ( )

protectedinherited

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

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

Definition at line 429 of file TaggingInterface.C.

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

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

◆ adCoupledScalarDot()

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

protectedinherited

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

Parameters

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

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

Definition at line 252 of file ScalarCoupleable.C.

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

◆ adCoupledScalarValue()

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

protectedinherited

Returns AD value of a scalar coupled variable.

Parameters

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

Returns: Reference to a ADVariableValue for the coupled variable

Definition at line 135 of file ScalarCoupleable.C.

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

◆ addJacobian() [1/2]

template<typename Residuals , typename Indices >

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

protectedinherited

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

Definition at line 482 of file TaggingInterface.h.

Referenced by TaggingInterface::addResidualsAndJacobian(), HDGKernel::assemble(), ADScalarKernel::computeADJacobian(), ADDGKernel::computeElemNeighJacobian(), FVElementalKernel::computeJacobian(), ADNodalKernel::computeJacobian(), NodalConstraint::computeJacobian(), ADDGKernel::computeOffDiagElemNeighJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), MortarScalarBase::computeScalarJacobian(), KernelScalarBase::computeScalarJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), and MortarScalarBase::computeScalarOffDiagJacobianScalar().

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

◆ addJacobian() [2/2]

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

inlineprotectedinherited

Add a local Jacobian matrix.

Definition at line 525 of file TaggingInterface.h.

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

◆ addJacobianElement()

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

inlineprotectedinherited

Add into a single Jacobian element.

Definition at line 514 of file TaggingInterface.h.

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

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

◆ addJacobianWithoutConstraints()

template<typename Residuals , typename Indices >

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

protectedinherited

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

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

Definition at line 504 of file TaggingInterface.h.

Referenced by TaggingInterface::addResidualsAndJacobianWithoutConstraints().

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

◆ addPostprocessorDependencyHelper()

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

inlineprotectedvirtualinherited

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

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, AuxKernelTempl< Real >, UserObject, and InitialConditionBase.

Definition at line 141 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal().

141 {}

◆ addResiduals() [1/2]

template<typename Residuals , typename Indices >

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

protectedinherited

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

Definition at line 415 of file TaggingInterface.h.

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

◆ addResiduals() [2/2]

template<typename T , typename Indices >

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

protectedinherited

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

Definition at line 438 of file TaggingInterface.h.

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

◆ addResidualsAndJacobian()

template<typename Residuals , typename Indices >

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

protectedinherited

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

Definition at line 471 of file TaggingInterface.h.

Referenced by FVScalarLagrangeMultiplierInterface::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), ADKernelScalarBase::computeJacobian(), FVFluxKernel::computeJacobian(), FVInterfaceKernel::computeJacobian(), FVScalarLagrangeMultiplierConstraint::computeResidualAndJacobian(), FVElementalKernel::computeResidualAndJacobian(), and ADKernelScalarBase::computeResidualAndJacobian().

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

◆ addResidualsAndJacobianWithoutConstraints()

template<typename Residuals , typename Indices >

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

protectedinherited

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

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

Definition at line 493 of file TaggingInterface.h.

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

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

◆ addResidualsWithoutConstraints()

template<typename Residuals , typename Indices >

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

protectedinherited

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

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

Definition at line 448 of file TaggingInterface.h.

Referenced by TaggingInterface::addResidualsAndJacobianWithoutConstraints().

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

◆ addUserObjectDependencyHelper()

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

inlineprotectedvirtualinherited

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

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, AuxKernelTempl< Real >, UserObject, and InitialConditionBase.

Definition at line 110 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBaseByName().

110 {}

◆ addVectorPostprocessorDependencyHelper()

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

inlineprotectedvirtualinherited

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

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, AuxKernelTempl< Real >, and UserObject.

Definition at line 311 of file VectorPostprocessorInterface.h.

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

312 {

313 }

◆ assignTaggedLocalMatrix()

void TaggingInterface::assignTaggedLocalMatrix ( )

protectedinherited

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

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

Definition at line 436 of file TaggingInterface.C.

Referenced by NodalEqualValueConstraint::computeJacobian().

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

◆ assignTaggedLocalResidual()

void TaggingInterface::assignTaggedLocalResidual ( )

protectedinherited

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

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

Definition at line 376 of file TaggingInterface.C.

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

 {
   for (auto & re : _re_blocks)
     *re = _local_re;
   for (auto & absre : _absre_blocks)
     for (const auto i : index_range(_local_re))
       (*absre)(i) = std::abs(_local_re(i));
 }

◆ callMooseError()

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix
	)		const

inherited

Calls moose error with the message msg.

Will prefix the message with the subapp name if one exists.

If with_prefix, then add the prefix from errorPrefix() to the error.

Definition at line 33 of file MooseBase.C.

Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().

 {
   _app.getOutputWarehouse().mooseConsole();
   const std::string prefix = _app.isUltimateMaster() ? "" : _app.name();
   if (with_prefix)
     msg = errorPrefix("error") + msg;
   moose::internal::mooseErrorRaw(msg, prefix);
 }

◆ computeJacobian()

void ADScalarKernel::computeJacobian ( )

overridevirtualinherited

Compute this object's contribution to the diagonal Jacobian entries.

Implements ResidualObject.

Definition at line 44 of file ADScalarKernel.C.

 {
   computeADJacobian();
 }

◆ computeNonlocalJacobian()

virtual void ResidualObject::computeNonlocalJacobian ( )

inlinevirtualinherited

Compute this object's contribution to the diagonal Jacobian entries corresponding to nonlocal dofs of the variable.

Reimplemented in NonlocalIntegratedBC, and NonlocalKernel.

Definition at line 87 of file ResidualObject.h.

87 {}

◆ computeNonlocalOffDiagJacobian()

virtual void ResidualObject::computeNonlocalOffDiagJacobian ( unsigned int )

inlinevirtualinherited

Computes Jacobian entries corresponding to nonlocal dofs of the jvar.

Reimplemented in NonlocalIntegratedBC, and NonlocalKernel.

Definition at line 92 of file ResidualObject.h.

92 {}

◆ computeOffDiagJacobian()

void ADScalarKernel::computeOffDiagJacobian ( unsigned int )

overridevirtualinherited

Computes this object's contribution to off-diagonal blocks of the system Jacobian matrix.

Parameters

jvar The number of the coupled variable. We pass the number of the coupled variable instead of an actual variable object because we can query our system and obtain the variable object associated with it. E.g. we need to make sure we are getting undisplaced variables if we are working on the undisplaced mesh, and displaced variables if we are working on the displaced mesh

Reimplemented from ResidualObject.

Definition at line 50 of file ADScalarKernel.C.

 {
   if (!_jacobian_already_computed)
   {
     computeADJacobian();
     _jacobian_already_computed = true;
   }
 }

◆ computeOffDiagJacobianScalar()

void ADScalarKernel::computeOffDiagJacobianScalar ( unsigned int )

overridevirtualinherited

Computes jacobian block with respect to a scalar variable.

Parameters

jvar	The number of the scalar variable

Reimplemented from ResidualObject.

Definition at line 60 of file ADScalarKernel.C.

61 {

62 }

◆ computeQpResidual()

ADReal ADScalarTimeDerivative::computeQpResidual ( )

overrideprotectedvirtual

Implements ADScalarKernel.

Definition at line 29 of file ADScalarTimeDerivative.C.

 {
   return _u_dot[_i];
 }

◆ computeResidual()

void ADScalarKernel::computeResidual ( )

overridevirtualinherited

Compute this object's contribution to the residual.

Implements ResidualObject.

Definition at line 33 of file ADScalarKernel.C.

 {
   prepareVectorTag(_assembly, _var.number());
 
   for (_i = 0; _i < _var.order(); _i++)
     _local_re(_i) += raw_value(computeQpResidual());
 
   accumulateTaggedLocalResidual();
 }

◆ computeResidualAndJacobian()

void ResidualObject::computeResidualAndJacobian ( )

virtualinherited

Compute this object's contribution to the residual and Jacobian simultaneously.

Reimplemented in InterfaceKernelTempl< T >, ADNodalBCTempl< Real, ADDirichletBCBase >, ADNodalBCTempl< T, ADDirichletBCBase >, ADNodalBCTempl< RealVectorValue, ADDirichletBCBase >, ADKernelScalarBase, FVFluxKernel, ADMortarConstraint, IntegratedBC, FVElementalKernel, HDGKernel, ADKernelTempl< T >, FVScalarLagrangeMultiplierConstraint, NodalBC, ADIntegratedBCTempl< T >, Kernel, HDGIntegratedBC, and ADKernelGradTempl< T >.

Definition at line 66 of file ResidualObject.C.

Referenced by ComputeResidualAndJacobianThread::compute().

 {
   mooseError(
       "This object has not yet implemented 'computeResidualAndJacobian'. If you would like that "
       "feature for this object, please contact a MOOSE developer.");
 }

◆ connectControllableParams()

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

inherited

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

Parameters

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

Definition at line 33 of file MooseBaseParameterInterface.C.

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

◆ coupledGenericScalarValue() [1/3]

template<bool is_ad>

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

protectedinherited

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

Parameters

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

Returns: Reference to a GenericVariableValue for the coupled scalar variable

◆ coupledGenericScalarValue() [2/3]

template<>

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

protectedinherited

Definition at line 152 of file ScalarCoupleable.C.

 {
   return coupledScalarValue(var_name, comp);
 }

◆ coupledGenericScalarValue() [3/3]

template<>

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

protectedinherited

Definition at line 160 of file ScalarCoupleable.C.

 {
   return adCoupledScalarValue(var_name, comp);
 }

◆ coupledMatrixTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 202 of file ScalarCoupleable.C.

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

◆ coupledPostprocessors()

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

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

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

Definition at line 129 of file PostprocessorInterface.C.

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

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

◆ coupledScalar()

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

protectedinherited

Returns the index for a scalar coupled variable by name.

Parameters

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

Returns: Index of coupled variable

Definition at line 93 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 ) const

protectedinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name The of the coupled variable

Definition at line 353 of file ScalarCoupleable.C.

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

◆ coupledScalarDot()

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

protectedinherited

Returns the time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 244 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDot()

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

protectedinherited

Returns the second time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 260 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 292 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDotOld()

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

protectedinherited

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

Parameters

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

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

Definition at line 276 of file ScalarCoupleable.C.

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

◆ coupledScalarDotDu()

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

protectedinherited

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

Parameters

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

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

Definition at line 284 of file ScalarCoupleable.C.

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

◆ coupledScalarDotOld()

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

protectedinherited

Returns the old time derivative of a scalar coupled variable.

Parameters

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

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

Definition at line 268 of file ScalarCoupleable.C.

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

◆ coupledScalarOrder()

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

protectedinherited

Returns the order for a scalar coupled variable by name.

Parameters

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

Returns: Order of coupled variable

Definition at line 100 of file ScalarCoupleable.C.

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

◆ coupledScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 124 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

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

◆ coupledScalarValueOld()

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

protectedinherited

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

Parameters

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

Returns: Reference to a old VariableValue for the coupled variable

Definition at line 216 of file ScalarCoupleable.C.

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

◆ coupledScalarValueOlder()

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

protectedinherited

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

Parameters

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

Returns: Reference to a older VariableValue for the coupled variable

Definition at line 228 of file ScalarCoupleable.C.

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

◆ coupledVectorTagScalarValue()

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

protectedinherited

Returns value of a scalar coupled variable.

Parameters

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

Returns: Reference to a VariableValue for the coupled variable

Definition at line 181 of file ScalarCoupleable.C.

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

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

Declares a piece of "managed" restartable data and initialize it.

Here, "managed" restartable data means that the caller can destruct this data upon destruction of the return value of this method. Therefore, this ManagedValue<T> wrapper should survive after the final calls to dataStore() for it. That is... at the very end.

This is needed for objects whose destruction ordering is important, and enables natural c++ destruction in reverse construction order of the object that declares it.

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 276 of file Restartable.h.

 {
   auto & data_ptr =
       declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...);
   return Restartable::ManagedValue<T>(data_ptr);
 }

◆ declareRecoverableData()

template<typename T , typename... Args>

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 351 of file Restartable.h.

 {
   const auto full_name = restartableName(data_name);
 
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
 
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableData()

template<typename T , typename... Args>

T & Restartable::declareRestartableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

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

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 269 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 294 of file Restartable.h.

 {
   return declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...).set();
 }

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 323 of file Restartable.h.

 {
   return declareRestartableDataWithObjectNameWithContext<T>(
       data_name, object_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 333 of file Restartable.h.

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

◆ determineState()

Moose::StateArg TransientInterface::determineState ( ) const

inlineinherited

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

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

Definition at line 83 of file TransientInterface.h.

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

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 40 of file MooseObject.h.

Referenced by EigenKernel::enabled().

40 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:51

◆ errorPrefix()

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

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ getCheckedPointerParam()

template<typename T >

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

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 268 of file MooseBaseParameterInterface.h.

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

◆ getCoupledMooseScalarVars()

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

inlineinherited

Get the list of coupled scalar variables.

Returns: The list of coupled variables

Definition at line 45 of file ScalarCoupleable.h.

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

   {
     return _coupled_moose_scalar_vars;
   }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), ElementReporter::shouldStore(), NodalReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getFunction()

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

inherited

Get a function with a given name.

Parameters

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

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

Definition at line 30 of file FunctionInterface.C.

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

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

◆ getFunctionByName()

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

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 36 of file FunctionInterface.C.

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

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

◆ getMasterSeed()

unsigned int RandomInterface::getMasterSeed ( ) const

inlineinherited

Definition at line 66 of file RandomInterface.h.

66 { return _master_seed; }

RandomInterface::_master_seed

unsigned int _master_seed

Definition: RandomInterface.h:79

◆ getMatrixTags()

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

inlineinherited

Definition at line 96 of file TaggingInterface.h.

96 { return _matrix_tags; }

TaggingInterface::_matrix_tags

std::set< TagID > _matrix_tags

The matrices this Kernel will contribute to.

Definition: TaggingInterface.h:358

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

Referenced by AddDefaultConvergenceAction::act(), ChainControlSetupAction::act(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultNonlinearConvergence::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ getParam() [1/2]

template<typename T >

const T & MooseBaseParameterInterface::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 204 of file MooseBaseParameterInterface.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 261 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getPostprocessorName()

const PostprocessorName & PostprocessorInterface::getPostprocessorName	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Get the name of a postprocessor.

This can only be used if the postprocessor parameter does not have a default value set (see isDefaultPostprocessorValue()), in which case the "name" is actually the default value.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: The name of the given Postprocessor

Definition at line 185 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ getPostprocessorValue()

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

inherited

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

Parameters

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

Returns: A reference to the desired value

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

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 36 of file PostprocessorInterface.C.

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

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

◆ getPostprocessorValueByName()

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

virtualinherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns: A reference to the desired value

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

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 57 of file PostprocessorInterface.C.

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

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

◆ getPostprocessorValueOld()

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

inherited

Definition at line 43 of file PostprocessorInterface.C.

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

◆ getPostprocessorValueOldByName()

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

inherited

Definition at line 63 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ getPostprocessorValueOlder()

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

inherited

Definition at line 50 of file PostprocessorInterface.C.

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

◆ getPostprocessorValueOlderByName()

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

inherited

Definition at line 69 of file PostprocessorInterface.C.

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

◆ getRandomLong()

unsigned long RandomInterface::getRandomLong ( ) const

inherited

Returns the next random number (long) from the generator tied to this object (elem/node).

Definition at line 69 of file RandomInterface.C.

 {
   mooseAssert(_generator, "Random Generator is NULL, did you call setRandomResetFrequency()?");
 
   dof_id_type id;
   if (_is_nodal)
     id = _curr_node->id();
   else
     id = _curr_element->id();
 
   return _generator->randl(id);
 }

◆ getRandomReal()

Real RandomInterface::getRandomReal ( ) const

inherited

Returns the next random number (Real) from the generator tied to this object (elem/node).

Definition at line 83 of file RandomInterface.C.

 {
   mooseAssert(_generator, "Random Generator is NULL, did you call setRandomResetFrequency()?");
 
   dof_id_type id;
   if (_is_nodal)
     id = _curr_node->id();
   else
     id = _curr_element->id();
 
   return _generator->rand(id);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 211 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getResetOnTime()

ExecFlagType RandomInterface::getResetOnTime ( ) const

inlineinherited

Definition at line 68 of file RandomInterface.h.

68 { return _reset_on; }

RandomInterface::_reset_on

ExecFlagType _reset_on

Definition: RandomInterface.h:81

◆ getRestartableData()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object.

Forwarded arguments are not allowed in this case because we assume that the object is restarted and we won't need different constructors to initialize it.

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

Parameters

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

Definition at line 287 of file Restartable.h.

 {
   return declareRestartableDataHelper<T>(data_name, nullptr).get();
 }

◆ getScalarVar()

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

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

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

Returns: Pointer to the desired variable

Definition at line 321 of file ScalarCoupleable.C.

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

◆ getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_matrix_tags;
   }

◆ getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 50 of file ScalarCoupleable.h.

   {
     return _sc_coupleable_vector_tags;
   }

◆ getScatterVectorPostprocessorValue()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 106 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueByName()

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

inherited

Return the scatter value for the post processor.

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

Parameters

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

Returns: The reference to the current scatter value

Definition at line 115 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

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

◆ getScatterVectorPostprocessorValueOld()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 122 of file VectorPostprocessorInterface.C.

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

◆ getScatterVectorPostprocessorValueOldByName()

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

inherited

Return the old scatter value for the post processor.

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

Parameters

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

Returns: The reference to the old scatter value

Definition at line 131 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

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

◆ getSeed()

unsigned int RandomInterface::getSeed ( std::size_t id )

inherited

Get the seed for the passed in elem/node id.

Parameters

id	- dof object id

Returns: current seed for this id

Definition at line 61 of file RandomInterface.C.

 {
   mooseAssert(_random_data, "RandomData object is NULL!");
 
   return _random_data->getSeed(id);
 }

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 68 of file MooseObject.C.

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

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 81 of file MooseObject.C.

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

◆ getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

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

Definition at line 169 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBase(param_name, is_dependency), param_name);
 }

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

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

Definition at line 86 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObject().

 {
   const auto object_name = getUserObjectName(param_name);
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.paramError(
         param_name, "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   return getUserObjectBaseByName(object_name, is_dependency);
 }

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 98 of file UserObjectInterface.C.

Referenced by UserObject::getDependObjects(), UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectByName().

 {
   if (!hasUserObjectByName(object_name))
     _uoi_moose_object.mooseError(
         "The requested UserObject with the name \"", object_name, "\" was not found.");
 
   const auto & uo_base_tid0 = _uoi_feproblem.getUserObjectBase(object_name, /* tid = */ 0);
   if (is_dependency)
     addUserObjectDependencyHelper(uo_base_tid0);
 
   const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
   return _uoi_feproblem.getUserObjectBase(object_name, tid);
 }

◆ getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 176 of file UserObjectInterface.h.

 {
   return castUserObject<T>(getUserObjectBaseByName(object_name, is_dependency));
 }

◆ getUserObjectName()

UserObjectName UserObjectInterface::getUserObjectName ( const std::string & param_name ) const

inherited

Returns: The name of the user object associated with the parameter param_name

Definition at line 35 of file UserObjectInterface.C.

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

 {
   const auto & params = _uoi_moose_object.parameters();
 
   if (!params.isParamValid(param_name))
     _uoi_moose_object.mooseError("Failed to get a parameter with the name \"",
                                  param_name,
                                  "\" when getting a UserObjectName.",
                                  "\n\nKnown parameters:\n",
                                  _uoi_moose_object.parameters());
 
   // Other interfaces will use this interface (PostprocessorInterface, VectorPostprocessorInterface)
   // to grab UOs with a specialized name, so we need to check them all
   UserObjectName name;
   if (params.isType<UserObjectName>(param_name))
     name = params.get<UserObjectName>(param_name);
   else if (params.isType<PostprocessorName>(param_name))
     name = params.get<PostprocessorName>(param_name);
   else if (params.isType<VectorPostprocessorName>(param_name))
     name = params.get<VectorPostprocessorName>(param_name);
   else if (params.isType<std::string>(param_name))
     name = params.get<std::string>(param_name);
   else
     _uoi_moose_object.paramError(
         param_name,
         "Parameter of type \"",
         params.type(param_name),
         "\" is not an expected type for getting the name of a UserObject.");
 
   return name;
 }

◆ getVariable()

const MooseVariableFieldBase& ResidualObject::getVariable ( unsigned int jvar_num ) const

inlineprotectedinherited

Retrieve the variable object from our system associated with jvar_num.

Definition at line 118 of file ResidualObject.h.

   {
     return _sys.getVariable(_tid, jvar_num);
   }

◆ getVectorPostprocessorName()

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

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name The name of the VectorPostprocessor parameter

Returns: The name of the given VectorPostprocessor

Definition at line 203 of file VectorPostprocessorInterface.C.

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

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

◆ getVectorPostprocessorValue() [1/2]

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

inherited

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

Retrieve the value of a VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 36 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValue() [2/2]

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

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 66 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueByName() [1/2]

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

inherited

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

Retrieve the value of the VectorPostprocessor

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 44 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValue().

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

◆ getVectorPostprocessorValueByName() [2/2]

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

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

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

Returns: A reference to the desired value

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

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 76 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 51 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOld() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 86 of file VectorPostprocessorInterface.C.

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

◆ getVectorPostprocessorValueOldByName() [1/2]

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

inherited

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

Retrieve the old value of a VectorPostprocessor

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 59 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld().

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

◆ getVectorPostprocessorValueOldByName() [2/2]

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

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

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

Returns: The value of the VectorPostprocessor

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

see getVectorPostprocessorValueByName

Definition at line 96 of file VectorPostprocessorInterface.C.

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

◆ getVectorTags()

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

inlineinherited

Definition at line 94 of file TaggingInterface.h.

94 { return _vector_tags; }

TaggingInterface::_vector_tags

std::set< TagID > _vector_tags

The residual tag ids this Kernel will contribute to.

Definition: TaggingInterface.h:352

◆ hasFunction()

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

inherited

Determine if the function exists.

Parameters

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

Returns: True if the function exists

Definition at line 42 of file FunctionInterface.C.

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

◆ hasFunctionByName()

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

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 48 of file FunctionInterface.C.

Referenced by FunctionInterface::hasFunction().

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

◆ hasPostprocessor()

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

inherited

Determine if the Postprocessor data exists.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessorByName getPostprocessorValue

Definition at line 107 of file PostprocessorInterface.C.

 {
   if (!postprocessorsAdded())
     _ppi_moose_object.mooseError(
         "Cannot call hasPostprocessor() until all Postprocessors have been constructed.");
 
   return hasPostprocessorByName(getPostprocessorNameInternal(param_name, index));
 }

◆ hasPostprocessorByName()

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

inherited

Determine if the Postprocessor data exists.

Parameters

name	The name of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessor getPostprocessorValueByName

Definition at line 118 of file PostprocessorInterface.C.

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

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

◆ hasUserObject() [1/2]

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Returns: Whether or not a UserObject exists with the name given by the parameter param_name.

Definition at line 68 of file UserObjectInterface.C.

 {
   return hasUserObjectByName(getUserObjectName(param_name));
 }

◆ hasUserObject() [2/2]

template<class T >

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Definition at line 184 of file UserObjectInterface.h.

 {
   return hasUserObjectByName<T>(getUserObjectName(param_name));
 }

◆ hasUserObjectByName() [1/2]

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 74 of file UserObjectInterface.C.

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

 {
   return _uoi_feproblem.hasUserObject(object_name);
 }

◆ hasUserObjectByName() [2/2]

template<class T >

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 191 of file UserObjectInterface.h.

 {
   if (!hasUserObjectByName(object_name))
     return false;
   return dynamic_cast<const T *>(&getUserObjectFromFEProblem(object_name));
 }

◆ hasVectorPostprocessor() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 138 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

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

◆ hasVectorPostprocessor() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

Definition at line 168 of file VectorPostprocessorInterface.C.

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

◆ hasVectorPostprocessorByName() [1/2]

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

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

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

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 149 of file VectorPostprocessorInterface.C.

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

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   const bool has_vpp = _vpi_feproblem.getReporterData().hasReporterValue<VectorPostprocessorValue>(
       VectorPostprocessorReporterName(name, vector_name));
 
   if (has_vpp)
     mooseAssert(_vpi_feproblem.hasUserObject(name) && dynamic_cast<const VectorPostprocessor *>(
                                                           &_vpi_feproblem.getUserObjectBase(name)),
                 "Has reporter VectorPostprocessor Reporter value but not VectorPostprocessor UO");
 
   return has_vpp;
 }

◆ hasVectorPostprocessorByName() [2/2]

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

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

Definition at line 178 of file VectorPostprocessorInterface.C.

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   return _vpi_feproblem.hasUserObject(name) &&
          dynamic_cast<const VectorPostprocessor *>(&_vpi_feproblem.getUserObjectBase(name));
 }

◆ hasVectorTags()

bool TaggingInterface::hasVectorTags ( ) const

inlineinherited

Definition at line 92 of file TaggingInterface.h.

Referenced by Kernel::computeResidual().

92 { return !_vector_tags.empty(); }

TaggingInterface::_vector_tags

std::set< TagID > _vector_tags

The residual tag ids this Kernel will contribute to.

Definition: TaggingInterface.h:352

◆ initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

Reimplemented in SolutionUserObjectBase, AdvancedOutput, MooseVariableBase, ParsedMaterialHelper< is_ad >, MultiApp, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseParsedFunction, MooseParsedGradFunction, DerivativeFunctionMaterialBaseTempl< is_ad >, Transfer, ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >, CSV, Exodus, OversampleOutput, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, MultiAppTransfer, Convergence, RadialAverage, MooseParsedVectorFunction, HDGKernel, ImageFunction, Console, PiecewiseConstantFromCSV, Nemesis, NodalVariableValue, ReferenceResidualConvergence, MortarNodalAuxKernelTempl< ComputeValueType >, LibtorchArtificialNeuralNetParameters, TimePeriod, MatDiffusionBase< T >, TransientMultiApp, ElementalVariableValue, GhostingUserObject, InterfaceQpUserObjectBase, MatDiffusionBase< Real >, SolutionAux, IsMatrixSymmetric, MultiAppProjectionTransfer, HistogramVectorPostprocessor, SolutionScalarAux, ParsedConvergence, LinearFVAdvection, LinearFVAnisotropicDiffusion, LinearFVDiffusion, MultiAppPositions, MultiAppDofCopyTransfer, MultiAppGeneralFieldNearestLocationTransfer, DefaultNonlinearConvergence, CoarsenedPiecewiseLinear, PiecewiseTabularBase, MatReaction, SideIntegralMaterialPropertyTempl< is_ad >, SideIntegralPostprocessor, MultiAppVariableValueSamplePostprocessorTransfer, NodalPatchRecoveryMaterialProperty, ProjectedStatefulMaterialAuxTempl< T, is_ad >, PiecewiseLinear, ElementSubdomainModifierBase, FullSolveMultiApp, SideFVFluxBCIntegral, MultiAppFieldTransfer, MultiAppVariableValueSampleTransfer, PiecewiseLinearBase, ChainControlDataPostprocessor, MultiAppConservativeTransfer, MultiAppCloneReporterTransfer, MultiAppReporterTransfer, and DerivativeSumMaterialTempl< is_ad >.

Definition at line 41 of file SetupInterface.C.

Referenced by SideIntegralPostprocessor::initialSetup(), ElementalVariableValue::initialSetup(), HDGKernel::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), and Positions::meshChanged().

42 {

43 }

◆ isActive()

virtual bool ScalarKernelBase::isActive ( )

inlinevirtualinherited

Use this to enable/disable the scalar kernel.

Returns: true if the scalar kernel is active

Definition at line 40 of file ScalarKernelBase.h.

40 { return true; }

◆ isCoupledScalar()

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

protectedinherited

Returns true if a variables has been coupled_as name.

Parameters

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

Definition at line 70 of file ScalarCoupleable.C.

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

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

◆ isDefaultPostprocessorValue()

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

inherited

Determine whether or not the Postprocessor is a default value.

A default value is when the value is either the value set by addParam, or is a user-set value in input instead of a name to a postprocessor.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the postprocessor

Returns: True if the Postprocessor is a default value, false if the Postprocessor is the name of a Postprocessor

Definition at line 75 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 38 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

38 { return _is_implicit; }

TransientInterface::_is_implicit

bool _is_implicit

If the object is using implicit or explicit form.

Definition: TransientInterface.h:58

◆ isMatrixTagged()

bool TaggingInterface::isMatrixTagged ( )

inlineinherited

Definition at line 90 of file TaggingInterface.h.

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

TaggingInterface::_matrix_tags

std::set< TagID > _matrix_tags

The matrices this Kernel will contribute to.

Definition: TaggingInterface.h:358

◆ isNodal()

bool RandomInterface::isNodal ( ) const

inlineinherited

Definition at line 67 of file RandomInterface.h.

Referenced by ElementValueSampler::ElementValueSampler(), and NodalValueSampler::NodalValueSampler().

67 { return _is_nodal; }

RandomInterface::_is_nodal

bool _is_nodal

Definition: RandomInterface.h:80

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 117 of file MooseBaseParameterInterface.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), DiffusionCG::addSolverVariables(), LibtorchNeuralNetControl::conditionalParameterError(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), FixedPointSolve::FixedPointSolve(), MooseBaseParameterInterface::getRenamedParam(), DefaultNonlinearConvergence::getSharedExecutionerParam(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

117 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

bool isParamSetByUser(const std::string &name) const

Method returns true if the parameter was by the user.

Definition: InputParameters.C:1173

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

◆ isParamValid()

bool MooseBaseParameterInterface::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 111 of file MooseBaseParameterInterface.h.

111 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:390

◆ isVectorPostprocessorDistributed()

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

inherited

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

Definition at line 190 of file VectorPostprocessorInterface.C.

 {
   return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
 }

◆ isVectorPostprocessorDistributedByName()

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

inherited

Definition at line 196 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

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

◆ isVectorTagged()

bool TaggingInterface::isVectorTagged ( )

inlineinherited

Definition at line 88 of file TaggingInterface.h.

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

TaggingInterface::_vector_tags

std::set< TagID > _vector_tags

The residual tag ids this Kernel will contribute to.

Definition: TaggingInterface.h:352

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

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

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

Definition at line 51 of file SetupInterface.C.

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

52 {

53 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

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

Definition at line 34 of file MeshChangedInterface.h.

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

34 {}

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), Executioner::augmentedPicardConvergenceCheck(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), Executioner::picardSolve(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

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

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 98 of file MooseBaseErrorInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), FEProblemBase::setRestartFile(), and SymmetryTransformGenerator::SymmetryTransformGenerator().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

Referenced by AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), BoundsBase::BoundsBase(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), OversampleOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchedMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 85 of file MooseBaseErrorInterface.h.

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

◆ name()

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

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 237 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:162

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 254 of file MooseBaseParameterInterface.h.

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

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

◆ paramWarning()

template<typename... Args>

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

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 247 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), FixedPointSolve::FixedPointSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

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

◆ precalculateJacobian()

virtual void ResidualObject::precalculateJacobian ( )

inlineprotectedvirtualinherited

Reimplemented in PenaltyPeriodicSegmentalConstraint.

Definition at line 112 of file ResidualObject.h.

Referenced by TimeDerivative::computeJacobian(), VectorTimeDerivative::computeJacobian(), VectorKernel::computeJacobian(), Kernel::computeJacobian(), ArrayKernel::computeJacobian(), IntegratedBC::computeJacobian(), EigenKernel::computeJacobian(), NonlocalKernel::computeJacobian(), DGLowerDKernel::computeJacobian(), ArrayDGLowerDKernel::computeJacobian(), DGKernelBase::computeJacobian(), and NonlocalKernel::computeNonlocalJacobian().

112 {}

◆ precalculateOffDiagJacobian()

virtual void ResidualObject::precalculateOffDiagJacobian ( unsigned int )

inlineprotectedvirtualinherited

Definition at line 113 of file ResidualObject.h.

Referenced by NonlocalKernel::computeNonlocalOffDiagJacobian(), Kernel::computeOffDiagJacobian(), VectorKernel::computeOffDiagJacobian(), ArrayKernel::computeOffDiagJacobian(), EigenKernel::computeOffDiagJacobian(), IntegratedBC::computeOffDiagJacobian(), NonlocalKernel::computeOffDiagJacobian(), ArrayDGKernel::computeOffDiagJacobian(), DGLowerDKernel::computeOffDiagJacobian(), ArrayDGLowerDKernel::computeOffDiagJacobian(), and DGKernelBase::computeOffDiagJacobian().

113 {}

◆ precalculateResidual()

virtual void ResidualObject::precalculateResidual ( )

inlineprotectedvirtualinherited

Reimplemented in ADPenaltyPeriodicSegmentalConstraint, and PenaltyPeriodicSegmentalConstraint.

Definition at line 111 of file ResidualObject.h.

Referenced by MortarConstraintBase::computeJacobian(), Kernel::computeResidual(), VectorKernel::computeResidual(), ArrayKernel::computeResidual(), TimeKernel::computeResidual(), VectorTimeKernel::computeResidual(), IntegratedBC::computeResidual(), EigenKernel::computeResidual(), DGLowerDKernel::computeResidual(), ArrayDGLowerDKernel::computeResidual(), MortarConstraintBase::computeResidual(), and DGKernelBase::computeResidual().

111 {}

◆ prepareMatrixTag() [1/2]

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

protectedinherited

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

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

Definition at line 282 of file TaggingInterface.C.

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

◆ prepareMatrixTag() [2/2]

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

protectedinherited

Definition at line 294 of file TaggingInterface.C.

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

◆ prepareMatrixTagLower()

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

protectedinherited

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

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

Definition at line 350 of file TaggingInterface.C.

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

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

◆ prepareMatrixTagNeighbor() [1/2]

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

protectedinherited

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

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

Definition at line 321 of file TaggingInterface.C.

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

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

◆ prepareMatrixTagNeighbor() [2/2]

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

protectedinherited

Definition at line 337 of file TaggingInterface.C.

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

◆ prepareMatrixTagNonlocal()

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

protectedinherited

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

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

Definition at line 306 of file TaggingInterface.C.

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

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

◆ prepareShapes()

void ResidualObject::prepareShapes ( unsigned int var_num )

virtualinherited

Prepare shape functions.

Parameters

var_num The variable number whose shape functions should be prepared

Reimplemented in DGKernelBase, InterfaceKernelBase, and IntegratedBCBase.

Definition at line 60 of file ResidualObject.C.

Referenced by ComputeJacobianThread::compute(), ComputeFullJacobianThread::computeOnElement(), and Kernel::computeResidualAndJacobian().

 {
   _subproblem.prepareShapes(var_num, _tid);
 }

◆ prepareVectorTag() [1/2]

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

protectedinherited

Prepare data for computing element residual according to active tags.

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

Definition at line 195 of file TaggingInterface.C.

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

◆ prepareVectorTag() [2/2]

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

protectedinherited

Prepare vector tags in a reference residual problem context.

Parameters

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

Definition at line 201 of file TaggingInterface.C.

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

◆ prepareVectorTagLower()

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

protectedinherited

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

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

Definition at line 260 of file TaggingInterface.C.

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

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

◆ prepareVectorTagNeighbor()

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

protectedinherited

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

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

Definition at line 237 of file TaggingInterface.C.

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

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

◆ reinit()

void ADScalarKernel::reinit ( )

overridevirtualinherited

Reinitialization method called before each call to computeResidual()

Implements ScalarKernelBase.

Definition at line 27 of file ADScalarKernel.C.

 {
   _jacobian_already_computed = false;
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

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

Definition at line 56 of file SetupInterface.C.

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

57 {

58 }

◆ restartableName()

std::string Restartable::restartableName ( const std::string & data_name ) const

protectedinherited

Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

This should only be used in this interface and in testing.

Definition at line 66 of file Restartable.C.

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

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

◆ setRandomDataPointer()

void RandomInterface::setRandomDataPointer ( RandomData * random_data )

inherited

Definition at line 54 of file RandomInterface.C.

Referenced by FEProblemBase::registerRandomInterface().

 {
   _random_data = random_data;
   _generator = &_random_data->getGenerator();
 }

◆ setRandomResetFrequency()

void RandomInterface::setRandomResetFrequency ( ExecFlagType exec_flag )

inherited

This interface should be called from a derived class to enable random number generation in this object.

Definition at line 47 of file RandomInterface.C.

 {
   _reset_on = exec_flag;
   _ri_problem.registerRandomInterface(*this, _ri_name);
 }

◆ setResidual() [1/3]

template<typename T >

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

protectedinherited

Set residual using the variables' insertion API.

Definition at line 538 of file TaggingInterface.h.

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

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

◆ setResidual() [2/3]

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

inlineprotectedinherited

Set residual at a specified degree of freedom index.

Definition at line 546 of file TaggingInterface.h.

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

◆ setResidual() [3/3]

template<typename SetResidualFunctor >

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

protectedinherited

Set residuals using the provided functor.

Definition at line 555 of file TaggingInterface.h.

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

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ subProblem()

const SubProblem& ResidualObject::subProblem ( ) const

inlineinherited

Returns a reference to the SubProblem for which this Kernel is active.

Definition at line 102 of file ResidualObject.h.

102 { return _subproblem; }

ResidualObject::_subproblem

SubProblem & _subproblem

Reference to this kernel's SubProblem.

Definition: ResidualObject.h:125

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObjectBase, Console, VectorPostprocessorVisualizationAux, EqualValueEmbeddedConstraint, NumNonlinearIterations, VectorMemoryUsage, MemoryUsage, and JSONOutput.

Definition at line 46 of file SetupInterface.C.

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().

47 {

48 }

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

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

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

The unique name for accessing input parameters of this object in the InputParameterWarehouse.

Definition at line 67 of file MooseBaseParameterInterface.h.

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

   {
     return MooseObjectName(_pars.get<std::string>("_unique_name"));
   }

◆ uniqueParameterName()

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

inlineinherited

The unique parameter name of a valid parameter of this object for accessing parameter controls.

Definition at line 52 of file MooseBaseParameterInterface.h.

   {
     return MooseObjectParameterName(
         _pars.get<std::string>("_moose_base"), _moose_base.name(), parameter_name);
   }

◆ uOld()

const VariableValue & ScalarKernelBase::uOld ( ) const

inherited

Retrieves the old value of the variable that this ScalarKernelBase operates on.

Store this as a reference in the constructor.

Definition at line 44 of file ScalarKernelBase.C.

 {
   if (_sys.solutionStatesInitialized())
     mooseError("The solution states have already been initialized when calling ",
                type(),
                "::uOld().\n\n",
                "Make sure to call uOld() within the object constructor.");
 
   return _var.slnOld();
 }

◆ useMatrixTag() [1/2]

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

inherited

Definition at line 168 of file TaggingInterface.C.

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

◆ useMatrixTag() [2/2]

void TaggingInterface::useMatrixTag	(	TagID	tag_id,
		MatrixTagsKey
	)

inherited

Definition at line 186 of file TaggingInterface.C.

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

◆ useVectorTag() [1/2]

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

inherited

Definition at line 159 of file TaggingInterface.C.

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

◆ useVectorTag() [2/2]

void TaggingInterface::useVectorTag	(	TagID	tag_id,
		VectorTagsKey
	)

inherited

Definition at line 177 of file TaggingInterface.C.

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

◆ validParams()

InputParameters ADScalarTimeDerivative::validParams ( )

static

Definition at line 15 of file ADScalarTimeDerivative.C.

 {
   InputParameters params = ADScalarTimeKernel::validParams();
   params.addClassDescription(
       "Adds the time derivative contribution to the residual for a scalar variable.");
   return params;
 }

◆ variable()

virtual const MooseVariableScalar& ScalarKernelBase::variable ( ) const

inlineoverridevirtualinherited

The variable that this kernel operates on.

Implements ResidualObject.

Definition at line 34 of file ScalarKernelBase.h.

34 { return _var; }

ScalarKernelBase::_var

MooseVariableScalar & _var

Scalar variable.

Definition: ScalarKernelBase.h:51

Member Data Documentation

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

Definition at line 168 of file MooseBaseParameterInterface.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _assembly

Assembly& ResidualObject::_assembly

protectedinherited

Reference to this Kernel's assembly object.

Definition at line 137 of file ResidualObject.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 78 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _dt

Real& TransientInterface::_dt

protectedinherited

Time step size.

Definition at line 70 of file TransientInterface.h.

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

◆ _dt_old

Real& TransientInterface::_dt_old

protectedinherited

Size of the old time step.

Definition at line 73 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 51 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

Referenced by ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), SetupInterface::getExecuteOnEnum(), JSONOutput::outputReporters(), XMLOutput::outputVectorPostprocessors(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 165 of file MooseBaseParameterInterface.h.

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

◆ _fe_problem

FEProblemBase& ResidualObject::_fe_problem

protectedinherited

Reference to this kernel's FEProblemBase.

Definition at line 128 of file ResidualObject.h.

Referenced by ADKernelTempl< T >::ADKernelTempl(), ArrayKernel::ArrayKernel(), HDGKernel::assemble(), ArrayNodalBC::computeJacobian(), VectorNodalBC::computeJacobian(), NodalBC::computeJacobian(), ArrayNodalBC::computeOffDiagJacobian(), VectorNodalBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), Kernel::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), and Kernel::Kernel().

◆ _i

unsigned int ScalarKernelBase::_i

protectedinherited

Definition at line 53 of file ScalarKernelBase.h.

Referenced by ADScalarKernel::computeADJacobian(), ScalarKernel::computeJacobian(), ODEKernel::computeJacobian(), ODEKernel::computeOffDiagJacobianScalar(), CoupledODETimeDerivative::computeQpJacobian(), ODETimeDerivative::computeQpJacobian(), ODETimeDerivative::computeQpResidual(), computeQpResidual(), CoupledODETimeDerivative::computeQpResidual(), ScalarKernel::computeResidual(), ODETimeKernel::computeResidual(), ODEKernel::computeResidual(), ADScalarKernel::computeResidual(), and ParsedODEKernel::updateParams().

◆ _is_implicit

bool TransientInterface::_is_implicit

protectedinherited

If the object is using implicit or explicit form.

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

Definition at line 58 of file TransientInterface.h.

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

◆ _is_transient

bool TransientInterface::_is_transient

protectedinherited

Definition at line 76 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _j

unsigned int ScalarKernelBase::_j

protectedinherited

Definition at line 53 of file ScalarKernelBase.h.

Referenced by ODEKernel::computeJacobian(), ODEKernel::computeOffDiagJacobianScalar(), CoupledODETimeDerivative::computeQpJacobian(), and ODETimeDerivative::computeQpJacobian().

◆ _local_ke

DenseMatrix<Number> TaggingInterface::_local_ke

protectedinherited

Holds local Jacobian entries as they are accumulated by this Kernel.

Definition at line 334 of file TaggingInterface.h.

◆ _local_re

DenseVector<Number> TaggingInterface::_local_re

protectedinherited

Holds local residual entries as they are accumulated by this Kernel.

Definition at line 331 of file TaggingInterface.h.

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 38 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& ResidualObject::_mesh

protectedinherited

Reference to this Kernel's mesh object.

Definition at line 140 of file ResidualObject.h.

Referenced by DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), FVFluxKernel::adjustRMGhostLayers(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), HDGKernel::assemble(), UpperBoundNodalKernel::computeQpJacobian(), LowerBoundNodalKernel::computeQpJacobian(), UpperBoundNodalKernel::computeQpOffDiagJacobian(), LowerBoundNodalKernel::computeQpOffDiagJacobian(), LowerBoundNodalKernel::computeQpResidual(), UpperBoundNodalKernel::computeQpResidual(), DGKernelBase::DGKernelBase(), DGLowerDKernel::DGLowerDKernel(), DGKernelBase::excludeBoundary(), NodeElemConstraint::getConnectedDofIndices(), NodeFaceConstraint::getConnectedDofIndices(), NodeFaceConstraint::getSecondaryConnectedBlocks(), DiracKernelBase::hasPointsOnElem(), HFEMDirichletBC::HFEMDirichletBC(), LinearNodalConstraint::LinearNodalConstraint(), LowerBoundNodalKernel::LowerBoundNodalKernel(), LowerDIntegratedBC::LowerDIntegratedBC(), NodalScalarKernel::NodalScalarKernel(), NodeElemConstraint::NodeElemConstraint(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), EqualValueEmbeddedConstraint::prepareSecondaryToPrimaryMap(), FVPointValueConstraint::setMyElem(), EqualValueEmbeddedConstraint::shouldApply(), EqualValueBoundaryConstraint::updateConstrainedNodes(), and UpperBoundNodalKernel::UpperBoundNodalKernel().

◆ _name

const std::string MooseBase::_name

protectedinherited

The name of this class.

Definition at line 90 of file MooseBase.h.

◆ _nonlocal_ke

DenseMatrix<Number> TaggingInterface::_nonlocal_ke

protectedinherited

Holds nonlocal Jacobian entries as they are accumulated by this Kernel.

Definition at line 337 of file TaggingInterface.h.

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

◆ _pars

const InputParameters& MooseBaseParameterInterface::_pars

protectedinherited

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

Definition at line 162 of file MooseBaseParameterInterface.h.

◆ _point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 244 of file ScalarCoupleable.h.

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

◆ _real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 238 of file ScalarCoupleable.h.

◆ _residuals

std::vector<ADReal> ADScalarKernel::_residuals

protectedinherited

Residuals for each order.

Definition at line 37 of file ADScalarKernel.h.

Referenced by ADScalarKernel::computeADJacobian().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 227 of file Restartable.h.

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

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 236 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 230 of file Restartable.h.

Referenced by Restartable::restartableName().

◆ _restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 233 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 232 of file ScalarCoupleable.h.

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

◆ _sc_tid

const THREAD_ID ScalarCoupleable::_sc_tid

protectedinherited

Thread ID of the thread using this object.

Definition at line 235 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero

protectedinherited

Zero value of a scalar variable.

Definition at line 241 of file ScalarCoupleable.h.

◆ _subproblem

SubProblem& ResidualObject::_subproblem

protectedinherited

Reference to this kernel's SubProblem.

Definition at line 125 of file ResidualObject.h.

Referenced by ADDGKernel::ADDGKernel(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), ADMortarConstraint::ADMortarConstraint(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), FVAdvection::computeQpResidual(), DGKernel::DGKernel(), FVKernel::FVKernel(), IntegratedBC::IntegratedBC(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), Kernel::Kernel(), LinearNodalConstraint::LinearNodalConstraint(), NodalBC::NodalBC(), NodalKernel::NodalKernel(), NeighborResidualObject::prepareNeighborShapes(), EqualValueEmbeddedConstraint::prepareSecondaryToPrimaryMap(), IntegratedBCBase::prepareShapes(), InterfaceKernelBase::prepareShapes(), DGKernelBase::prepareShapes(), ResidualObject::prepareShapes(), NodalScalarKernel::reinit(), ResidualObject::subProblem(), and EqualValueBoundaryConstraint::updateConstrainedNodes().

◆ _sys

SystemBase& ResidualObject::_sys

protectedinherited

Reference to the EquationSystem object.

Definition at line 131 of file ResidualObject.h.

◆ _t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 61 of file TransientInterface.h.

◆ _t_old

const Real& TransientInterface::_t_old

protectedinherited

Old time.

Definition at line 64 of file TransientInterface.h.

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

◆ _t_step

int& TransientInterface::_t_step

protectedinherited

The number of the time step.

Definition at line 67 of file TransientInterface.h.

Referenced by AccumulateReporter::execute(), IterationInfo::execute(), PIDTransientControl::execute(), ChangeOverTimePostprocessor::finalize(), and ChangeOverFixedPointPostprocessor::finalize().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protectedinherited

Definition at line 50 of file TransientInterface.h.

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

◆ _ti_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 48 of file TransientInterface.h.

◆ _tid

THREAD_ID ResidualObject::_tid

protectedinherited

The thread ID for this kernel.

Definition at line 134 of file ResidualObject.h.

◆ _type

const std::string MooseBase::_type

protectedinherited

The type of this class.

Definition at line 87 of file MooseBase.h.

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

◆ _u

const ADVariableValue& ADScalarKernel::_u

protectedinherited

The current solution.

Definition at line 34 of file ADScalarKernel.h.

◆ _u_dot

const ADVariableValue& ADScalarTimeKernel::_u_dot

protectedinherited

Time derivative of the kernel variable.

Definition at line 23 of file ADScalarTimeKernel.h.

Referenced by computeQpResidual().

◆ _var

MooseVariableScalar& ScalarKernelBase::_var

protectedinherited

Scalar variable.

Definition at line 51 of file ScalarKernelBase.h.

Referenced by ADScalarKernel::computeADJacobian(), ScalarKernel::computeJacobian(), ODEKernel::computeJacobian(), NodalEqualValueConstraint::computeJacobian(), ODEKernel::computeOffDiagJacobianScalar(), NodalScalarKernel::computeOffDiagJacobianScalar(), ScalarKernel::computeResidual(), ODEKernel::computeResidual(), ADScalarKernel::computeResidual(), ODETimeKernel::computeResidual(), NodalEqualValueConstraint::computeResidual(), ParsedODEKernel::ParsedODEKernel(), ScalarKernelBase::uOld(), and ScalarKernelBase::variable().

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

include/scalarkernels/ADScalarTimeDerivative.h
src/scalarkernels/ADScalarTimeDerivative.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Member Enumeration Documentation

◆ ResidualTagType

Constructor & Destructor Documentation

◆ ADScalarTimeDerivative()

Member Function Documentation

◆ accumulateTaggedLocalMatrix() [1/3]

◆ accumulateTaggedLocalMatrix() [2/3]

◆ accumulateTaggedLocalMatrix() [3/3]

◆ accumulateTaggedLocalResidual()

◆ accumulateTaggedNonlocalMatrix()

◆ adCoupledScalarDot()

◆ adCoupledScalarValue()

◆ addJacobian() [1/2]

◆ addJacobian() [2/2]

◆ addJacobianElement()

◆ addJacobianWithoutConstraints()

◆ addPostprocessorDependencyHelper()

◆ addResiduals() [1/2]

◆ addResiduals() [2/2]

◆ addResidualsAndJacobian()

◆ addResidualsAndJacobianWithoutConstraints()

◆ addResidualsWithoutConstraints()

◆ addUserObjectDependencyHelper()

◆ addVectorPostprocessorDependencyHelper()

◆ assignTaggedLocalMatrix()

◆ assignTaggedLocalResidual()

◆ callMooseError()

◆ computeJacobian()

◆ computeNonlocalJacobian()

◆ computeNonlocalOffDiagJacobian()

◆ computeOffDiagJacobian()

◆ computeOffDiagJacobianScalar()

◆ computeQpResidual()

◆ computeResidual()

◆ computeResidualAndJacobian()

◆ connectControllableParams()

◆ coupledGenericScalarValue() [1/3]

◆ coupledGenericScalarValue() [2/3]

◆ coupledGenericScalarValue() [3/3]

◆ coupledMatrixTagScalarValue()

◆ coupledPostprocessors()

◆ coupledScalar()

◆ coupledScalarComponents()

◆ coupledScalarDot()

◆ coupledScalarDotDot()

◆ coupledScalarDotDotDu()

◆ coupledScalarDotDotOld()

◆ coupledScalarDotDu()

◆ coupledScalarDotOld()

◆ coupledScalarOrder()

◆ coupledScalarValue()

◆ coupledScalarValueOld()

◆ coupledScalarValueOlder()

◆ coupledVectorTagScalarValue()

◆ customSetup()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ determineState()

◆ enabled()

◆ errorPrefix()

◆ getCheckedPointerParam()

◆ getCoupledMooseScalarVars()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getExecuteOnEnum()

◆ getFunction()