Class for stuff related to variables. More...

#include <FVInitialConditionTempl.h>

Inheritance diagram for MooseVariableField< OutputType >:

Public Types
typedef libMesh::TensorTools::IncrementRank< OutputType >::type	OutputGradient

typedef libMesh::TensorTools::IncrementRank< OutputGradient >::type	OutputSecond

typedef libMesh::TensorTools::DecrementRank< OutputType >::type	OutputDivergence

typedef MooseArray< OutputType >	FieldVariableValue

typedef MooseArray< OutputGradient >	FieldVariableGradient

typedef MooseArray< OutputSecond >	FieldVariableSecond

typedef MooseArray< OutputType >	FieldVariableCurl

typedef MooseArray< OutputDivergence >	FieldVariableDivergence

typedef Moose::ShapeType< OutputType >::type	OutputShape

typedef libMesh::TensorTools::IncrementRank< OutputShape >::type	OutputShapeGradient

typedef libMesh::TensorTools::IncrementRank< OutputShapeGradient >::type	OutputShapeSecond

typedef libMesh::TensorTools::DecrementRank< OutputShape >::type	OutputShapeDivergence

typedef MooseArray< std::vector< OutputShape > >	FieldVariablePhiValue

typedef MooseArray< std::vector< OutputShapeGradient > >	FieldVariablePhiGradient

typedef MooseArray< std::vector< OutputShapeSecond > >	FieldVariablePhiSecond

typedef MooseArray< std::vector< OutputShape > >	FieldVariablePhiCurl

typedef MooseArray< std::vector< OutputShapeDivergence > >	FieldVariablePhiDivergence

typedef MooseArray< std::vector< OutputShape > >	FieldVariableTestValue

typedef MooseArray< std::vector< OutputShapeGradient > >	FieldVariableTestGradient

typedef MooseArray< std::vector< OutputShapeSecond > >	FieldVariableTestSecond

typedef MooseArray< std::vector< OutputShape > >	FieldVariableTestCurl

typedef MooseArray< std::vector< OutputShapeDivergence > >	FieldVariableTestDivergence

typedef Moose::DOFType< OutputType >::type	OutputData

typedef MooseArray< OutputData >	DoFValue

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

using	FunctorType = FunctorBase< Moose::ADType< OutputType >::type >

using	ValueType = Moose::ADType< OutputType >::type

using	GradientType = typename FunctorReturnType< Moose::ADType< OutputType >::type, FunctorEvaluationKind::Gradient >::type
	This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array). More...

using	DotType = ValueType

Public Member Functions
	MooseVariableField (const InputParameters &parameters)

virtual Moose::VarFieldType	fieldType () const override
	Field type of this variable. More...

virtual bool	isArray () const override

virtual bool	isVector () const override

virtual void	setNodalValue (const OutputType &value, unsigned int idx=0)=0

virtual const ADTemplateVariableValue< OutputType > &	adSln () const =0
	AD solution getter. More...

virtual const ADTemplateVariableValue< OutputType > &	adSlnNeighbor () const =0
	AD neighbor solution getter. More...

virtual const ADTemplateVariableGradient< OutputType > &	adGradSln () const =0
	AD grad solution getter. More...

virtual const ADTemplateVariableGradient< OutputType > &	adGradSlnDot () const =0
	AD grad of time derivative solution getter. More...

virtual const ADTemplateVariableCurl< OutputType > &	adCurlSln () const =0
	AD curl solution getter. More...

virtual const ADTemplateVariableGradient< OutputType > &	adGradSlnNeighbor () const =0
	AD grad neighbor solution getter. More...

virtual const ADTemplateVariableGradient< OutputType > &	adGradSlnNeighborDot () const =0
	AD grad of time derivative neighbor solution getter. More...

virtual const ADTemplateVariableCurl< OutputType > &	adCurlSlnNeighbor () const =0
	AD curl neighbor solution getter. More...

virtual const ADTemplateVariableSecond< OutputType > &	adSecondSln () const =0
	AD second solution getter. More...

virtual const ADTemplateVariableSecond< OutputType > &	adSecondSlnNeighbor () const =0
	AD second neighbor solution getter. More...

virtual const ADTemplateVariableValue< OutputType > &	adUDot () const =0
	AD time derivative getter. More...

virtual const ADTemplateVariableValue< OutputType > &	adUDotDot () const =0
	AD second time derivative getter. More...

virtual const ADTemplateVariableValue< OutputType > &	adUDotNeighbor () const =0
	AD neighbor time derivative getter. More...

virtual const ADTemplateVariableValue< OutputType > &	adUDotDotNeighbor () const =0
	AD neighbor second time derivative getter. More...

virtual const MooseArray< ADReal > &	adDofValues () const =0
	Return the AD dof values. More...

virtual const MooseArray< ADReal > &	adDofValuesNeighbor () const =0
	Return the AD neighbor dof values. More...

virtual const MooseArray< ADReal > &	adDofValuesDot () const =0
	Return the AD time derivatives at dofs. More...

virtual const FieldVariableValue &	sln () const =0

virtual const FieldVariableValue &	slnOld () const =0

virtual const FieldVariableValue &	slnNeighbor () const =0

virtual const FieldVariableValue &	slnOldNeighbor () const =0

virtual const FieldVariableValue &	slnOlder () const =0

virtual const FieldVariableGradient &	gradSln () const =0
	element gradients More...

virtual const FieldVariableGradient &	gradSlnOld () const =0

virtual const FieldVariableGradient &	gradSlnNeighbor () const =0
	neighbor solution gradients More...

virtual const FieldVariableGradient &	gradSlnOldNeighbor () const =0

virtual bool	computingSecond () const =0
	Whether or not this variable is computing any second derivatives. More...

virtual bool	computingCurl () const =0
	Whether or not this variable is computing any curl quantities. More...

virtual bool	computingDiv () const =0
	Whether or not this variable is computing any divergence quantities. More...

virtual const FieldVariablePhiValue &	phi () const =0
	Return the variable's elemental shape functions. More...

virtual const FieldVariablePhiGradient &	gradPhi () const =0
	Return the gradients of the variable's elemental shape functions. More...

virtual const FieldVariablePhiSecond &	secondPhi () const =0
	Return the rank-2 tensor of second derivatives of the variable's elemental shape functions. More...

virtual const FieldVariablePhiValue &	curlPhi () const =0
	Curl of the shape functions. More...

virtual const FieldVariablePhiDivergence &	divPhi () const =0
	Divergence of the shape functions. More...

virtual const FieldVariablePhiValue &	phiFace () const =0
	Return the variable's shape functions on an element face. More...

virtual const FieldVariablePhiGradient &	gradPhiFace () const =0
	Return the gradients of the variable's shape functions on an element face. More...

virtual const FieldVariablePhiSecond &	secondPhiFace () const =0
	Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face. More...

virtual const FieldVariablePhiValue &	phiFaceNeighbor () const =0
	Return the variable's shape functions on a neighboring element face. More...

virtual const FieldVariablePhiGradient &	gradPhiFaceNeighbor () const =0
	Return the gradients of the variable's shape functions on a neighboring element face. More...

virtual const FieldVariablePhiSecond &	secondPhiFaceNeighbor () const =0
	Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element face. More...

virtual const FieldVariablePhiValue &	phiNeighbor () const =0
	Return the variable's shape functions on a neighboring element. More...

virtual const FieldVariablePhiGradient &	gradPhiNeighbor () const =0
	Return the gradients of the variable's shape functions on a neighboring element. More...

virtual const FieldVariablePhiSecond &	secondPhiNeighbor () const =0
	Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element. More...

virtual const FieldVariablePhiValue &	phiLower () const =0
	Return the variable's shape functions on a lower-dimensional element. More...

virtual void	setDofValues (const DenseVector< OutputData > &values)=0
	Set local DOF values and evaluate the values on quadrature points. More...

virtual void	setLowerDofValues (const DenseVector< OutputData > &values)=0
	Set local DOF values for a lower dimensional element and evaluate the values on quadrature points. More...

bool	usesPhiNeighbor () const
	Whether or not this variable is actually using the shape function value. More...

bool	usesGradPhiNeighbor () const
	Whether or not this variable is actually using the shape function gradient. More...

virtual bool	usesSecondPhiNeighbor () const =0
	Whether or not this variable is actually using the shape function second derivatives. More...

virtual void	clearDofIndices ()=0
	Clear out the dof indices. More...

virtual void	prepare ()=0
	Prepare the elemental degrees of freedom. More...

virtual void	prepareNeighbor ()=0
	Prepare the neighbor element degrees of freedom. More...

virtual void	prepareLowerD ()=0
	Prepare a lower dimensional element's degrees of freedom. More...

virtual void	prepareAux ()=0

virtual void	reinitNode ()=0

virtual void	reinitAux ()=0

virtual void	reinitAuxNeighbor ()=0

virtual void	reinitNodes (const std::vector< dof_id_type > &nodes)=0

virtual void	reinitNodesNeighbor (const std::vector< dof_id_type > &nodes)=0

const std::string &	componentName (const unsigned int comp) const
	Get the variable name of a component in libMesh. More...

virtual bool	isFV () const

virtual bool	isNodalDefined () const =0
	Is this variable defined at nodes. More...

virtual const dof_id_type &	nodalDofIndex () const =0

virtual const dof_id_type &	nodalDofIndexNeighbor () const =0

virtual const Elem *const &	currentElem () const =0
	Current element this variable is evaluated at. More...

const std::set< SubdomainID > &	activeSubdomains () const
	The subdomains the variable is active on. More...

bool	activeOnSubdomain (SubdomainID subdomain) const
	Is the variable active on the subdomain? More...

bool	activeOnSubdomains (const std::set< SubdomainID > &subdomains) const
	Is the variable active on the subdomains? More...

virtual bool	needsGradientVectorStorage () const
	Check if this variable needs a raw vector of gradients at dof-values. More...

virtual void	prepareIC ()=0
	Prepare the initial condition. More...

virtual void	computeFaceValues (const FaceInfo &)
	Compute values at face quadrature points for the element+neighbor (both sides of the face). More...

virtual void	computeElemValues ()=0
	Compute values at interior quadrature points. More...

virtual void	computeElemValuesFace ()=0
	Compute values at facial quadrature points. More...

virtual void	computeNeighborValuesFace ()=0
	Compute values at facial quadrature points for the neighbor. More...

virtual void	computeNeighborValues ()=0
	Compute values at quadrature points for the neighbor. More...

virtual void	computeLowerDValues ()=0
	compute values at quadrature points on the lower dimensional element More...

virtual void	computeNodalNeighborValues ()=0
	Compute nodal values of this variable in the neighbor. More...

virtual void	computeNodalValues ()=0
	Compute nodal values of this variable. More...

virtual const std::vector< dof_id_type > &	dofIndicesNeighbor () const =0
	Get neighbor DOF indices for currently selected element. More...

virtual const std::vector< dof_id_type > &	dofIndicesLower () const =0
	Get dof indices for the current lower dimensional element (this is meaningful when performing mortar FEM) More...

virtual unsigned int	numberOfDofsNeighbor ()=0

virtual void	insert (libMesh::NumericVector< libMesh::Number > &vector)=0
	Insert the currently cached degree of freedom values into the provided `vector`. More...

virtual void	insertLower (libMesh::NumericVector< libMesh::Number > &vector)=0
	Insert the currently cached degree of freedom values for a lower-dimensional element into the provided `vector`. More...

virtual void	add (libMesh::NumericVector< libMesh::Number > &vector)=0
	Add the currently cached degree of freedom values into the provided `vector`. More...

virtual std::size_t	phiSize () const =0
	Return phi size. More...

virtual std::size_t	phiFaceSize () const =0
	Return phiFace size. More...

virtual std::size_t	phiNeighborSize () const =0
	Return phiNeighbor size. More...

virtual std::size_t	phiFaceNeighborSize () const =0
	Return phiFaceNeighbor size. More...

virtual std::size_t	phiLowerSize () const =0
	Return the number of shape functions on the lower dimensional element for this variable. More...

virtual unsigned int	oldestSolutionStateRequested () const =0
	The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc). More...

const std::string &	arrayVariableComponent (const unsigned int i) const
	Returns the variable name of a component of an array variable. More...

unsigned int	number () const
	Get variable number coming from libMesh. More...

const libMesh::FEType &	feType () const
	Get the type of finite element object. More...

SystemBase &	sys ()
	Get the system this variable is part of. More...

const SystemBase &	sys () const
	Get the system this variable is part of. More...

const std::string &	name () const override
	Get the variable name. More...

bool	useDual () const
	Get dual mortar option. More...

const std::vector< dof_id_type > &	allDofIndices () const
	Get all global dofindices for the variable. More...

unsigned int	totalVarDofs ()

Moose::VarKindType	kind () const
	Kind of the variable (Nonlinear, Auxiliary, ...) More...

void	scalingFactor (const std::vector< Real > &factor)
	Set the scaling factor for this variable. More...

Real	scalingFactor () const
	Get the scaling factor for this variable. More...

const std::vector< Real > &	arrayScalingFactor () const

libMesh::Order	order () const
	Get the order of this variable Note: Order enum can be implicitly converted to unsigned int. More...

unsigned int	count () const
	Get the number of components Note: For standard and vector variables, the number is one. More...

virtual bool	isNodal () const
	Is this variable nodal. More...

virtual bool	hasDoFsOnNodes () const
	Does this variable have DoFs on nodes. More...

virtual libMesh::FEContinuity	getContinuity () const
	Return the continuity of this variable. More...

const libMesh::DofMap &	dofMap () const
	The DofMap associated with the system this variable is in. More...

virtual void	getDofIndices (const Elem *, std::vector< dof_id_type > &) const

virtual const std::vector< dof_id_type > &	dofIndices () const
	Get local DoF indices. More...

std::vector< dof_id_type >	componentDofIndices (const std::vector< dof_id_type > &dof_indices, unsigned int component) const
	Obtain DoF indices of a component with the indices of the 0th component. More...

virtual unsigned int	numberOfDofs () const
	Get the number of local DoFs. More...

bool	eigen () const
	Whether or not this variable operates on an eigen kernel. More...

void	eigen (bool eigen)
	Mark this variable as an eigen var or non-eigen var. More...

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

virtual void	clearAllDofIndices ()

virtual void	setActiveTags (const std::set< TagID > &vtags)
	Set the active vector tags. More...

bool	isLowerD () const

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

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 *	queryParam (const std::string &name) const
	Query a parameter 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...

const std::vector< SubdomainName > &	blocks () const
	Return the block names for this object. More...

unsigned int	numBlocks () const
	Return the number of blocks for this object. More...

virtual const std::set< SubdomainID > &	blockIDs () const
	Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids. More...

unsigned int	blocksMaxDimension () const
	Return the largest mesh dimension of the elements in the blocks for this object. More...

bool	hasBlocks (const SubdomainName &name) const
	Test if the supplied block name is valid for this object. More...

bool	hasBlocks (const std::vector< SubdomainName > &names) const
	Test if the supplied vector of block names are valid for this object. More...

bool	hasBlocks (const std::set< SubdomainName > &names) const
	Test if the supplied set of block names are valid for this object. More...

bool	hasBlocks (const std::vector< SubdomainID > &ids) const
	Test if the supplied vector block ids are valid for this object. More...

bool	hasBlocks (const std::set< SubdomainID > &ids) const
	Test if the supplied set of block ids are valid for this object. More...

bool	isBlockSubset (const std::set< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const
	Test if the class block ids are a subset of the supplied objects. More...

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

const std::set< SubdomainID > &	meshBlockIDs () const
	Return all of the SubdomainIDs for the mesh. More...

virtual bool	blockRestricted () const
	Returns true if this object has been restricted to a block. More...

virtual void	checkVariable (const MooseVariableFieldBase &variable) const
	Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. More...

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

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

virtual void	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...

FunctorReturnType< Moose::ADType< OutputType >::type, FET >::type	genericEvaluate (const Space &r, const State &state) const
	Perform a generic evaluation based on the supplied template argument `FET` and supplied spatial and temporal arguments. More...

const MooseFunctorName &	functorName () const
	Return the functor name. More...

virtual void	customSetup (const ExecFlagType &exec_type) override

void	setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
	Set how often to clear the functor evaluation cache. More...

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
	Returns whether this (sided) face is an extrapolated boundary face for this functor. More...

bool	isInternalFace (const FaceInfo &) const
	Returns true if the face is an internal face. More...

virtual bool	isConstant () const
	Returns true if this functor is a constant. More...

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

void	checkFace (const Moose::FaceArg &face) const
	Examines the incoming face argument. More...

virtual bool	supportsFaceArg () const=0
	Whether this functor supports evaluation with FaceArg. More...

virtual bool	supportsElemSideQpArg () const=0
	Whether this functor supports evaluation with ElemSideQpArg. More...

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


virtual void	setDofValue (const OutputData &value, unsigned int index)=0
	Degree of freedom value setters. More...


virtual const MooseArray< OutputType > &	nodalValueArray () const =0
	Methods for retrieving values of variables at the nodes in a MooseArray for AuxKernelBase. More...

virtual const MooseArray< OutputType > &	nodalValueOldArray () const =0

virtual const MooseArray< OutputType > &	nodalValueOlderArray () const =0


ValueType	operator() (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluate` overloads with the same arguments but allows for caching implementation. More...

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const


GradientType	gradient (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateGradient` overloads with the same arguments but allows for caching implementation. More...

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const


DotType	dot (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateDot` overloads with the same arguments but allows for caching implementation. More...

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const


GradientType	gradDot (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluateGradDot` overloads with the same arguments but allows for caching implementation. More...

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) 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
bool	doDerivatives () const

virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)
	A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...

void	initializeBlockRestrictable (const MooseObject *moose_object)
	An initialization routine needed for dual constructors. More...

Moose::CoordinateSystemType	getBlockCoordSystem ()
	Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...

Functor evaluation routines
These methods are all for evaluating functors with different kinds of spatial arguments. Each of these methods also takes a state argument. For a description of the state argument, please see the `StateArg` doxygen
virtual ValueType	evaluate (const ElemArg &elem, const StateArg &state) const=0
	Evaluate the functor with a given element. More...

virtual ValueType	evaluate (const FaceArg &face, const StateArg &state) const=0

virtual ValueType	evaluate (const ElemQpArg &qp, const StateArg &state) const=0

virtual ValueType	evaluate (const ElemSideQpArg &side_qp, const StateArg &state) const=0

virtual ValueType	evaluate (const ElemPointArg &elem_point, const StateArg &state) const=0
	Evaluate the functor with a given element and point. More...

virtual ValueType	evaluate (const NodeArg &node, const StateArg &state) const=0

virtual GradientType	evaluateGradient (const ElemArg &, const StateArg &) const
	Evaluate the functor gradient with a given element. More...

virtual GradientType	evaluateGradient (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemPointArg &, const StateArg &) const
	Evaluate the functor gradient with a given element and point. More...

virtual GradientType	evaluateGradient (const NodeArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemArg &, const StateArg &) const
	Evaluate the functor time derivative with a given element. More...

virtual DotType	evaluateDot (const FaceArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemSideQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemPointArg &, const StateArg &) const
	Evaluate the functor time derivative with a given element and point. More...

virtual DotType	evaluateDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const
	Evaluate the functor gradient-dot with a given element. More...

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const
	Evaluate the functor gradient-dot with a given element and point. More...

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

Protected Attributes
SystemBase &	_sys
	System this variable is part of. More...

libMesh::FEType	_fe_type
	The FEType associated with this variable. More...

unsigned int	_var_num
	variable number (from libMesh) More...

unsigned int	_index
	variable number within MOOSE More...

bool	_is_eigen
	Whether or not this variable operates on eigen kernels. More...

Moose::VarKindType	_var_kind
	Variable type (see MooseTypes.h) More...

SubProblem &	_subproblem
	Problem this variable is part of. More...

const libMesh::Variable &	_variable
	libMesh variable object for this variable More...

Assembly &	_assembly
	Assembly data. More...

const libMesh::DofMap &	_dof_map
	DOF map. More...

std::vector< dof_id_type >	_dof_indices
	DOF indices. More...

MooseMesh &	_mesh
	mesh the variable is active in More...

THREAD_ID	_tid
	Thread ID. More...

const unsigned int	_count
	Number of variables in the array. More...

std::vector< Real >	_scaling_factor
	scaling factor for this variable More...

std::string	_var_name
	Variable name. More...

bool	_use_dual
	If dual mortar approach is used. More...

bool	_is_lower_d
	Whether this variable lives on lower dimensional blocks. More...

std::vector< std::string >	_array_var_component_names
	Array variable names when the variable is an array variable. 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 MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object. More...

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

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

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

const TimeIntegrator *const	_time_integrator
	the time integrator used for computing time derivatives More...

ADReal	_ad_real_dummy = 0
	A dummy ADReal variable. More...

virtual const DoFValue &	dofValues () const =0
	dof values getters More...

virtual const DoFValue &	dofValuesOld () const =0

virtual const DoFValue &	dofValuesOlder () const =0

virtual const DoFValue &	dofValuesPreviousNL () const =0

virtual const DoFValue &	dofValuesNeighbor () const =0

virtual const DoFValue &	dofValuesOldNeighbor () const =0

virtual const DoFValue &	dofValuesOlderNeighbor () const =0

virtual const DoFValue &	dofValuesPreviousNLNeighbor () const =0

virtual const DoFValue &	dofValuesDot () const =0

virtual const DoFValue &	dofValuesDotNeighbor () const =0

virtual const DoFValue &	dofValuesDotOld () const =0

virtual const DoFValue &	dofValuesDotOldNeighbor () const =0

virtual const DoFValue &	dofValuesDotDot () const =0

virtual const DoFValue &	dofValuesDotDotNeighbor () const =0

virtual const DoFValue &	dofValuesDotDotOld () const =0

virtual const DoFValue &	dofValuesDotDotOldNeighbor () const =0

virtual const MooseArray< libMesh::Number > &	dofValuesDuDotDu () const =0

virtual const MooseArray< libMesh::Number > &	dofValuesDuDotDuNeighbor () const =0

virtual const MooseArray< libMesh::Number > &	dofValuesDuDotDotDu () const =0

virtual const MooseArray< libMesh::Number > &	dofValuesDuDotDotDuNeighbor () const =0

template<bool is_ad>
const MooseArray< GenericReal< is_ad > > &	genericDofValues () const

virtual const FieldVariableValue &	vectorTagValue (TagID tag) const =0
	tag values getters More...

virtual const DoFValue &	nodalVectorTagValue (TagID tag) const =0

virtual const DoFValue &	vectorTagDofValue (TagID tag) const =0

virtual const DoFValue &	nodalMatrixTagValue (TagID tag) const =0

virtual const FieldVariableValue &	matrixTagValue (TagID tag) const =0

virtual void	residualSetup () override

virtual void	jacobianSetup () override

virtual void	timestepSetup () override

bool	hasBlocks (const SubdomainID id) const override
	Returns whether the functor is defined on this block. More...

const libMesh::NumericVector< libMesh::Number > &	getSolution (const Moose::StateArg &state) const
	Get the solution corresponding to the provided state. More...

Detailed Description

template<typename OutputType>
class MooseVariableField< OutputType >

Class for stuff related to variables.

Each variable can compute nodal or elemental (at QPs) values.

OutputType OutputShape OutputData

Real Real Real RealVectorValue RealVectorValue Real RealEigenVector Real RealEigenVector

Definition at line 23 of file FVInitialConditionTempl.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

MooseVariableField< OutputType >::MooseVariableField ( const InputParameters & parameters )

Definition at line 26 of file MooseVariableField.C.

   : MooseVariableFieldBase(parameters),
     Moose::FunctorBase<typename Moose::ADType<OutputType>::type>(name()),
     MeshChangedInterface(parameters),
     _time_integrator(_sys.queryTimeIntegrator(_var_num))
 {
 }

Member Function Documentation

◆ activeOnSubdomain()

bool MooseVariableFieldBase::activeOnSubdomain ( SubdomainID subdomain ) const

inherited

Is the variable active on the subdomain?

Parameters

subdomain The subdomain id in question

Returns: true if active on subdomain, false otherwise

Definition at line 45 of file MooseVariableFieldBase.C.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInternalFace(), FlagElementsThread::onElement(), and ComputeDiracThread::onElement().

 {
   return this->_sys.system().variable(_var_num).active_on_subdomain(subdomain);
 }

◆ activeOnSubdomains()

bool MooseVariableFieldBase::activeOnSubdomains ( const std::set< SubdomainID > & subdomains ) const

inherited

Is the variable active on the subdomains?

Parameters

subdomains The subdomain ids in question

Returns: true if active on all provided subdomains, false otherwise

Definition at line 51 of file MooseVariableFieldBase.C.

Referenced by BlockRestrictable::checkVariable(), and ComputeFullJacobianThread::computeOnInternalFace().

 {
   const auto & active_subs = activeSubdomains();
   return std::includes(
       active_subs.begin(), active_subs.end(), subdomains.begin(), subdomains.end());
 }

◆ activeSubdomains()

const std::set< SubdomainID > & MooseVariableFieldBase::activeSubdomains ( ) const

inherited

The subdomains the variable is active on.

Definition at line 39 of file MooseVariableFieldBase.C.

Referenced by SetupResidualDebugAction::act(), MooseVariableFieldBase::activeOnSubdomains(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), BlockRestrictable::checkVariable(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

 {
   return this->_sys.system().variable(_var_num).active_subdomains();
 }

◆ adCurlSln()

template<typename OutputType>

virtual const ADTemplateVariableCurl<OutputType>& MooseVariableField< OutputType >::adCurlSln ( ) const

pure virtual

AD curl solution getter.

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ adCurlSlnNeighbor()

template<typename OutputType>

virtual const ADTemplateVariableCurl<OutputType>& MooseVariableField< OutputType >::adCurlSlnNeighbor ( ) const

pure virtual

AD curl neighbor solution getter.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

const std::vector< dof_id_type > & MooseVariableBase::allDofIndices ( ) const

inherited

Get all global dofindices for the variable.

Definition at line 201 of file MooseVariableBase.C.

Referenced by FEProblemBase::addJacobianBlockTags(), Assembly::addJacobianNonlocal(), Assembly::cacheJacobianNonlocal(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), Assembly::prepareNonlocal(), Assembly::prepareVariableNonlocal(), and MooseVariableBase::totalVarDofs().

 {
   const auto it = _sys.subproblem()._var_dof_map.find(name());
   if (it != _sys.subproblem()._var_dof_map.end())
     return it->second;
   else
     mooseError("VariableAllDoFMap not prepared for ",
                name(),
                " . Check nonlocal coupling requirement for the variable.");
 }

◆ arrayScalingFactor()

const std::vector<Real>& MooseVariableBase::arrayScalingFactor ( ) const

inlineinherited

Definition at line 99 of file MooseVariableBase.h.

Referenced by Assembly::addJacobianBlock(), Assembly::addJacobianBlockNonlocal(), and Assembly::cacheJacobianBlockNonzero().

99 { return _scaling_factor; }

MooseVariableBase::_scaling_factor

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition: MooseVariableBase.h:240

◆ arrayVariableComponent()

const std::string & MooseVariableBase::arrayVariableComponent ( const unsigned int i ) const

inherited

Returns the variable name of a component of an array variable.

Definition at line 192 of file MooseVariableBase.C.

Referenced by MooseVariableFieldBase::componentName(), AdvancedOutput::initAvailableLists(), and AdvancedOutput::initShowHideLists().

 {
   mooseAssert(
       i < _array_var_component_names.size(),
       "Requested array variable component number is greater than the number of component names.");
   return _array_var_component_names[i];
 }

◆ blockIDs()

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

virtualinherited

Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids.

Returns: a set of SubdomainIDs that are valid for this object

Definition at line 194 of file BlockRestrictable.C.

Referenced by FunctorMaterial::addFunctorProperty(), DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), NodalPatchRecoveryAuxBase::blockRestrictElements(), ComboMarker::ComboMarker(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), BlockRestrictable::getBlockCoordSystem(), MaterialBase::getGenericZeroMaterialPropertyByName(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), IndicatorMarker::IndicatorMarker(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), FunctorExtremaPositions::initialize(), MooseVariableBase::MooseVariableBase(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), ProjectionAux::ProjectionAux(), MaterialBase::registerPropName(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

 {
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
     return _blk_mesh->meshSubdomains();
   else
     return _blk_ids;
 }

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 182 of file BlockRestrictable.C.

Referenced by NodalPatchRecoveryAuxBase::blockRestrictElements(), BlockRestrictable::checkVariable(), SubdomainsDivision::divisionIndex(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), BlockRestrictable::initializeBlockRestrictable(), SolutionIC::initialSetup(), MooseVariableBase::MooseVariableBase(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

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

◆ blocks()

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

inherited

Return the block names for this object.

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

Returns: vector of SubdomainNames that are valid for this object

Definition at line 188 of file BlockRestrictable.C.

Referenced by MaterialOutputAction::getParams(), SubdomainsDivision::initialize(), and SolutionIC::initialSetup().

 {
   return _blocks;
 }

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

Return the largest mesh dimension of the elements in the blocks for this object.

Definition at line 371 of file BlockRestrictable.C.

 {
   mooseAssert(_blk_dim != libMesh::invalid_uint, "Block restriction not initialized");
   return _blk_dim;
 }

◆ buildOutputHideVariableList()

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

inherited

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

Parameters

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

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

Definition at line 61 of file OutputInterface.C.

Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface::OutputInterface().

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

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

◆ checkFace()

void Moose::FunctorBase< Moose::ADType< OutputType >::type >::checkFace ( const Moose::FaceArg & face ) const

inherited

Examines the incoming face argument.

If the face argument producer (residual object, postprocessor, etc.) did not indicate a sidedness to the face, e.g. if the face_side member of the FaceArg is nullptr, then we may "modify" the sidedness of the argument if we are only defined on one side of the face. If the face argument producer has indicated a sidedness and we are not defined on that side, then we will error

Parameters

face	The face argument created by the face argument producer, likely a residual object

Returns: A face with possibly changed sidedness depending on whether we aren't defined on both sides of the face

Definition at line 732 of file MooseFunctor.h.

 {
 #if DEBUG
   const Elem * const elem = face.face_side;
   const FaceInfo * const fi = face.fi;
   mooseAssert(fi, "face info should be non-null");
   bool check_elem_def = false;
   bool check_neighbor_def = false;
   // We check if the functor is defined on both sides of the face
   if (!elem)
   {
     if (!hasFaceSide(*fi, true))
       check_neighbor_def = true;
     else if (!hasFaceSide(*fi, false))
       check_elem_def = true;
   }
   else if (elem == fi->elemPtr())
     check_elem_def = true;
   else
   {
     mooseAssert(elem == fi->neighborPtr(), "This has to match something");
     check_neighbor_def = true;
   }
 
   if (check_elem_def && !hasFaceSide(*fi, true))
   {
     std::string additional_message = "It is not defined on the neighbor side either.";
     if (hasFaceSide(*fi, false))
       additional_message = "It is however defined on the neighbor side.";
     additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
     mooseError(_functor_name,
                " is not defined on the element side of the face information, but a face argument "
                "producer "
                "(e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
                additional_message);
   }
   if (check_neighbor_def && !hasFaceSide(*fi, false))
   {
     std::string additional_message = "It is not defined on the element side either.";
     if (hasFaceSide(*fi, true))
       additional_message = "It is however defined on the element side.";
     additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
     mooseError(
         _functor_name,
         " is not defined on the neighbor side of the face information, but a face argument "
         "producer (e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
         additional_message);
   }
 #endif
 }

◆ checkVariable()

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

virtualinherited

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

Parameters

variable The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 343 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

 {
   // a variable defined on all internal sides does not need this check because
   // it can be coupled with other variables in DG kernels
   if (!_blk_mesh->interiorLowerDBlocks().empty() &&
       variable.activeOnSubdomains(_blk_mesh->interiorLowerDBlocks()))
     return;
 
   if (!isBlockSubset(variable.activeSubdomains()))
   {
     std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
     std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
     mooseError("The 'block' parameter of the object '",
                _blk_name,
                "' must be a subset of the 'block' parameter of the variable '",
                variable.name(),
                "':\n    Object '",
                _blk_name,
                "': ",
                obj_ids,
                "\n    Variable '",
                variable.name(),
                "': ",
                var_ids);
   }
 }

◆ clearAllDofIndices()

virtual void MooseVariableBase::clearAllDofIndices ( )

inlinevirtualinherited

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Definition at line 172 of file MooseVariableBase.h.

172 { _dof_indices.clear(); }

MooseVariableBase::_dof_indices

std::vector< dof_id_type > _dof_indices

DOF indices.

Definition: MooseVariableBase.h:228

◆ clearDofIndices()

virtual void MooseVariableFieldBase::clearDofIndices ( )

pure virtualinherited

Clear out the dof indices.

We do this in case this variable is not going to be prepared at all...

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ componentDofIndices()

std::vector< dof_id_type > MooseVariableBase::componentDofIndices	(	const std::vector< dof_id_type > &	dof_indices,
		unsigned int	component
	)		const

inherited

Obtain DoF indices of a component with the indices of the 0th component.

Definition at line 219 of file MooseVariableBase.C.

Referenced by Assembly::addJacobianBlock(), and Assembly::cacheJacobianBlockNonzero().

 {
   std::vector<dof_id_type> new_dof_indices(dof_indices);
   if (component != 0)
   {
     if (isNodal())
       for (auto & id : new_dof_indices)
         id += component;
     else
     {
       unsigned int n = dof_indices.size();
       for (auto & id : new_dof_indices)
         id += component * n;
     }
   }
   return new_dof_indices;
 }

◆ componentName()

const std::string & MooseVariableFieldBase::componentName ( const unsigned int comp ) const

inherited

Get the variable name of a component in libMesh.

Definition at line 27 of file MooseVariableFieldBase.C.

 {
   if (comp >= _count)
     mooseError("Component index must be less than the number of components of variable ",
                _var_name);
   if (isArray())
     return this->arrayVariableComponent(comp);
   else
     return _var_name;
 }

◆ computeElemValues()

virtual void MooseVariableFieldBase::computeElemValues ( )

pure virtualinherited

◆ computeElemValuesFace()

virtual void MooseVariableFieldBase::computeElemValuesFace ( )

pure virtualinherited

◆ computeFaceValues()

virtual void MooseVariableFieldBase::computeFaceValues ( const FaceInfo & )

inlinevirtualinherited

Compute values at face quadrature points for the element+neighbor (both sides of the face).

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 131 of file MooseVariableFieldBase.h.

131 { mooseError("not implemented"); }

MooseBaseErrorInterface::mooseError

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

Emits an error prefixed with object name and type.

Definition: MooseBaseErrorInterface.h:29

◆ computeLowerDValues()

virtual void MooseVariableFieldBase::computeLowerDValues ( )

pure virtualinherited

compute values at quadrature points on the lower dimensional element

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

◆ computeNeighborValues()

virtual void MooseVariableFieldBase::computeNeighborValues ( )

template<typename OutputType>

virtual bool MooseVariableField< OutputType >::computingCurl ( ) const

pure virtual

Whether or not this variable is computing any curl quantities.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ computingDiv()

template<typename OutputType>

virtual bool MooseVariableField< OutputType >::computingDiv ( ) const

pure virtual

Whether or not this variable is computing any divergence quantities.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ computingSecond()

template<typename OutputType>

virtual bool MooseVariableField< OutputType >::computingSecond ( ) const

pure virtual

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

◆ count()

unsigned int MooseVariableBase::count ( ) const

inlineinherited

Get the number of components Note: For standard and vector variables, the number is one.

Definition at line 111 of file MooseVariableBase.h.

Referenced by Assembly::addJacobianBlock(), EigenProblem::adjustEigenVector(), ArrayBodyForce::ArrayBodyForce(), ArrayConstantIC::ArrayConstantIC(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayFunctionIC::ArrayFunctionIC(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), ArrayParsedAux::ArrayParsedAux(), ArrayVarReductionAux::ArrayVarReductionAux(), BuildArrayVariableAux::BuildArrayVariableAux(), Assembly::cacheJacobianBlockNonzero(), TagAuxBase< AuxKernel >::checkCoupledVariable(), BuildArrayVariableAux::compute(), ArrayNodalBC::computeJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), ArrayNodalBC::computeOffDiagJacobian(), ArrayTimeDerivative::computeQpJacobian(), ArrayReaction::computeQpJacobian(), ArrayDiffusion::computeQpJacobian(), ArrayCoupledTimeDerivative::computeQpJacobian(), EigenArrayDirichletBC::computeQpJacobian(), ArrayIntegratedBC::computeQpJacobian(), ArrayKernel::computeQpJacobian(), ArrayNodalBC::computeQpJacobian(), ArrayCoupledTimeDerivative::computeQpOffDiagJacobian(), EigenArrayDirichletBC::computeQpOffDiagJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobian(), ArrayKernel::computeQpOffDiagJacobian(), ArrayNodalBC::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), Kernel::computeQpOffDiagJacobianArray(), ArrayIntegratedBC::computeQpOffDiagJacobianScalar(), ArrayKernel::computeQpOffDiagJacobianScalar(), ArrayTimeDerivative::computeQpResidual(), ArrayReaction::computeQpResidual(), ArrayCoupledTimeDerivative::computeQpResidual(), FunctionArrayAux::computeValue(), ArrayParsedAux::computeValue(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), FunctionArrayAux::FunctionArrayAux(), ArrayFunctionIC::gradient(), AdvancedOutput::initAvailableLists(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), ArrayDiffusion::initQpResidual(), AdvancedOutput::initShowHideLists(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), MultiAppDofCopyTransfer::transfer(), MultiAppDofCopyTransfer::transferDofObject(), and ArrayFunctionIC::value().

111 { return _count; }

MooseVariableBase::_count

const unsigned int _count

Number of variables in the array.

Definition: MooseVariableBase.h:237

◆ curlPhi()

template<typename OutputType>

virtual const FieldVariablePhiValue& MooseVariableField< OutputType >::curlPhi ( ) const

pure virtual

Curl of the shape functions.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ currentElem()

virtual const Elem* const& MooseVariableFieldBase::currentElem ( ) const

pure virtualinherited

Current element this variable is evaluated at.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

◆ customSetup() [1/2]

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

◆ customSetup() [2/2]

void Moose::FunctorBase< Moose::ADType< OutputType >::type >::customSetup ( const ExecFlagType & exec_type )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Definition at line 839 of file MooseFunctor.h.

 {
   if (_clearance_schedule.count(exec_type))
     clearCacheData();
 }

◆ divPhi()

template<typename OutputType>

virtual const FieldVariablePhiDivergence& MooseVariableField< OutputType >::divPhi ( ) const

pure virtual

Divergence of the shape functions.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ doDerivatives()

bool MooseVariableBase::doDerivatives ( ) const

protectedinherited

Returns: whether we should insert derivatives

◆ dofIndices()

virtual const std::vector<dof_id_type>& MooseVariableBase::dofIndices ( ) const

inlinevirtualinherited

Get local DoF indices.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Definition at line 147 of file MooseVariableBase.h.

Referenced by Assembly::addJacobianCoupledVarPair(), Assembly::addJacobianLowerD(), Assembly::addJacobianNeighbor(), Assembly::addJacobianNeighborLowerD(), Assembly::addJacobianNonlocal(), Assembly::cacheJacobianCoupledVarPair(), Assembly::cacheJacobianMortar(), Assembly::cacheJacobianNeighbor(), Assembly::cacheJacobianNonlocal(), AuxScalarKernel::compute(), ADScalarKernel::computeADJacobian(), FVScalarLagrangeMultiplierInterface::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), ADMortarConstraint::computeJacobian(), MortarConstraint::computeJacobian(), ADKernelScalarBase::computeJacobian(), ADMortarScalarBase::computeJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), ADPeriodicSegmentalConstraint::computeQpResidual(), ADPenaltyPeriodicSegmentalConstraint::computeQpResidual(), FVScalarLagrangeMultiplierInterface::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), ADKernelScalarBase::computeResidual(), ADMortarScalarBase::computeResidual(), MortarScalarBase::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidualAndJacobian(), ADKernelScalarBase::computeResidualAndJacobian(), MortarScalarBase::computeScalarJacobian(), KernelScalarBase::computeScalarJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), ADPenaltyPeriodicSegmentalConstraint::computeScalarQpResidual(), KernelScalarBase::computeScalarResidual(), ScalarVariable::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), TableOutput::outputScalarVariables(), Exodus::outputScalarVariables(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), FEProblemBase::projectInitialConditionOnCustomRange(), and FEProblemBase::projectSolution().

147 { return _dof_indices; }

MooseVariableBase::_dof_indices

std::vector< dof_id_type > _dof_indices

DOF indices.

Definition: MooseVariableBase.h:228

◆ dofIndicesLower()

virtual const std::vector<dof_id_type>& MooseVariableFieldBase::dofIndicesLower ( ) const

pure virtualinherited

Get dof indices for the current lower dimensional element (this is meaningful when performing mortar FEM)

Returns: the lower dimensional element's dofs

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

Referenced by MortarConstraint::computeJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), and Assembly::prepareLowerD().

◆ dofIndicesNeighbor()

virtual const std::vector<dof_id_type>& MooseVariableFieldBase::dofIndicesNeighbor ( ) const

pure virtualinherited

Get neighbor DOF indices for currently selected element.

Returns: the neighbor degree of freedom indices

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Referenced by ADMortarConstraint::computeJacobian(), MortarConstraint::computeJacobian(), NodeFaceConstraint::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), MortarScalarBase::computeScalarOffDiagJacobian(), Assembly::prepareLowerD(), and Assembly::prepareNeighbor().

◆ dofMap()

const libMesh::DofMap& MooseVariableBase::dofMap ( ) const

inlineinherited

The DofMap associated with the system this variable is in.

Definition at line 136 of file MooseVariableBase.h.

Referenced by AuxScalarKernel::compute(), and ScalarVariable::execute().

136 { return _dof_map; }

MooseVariableBase::_dof_map

const libMesh::DofMap & _dof_map

DOF map.

Definition: MooseVariableBase.h:225

◆ dofValues()

template<typename OutputType>

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 890 of file MooseFunctor.h.

 {
   return evaluateDot(elem, state);
 }

◆ dot() [2/6]

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 897 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateDot(face, state);
 }

◆ dot() [3/6]

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 905 of file MooseFunctor.h.

 {
   return evaluateDot(elem_qp, state);
 }

◆ dot() [4/6]

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 912 of file MooseFunctor.h.

 {
   return evaluateDot(elem_side_qp, state);
 }

◆ dot() [5/6]

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 919 of file MooseFunctor.h.

 {
   return evaluateDot(elem_point, state);
 }

◆ dot() [6/6]

FunctorBase< Moose::ADType< OutputType >::type >::DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::dot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 926 of file MooseFunctor.h.

 {
   return evaluateDot(node, state);
 }

◆ eigen() [1/2]

bool MooseVariableBase::eigen ( ) const

inlineinherited

Whether or not this variable operates on an eigen kernel.

Definition at line 163 of file MooseVariableBase.h.

Referenced by EigenProblem::adjustEigenVector().

163 { return _is_eigen; }

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:210

◆ eigen() [2/2]

void MooseVariableBase::eigen ( bool eigen )

inlineinherited

Mark this variable as an eigen var or non-eigen var.

Definition at line 168 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen().

168 { _is_eigen = eigen; }

MooseVariableBase::eigen

bool eigen() const

Whether or not this variable operates on an eigen kernel.

Definition: MooseVariableBase.h:163

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:210

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

◆ evaluate() [1/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Evaluate the functor with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluate() [2/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const FaceArg &	face,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluate() [3/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluate() [4/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const ElemSideQpArg &	side_qp,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluate() [5/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Evaluate the functor with a given element and point.

Some example implementations of this method could perform a two-term Taylor expansion using cell-centered value and gradient

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluate() [6/6]

virtual ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluate	(	const NodeArg &	node,
		const StateArg &	state
	)		const

protectedpure virtualinherited

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ evaluateDot() [1/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const ElemArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor time derivative with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

Definition at line 385 of file MooseFunctor.h.

   {
     mooseError("Element time derivative not implemented for functor " + functorName());
   }

◆ evaluateDot() [2/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, and MooseVariableFV< OutputType >.

Definition at line 395 of file MooseFunctor.h.

   {
     mooseError("Face time derivative not implemented for functor " + functorName());
   }

◆ evaluateDot() [3/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, and MooseVariableFV< OutputType >.

Definition at line 405 of file MooseFunctor.h.

   {
     mooseError("Element quadrature point time derivative not implemented for functor " +
                functorName());
   }

◆ evaluateDot() [4/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented in MooseVariableFE< OutputType >, and MooseVariableFE< VectorValue< Real > >.

Definition at line 416 of file MooseFunctor.h.

   {
     mooseError("Element side quadrature point time derivative not implemented for functor " +
                functorName());
   }

◆ evaluateDot() [5/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor time derivative with a given element and point.

Definition at line 425 of file MooseFunctor.h.

   {
     mooseError("Element-point time derivative not implemented for functor " + functorName());
   }

◆ evaluateDot() [6/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 430 of file MooseFunctor.h.

   {
     mooseError("Time derivative at node not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [1/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const ElemArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented in MooseVariableFE< OutputType >, and MooseVariableFE< VectorValue< Real > >.

Definition at line 439 of file MooseFunctor.h.

   {
     mooseError("Element gradient-dot not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [2/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 449 of file MooseFunctor.h.

   {
     mooseError("Face gradient-dot not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [3/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 459 of file MooseFunctor.h.

   {
     mooseError("Element quadrature point gradient-dot not implemented for functor " +
                functorName());
   }

◆ evaluateGradDot() [4/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 470 of file MooseFunctor.h.

   {
     mooseError("Element side quadrature point gradient-dot not implemented for functor " +
                functorName());
   }

◆ evaluateGradDot() [5/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element and point.

Definition at line 479 of file MooseFunctor.h.

   {
     mooseError("Element-point gradient-dot not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [6/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 484 of file MooseFunctor.h.

   {
     mooseError("Gradient-dot at node not implemented for functor " + functorName());
   }

◆ evaluateGradient() [1/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const ElemArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

Definition at line 332 of file MooseFunctor.h.

   {
     mooseError("Element gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [2/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented in MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

Definition at line 342 of file MooseFunctor.h.

   {
     mooseError("Face gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [3/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

Definition at line 352 of file MooseFunctor.h.

   {
     mooseError("Element quadrature point gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [4/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented in MooseVariableFE< OutputType >, and MooseVariableFE< VectorValue< Real > >.

Definition at line 362 of file MooseFunctor.h.

   {
     mooseError("Element side quadrature point gradient not implemented for functor " +
                functorName());
   }

◆ evaluateGradient() [5/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient with a given element and point.

Definition at line 371 of file MooseFunctor.h.

   {
     mooseError("Element-point gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [6/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 376 of file MooseFunctor.h.

   {
     mooseError("Gradient at node not implemented for functor " + functorName());
   }

◆ feType()

const libMesh::FEType& MooseVariableBase::feType ( ) const

inlineinherited

Get the type of finite element object.

Definition at line 57 of file MooseVariableBase.h.

Referenced by SetupResidualDebugAction::act(), ADDGKernel::ADDGKernel(), Assembly::adGradPhi(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), AuxKernelTempl< Real >::AuxKernelTempl(), BoundsBase::BoundsBase(), BuildArrayVariableAux::BuildArrayVariableAux(), TagAuxBase< AuxKernel >::checkCoupledVariable(), SamplerBase::checkForStandardFieldVariableType(), GapValueAux::computeValue(), CopyValueAux::CopyValueAux(), DGKernel::DGKernel(), MultiAppNearestNodeTransfer::execute(), moose::internal::incompatVarMsg(), AdvancedOutput::initAvailableLists(), MultiAppProjectionTransfer::initialSetup(), AdvancedOutput::initShowHideLists(), IntegratedBC::IntegratedBC(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InternalSideIndicatorBase::InternalSideIndicatorBase(), Kernel::Kernel(), MeshDivisionAux::MeshDivisionAux(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NodalBC::NodalBC(), NodalKernel::NodalKernel(), SolutionUserObjectBase::pointValueWrapper(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), MultiAppDofCopyTransfer::transfer(), and VectorNodalBC::VectorNodalBC().

57 { return _fe_type; }

MooseVariableBase::_fe_type

libMesh::FEType _fe_type

The FEType associated with this variable.

Definition: MooseVariableBase.h:201

◆ fieldType()

template<typename OutputType >

Moose::VarFieldType MooseVariableField< OutputType >::fieldType ( ) const

overridevirtual

Field type of this variable.

Implements MooseVariableFieldBase.

Definition at line 72 of file MooseVariableField.C.

 {
   if (std::is_same<OutputType, Real>::value)
     return Moose::VarFieldType::VAR_FIELD_STANDARD;
   else if (std::is_same<OutputType, RealVectorValue>::value)
     return Moose::VarFieldType::VAR_FIELD_VECTOR;
   else if (std::is_same<OutputType, RealEigenVector>::value)
     return Moose::VarFieldType::VAR_FIELD_ARRAY;
   else
     mooseError("Unknown variable field type");
 }

◆ functorName()

const MooseFunctorName& Moose::FunctorBase< Moose::ADType< OutputType >::type >::functorName ( ) const

inlineinherited

Return the functor name.

Definition at line 170 of file MooseFunctor.h.

170 { return _functor_name; }

Moose::FunctorBase< Moose::ADType< OutputType >::type >::_functor_name

MooseFunctorName _functor_name

name of the functor

Definition: MooseFunctor.h:564

◆ genericDofValues()

template<typename OutputType >

template<bool is_ad>

const MooseArray< GenericReal< is_ad > > & MooseVariableField< OutputType >::genericDofValues ( ) const

Definition at line 428 of file MooseVariableField.h.

 {
   return adDofValues();
 }

◆ genericEvaluate()

FunctorReturnType< Moose::ADType< OutputType >::type , FET >::type Moose::FunctorBase< Moose::ADType< OutputType >::type >::genericEvaluate	(	const Space &	r,
		const State &	state
	)		const

inherited

Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.

Definition at line 987 of file MooseFunctor.h.

 {
   if constexpr (FET == FunctorEvaluationKind::Value)
     return (*this)(r, state);
   else if constexpr (FET == FunctorEvaluationKind::Gradient)
     return gradient(r, state);
   else if constexpr (FET == FunctorEvaluationKind::Dot)
     return dot(r, state);
   else
     return gradDot(r, state);
 }

◆ getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )

protectedinherited

Check if the blocks this object operates on all have the same coordinate system, and if so return it.

Definition at line 321 of file BlockRestrictable.C.

 {
   if (!_blk_mesh)
     mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
   if (!_blk_feproblem)
     mooseError("No problem available in BlockRestrictable::checkCoordSystem()");
 
   const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   if (subdomains.empty())
     mooseError("No subdomains found in the problem.");
 
   // make sure all subdomains are using the same coordinate system
   auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
   for (auto subdomain : subdomains)
     if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
       mooseError("This object requires all subdomains to have the same coordinate system.");
 
   return coord_system;
 }

◆ 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 286 of file MooseBaseParameterInterface.h.

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

◆ getContinuity()

virtual libMesh::FEContinuity MooseVariableBase::getContinuity ( ) const

inlinevirtualinherited

Return the continuity of this variable.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Definition at line 128 of file MooseVariableBase.h.

Referenced by ProjectionAux::computeValue(), and MultiAppGeneralFieldNearestLocationTransfer::initialSetup().

   {
     mooseError("Base class cannot determine this");
   };

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

◆ getDofIndices()

virtual void MooseVariableBase::getDofIndices	(	const Elem *	,
		std::vector< dof_id_type > &
	)		const

inlinevirtualinherited

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Definition at line 138 of file MooseVariableBase.h.

Referenced by MultiAppVariableValueSamplePostprocessorTransfer::execute(), NodeElemConstraint::getConnectedDofIndices(), and NodeFaceConstraint::getConnectedDofIndices().

   {
     mooseError("not implemented");
   };

◆ 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(), Exodus::outputSetup(), ElementReporter::shouldStore(), NodalReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::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

◆ getOutputs()

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

inherited

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

Returns: A set of OutputNames

Definition at line 94 of file OutputInterface.C.

 {
   return _oi_outputs;
 }

◆ 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 215 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 279 of file MooseBaseParameterInterface.h.

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

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

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

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

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

◆ getSolution()

template<typename OutputType >

const NumericVector< Number > & MooseVariableField< OutputType >::getSolution ( const Moose::StateArg & state ) const

protected

Get the solution corresponding to the provided state.

Definition at line 60 of file MooseVariableField.C.

 {
   // It's not safe to use solutionState(0) because it returns the libMesh System solution member
   // which is wrong during things like finite difference Jacobian evaluation, e.g. when PETSc
   // perturbs the solution vector we feed these perturbations into the current_local_solution
   // while the libMesh solution is frozen in the non-perturbed state
   return (state.state == 0) ? *this->_sys.currentSolution()
                             : this->_sys.solutionState(state.state, state.iteration_type);
 }

◆ gradDot() [1/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 933 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem, state);
 }

◆ gradDot() [2/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 940 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradDot(face, state);
 }

◆ gradDot() [3/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 948 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_qp, state);
 }

◆ gradDot() [4/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 955 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_side_qp, state);
 }

◆ gradDot() [5/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 962 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_point, state);
 }

◆ gradDot() [6/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 969 of file MooseFunctor.h.

 {
   return evaluateGradDot(node, state);
 }

◆ gradient() [1/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradient overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 847 of file MooseFunctor.h.

 {
   return evaluateGradient(elem, state);
 }

◆ gradient() [2/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 854 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradient(face, state);
 }

◆ gradient() [3/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 862 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_qp, state);
 }

◆ gradient() [4/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 869 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_side_qp, state);
 }

◆ gradient() [5/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 876 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_point, state);
 }

◆ gradient() [6/6]

FunctorBase< Moose::ADType< OutputType >::type >::GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::gradient	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 883 of file MooseFunctor.h.

 {
   return evaluateGradient(node, state);
 }

◆ gradPhi()

template<typename OutputType>

virtual const FieldVariablePhiGradient& MooseVariableField< OutputType >::gradPhi ( ) const

pure virtual

◆ gradPhiFace()

template<typename OutputType>

virtual const FieldVariablePhiGradient& MooseVariableField< OutputType >::gradPhiFace ( ) const

pure virtual

◆ gradPhiFaceNeighbor()

template<typename OutputType>

virtual const FieldVariablePhiGradient& MooseVariableField< OutputType >::gradPhiFaceNeighbor ( ) const

pure virtual

Return the gradients of the variable's shape functions on a neighboring element face.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

template<typename OutputType>

virtual const FieldVariableGradient& MooseVariableField< OutputType >::gradSlnOld ( ) const

pure virtual

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ gradSlnOldNeighbor()

template<typename OutputType>

virtual const FieldVariableGradient& MooseVariableField< OutputType >::gradSlnOldNeighbor ( ) const

pure virtual

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

◆ hasBlockMaterialProperty()

template<typename T , bool is_ad>

bool BlockRestrictable::hasBlockMaterialProperty ( const std::string & prop_name )

inherited

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

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

Template Parameters

T	The type of material property

Parameters

prop_name the name of the property to query

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

See also: Material::hasBlockMaterialProperty

Definition at line 271 of file BlockRestrictable.h.

 {
   mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
   return hasBlockMaterialPropertyHelper(prop_name) &&
          _blk_material_data->haveGenericProperty<T, is_ad>(prop_name);
 }

◆ hasBlockMaterialPropertyHelper()

bool BlockRestrictable::hasBlockMaterialPropertyHelper ( const std::string & prop_name )

protectedvirtualinherited

A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.

It also avoid circular #include problems.

See also: hasBlockMaterialProperty

Definition at line 285 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

 {
 
   // Reference to MaterialWarehouse for testing and retrieving block ids
   const MaterialWarehouse & warehouse = _blk_feproblem->getMaterialWarehouse();
 
   // Complete set of ids that this object is active
   const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   // Loop over each id for this object
   for (const auto & id : ids)
   {
     // Storage of material properties that have been DECLARED on this id
     std::set<std::string> declared_props;
 
     // If block materials exist, populated the set of properties that were declared
     if (warehouse.hasActiveBlockObjects(id))
     {
       const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
       for (const auto & mat : mats)
       {
         const std::set<std::string> & mat_props = mat->getSuppliedItems();
         declared_props.insert(mat_props.begin(), mat_props.end());
       }
     }
 
     // If the supplied property is not in the list of properties on the current id, return false
     if (declared_props.find(prop_name) == declared_props.end())
       return false;
   }
 
   // If you get here the supplied property is defined on all blocks
   return true;
 }

◆ hasBlocks() [1/6]

bool BlockRestrictable::hasBlocks ( const SubdomainName & name ) const

inherited

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

Parameters

name	A SubdomainName to check

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

Definition at line 209 of file BlockRestrictable.C.

Referenced by LinearFVFluxKernel::addMatrixContribution(), DiracKernelBase::addPoint(), LinearFVFluxKernel::addRightHandSideContribution(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), DomainUserObject::checkVariable(), ComputeJacobianThread::compute(), ComboMarker::computeElementMarker(), GradientJumpIndicator::computeQpIntegral(), ProjectionAux::computeValue(), DomainUserObject::DomainUserObject(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MeshDivisionFunctorReductionVectorPostprocessor::hasBlocks(), BlockRestrictable::hasBlocks(), MooseVariableField< Real >::hasBlocks(), FVFluxKernel::hasFaceSide(), IndicatorMarker::IndicatorMarker(), NodePositions::initialize(), ParsedDownSelectionPositions::initialize(), UpdateErrorVectorsThread::onElement(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and BlockRestrictionDebugOutput::printBlockRestrictionMap().

 {
   // Create a vector and utilize the getSubdomainIDs function, which
   // handles the ANY_BLOCK_ID (getSubdomainID does not)
   std::vector<SubdomainName> names(1);
   names[0] = name;
   return hasBlocks(_blk_mesh->getSubdomainIDs(names));
 }

◆ hasBlocks() [2/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainName > & names ) const

inherited

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

Parameters

names A vector of SubdomainNames to check

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

Definition at line 219 of file BlockRestrictable.C.

 {
   return hasBlocks(_blk_mesh->getSubdomainIDs(names));
 }

◆ hasBlocks() [3/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainName > & names ) const

inherited

Test if the supplied set of block names are valid for this object.

Parameters

names A set of SubdomainNames to check

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

Definition at line 225 of file BlockRestrictable.C.

 {
   return hasBlocks(_blk_mesh->getSubdomainIDs(names));
 }

◆ hasBlocks() [4/6]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainID > & ids ) const

inherited

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

Parameters

ids	A vector of SubdomainIDs ids to check

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

Definition at line 240 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/6]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainID > & ids ) const

inherited

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

Parameters

ids	A std::set of SubdomainIDs to check

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

See also: isSubset

Definition at line 247 of file BlockRestrictable.C.

 {
   if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
     return true;
   else
     return std::includes(_blk_ids.begin(), _blk_ids.end(), ids.begin(), ids.end());
 }

◆ hasBlocks() [6/6]

template<typename OutputType>

bool MooseVariableField< OutputType >::hasBlocks ( const SubdomainID ) const

inlineoverridevirtual

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 400 of file MooseVariableField.h.

Referenced by Coupleable::checkWritableVar(), InternalSideIndicatorBase::computeIndicator(), GradientJumpIndicator::computeQpIntegral(), FVInterfaceKernel::FVInterfaceKernel(), ComputeLinearFVGreenGaussGradientVolumeThread::operator()(), and FVInterfaceKernel::singleSidedFaceArg().

400 { return BlockRestrictable::hasBlocks(id); }

BlockRestrictable::hasBlocks

bool hasBlocks(const SubdomainName &name) const

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

Definition: BlockRestrictable.C:209

◆ hasDoFsOnNodes()

virtual bool MooseVariableBase::hasDoFsOnNodes ( ) const

inlinevirtualinherited

Does this variable have DoFs on nodes.

Returns: true if it does, false if not.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 123 of file MooseVariableBase.h.

123 { mooseError("Base class cannot determine this"); };

MooseBaseErrorInterface::mooseError

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

Emits an error prefixed with object name and type.

Definition: MooseBaseErrorInterface.h:29

◆ hasFaceSide()

bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::hasFaceSide	(	const FaceInfo &	fi,
		const bool	fi_elem_side
	)		const

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 976 of file MooseFunctor.h.

 {
   if (fi_elem_side)
     return hasBlocks(fi.elem().subdomain_id());
   else
     return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
 }

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject * moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 74 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

 {
   // If the mesh pointer is not defined, but FEProblemBase is, get it from there
   if (_blk_feproblem != NULL && _blk_mesh == NULL)
     _blk_mesh = &_blk_feproblem->mesh();
 
   // Check that the mesh pointer was defined, it is required for this class to operate
   if (_blk_mesh == NULL)
     mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
                "pointer to the MooseMesh via '_mesh'");
 
   // Populate the MaterialData pointer
   if (_blk_feproblem != NULL)
     _blk_material_data = &_blk_feproblem->getMaterialData(Moose::BLOCK_MATERIAL_DATA, _blk_tid);
 
   // The 'block' input is defined
   if (moose_object->isParamValid("block"))
   {
     // Extract the blocks from the input
     _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");
 
     // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
     if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
       _blk_ids.insert(Moose::ANY_BLOCK_ID);
     else
     {
       // Get the IDs from the supplied names
       _vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
       _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
     }
   }
 
   // When 'blocks' is not set and there is a "variable", use the blocks from the variable
   else if (moose_object->isParamValid("variable"))
   {
     std::string variable_name = moose_object->parameters().getMooseType("variable");
     if (!variable_name.empty())
       _blk_ids = _blk_feproblem
                      ->getVariable(_blk_tid,
                                    variable_name,
                                    Moose::VarKindType::VAR_ANY,
                                    Moose::VarFieldType::VAR_FIELD_ANY)
                      .activeSubdomains();
   }
 
   // Produce error if the object is not allowed to be both block and boundary restricted
   if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
     if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
       moose_object->paramError("block",
                                "Attempted to restrict the object '",
                                _blk_name,
                                "' to a block, but the object is already restricted by boundary");
 
   // If no blocks were defined above, specify that it is valid on all blocks
   if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
   {
     _blk_ids.insert(Moose::ANY_BLOCK_ID);
     _blocks = {"ANY_BLOCK_ID"};
   }
 
   // If this object is block restricted, check that defined blocks exist on the mesh
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
   {
     const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
     std::vector<SubdomainID> diff;
 
     std::set_difference(_blk_ids.begin(),
                         _blk_ids.end(),
                         valid_ids.begin(),
                         valid_ids.end(),
                         std::back_inserter(diff));
 
     if (!diff.empty())
     {
       std::ostringstream msg;
       auto sep = " ";
       msg << "the following blocks (ids) do not exist on the mesh:";
       for (const auto & id : diff)
       {
         if (_blk_name.size() > 0)
         {
           auto & name =
               _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
           if (std::to_string(id) != name)
             msg << sep << name << " (" << id << ")";
           else
             msg << sep << id;
         }
         else
           msg << sep << id;
         sep = ", ";
       }
       std::vector<SubdomainID> valid_ids_vec(valid_ids.begin(), valid_ids.end());
       auto valid_names = _blk_mesh->getSubdomainNames(valid_ids_vec);
       msg << "\nBlocks names (resp. ids) that do exist: " << Moose::stringify(valid_names) << " ("
           << Moose::stringify(valid_ids) << ")";
       moose_object->paramError("block", msg.str());
     }
   }
 
   // Get the mesh dimension for the blocks
   if (blockRestricted())
     _blk_dim = _blk_mesh->getBlocksMaxDimension(_blocks);
   else
     _blk_dim = _blk_mesh->dimension();
 }

◆ initialSetup()

void MooseVariableBase::initialSetup ( )

overridevirtualinherited

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

Reimplemented from SetupInterface.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 247 of file MooseVariableBase.C.

Referenced by MooseLinearVariableFV< Real >::initialSetup(), and MooseVariableFV< Real >::initialSetup().

 {
   // Currently the scaling vector is only used through AD residual computing objects
   if ((_var_kind == Moose::VAR_SOLVER) && _subproblem.haveADObjects() &&
       (_subproblem.automaticScaling() || (std::find_if(_scaling_factor.begin(),
                                                        _scaling_factor.end(),
                                                        [](const Real element) {
                                                          return !MooseUtils::absoluteFuzzyEqual(
                                                              element, 1.);
                                                        }) != _scaling_factor.end())))
 
     _sys.addScalingVector();
 }

◆ insert()

virtual void MooseVariableFieldBase::insert ( libMesh::NumericVector< libMesh::Number > & vector )

pure virtualinherited

Insert the currently cached degree of freedom values into the provided vector.

Implemented 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 >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Referenced by BlockRestrictionDebugOutput::printBlockRestrictionMap(), and ConstraintWarehouse::subdomainsCovered().

◆ insertLower()

virtual void MooseVariableFieldBase::insertLower ( libMesh::NumericVector< libMesh::Number > & vector )

pure virtualinherited

Insert the currently cached degree of freedom values for a lower-dimensional element into the provided vector.

Implemented 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 >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

◆ isArray()

template<typename OutputType >

bool MooseVariableField< OutputType >::isArray ( ) const

overridevirtual

Returns: whether this is an array variable

Reimplemented from MooseVariableBase.

Definition at line 86 of file MooseVariableField.C.

 {
   const auto is_array = MooseVariableBase::isArray();
   if (std::is_same<OutputType, RealEigenVector>::value != is_array)
     mooseError("A variable is marked as an array variable in a base class, but in a derived class "
                "the output type is not consistent.");
   return is_array;
 }

◆ isBlockSubset() [1/2]

bool BlockRestrictable::isBlockSubset ( const std::set< SubdomainID > & ids ) const

inherited

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

Parameters

ids	A std::set of Subdomains to check

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

See also: hasBlocks

Definition at line 256 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), BlockRestrictable::isBlockSubset(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), and ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux().

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

◆ isBlockSubset() [2/2]

bool BlockRestrictable::isBlockSubset ( const std::vector< SubdomainID > & ids ) const

inherited

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

Parameters

ids	A std::vector of Subdomains to check

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

See also: hasBlocks

Definition at line 272 of file BlockRestrictable.C.

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

◆ isConstant()

virtual bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::isConstant ( ) const

inlinevirtualinherited

Returns true if this functor is a constant.

Definition at line 260 of file MooseFunctor.h.

260 { return false; }

◆ isExtrapolatedBoundaryFace()

virtual bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::isExtrapolatedBoundaryFace	(	const FaceInfo &	,
		const Elem *	,
		const StateArg &
	)		const

inlinevirtualinherited

Returns whether this (sided) face is an extrapolated boundary face for this functor.

Reimplemented in MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

Definition at line 247 of file MooseFunctor.h.

   {
     mooseError("not implemented");
   }

◆ isFV()

virtual bool MooseVariableFieldBase::isFV ( ) const

inlinevirtualinherited

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 81 of file MooseVariableFieldBase.h.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), GradientJumpIndicator::computeQpIntegral(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), and InternalSideIndicatorTempl< ComputeValueType >::isVarFV().

81 { return false; }

◆ isInternalFace()

bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::isInternalFace ( const FaceInfo & fi ) const

inherited

Returns true if the face is an internal face.

Definition at line 569 of file MooseFunctor.h.

 {
   if (!fi.neighborPtr())
     return false;
 
   return hasBlocks(fi.elem().subdomain_id()) && hasBlocks(fi.neighborPtr()->subdomain_id());
 }

◆ isLowerD()

bool MooseVariableBase::isLowerD ( ) const

inlineinherited

Returns: whether this variable lives on lower dimensional blocks

Definition at line 189 of file MooseVariableBase.h.

189 { return _is_lower_d; }

MooseVariableBase::_is_lower_d

bool _is_lower_d

Whether this variable lives on lower dimensional blocks.

Definition: MooseVariableBase.h:249

◆ isNodal()

virtual bool MooseVariableBase::isNodal ( ) const

inlinevirtualinherited

Is this variable nodal.

Returns: true if it nodal, otherwise false

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 117 of file MooseVariableBase.h.

Referenced by InitialConditionWarehouse::addObject(), AuxKernelTempl< Real >::AuxKernelTempl(), BoundsBase::BoundsBase(), MooseVariableBase::componentDofIndices(), ProjectionAux::computeValue(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), and MeshDivisionAux::MeshDivisionAux().

117 { mooseError("Base class cannot determine this"); }

MooseBaseErrorInterface::mooseError

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

Emits an error prefixed with object name and type.

Definition: MooseBaseErrorInterface.h:29

◆ isNodalDefined()

virtual bool MooseVariableFieldBase::isNodalDefined ( ) const

pure virtualinherited

Is this variable defined at nodes.

Returns: true if it the variable is defined at nodes, otherwise false

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Referenced by FunctorIC::gradient(), and FunctorIC::value().

◆ 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 128 of file MooseBaseParameterInterface.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseBaseParameterInterface::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MFEMSolverBase::setPreconditioner(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

128 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

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

Method returns true if the parameter was set by the user.

Definition: InputParameters.C:1178

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

◆ 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 122 of file MooseBaseParameterInterface.h.

122 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

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

◆ isVector()

template<typename OutputType >

bool MooseVariableField< OutputType >::isVector ( ) const

overridevirtual

Returns: true if this is a vector-valued element, false otherwise.

Implements MooseVariableFieldBase.

Definition at line 97 of file MooseVariableField.C.

 {
   return std::is_same<OutputType, RealVectorValue>::value;
 }

◆ jacobianSetup()

template<typename OutputType >

void MooseVariableField< OutputType >::jacobianSetup ( )

overridevirtual

Reimplemented from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

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 >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 44 of file MooseVariableField.C.

Referenced by MooseVariableFE< Real >::jacobianSetup().

 {
   MooseVariableFieldBase::jacobianSetup();
   FunctorBase<typename Moose::ADType<OutputType>::type>::jacobianSetup();
 }

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const

inlineinherited

Kind of the variable (Nonlinear, Auxiliary, ...)

Definition at line 88 of file MooseVariableBase.h.

Referenced by ADPenaltyPeriodicSegmentalConstraint::ADPenaltyPeriodicSegmentalConstraint(), ADPeriodicSegmentalConstraint::ADPeriodicSegmentalConstraint(), FVFluxBC::FVFluxBC(), MooseVariableInterface< Real >::MooseVariableInterface(), PenaltyPeriodicSegmentalConstraint::PenaltyPeriodicSegmentalConstraint(), and PeriodicSegmentalConstraint::PeriodicSegmentalConstraint().

88 { return _var_kind; }

MooseVariableBase::_var_kind

Moose::VarKindType _var_kind

Variable type (see MooseTypes.h)

Definition: MooseVariableBase.h:213

◆ matrixTagValue()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::matrixTagValue ( TagID tag ) const

pure virtual

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ meshBlockIDs()

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

inherited

Return all of the SubdomainIDs for the mesh.

Returns: A set of all subdomians for the entire mesh

Definition at line 279 of file BlockRestrictable.C.

Referenced by BlockRestrictable::checkVariable(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and SolutionIC::initialSetup().

 {
   return _blk_mesh->meshSubdomains();
 }

◆ 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, SampledOutput, RadialAverage, Nemesis, NEML2ModelExecutor, GhostingUserObject, FVPointValueConstraint, ExplicitTimeIntegrator, NEML2BatchIndexGenerator, MultiAppVariableValueSamplePostprocessorTransfer, MoveNodesToGeometryModifierBase, ElementSubdomainModifierBase, SidesetInfoVectorPostprocessor, NearestNodeNumberUO, and EqualValueBoundaryConstraint.

Definition at line 30 of file MeshChangedInterface.h.

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

30 {}

◆ 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(), 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(), 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(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), SolutionUserObjectBase::SolutionUserObjectBase(), 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 CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), 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(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CartesianGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::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(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), 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()

const std::string& MooseVariableBase::name ( ) const

inlineoverridevirtualinherited

Get the variable name.

Reimplemented from MooseBase.

Definition at line 72 of file MooseVariableBase.h.

Referenced by SetupResidualDebugAction::act(), DiffusionLHDGKernel::additionalROVariables(), IPHDGAssemblyHelper::additionalROVariables(), InitialConditionWarehouse::addObject(), MooseLinearVariableFV< Real >::adError(), MooseVariableBase::allDofIndices(), ArrayParsedAux::ArrayParsedAux(), SamplerBase::checkForStandardFieldVariableType(), DomainUserObject::checkVariable(), BlockRestrictable::checkVariable(), Coupleable::checkWritableVar(), Coupleable::coupledName(), DebugResidualAux::DebugResidualAux(), GreaterThanLessThanPostprocessor::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), FunctionArrayAux::FunctionArrayAux(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), GapValueAux::GapValueAux(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), DerivativeMaterialInterface< MortarScalarBase >::isNotObjectVariable(), MooseLinearVariableFV< Real >::lowerDError(), MooseVariableBase::MooseVariableBase(), MooseLinearVariableFV< Real >::nodalError(), ParsedODEKernel::ParsedODEKernel(), ConstraintWarehouse::subdomainsCovered(), MooseLinearVariableFV< Real >::timeIntegratorError(), MultiAppDofCopyTransfer::transfer(), MultiAppShapeEvaluationTransfer::transferVariable(), FVFluxBC::uOnGhost(), and FVFluxBC::uOnUSub().

72 { return _var_name; }

MooseVariableBase::_var_name

std::string _var_name

Variable name.

Definition: MooseVariableBase.h:243

◆ needsGradientVectorStorage()

virtual bool MooseVariableFieldBase::needsGradientVectorStorage ( ) const

inlinevirtualinherited

Check if this variable needs a raw vector of gradients at dof-values.

This is mainly used for finite volume variables.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 120 of file MooseVariableFieldBase.h.

120 { return false; }

◆ nodalDofIndex()

virtual const dof_id_type& MooseVariableFieldBase::nodalDofIndex ( ) const

pure virtualinherited

◆ nodalDofIndexNeighbor()

virtual const dof_id_type& MooseVariableFieldBase::nodalDofIndexNeighbor ( ) const

pure virtualinherited

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ nodalMatrixTagValue()

template<typename OutputType>

virtual const DoFValue& MooseVariableField< OutputType >::nodalMatrixTagValue ( TagID tag ) const

pure virtual

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

unsigned int MooseVariableBase::number ( ) const

inlineinherited

Get variable number coming from libMesh.

Returns: the libmesh variable number

Definition at line 52 of file MooseVariableBase.h.

52 { return _var_num; }

MooseVariableBase::_var_num

unsigned int _var_num

variable number (from libMesh)

Definition: MooseVariableBase.h:204

◆ numberOfDofs()

virtual unsigned int MooseVariableBase::numberOfDofs ( ) const

inlinevirtualinherited

Get the number of local DoFs.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

Definition at line 158 of file MooseVariableBase.h.

Referenced by BuildArrayVariableAux::compute(), TagVectorArrayVariableAux::compute(), and ComputeDiracThread::onElement().

158 { return _dof_indices.size(); }

MooseVariableBase::_dof_indices

std::vector< dof_id_type > _dof_indices

DOF indices.

Definition: MooseVariableBase.h:228

◆ numberOfDofsNeighbor()

virtual unsigned int MooseVariableFieldBase::numberOfDofsNeighbor ( )

pure virtualinherited

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 203 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::initialize(), and QuadraturePointsPositions::initialize().

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

◆ oldestSolutionStateRequested()

virtual unsigned int MooseVariableFieldBase::oldestSolutionStateRequested ( ) const

pure virtualinherited

The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc).

Implemented 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 >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

◆ operator()() [1/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluate overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 597 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem, state);
 
   mooseAssert(state.state == 0,
               "Cached evaluations are only currently supported for the current state.");
 
   return queryFVArgCache(_elem_arg_to_value, elem);
 }

◆ operator()() [2/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 610 of file MooseFunctor.h.

 {
   checkFace(face_in);
 
   if (_always_evaluate)
     return evaluate(face_in, state);
 
   mooseAssert(state.state == 0,
               "Cached evaluations are only currently supported for the current state.");
 
   return queryFVArgCache(_face_arg_to_value, face_in);
 }

◆ operator()() [3/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 656 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem_qp, state);
 
   const auto elem_id = elem_qp.elem->id();
   if (elem_id != _current_qp_map_key)
   {
     _current_qp_map_key = elem_id;
     _current_qp_map_value = &_qp_to_value[elem_id];
   }
   auto & qp_data = *_current_qp_map_value;
   const auto qp = elem_qp.qp;
   const auto * const qrule = elem_qp.qrule;
   mooseAssert(qrule, "qrule must be non-null");
 
   return queryQpCache(qp, *qrule, qp_data, elem_qp, state);
 }

◆ operator()() [4/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 677 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem_side_qp, state);
 
   const Elem * const elem = elem_side_qp.elem;
   mooseAssert(elem, "elem must be non-null");
   const auto elem_id = elem->id();
   if (elem_id != _current_side_qp_map_key)
   {
     _current_side_qp_map_key = elem_id;
     _current_side_qp_map_value = &_side_qp_to_value[elem_id];
   }
   auto & side_qp_data = *_current_side_qp_map_value;
   const auto side = elem_side_qp.side;
   const auto qp = elem_side_qp.qp;
   const auto * const qrule = elem_side_qp.qrule;
   mooseAssert(qrule, "qrule must be non-null");
 
   // Check and see whether we even have sized for this side
   if (side >= side_qp_data.size())
     side_qp_data.resize(elem->n_sides());
 
   // Ok we were sized enough for our side
   auto & qp_data = side_qp_data[side];
   return queryQpCache(qp, *qrule, qp_data, elem_side_qp, state);
 }

◆ operator()() [5/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 707 of file MooseFunctor.h.

 {
   return evaluate(elem_point, state);
 }

◆ operator()() [6/6]

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::operator()	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 724 of file MooseFunctor.h.

 {
   mooseAssert(node.subdomain_ids, "Subdomain IDs must be supplied to the node argument");
   return evaluate(node, state);
 }

◆ order()

Order MooseVariableBase::order ( ) const

inherited

Get the order of this variable Note: Order enum can be implicitly converted to unsigned int.

Definition at line 213 of file MooseVariableBase.C.

Referenced by FEProblemBase::checkDisplacementOrders(), AuxScalarKernel::compute(), ScalarInitialCondition::compute(), ADScalarKernel::computeADJacobian(), ODEKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), ODEKernel::computeOffDiagJacobianScalar(), Kernel::computeOffDiagJacobianScalar(), ScalarLagrangeMultiplier::computeOffDiagJacobianScalar(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), ArrayDGDiffusion::computeQpJacobian(), DGDiffusion::computeQpJacobian(), DGFunctionDiffusionDirichletBC::computeQpJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobianScalar(), ArrayKernel::computeQpOffDiagJacobianScalar(), ADDGDiffusion::computeQpResidual(), DGDiffusion::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), ScalarKernel::computeResidual(), ADScalarKernel::computeResidual(), ODETimeKernel::computeResidual(), ODEKernel::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), ProjectionAux::computeValue(), ScalarCoupleable::coupledScalarOrder(), MultiAppPostprocessorToAuxScalarTransfer::execute(), FunctionScalarAux::FunctionScalarAux(), GapValueAux::GapValueAux(), ArrayDGDiffusion::initQpResidual(), NodalPatchRecovery::NodalPatchRecovery(), FEProblemBase::projectInitialConditionOnCustomRange(), ProjectionAux::ProjectionAux(), FEProblemBase::projectSolution(), and ScalarComponentIC::ScalarComponentIC().

 {
   return _fe_type.order;
 }

◆ 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 255 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:173

◆ 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 272 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 265 of file MooseBaseParameterInterface.h.

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

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

◆ phi()

template<typename OutputType>

virtual const FieldVariablePhiValue& MooseVariableField< OutputType >::phi ( ) const

pure virtual

◆ phiFace()

template<typename OutputType>

virtual const FieldVariablePhiValue& MooseVariableField< OutputType >::phiFace ( ) const

pure virtual

◆ phiFaceNeighbor()

template<typename OutputType>

virtual const FieldVariablePhiValue& MooseVariableField< OutputType >::phiFaceNeighbor ( ) const

pure virtual

◆ phiFaceNeighborSize()

virtual std::size_t MooseVariableFieldBase::phiFaceNeighborSize ( ) const

pure virtualinherited

Return phiFaceNeighbor size.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

◆ phiFaceSize()

virtual std::size_t MooseVariableFieldBase::phiFaceSize ( ) const

pure virtualinherited

Return phiFace size.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

◆ phiLower()

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ prepareNeighbor()

virtual void MooseVariableFieldBase::prepareNeighbor ( )

pure virtualinherited

Prepare the neighbor element degrees of freedom.

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ queryParam()

template<typename T >

const T * MooseBaseParameterInterface::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 222 of file MooseBaseParameterInterface.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

Reimplemented from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

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 >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 36 of file MooseVariableField.C.

Referenced by MooseVariableFE< Real >::residualSetup().

 {
   MooseVariableFieldBase::residualSetup();
   FunctorBase<typename Moose::ADType<OutputType>::type>::residualSetup();
 }

◆ scalingFactor() [1/2]

void MooseVariableBase::scalingFactor ( const std::vector< Real > & factor )

inherited

Set the scaling factor for this variable.

Definition at line 239 of file MooseVariableBase.C.

 {
   mooseAssert(factor.size() == _count, "Inconsistent scaling factor size");
   for (const auto i : make_range(_count))
     _scaling_factor[i] = factor[i];
 }

◆ scalingFactor() [2/2]

Real MooseVariableBase::scalingFactor ( ) const

inlineinherited

Get the scaling factor for this variable.

Definition at line 98 of file MooseVariableBase.h.

 {
   mooseError("setActiveTags must be overridden in derived classes.");
 }

◆ setCacheClearanceSchedule()

void Moose::FunctorBase< Moose::ADType< OutputType >::type >::setCacheClearanceSchedule ( const std::set< ExecFlagType > & clearance_schedule )

inherited

Set how often to clear the functor evaluation cache.

Definition at line 714 of file MooseFunctor.h.

 {
   if (clearance_schedule.count(EXEC_ALWAYS))
     _always_evaluate = true;
 
   _clearance_schedule = clearance_schedule;
 }

◆ setDofValue()

template<typename OutputType>

virtual void MooseVariableField< OutputType >::setDofValue	(	const OutputData &	value,
		unsigned int	index
	)

pure virtual

Degree of freedom value setters.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealVectorValue >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

Referenced by VolumeAux::compute(), and ElementLpNormAux::compute().

◆ setDofValues()

template<typename OutputType>

virtual void MooseVariableField< OutputType >::setDofValues ( const DenseVector< OutputData > & values )

pure virtual

Set local DOF values and evaluate the values on quadrature points.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealVectorValue >, MooseVariableFV< OutputType >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Referenced by BuildArrayVariableAux::compute(), and TagVectorArrayVariableAux::compute().

◆ setLowerDofValues()

template<typename OutputType>

virtual void MooseVariableField< OutputType >::setLowerDofValues ( const DenseVector< OutputData > & values )

pure virtual

Set local DOF values for a lower dimensional element and evaluate the values on quadrature points.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealVectorValue >, MooseVariableFV< OutputType >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

◆ setNodalValue()

template<typename OutputType>

virtual void MooseVariableField< OutputType >::setNodalValue	(	const OutputType &	value,
		unsigned int	idx = `0`
	)

pure virtual

◆ sln()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::sln ( ) const

pure virtual

Returns: the current elemental solution

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

Referenced by MultiAppVariableValueSampleTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), and ElementalVariableValue::execute().

◆ slnNeighbor()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::slnNeighbor ( ) const

pure virtual

Returns: the current neighbor solution

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

◆ slnOld()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::slnOld ( ) const

pure virtual

Returns: the old elemental solution, e.g. that of the previous timestep

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ slnOlder()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::slnOlder ( ) const

pure virtual

Returns: the older elemental solution, e.g. that of two timesteps ago

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ slnOldNeighbor()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::slnOldNeighbor ( ) const

pure virtual

Returns: the old neighbor solution, e.g. that of the previous timestep

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

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

◆ supportsElemSideQpArg()

virtual bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::supportsElemSideQpArg ( ) const

pure virtualinherited

Whether this functor supports evaluation with ElemSideQpArg.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ supportsFaceArg()

virtual bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::supportsFaceArg ( ) const

pure virtualinherited

Whether this functor supports evaluation with FaceArg.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< VectorValue< Real > >, MooseVariableFV< OutputType >, and MooseLinearVariableFV< OutputType >.

◆ sys() [1/2]

SystemBase& MooseVariableBase::sys ( )

inlineinherited

Get the system this variable is part of.

Definition at line 62 of file MooseVariableBase.h.

62 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:198

◆ sys() [2/2]

const SystemBase& MooseVariableBase::sys ( ) const

inlineinherited

Get the system this variable is part of.

Definition at line 67 of file MooseVariableBase.h.

67 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:198

◆ timestepSetup()

template<typename OutputType >

void MooseVariableField< OutputType >::timestepSetup ( )

overridevirtual

Reimplemented from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< Real >.

Definition at line 52 of file MooseVariableField.C.

Referenced by MooseVariableFV< Real >::timestepSetup().

 {
   MooseVariableFieldBase::timestepSetup();
   FunctorBase<typename Moose::ADType<OutputType>::type>::timestepSetup();
 }

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )

inlineinherited

Definition at line 83 of file MooseVariableBase.h.

83 { return allDofIndices().size(); }

MooseVariableBase::allDofIndices

const std::vector< dof_id_type > & allDofIndices() const

Get all global dofindices for the variable.

Definition: MooseVariableBase.C:201

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

◆ useDual()

bool MooseVariableBase::useDual ( ) const

inlineinherited

Get dual mortar option.

Definition at line 77 of file MooseVariableBase.h.

Referenced by MortarConstraintBase::MortarConstraintBase().

77 { return _use_dual; }

MooseVariableBase::_use_dual

bool _use_dual

If dual mortar approach is used.

Definition: MooseVariableBase.h:246

◆ usesGradPhiNeighbor()

template<typename OutputType>

bool MooseVariableField< OutputType >::usesGradPhiNeighbor ( ) const

inline

Whether or not this variable is actually using the shape function gradient.

Currently hardcoded to true because we always compute the value.

Definition at line 344 of file MooseVariableField.h.

Referenced by Assembly::copyNeighborShapes().

344 { return true; }

◆ usesPhiNeighbor()

template<typename OutputType>

bool MooseVariableField< OutputType >::usesPhiNeighbor ( ) const

inline

Whether or not this variable is actually using the shape function value.

Currently hardcoded to true because we always compute the value.

Definition at line 337 of file MooseVariableField.h.

Referenced by Assembly::copyNeighborShapes().

337 { return true; }

◆ usesSecondPhiNeighbor()

template<typename OutputType>

virtual bool MooseVariableField< OutputType >::usesSecondPhiNeighbor ( ) const

pure virtual

Whether or not this variable is actually using the shape function second derivatives.

Implemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Referenced by Assembly::copyNeighborShapes().

◆ validParams()

template<typename OutputType >

InputParameters MooseVariableField< OutputType >::validParams ( )

static

Definition at line 20 of file MooseVariableField.C.

Referenced by MooseLinearVariableFV< Real >::validParams(), and MooseVariableFV< Real >::validParams().

 {
   return MooseVariableFieldBase::validParams();
 }

◆ vectorTagDofValue()

template<typename OutputType>

virtual const DoFValue& MooseVariableField< OutputType >::vectorTagDofValue ( TagID tag ) const

pure virtual

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

◆ vectorTagValue()

template<typename OutputType>

virtual const FieldVariableValue& MooseVariableField< OutputType >::vectorTagValue ( TagID tag ) const

pure virtual

tag values getters

Implemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, 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 >, and MooseVariableFV< Real >.

Member Data Documentation

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

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

◆ _ad_real_dummy

template<typename OutputType>

ADReal MooseVariableField< OutputType >::_ad_real_dummy = 0

mutableprotected

A dummy ADReal variable.

Definition at line 412 of file MooseVariableField.h.

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _array_var_component_names

std::vector<std::string> MooseVariableBase::_array_var_component_names

protectedinherited

Array variable names when the variable is an array variable.

Definition at line 252 of file MooseVariableBase.h.

Referenced by MooseVariableBase::arrayVariableComponent(), MooseVariableBase::isArray(), and MooseVariableBase::MooseVariableBase().

◆ _assembly

Assembly& MooseVariableBase::_assembly

protectedinherited

Assembly data.

Definition at line 222 of file MooseVariableBase.h.

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

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 214 of file BlockRestrictable.h.

Referenced by BlockRestrictable::hasBlockMaterialProperty(), and BlockRestrictable::initializeBlockRestrictable().

libMesh::FEType MooseVariableBase::_fe_type

protectedinherited

The FEType associated with this variable.

Definition at line 201 of file MooseVariableBase.h.

Referenced by MooseVariableBase::feType(), MooseVariableBase::MooseVariableBase(), MooseVariableConstMonomial::MooseVariableConstMonomial(), and MooseVariableBase::order().

protectedinherited

variable number (from libMesh)

Definition at line 204 of file MooseVariableBase.h.

Referenced by MooseVariableFieldBase::activeOnSubdomain(), MooseVariableFieldBase::activeSubdomains(), MooseVariableBase::MooseVariableBase(), MooseVariableBase::number(), and MooseVariableScalar::reinit().

◆ _variable

const libMesh::Variable& MooseVariableBase::_variable

protectedinherited

libMesh variable object for this variable

Definition at line 219 of file MooseVariableBase.h.

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

include/fvics/FVInitialConditionTempl.h
include/variables/MooseVariableField.h
src/variables/MooseVariableField.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename OutputType> class MooseVariableField< OutputType >

OutputType OutputShape OutputData

Member Typedef Documentation

◆ DataFileParameterType

◆ DoFValue

◆ DotType

◆ FieldVariableCurl

◆ FieldVariableDivergence

◆ FieldVariableGradient

◆ FieldVariablePhiCurl

◆ FieldVariablePhiDivergence

◆ FieldVariablePhiGradient

◆ FieldVariablePhiSecond

◆ FieldVariablePhiValue

◆ FieldVariableSecond

◆ FieldVariableTestCurl

◆ FieldVariableTestDivergence

◆ FieldVariableTestGradient

◆ FieldVariableTestSecond

◆ FieldVariableTestValue

◆ FieldVariableValue

◆ FunctorType

◆ GradientType

◆ OutputData

◆ OutputDivergence

◆ OutputGradient

◆ OutputSecond

◆ OutputShape

◆ OutputShapeDivergence

◆ OutputShapeGradient

◆ OutputShapeSecond

◆ ValueType

Constructor & Destructor Documentation

◆ MooseVariableField()

Member Function Documentation

◆ activeOnSubdomain()

◆ activeOnSubdomains()

◆ activeSubdomains()

◆ adCurlSln()

◆ adCurlSlnNeighbor()

◆ add()

◆ adDofValues()

◆ adDofValuesDot()

◆ adDofValuesNeighbor()

◆ adGradSln()

◆ adGradSlnDot()

◆ adGradSlnNeighbor()

◆ adGradSlnNeighborDot()

◆ adSecondSln()

◆ adSecondSlnNeighbor()

◆ adSln()

◆ adSlnNeighbor()

◆ adUDot()

◆ adUDotDot()

◆ adUDotDotNeighbor()

◆ adUDotNeighbor()

◆ allDofIndices()

◆ arrayScalingFactor()

◆ arrayVariableComponent()

◆ blockIDs()

◆ blockRestricted()

◆ blocks()

◆ blocksMaxDimension()

◆ buildOutputHideVariableList()

◆ callMooseError()

◆ checkFace()

◆ checkVariable()

◆ clearAllDofIndices()

◆ clearDofIndices()

◆ componentDofIndices()

◆ componentName()

◆ computeElemValues()

◆ computeElemValuesFace()

template<typename OutputType>
class MooseVariableField< OutputType >