#include <MooseVariableConstMonomial.h>

Inheritance diagram for MooseVariableConstMonomial:

Public Types
using	OutputGradient = typename MooseVariableField< Real >::OutputGradient

using	OutputSecond = typename MooseVariableField< Real >::OutputSecond

using	OutputDivergence = typename MooseVariableField< Real >::OutputDivergence

using	FieldVariableValue = typename MooseVariableField< Real >::FieldVariableValue

using	FieldVariableGradient = typename MooseVariableField< Real >::FieldVariableGradient

using	FieldVariableSecond = typename MooseVariableField< Real >::FieldVariableSecond

using	FieldVariableCurl = typename MooseVariableField< Real >::FieldVariableCurl

using	FieldVariableDivergence = typename MooseVariableField< Real >::FieldVariableDivergence

using	OutputShape = typename MooseVariableField< Real >::OutputShape

using	OutputShapeGradient = typename MooseVariableField< Real >::OutputShapeGradient

using	OutputShapeSecond = typename MooseVariableField< Real >::OutputShapeSecond

using	OutputShapeDivergence = typename MooseVariableField< Real >::OutputShapeDivergence

using	FieldVariablePhiValue = typename MooseVariableField< Real >::FieldVariablePhiValue

using	FieldVariablePhiGradient = typename MooseVariableField< Real >::FieldVariablePhiGradient

using	FieldVariablePhiSecond = typename MooseVariableField< Real >::FieldVariablePhiSecond

using	FieldVariablePhiCurl = typename MooseVariableField< Real >::FieldVariablePhiCurl

using	FieldVariablePhiDivergence = typename MooseVariableField< Real >::FieldVariablePhiDivergence

using	FieldVariableTestValue = typename MooseVariableField< Real >::FieldVariableTestValue

using	FieldVariableTestGradient = typename MooseVariableField< Real >::FieldVariableTestGradient

using	FieldVariableTestSecond = typename MooseVariableField< Real >::FieldVariableTestSecond

using	FieldVariableTestCurl = typename MooseVariableField< Real >::FieldVariableTestCurl

using	FieldVariableTestDivergence = typename MooseVariableField< Real >::FieldVariableTestDivergence

using	FunctorArg = typename Moose::ADType< Real >::type

using	DofValue = typename MooseVariableDataBase< OutputType >::DofValue

using	DofValues = typename MooseVariableDataBase< OutputType >::DofValues

using	ADDofValue = typename MooseVariableDataBase< OutputType >::ADDofValue

using	ADDofValues = typename MooseVariableDataBase< OutputType >::ADDofValues

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

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

using	DotType = ValueType

Public Member Functions
	MooseVariableConstMonomial (const InputParameters &parameters)

virtual void	computeElemValues () override
	Actually compute variable values from the solution vectors.

virtual void	computeElemValuesFace () override
	Compute values at facial quadrature points.

virtual void	computeNeighborValuesFace () override
	Compute values at facial quadrature points for the neighbor.

virtual void	computeNeighborValues () override
	Compute values at quadrature points for the neighbor.

void	clearDofIndices () override
	Clear out the dof indices.

void	prepare () override
	Prepare the elemental degrees of freedom.

void	prepareNeighbor () override
	Prepare the neighbor element degrees of freedom.

void	prepareLowerD () override
	Prepare a lower dimensional element's degrees of freedom.

virtual void	prepareIC () override
	Prepare the initial condition.

void	prepareAux () override

void	reinitNode () override

void	reinitAux () override

void	reinitAuxNeighbor () override

void	reinitNodes (const std::vector< dof_id_type > &nodes) override

void	reinitNodesNeighbor (const std::vector< dof_id_type > &nodes) override

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

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

bool	usesSecondPhi () const
	Whether or not this variable is computing any second derivatives.

bool	usesSecondPhiNeighbor () const override final
	Whether or not this variable is actually using the shape function second derivative on a neighbor.

bool	computingSecond () const override final
	Whether or not this variable is computing any second derivatives.

bool	computingCurl () const override final
	Whether or not this variable is computing the curl.

bool	computingDiv () const override final
	Whether or not this variable is computing the divergence.

bool	isNodal () const override
	Is this variable nodal.

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

bool	supportsQpBasedLoops () const override
	Whether this variable supports QP-indexed loops.

bool	supportsGeometricInfoBasedLoops () const override
	Whether this variable supports geometric-info-based loops, such as ElemInfo/FaceInfo loops.

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

const Node *const &	node () const

const dof_id_type &	nodalDofIndex () const override

virtual bool	isNodalDefined () const override
	Is this variable defined at nodes.

const Node *const &	nodeNeighbor () const

const dof_id_type &	nodalDofIndexNeighbor () const override

bool	isNodalNeighborDefined () const

const Elem *const &	currentElem () const override
	Current element this variable is evaluated at.

const unsigned int &	currentSide () const
	Current side this variable is being evaluated on.

const Elem *const &	neighbor () const
	Current neighboring element.

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

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

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

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

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

void	clearAllDofIndices () final

unsigned int	numberOfDofsNeighbor () override

const FieldVariablePhiValue &	phi () const override
	Return the variable's elemental shape functions.

const FieldVariablePhiGradient &	gradPhi () const override final
	Return the gradients of the variable's elemental shape functions.

const MappedArrayVariablePhiGradient &	arrayGradPhi () const

const FieldVariablePhiSecond &	secondPhi () const override final
	Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.

const FieldVariablePhiCurl &	curlPhi () const override final
	Curl of the shape functions.

const FieldVariablePhiDivergence &	divPhi () const override final
	Divergence of the shape functions.

const FieldVariablePhiValue &	phiFace () const override final
	Return the variable's shape functions on an element face.

const FieldVariablePhiGradient &	gradPhiFace () const override final
	Return the gradients of the variable's shape functions on an element face.

const MappedArrayVariablePhiGradient &	arrayGradPhiFace () const

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

const FieldVariablePhiCurl &	curlPhiFace () const

const FieldVariablePhiDivergence &	divPhiFace () const

const FieldVariablePhiValue &	phiNeighbor () const override final
	Return the variable's shape functions on a neighboring element.

const FieldVariablePhiGradient &	gradPhiNeighbor () const override final
	Return the gradients of the variable's shape functions on a neighboring element.

const MappedArrayVariablePhiGradient &	arrayGradPhiNeighbor () const

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

const FieldVariablePhiCurl &	curlPhiNeighbor () const

const FieldVariablePhiDivergence &	divPhiNeighbor () const

const FieldVariablePhiValue &	phiFaceNeighbor () const override final
	Return the variable's shape functions on a neighboring element face.

const FieldVariablePhiGradient &	gradPhiFaceNeighbor () const override final
	Return the gradients of the variable's shape functions on a neighboring element face.

const MappedArrayVariablePhiGradient &	arrayGradPhiFaceNeighbor () const

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

const FieldVariablePhiCurl &	curlPhiFaceNeighbor () const

const FieldVariablePhiDivergence &	divPhiFaceNeighbor () const

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

const FieldVariablePhiGradient &	gradPhiLower () const

const ADTemplateVariableTestGradient< OutputShape > &	adGradPhi () const

const ADTemplateVariableTestGradient< OutputShape > &	adGradPhiFace () const

const ADTemplateVariableTestGradient< OutputShape > &	adGradPhiFaceNeighbor () const

const FieldVariableValue &	increment () const

const FieldVariableValue &	vectorTagValue (TagID tag) const override
	tag values getters

const FieldVariableGradient &	vectorTagGradient (TagID tag) const

const DofValues &	vectorTagDofValue (TagID tag) const override

const FieldVariableValue &	matrixTagValue (TagID tag) const override

const FieldVariableValue &	sln () const override
	element solutions

const FieldVariableValue &	slnOld () const override

const FieldVariableValue &	slnOlder () const override

const FieldVariableValue &	slnPreviousNL () const

const FieldVariableGradient &	gradSln () const override
	element gradients

const FieldVariableGradient &	gradSlnOld () const override

const FieldVariableGradient &	gradSlnOlder () const

const FieldVariableGradient &	gradSlnPreviousNL () const

const FieldVariableGradient &	gradSlnDot () const
	element gradient dots

const FieldVariableGradient &	gradSlnDotDot () const

const FieldVariableSecond &	secondSln () const
	element seconds

const FieldVariableSecond &	secondSlnOld () const

const FieldVariableSecond &	secondSlnOlder () const

const FieldVariableSecond &	secondSlnPreviousNL () const

const FieldVariableCurl &	curlSln () const
	element curls

const FieldVariableCurl &	curlSlnOld () const

const FieldVariableCurl &	curlSlnOlder () const

const FieldVariableDivergence &	divSln () const
	element divergence

const FieldVariableDivergence &	divSlnOld () const

const FieldVariableDivergence &	divSlnOlder () const

const ADTemplateVariableValue< Real > &	adSln () const override
	AD.

const ADTemplateVariableGradient< Real > &	adGradSln () const override
	AD grad solution getter.

const ADTemplateVariableSecond< Real > &	adSecondSln () const override
	AD second solution getter.

const ADTemplateVariableValue< Real > &	adUDot () const override
	AD time derivative getter.

const ADTemplateVariableValue< Real > &	adUDotDot () const override
	AD second time derivative getter.

const ADTemplateVariableGradient< Real > &	adGradSlnDot () const override
	AD grad of time derivative solution getter.

const ADTemplateVariableCurl< Real > &	adCurlSln () const override
	AD curl solution getter.

const ADTemplateVariableValue< Real > &	adSlnNeighbor () const override
	neighbor AD

const ADTemplateVariableGradient< Real > &	adGradSlnNeighbor () const override
	AD grad neighbor solution getter.

const ADTemplateVariableSecond< Real > &	adSecondSlnNeighbor () const override
	AD second neighbor solution getter.

const ADTemplateVariableValue< Real > &	adUDotNeighbor () const override
	AD neighbor time derivative getter.

const ADTemplateVariableValue< Real > &	adUDotDotNeighbor () const override
	AD neighbor second time derivative getter.

const ADTemplateVariableGradient< Real > &	adGradSlnNeighborDot () const override
	AD grad of time derivative neighbor solution getter.

const ADTemplateVariableCurl< Real > &	adCurlSlnNeighbor () const override
	AD curl neighbor solution getter.

const FieldVariableValue &	uDot () const
	element dots

const FieldVariableValue &	uDotDot () const

const FieldVariableValue &	uDotOld () const

const FieldVariableValue &	uDotDotOld () const

const VariableValue &	duDotDu () const

const VariableValue &	duDotDotDu () const

const FieldVariableValue &	slnNeighbor () const override
	neighbor solutions

const FieldVariableValue &	slnOldNeighbor () const override

const FieldVariableValue &	slnOlderNeighbor () const

const FieldVariableValue &	slnPreviousNLNeighbor () const

const FieldVariableGradient &	gradSlnNeighbor () const override
	neighbor solution gradients

const FieldVariableGradient &	gradSlnOldNeighbor () const override

const FieldVariableGradient &	gradSlnOlderNeighbor () const

const FieldVariableGradient &	gradSlnPreviousNLNeighbor () const

const FieldVariableGradient &	gradSlnNeighborDot () const
	neighbor grad dots

const FieldVariableGradient &	gradSlnNeighborDotDot () const

const FieldVariableSecond &	secondSlnNeighbor () const
	neighbor solution seconds

const FieldVariableSecond &	secondSlnOldNeighbor () const

const FieldVariableSecond &	secondSlnOlderNeighbor () const

const FieldVariableSecond &	secondSlnPreviousNLNeighbor () const

const FieldVariableCurl &	curlSlnNeighbor () const
	neighbor solution curls

const FieldVariableCurl &	curlSlnOldNeighbor () const

const FieldVariableCurl &	curlSlnOlderNeighbor () const

const FieldVariableDivergence &	divSlnNeighbor () const
	neighbor solution divergence

const FieldVariableDivergence &	divSlnOldNeighbor () const

const FieldVariableDivergence &	divSlnOlderNeighbor () const

const FieldVariableValue &	uDotNeighbor () const
	neighbor dots

const FieldVariableValue &	uDotDotNeighbor () const

const FieldVariableValue &	uDotOldNeighbor () const

const FieldVariableValue &	uDotDotOldNeighbor () const

const VariableValue &	duDotDuNeighbor () const

const VariableValue &	duDotDotDuNeighbor () const

const ADTemplateVariableValue< Real > &	adSlnLower () const
	lower-d element solution

const FieldVariableValue &	slnLower () const

const FieldVariableValue &	slnLowerOld () const

virtual void	computeLowerDValues () override
	compute values at quadrature points on the lower dimensional element

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

virtual void	setDofValue (const DofValue &value, unsigned int index) override
	Degree of freedom value setters.

virtual void	setDofValues (const DenseVector< DofValue > &values) override
	Set local DOF values and evaluate the values on quadrature points.

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

void	insertNodalValue (libMesh::NumericVector< libMesh::Number > &residual, const DofValue &v)
	Write a nodal value to the passed-in solution vector.

DofValue	getNodalValue (const Node &node) const
	Get the value of this variable at given node.

DofValue	getNodalValueOld (const Node &node) const
	Get the old value of this variable at given node.

DofValue	getNodalValueOlder (const Node &node) const
	Get the t-2 value of this variable at given node.

DofValue	getElementalValue (const Elem *elem, unsigned int idx=0) const
	Get the current value of this variable on an element.

DofValue	getElementalValueOld (const Elem *elem, unsigned int idx=0) const
	Get the old value of this variable on an element.

DofValue	getElementalValueOlder (const Elem *elem, unsigned int idx=0) const
	Get the older value of this variable on an element.

virtual void	insert (libMesh::NumericVector< libMesh::Number > &vector) override
	Set the current local DOF values to the input vector.

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

virtual void	add (libMesh::NumericVector< libMesh::Number > &vector) override
	Add the current local DOF values to the input vector.

void	addSolution (const DenseVector< libMesh::Number > &v)
	Add passed in local DOF values onto the current solution.

void	addSolutionNeighbor (const DenseVector< libMesh::Number > &v)
	Add passed in local neighbor DOF values onto the current solution.

const DofValues &	dofValue () const

const DofValues &	dofValues () const override
	dof values getters

const DofValues &	dofValuesOld () const override

const DofValues &	dofValuesOlder () const override

const DofValues &	dofValuesPreviousNL () const override

const DofValues &	dofValuesNeighbor () const override

const DofValues &	dofValuesOldNeighbor () const override

const DofValues &	dofValuesOlderNeighbor () const override

const DofValues &	dofValuesPreviousNLNeighbor () const override

const DofValues &	dofValuesDot () const override

const DofValues &	dofValuesDotNeighbor () const override

const DofValues &	dofValuesDotNeighborResidual () const

const DofValues &	dofValuesDotOld () const override

const DofValues &	dofValuesDotOldNeighbor () const override

const DofValues &	dofValuesDotDot () const override

const DofValues &	dofValuesDotDotNeighbor () const override

const DofValues &	dofValuesDotDotNeighborResidual () const

const DofValues &	dofValuesDotDotOld () const override

const DofValues &	dofValuesDotDotOldNeighbor () const override

const MooseArray< libMesh::Number > &	dofValuesDuDotDu () const override

const MooseArray< libMesh::Number > &	dofValuesDuDotDuNeighbor () const override

const MooseArray< libMesh::Number > &	dofValuesDuDotDotDu () const override

const MooseArray< libMesh::Number > &	dofValuesDuDotDotDuNeighbor () const override

const ADDofValues &	adDofValues () const override
	Return the AD dof values.

const ADDofValues &	adDofValuesNeighbor () const override
	Return the AD neighbor dof values.

const ADDofValues &	adDofValuesDot () const override
	Return the AD time derivatives at dofs.

void	computeIncrementAtQps (const libMesh::NumericVector< libMesh::Number > &increment_vec)
	Compute and store incremental change in solution at QPs based on increment_vec.

void	computeIncrementAtNode (const libMesh::NumericVector< libMesh::Number > &increment_vec)
	Compute and store incremental change at the current node based on increment_vec.

Real	getValue (const Elem *elem, const std::vector< std::vector< OutputShape > > &phi) const
	Compute the variable value at a point on an element.

OutputTools< Real >::OutputGradient	getGradient (const Elem *elem, const std::vector< std::vector< typename OutputTools< Real >::OutputShapeGradient > > &grad_phi) const
	Compute the variable gradient value at a point on an element.

virtual std::size_t	phiSize () const final
	Return phi size.

virtual std::size_t	phiFaceSize () const final
	Return phiFace size.

virtual std::size_t	phiNeighborSize () const final
	Return phiNeighbor size.

virtual std::size_t	phiFaceNeighborSize () const final
	Return phiFaceNeighbor size.

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

const Real &	nodalValue () const
	Methods for retrieving values of variables at the nodes.

const Real &	nodalValueOld () const

const Real &	nodalValueOlder () const

const Real &	nodalValuePreviousNL () const

const Real &	nodalValueDot () const

const Real &	nodalValueDotDot () const

const Real &	nodalValueDotOld () const

const Real &	nodalValueDotDotOld () const

const Real &	nodalValueDuDotDu () const

const Real &	nodalValueDuDotDotDu () const

const Real &	nodalValueNeighbor () const

const Real &	nodalValueOldNeighbor () const

const Real &	nodalValueOlderNeighbor () const

const Real &	nodalValuePreviousNLNeighbor () const

const Real &	nodalValueDotNeighbor () const

const Real &	nodalValueDotNeighborResidual () const

const Real &	nodalValueDotDotNeighbor () const

const Real &	nodalValueDotDotNeighborResidual () const

const Real &	nodalValueDotOldNeighbor () const

const Real &	nodalValueDotDotOldNeighbor () const

const Real &	nodalValueDuDotDuNeighbor () const

const Real &	nodalValueDuDotDotDuNeighbor () const

const MooseArray< Real > &	nodalValueArray () const override
	Methods for retrieving values of variables at the nodes in a MooseArray for AuxKernelBase.

const MooseArray< Real > &	nodalValueOldArray () const override

const MooseArray< Real > &	nodalValueOlderArray () const override

const DofValues &	nodalVectorTagValue (TagID tag) const override

const DofValues &	nodalMatrixTagValue (TagID tag) const override

const Moose::ADType< Real >::type &	adNodalValue () const

virtual void	computeNodalValues () override
	Compute nodal values of this variable.

virtual void	computeNodalNeighborValues () override
	Compute nodal values of this variable in the neighbor.

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

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

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

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

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

virtual void	sizeMatrixTagData () override
	Size data structures related to matrix tagging.

bool	supportsFaceArg () const override final
	Whether this functor supports evaluation with FaceArg.

bool	supportsElemSideQpArg () const override final
	Whether this functor supports evaluation with ElemSideQpArg.

void	computeSolution (const Elem *const elem, const unsigned int n_qp, const StateArg &state, const Shapes &phi, Solution &local_soln, const GradShapes &grad_phi, GradSolution &grad_local_soln, Solution &dot_local_soln, GradSolution &grad_dot_local_soln) const

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

virtual bool	isArray () const override

virtual bool	isVector () const override

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

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

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

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

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

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

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

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

virtual bool	isFV () const

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

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

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

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

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

virtual void	requireQpComputations () const
	Request that quadrature point data be (pre)computed.

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

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

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

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

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

bool	useDual () const
	Get dual mortar option.

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

unsigned int	totalVarDofs ()

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

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

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

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.

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

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

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.

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

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

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

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

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

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

bool	isKokkosObject () const
	Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

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

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

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

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

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

MooseObjectName	uniqueName () const

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

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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.

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object.

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object.

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.

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

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

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.

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.

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.

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const

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.

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used.

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

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

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

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

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

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

template<typename... Args>
void	mooseDeprecated (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and a stack trace.

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

template<typename... Args>
void	mooseDeprecatedNoTrace (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and no stack trace.

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
	External method for calling moose error with added object context.

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.

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

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path.

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

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

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.

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

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

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

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.

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

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

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.

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

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

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

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

virtual void	customSetup (const ExecFlagType &exec_type) override

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

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.

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

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

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

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

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

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.


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

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.

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.

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.

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

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)
	External method for calling moose error with added object context.

Public Attributes
	usingCombinedWarningSolutionWarnings

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

Static Public Attributes
static const std::string	type_param = "_type"
	The name of the parameter that contains the object type.

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name.

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name.

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp.

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base.

static const std::string	kokkos_object_param = "_kokkos_object"
	The name of the parameter that indicates an object is a Kokkos functor.

Protected Types
using	ElemArg = Moose::ElemArg

using	ElemQpArg = Moose::ElemQpArg

using	ElemSideQpArg = Moose::ElemSideQpArg

using	FaceArg = Moose::FaceArg

using	StateArg = Moose::StateArg

using	NodeArg = Moose::NodeArg

using	ElemPointArg = Moose::ElemPointArg

Protected Member Functions
ValueType	faceEvaluate (const FaceArg &, const StateArg &, const std::vector< ValueType > &cache_data) const
	A common method that both evaluate(FaceArg) and evaluateDot(FaceArg) can call.

ValueType	evaluate (const ElemQpArg &elem_qp, const StateArg &state) const override final

ValueType	evaluate (const ElemSideQpArg &elem_side_qp, const StateArg &state) const override final

ValueType	evaluate (const ElemArg &, const StateArg &) const override final
	Evaluate the functor with a given element.

ValueType	evaluate (const ElemPointArg &, const StateArg &) const override final
	Evaluate the functor with a given element and point.

ValueType	evaluate (const NodeArg &node_arg, const StateArg &state) const override final

ValueType	evaluate (const FaceArg &, const StateArg &) const override final

GradientType	evaluateGradient (const ElemQpArg &elem_qp, const StateArg &state) const override

GradientType	evaluateGradient (const ElemSideQpArg &elem_side_qp, const StateArg &state) const override final

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

DotType	evaluateDot (const ElemQpArg &elem_qp, const StateArg &state) const override final

DotType	evaluateDot (const ElemSideQpArg &elem_side_qp, const StateArg &state) const override final

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

DotType	evaluateDot (const FaceArg &, const StateArg &) const override final

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

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

bool	doDerivatives () const

template<bool warning>
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
	Set solution invalid mark for the given solution ID.

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

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

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

void	initializeKokkosBlockRestrictable ()

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

KOKKOS_FUNCTION dof_id_type	numKokkosBlockElements () const
	Get the number of elements this Kokkos object is operating on.

KOKKOS_FUNCTION dof_id_type	numKokkosBlockNodes () const
	Get the number of nodes this Kokkos object is operating on.

KOKKOS_FUNCTION dof_id_type	numKokkosBlockSides () const
	Get the number of sides this Kokkos object is operating on.

KOKKOS_FUNCTION ContiguousElementID	kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID this Kokkos thread is operating on.

KOKKOS_FUNCTION ContiguousElementID	kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous node index this Kokkos thread is operating on.

KOKKOS_FUNCTION auto	kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
	Get the contiguous element ID - side index pair this Kokkos thread is operating on.

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 GradientType	evaluateGradient (const FaceArg &, const StateArg &) const

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

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

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

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

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.

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

Protected Attributes
	usingMooseVariableFieldMembers

std::unique_ptr< MooseVariableData< Real > >	_element_data
	Holder for all the data associated with the "main" element.

std::unique_ptr< MooseVariableData< Real > >	_neighbor_data
	Holder for all the data associated with the neighbor element.

std::unique_ptr< MooseVariableData< Real > >	_lower_data
	Holder for all the data associated with the lower dimeensional element.

SystemBase &	_sys
	System this variable is part of.

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

unsigned int	_var_num
	variable number (from libMesh)

unsigned int	_index
	variable number within MOOSE

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

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

SubProblem &	_subproblem
	Problem this variable is part of.

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

Assembly &	_assembly
	Assembly data.

const libMesh::DofMap &	_dof_map
	DOF map.

std::vector< dof_id_type >	_dof_indices
	DOF indices.

MooseMesh &	_mesh
	mesh the variable is active in

THREAD_ID	_tid
	Thread ID.

const unsigned int	_count
	Number of variables in the array.

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

bool	_use_dual
	If dual mortar approach is used.

bool	_is_lower_d
	Whether this variable lives on lower dimensional blocks.

std::vector< std::string >	_array_var_component_names
	Array variable names when the variable is an array variable.

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

MooseApp &	_app
	The MOOSE application this is associated with.

Factory &	_factory
	The Factory associated with the MooseApp.

ActionFactory &	_action_factory
	Builds Actions.

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

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

const InputParameters &	_pars
	The object's parameters.

const Parallel::Communicator &	_communicator

const MaterialData *	_blk_material_data
	Pointer to the MaterialData class for this object.

const ExecFlagEnum &	_execute_enum
	Execute settings for this object.

const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase.

FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance.

Private Member Functions
void	computeSolution (const Elem *elem, unsigned int n_qp, const StateArg &state, const Shapes &phi, Solution &local_soln, const GradShapes &grad_phi, GradSolution &grad_local_soln, Solution &dot_local_soln, GradSolution &grad_dot_local_soln) const
	Compute the solution, gradient, time derivative, and gradient of the time derivative with provided shape functions.

void	evaluateOnElement (const ElemQpArg &elem_qp, const StateArg &state, bool cache_eligible) const
	Evaluate solution and gradient for the `elem_qp` argument.

void	evaluateOnElementSide (const ElemSideQpArg &elem_side_qp, const StateArg &state, bool cache_eligible) const
	Evaluate solution and gradient for the `elem_side_qp` argument.

void	clearCacheData ()
	clear cache data

ValueType	queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Moose::ADType< OutputType >::type > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
	check a qp cache and if invalid then evaluate

ValueType	queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
	check a finite volume spatial argument cache and if invalid then evaluate

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
	Internal method for getting a hit node (if available) given a set of parameters.

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)
	Internal method for getting the message prefix for an object (object type, name, etc).

Private Attributes
const Elem *	_current_elem_qp_functor_elem
	Keep track of the current elem-qp functor element in order to enable local caching (e.g.

std::vector< ValueType >	_current_elem_qp_functor_sln
	The values of the solution for the `_current_elem_qp_functor_elem`.

std::vector< GradientType >	_current_elem_qp_functor_gradient
	The values of the gradient for the `_current_elem_qp_functor_elem`.

std::vector< DotType >	_current_elem_qp_functor_dot
	The values of the time derivative for the `_current_elem_qp_functor_elem`.

std::vector< GradientType >	_current_elem_qp_functor_grad_dot
	The values of the gradient of the time derivative for the `_current_elem_qp_functor_elem`.

std::pair< const Elem *, unsigned int >	_current_elem_side_qp_functor_elem_side
	Keep track of the current elem-side-qp functor element and side in order to enable local caching (e.g.

std::vector< ValueType >	_current_elem_side_qp_functor_sln
	The values of the solution for the `_current_elem_side_qp_functor_elem_side`.

std::vector< GradientType >	_current_elem_side_qp_functor_gradient
	The values of the gradient for the `_current_elem_side_qp_functor_elem_side`.

std::vector< DotType >	_current_elem_side_qp_functor_dot
	The values of the time derivative for the `_current_elem_side_qp_functor_elem_side`.

std::vector< GradientType >	_current_elem_side_qp_functor_grad_dot
	The values of the gradient of the time derivative for the `_current_elem_side_qp_functor_elem_side`.

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base
	The MooseBase that owns this interface.

const FEProblemBase *	_si_problem
	A pointer to FEProblem base.

std::set< SubdomainID >	_blk_ids
	Set of block ids supplied by the user via the input file (for error checking)

std::vector< SubdomainID >	_vec_ids
	Vector of block ids supplied by the user via the input file (for error reporting)

std::vector< SubdomainName >	_blocks
	Vector the block names supplied by the user via the input file.

const bool	_blk_dual_restrictable
	Flag for allowing dual restriction.

FEProblemBase *	_blk_feproblem
	Pointer to FEProblemBase.

const MooseMesh *	_blk_mesh
	Pointer to Mesh.

const std::set< BoundaryID >	_empty_boundary_ids
	An empty set for referencing when boundary_ids is not included.

const std::set< BoundaryID > &	_boundary_ids
	Reference to the boundary_ids, defaults to an empty set if not provided.

THREAD_ID	_blk_tid
	Thread id for this object.

const std::string &	_blk_name
	Name of the object.

unsigned int	_blk_dim
	Largest mesh dimension of the elements in the blocks for this object.

const MooseObject *	_moose_object
	Pointer to the MOOSE object.

Moose::Kokkos::Array< ContiguousElementID >	_kokkos_element_ids
	List of contiguous element IDs this Kokkos object is operating on.

Moose::Kokkos::Array< ContiguousNodeID >	_kokkos_node_ids
	List of contiguous node IDs this Kokkos object is operating on.

Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > >	_kokkos_element_side_ids
	List of contiguous local element ID - side index pairs this Kokkos object is operating on.

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

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

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

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

std::set< ExecFlagType >	_clearance_schedule
	How often to clear the material property cache.

bool	_always_evaluate
	Boolean to check if we always need evaluation.

dof_id_type	_current_qp_map_key
	Current key for qp map cache.

std::vector< std::pair< bool, ValueType > > *	_current_qp_map_value
	Current value for qp map cache.

std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > >	_qp_to_value
	Cached element quadrature point functor property evaluations.

dof_id_type	_current_side_qp_map_key
	Current key for side-qp map cache.

std::vector< std::vector< std::pair< bool, ValueType > > > *	_current_side_qp_map_value
	Current value for side-qp map cache.

std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > >	_side_qp_to_value
	Cached element quadrature point functor property evaluations.

std::map< ElemArg, ValueType >	_elem_arg_to_value
	Map from element arguments to their cached evaluations.

std::map< FaceArg, ValueType >	_face_arg_to_value
	Map from face arguments to their cached evaluations.

std::map< NodeArg, ValueType >	_node_arg_to_value
	Map from nodal arguments to their cached evaluations.

MooseFunctorName	_functor_name
	name of the functor

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

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

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

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

ADReal	_ad_real_dummy = 0
	A dummy ADReal variable.

Detailed Description

Definition at line 14 of file MooseVariableConstMonomial.h.

Member Typedef Documentation

◆ ADDofValue

template<typename OutputType >

using MooseVariableField< OutputType >::ADDofValue = typename MooseVariableDataBase<OutputType>::ADDofValue

inherited

Definition at line 83 of file MooseVariableField.h.

◆ ADDofValues

template<typename OutputType >

using MooseVariableField< OutputType >::ADDofValues = typename MooseVariableDataBase<OutputType>::ADDofValues

inherited

Definition at line 84 of file MooseVariableField.h.

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

◆ DofValue

template<typename OutputType >

using MooseVariableField< OutputType >::DofValue = typename MooseVariableDataBase<OutputType>::DofValue

inherited

Definition at line 81 of file MooseVariableField.h.

◆ DofValues

template<typename OutputType >

using MooseVariableField< OutputType >::DofValues = typename MooseVariableDataBase<OutputType>::DofValues

inherited

Definition at line 82 of file MooseVariableField.h.

◆ DotType

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

inherited

Definition at line 150 of file MooseFunctor.h.

◆ ElemArg

using MooseVariableFE< Real >::ElemArg = Moose::ElemArg

protectedinherited

Definition at line 737 of file MooseVariableFE.h.

◆ ElemPointArg

using MooseVariableFE< Real >::ElemPointArg = Moose::ElemPointArg

protectedinherited

Definition at line 743 of file MooseVariableFE.h.

◆ ElemQpArg

using MooseVariableFE< Real >::ElemQpArg = Moose::ElemQpArg

protectedinherited

Definition at line 738 of file MooseVariableFE.h.

◆ ElemSideQpArg

using MooseVariableFE< Real >::ElemSideQpArg = Moose::ElemSideQpArg

protectedinherited

Definition at line 739 of file MooseVariableFE.h.

◆ FaceArg

using MooseVariableFE< Real >::FaceArg = Moose::FaceArg

protectedinherited

Definition at line 740 of file MooseVariableFE.h.

◆ FieldVariableCurl

using MooseVariableFE< Real >::FieldVariableCurl = typename MooseVariableField<Real >::FieldVariableCurl

inherited

Definition at line 56 of file MooseVariableFE.h.

◆ FieldVariableDivergence

using MooseVariableFE< Real >::FieldVariableDivergence = typename MooseVariableField<Real >::FieldVariableDivergence

inherited

Definition at line 57 of file MooseVariableFE.h.

◆ FieldVariableGradient

using MooseVariableFE< Real >::FieldVariableGradient = typename MooseVariableField<Real >::FieldVariableGradient

inherited

Definition at line 54 of file MooseVariableFE.h.

◆ FieldVariablePhiCurl

using MooseVariableFE< Real >::FieldVariablePhiCurl = typename MooseVariableField<Real >::FieldVariablePhiCurl

inherited

Definition at line 68 of file MooseVariableFE.h.

◆ FieldVariablePhiDivergence

using MooseVariableFE< Real >::FieldVariablePhiDivergence = typename MooseVariableField<Real >::FieldVariablePhiDivergence

inherited

Definition at line 69 of file MooseVariableFE.h.

◆ FieldVariablePhiGradient

using MooseVariableFE< Real >::FieldVariablePhiGradient = typename MooseVariableField<Real >::FieldVariablePhiGradient

inherited

Definition at line 65 of file MooseVariableFE.h.

◆ FieldVariablePhiSecond

using MooseVariableFE< Real >::FieldVariablePhiSecond = typename MooseVariableField<Real >::FieldVariablePhiSecond

inherited

Definition at line 67 of file MooseVariableFE.h.

◆ FieldVariablePhiValue

using MooseVariableFE< Real >::FieldVariablePhiValue = typename MooseVariableField<Real >::FieldVariablePhiValue

inherited

Definition at line 64 of file MooseVariableFE.h.

◆ FieldVariableSecond

using MooseVariableFE< Real >::FieldVariableSecond = typename MooseVariableField<Real >::FieldVariableSecond

inherited

Definition at line 55 of file MooseVariableFE.h.

◆ FieldVariableTestCurl

using MooseVariableFE< Real >::FieldVariableTestCurl = typename MooseVariableField<Real >::FieldVariableTestCurl

inherited

Definition at line 76 of file MooseVariableFE.h.

◆ FieldVariableTestDivergence

using MooseVariableFE< Real >::FieldVariableTestDivergence = typename MooseVariableField<Real >::FieldVariableTestDivergence

inherited

Definition at line 77 of file MooseVariableFE.h.

◆ FieldVariableTestGradient

using MooseVariableFE< Real >::FieldVariableTestGradient = typename MooseVariableField<Real >::FieldVariableTestGradient

inherited

Definition at line 73 of file MooseVariableFE.h.

◆ FieldVariableTestSecond

using MooseVariableFE< Real >::FieldVariableTestSecond = typename MooseVariableField<Real >::FieldVariableTestSecond

inherited

Definition at line 75 of file MooseVariableFE.h.

◆ FieldVariableTestValue

using MooseVariableFE< Real >::FieldVariableTestValue = typename MooseVariableField<Real >::FieldVariableTestValue

inherited

Definition at line 72 of file MooseVariableFE.h.

◆ FieldVariableValue

using MooseVariableFE< Real >::FieldVariableValue = typename MooseVariableField<Real >::FieldVariableValue

inherited

Definition at line 53 of file MooseVariableFE.h.

◆ FunctorArg

using MooseVariableFE< Real >::FunctorArg = typename Moose::ADType<Real >::type

inherited

Definition at line 85 of file MooseVariableFE.h.

◆ FunctorType

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

inherited

Definition at line 140 of file MooseFunctor.h.

◆ GradientType

using Moose::FunctorBase< Moose::ADType< OutputType >::type >::GradientType = typename FunctorReturnType<Moose::ADType< OutputType >::type , FunctorEvaluationKind::Gradient>::type

inherited

This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).

This logic will make it such that if a user requests a functor type T that is a container of algebraic types, for example Reals, then the GradientType will be a container of the gradients of those algebraic types, in this example VectorValue<Reals>. So if T is std::vector<Real>, then GradientType will be std::vector<VectorValue<Real>>. As another example: T = std::array<VectorValue<Real>, 1> -> GradientType = std::array<TensorValue<Real>, 1>

Definition at line 149 of file MooseFunctor.h.

◆ NodeArg

using MooseVariableFE< Real >::NodeArg = Moose::NodeArg

protectedinherited

Definition at line 742 of file MooseVariableFE.h.

◆ OutputDivergence

using MooseVariableFE< Real >::OutputDivergence = typename MooseVariableField<Real >::OutputDivergence

inherited

Definition at line 51 of file MooseVariableFE.h.

◆ OutputGradient

using MooseVariableFE< Real >::OutputGradient = typename MooseVariableField<Real >::OutputGradient

inherited

Definition at line 49 of file MooseVariableFE.h.

◆ OutputSecond

using MooseVariableFE< Real >::OutputSecond = typename MooseVariableField<Real >::OutputSecond

inherited

Definition at line 50 of file MooseVariableFE.h.

◆ OutputShape

using MooseVariableFE< Real >::OutputShape = typename MooseVariableField<Real >::OutputShape

inherited

Definition at line 59 of file MooseVariableFE.h.

◆ OutputShapeDivergence

using MooseVariableFE< Real >::OutputShapeDivergence = typename MooseVariableField<Real >::OutputShapeDivergence

inherited

Definition at line 62 of file MooseVariableFE.h.

◆ OutputShapeGradient

using MooseVariableFE< Real >::OutputShapeGradient = typename MooseVariableField<Real >::OutputShapeGradient

inherited

Definition at line 60 of file MooseVariableFE.h.

◆ OutputShapeSecond

using MooseVariableFE< Real >::OutputShapeSecond = typename MooseVariableField<Real >::OutputShapeSecond

inherited

Definition at line 61 of file MooseVariableFE.h.

◆ StateArg

using MooseVariableFE< Real >::StateArg = Moose::StateArg

protectedinherited

Definition at line 741 of file MooseVariableFE.h.

◆ ValueType

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

inherited

Definition at line 141 of file MooseFunctor.h.

Constructor & Destructor Documentation

◆ MooseVariableConstMonomial()

MooseVariableConstMonomial::MooseVariableConstMonomial ( const InputParameters & parameters )

Definition at line 30 of file MooseVariableConstMonomial.C.

  : MooseVariable(parameters)
{
  if (_fe_type.order != CONSTANT || _fe_type.family != MONOMIAL)
    mooseError("This type is only meant for a CONSTANT "
               "MONOMIAL finite element basis. You have requested a ",
               Utility::enum_to_string(_fe_type.family),
               " family and order ",
               Utility::enum_to_string(Order(_fe_type.order)));
}

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.

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

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

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

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

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

◆ activeSubdomains()

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

inherited

The subdomains the variable is active on.

Definition at line 39 of file MooseVariableFieldBase.C.

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

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

◆ adCurlSln()

const ADTemplateVariableCurl< Real > & MooseVariableFE< Real >::adCurlSln ( ) const

inlineoverridevirtualinherited

AD curl solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 366 of file MooseVariableFE.h.

  {
    return _element_data->adCurlSln();
  }

◆ adCurlSlnNeighbor()

const ADTemplateVariableCurl< Real > & MooseVariableFE< Real >::adCurlSlnNeighbor ( ) const

inlineoverridevirtualinherited

AD curl neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 396 of file MooseVariableFE.h.

  {
    return _neighbor_data->adCurlSln();
  }

◆ add()

void MooseVariableFE< Real >::add ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtualinherited

Add the current local DOF values to the input vector.

Implements MooseVariableFieldBase.

Definition at line 573 of file MooseVariableFE.C.

{
  _element_data->add(vector);
}

◆ adDofValues()

const MooseVariableFE< Real >::ADDofValues & MooseVariableFE< Real >::adDofValues ( ) const

inlineoverridevirtualinherited

Return the AD dof values.

Implements MooseVariableField< OutputType >.

Definition at line 609 of file MooseVariableFE.h.

{
  return _element_data->adDofValues();
}

◆ adDofValuesDot()

const MooseVariableFE< Real >::ADDofValues & MooseVariableFE< Real >::adDofValuesDot ( ) const

inlineoverridevirtualinherited

Return the AD time derivatives at dofs.

Implements MooseVariableField< OutputType >.

Definition at line 611 of file MooseVariableFE.h.

{
  return _element_data->adDofValuesDot();
}

◆ adDofValuesNeighbor()

const MooseVariableFE< Real >::ADDofValues & MooseVariableFE< Real >::adDofValuesNeighbor ( ) const

inlineoverridevirtualinherited

Return the AD neighbor dof values.

Implements MooseVariableField< OutputType >.

Definition at line 610 of file MooseVariableFE.h.

{
  return _neighbor_data->adDofValues();
}

◆ addSolution()

void MooseVariableFE< Real >::addSolution ( const DenseVector< libMesh::Number > & v )

inherited

Add passed in local DOF values onto the current solution.

Definition at line 578 of file MooseVariableFE.C.

{
  _element_data->addSolution(this->_sys.solution(), v);
}

◆ addSolutionNeighbor()

void MooseVariableFE< Real >::addSolutionNeighbor ( const DenseVector< libMesh::Number > & v )

inherited

Add passed in local neighbor DOF values onto the current solution.

Definition at line 583 of file MooseVariableFE.C.

{
  _neighbor_data->addSolution(this->_sys.solution(), v);
}

◆ adGradPhi()

const ADTemplateVariableTestGradient< OutputShape > & MooseVariableFE< Real >::adGradPhi ( ) const

inlineinherited

Definition at line 252 of file MooseVariableFE.h.

  {
    return _element_data->adGradPhi();
  }

◆ adGradPhiFace()

const ADTemplateVariableTestGradient< OutputShape > & MooseVariableFE< Real >::adGradPhiFace ( ) const

inlineinherited

Definition at line 257 of file MooseVariableFE.h.

  {
    return _element_data->adGradPhiFace();
  }

◆ adGradPhiFaceNeighbor()

const ADTemplateVariableTestGradient< OutputShape > & MooseVariableFE< Real >::adGradPhiFaceNeighbor ( ) const

inlineinherited

Definition at line 262 of file MooseVariableFE.h.

  {
    return _neighbor_data->adGradPhiFace();
  }

◆ adGradSln()

const ADTemplateVariableGradient< Real > & MooseVariableFE< Real >::adGradSln ( ) const

inlineoverridevirtualinherited

AD grad solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 346 of file MooseVariableFE.h.

  {
    return _element_data->adGradSln();
  }

◆ adGradSlnDot()

const ADTemplateVariableGradient< Real > & MooseVariableFE< Real >::adGradSlnDot ( ) const

inlineoverridevirtualinherited

AD grad of time derivative solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 362 of file MooseVariableFE.h.

  {
    return _element_data->adGradSlnDot();
  }

◆ adGradSlnNeighbor()

const ADTemplateVariableGradient< Real > & MooseVariableFE< Real >::adGradSlnNeighbor ( ) const

inlineoverridevirtualinherited

AD grad neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 376 of file MooseVariableFE.h.

  {
    return _neighbor_data->adGradSln();
  }

◆ adGradSlnNeighborDot()

const ADTemplateVariableGradient< Real > & MooseVariableFE< Real >::adGradSlnNeighborDot ( ) const

inlineoverridevirtualinherited

AD grad of time derivative neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 392 of file MooseVariableFE.h.

  {
    return _neighbor_data->adGradSlnDot();
  }

◆ adNodalValue()

const Moose::ADType< Real >::type & MooseVariableFE< Real >::adNodalValue ( ) const

inlineinherited

Definition at line 703 of file MooseVariableFE.h.

{
  return _element_data->adNodalValue();
}

◆ adSecondSln()

const ADTemplateVariableSecond< Real > & MooseVariableFE< Real >::adSecondSln ( ) const

inlineoverridevirtualinherited

AD second solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 350 of file MooseVariableFE.h.

  {
    return _element_data->adSecondSln();
  }

◆ adSecondSlnNeighbor()

const ADTemplateVariableSecond< Real > & MooseVariableFE< Real >::adSecondSlnNeighbor ( ) const

inlineoverridevirtualinherited

AD second neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 380 of file MooseVariableFE.h.

  {
    return _neighbor_data->adSecondSln();
  }

◆ adSln()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adSln ( ) const

inlineoverridevirtualinherited

AD.

Implements MooseVariableField< OutputType >.

Definition at line 341 of file MooseVariableFE.h.

  {
    return _element_data->adSln();
  }

◆ adSlnLower()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adSlnLower ( ) const

inlineinherited

lower-d element solution

Definition at line 504 of file MooseVariableFE.h.

504{ return _lower_data->adSln(); }

MooseVariableFE< Real >::_lower_data

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition MooseVariableFE.h:731

◆ adSlnNeighbor()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adSlnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor AD

Implements MooseVariableField< OutputType >.

Definition at line 372 of file MooseVariableFE.h.

  {
    return _neighbor_data->adSln();
  }

◆ adUDot()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adUDot ( ) const

inlineoverridevirtualinherited

AD time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 354 of file MooseVariableFE.h.

  {
    return _element_data->adUDot();
  }

◆ adUDotDot()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adUDotDot ( ) const

inlineoverridevirtualinherited

AD second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 358 of file MooseVariableFE.h.

  {
    return _element_data->adUDotDot();
  }

◆ adUDotDotNeighbor()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adUDotDotNeighbor ( ) const

inlineoverridevirtualinherited

AD neighbor second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 388 of file MooseVariableFE.h.

  {
    return _neighbor_data->adUDotDot();
  }

◆ adUDotNeighbor()

const ADTemplateVariableValue< Real > & MooseVariableFE< Real >::adUDotNeighbor ( ) const

inlineoverridevirtualinherited

AD neighbor time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 384 of file MooseVariableFE.h.

  {
    return _neighbor_data->adUDot();
  }

◆ allDofIndices()

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

inherited

Get all global dofindices for the variable.

Definition at line 157 of file MooseVariableBase.C.

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

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

◆ arrayGradPhi()

const MappedArrayVariablePhiGradient & MooseVariableFE< Real >::arrayGradPhi ( ) const

inlineinherited

Definition at line 199 of file MooseVariableFE.h.

  {
    return _element_data->arrayGradPhi();
  }

◆ arrayGradPhiFace()

const MappedArrayVariablePhiGradient & MooseVariableFE< Real >::arrayGradPhiFace ( ) const

inlineinherited

Definition at line 212 of file MooseVariableFE.h.

  {
    return _element_data->arrayGradPhiFace();
  }

◆ arrayGradPhiFaceNeighbor()

const MappedArrayVariablePhiGradient & MooseVariableFE< Real >::arrayGradPhiFaceNeighbor ( ) const

inlineinherited

Definition at line 241 of file MooseVariableFE.h.

  {
    return _neighbor_data->arrayGradPhiFace();
  }

◆ arrayGradPhiNeighbor()

const MappedArrayVariablePhiGradient & MooseVariableFE< Real >::arrayGradPhiNeighbor ( ) const

inlineinherited

Definition at line 225 of file MooseVariableFE.h.

  {
    return _neighbor_data->arrayGradPhi();
  }

◆ arrayScalingFactor()

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

inlineinherited

Definition at line 102 of file MooseVariableBase.h.

102{ return _scaling_factor; }

MooseVariableBase::_scaling_factor

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition MooseVariableBase.h:260

Referenced by Assembly::addJacobianBlockNonlocal(), Assembly::cacheJacobianBlock(), Assembly::cacheJacobianBlockNonzero(), ADArrayKernel::computeJacobian(), ADArrayNodalKernel::computeJacobian(), and ADArrayNodalKernel::computeResidual().

◆ 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 148 of file MooseVariableBase.C.

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

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

◆ 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 209 of file BlockRestrictable.C.

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

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

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 197 of file BlockRestrictable.C.

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

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(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

◆ 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 203 of file BlockRestrictable.C.

{
  return _blocks;
}

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

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

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

Definition at line 386 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 68 of file OutputInterface.C.

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

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

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node,
		const bool	show_trace = `true`
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 114 of file MooseBase.C.

{
  if (!node)
    node = MooseBase::getHitNode(params);
 
  std::string multiapp_prefix = "";
  if (app)
  {
    if (!app->isUltimateMaster())
      multiapp_prefix = app->name();
    app->getOutputWarehouse().mooseConsole();
  }
 
  if (with_prefix)
    // False here because the hit context will get processed by the node
    msg = messagePrefix(params, false) + msg;
 
  moose::internal::mooseErrorRaw(msg, multiapp_prefix, node, show_trace);
}

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`,
		const bool	show_trace = `true`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 105 of file MooseBase.C.

{
  callMooseError(&_app, _pars, msg, with_prefix, node, show_trace);
}

Referenced by MooseBase::callMooseError(), InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

◆ 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 \emph 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 280 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 358 of file BlockRestrictable.C.

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

Referenced by DomainUserObject::checkVariable().

◆ clearAllDofIndices()

void MooseVariableFE< Real >::clearAllDofIndices ( )

finalvirtualinherited

Reimplemented from MooseVariableBase.

Definition at line 190 of file MooseVariableFE.C.

{
  _element_data->clearDofIndices();
  _neighbor_data->clearDofIndices();
  _lower_data->clearDofIndices();
}

◆ clearCacheData()

void Moose::FunctorBase< Moose::ADType< OutputType >::type >::clearCacheData ( )

privateinherited

clear cache data

Definition at line 500 of file MooseFunctor.h.

{
  for (auto & map_pr : _qp_to_value)
    for (auto & pr : map_pr.second)
      pr.first = false;
 
  for (auto & map_pr : _side_qp_to_value)
  {
    auto & side_vector = map_pr.second;
    for (auto & qp_vector : side_vector)
      for (auto & pr : qp_vector)
        pr.first = false;
  }
 
  _current_qp_map_key = libMesh::DofObject::invalid_id;
  _current_qp_map_value = nullptr;
  _current_side_qp_map_key = libMesh::DofObject::invalid_id;
  _current_side_qp_map_value = nullptr;
 
  _elem_arg_to_value.clear();
  _face_arg_to_value.clear();
  _node_arg_to_value.clear();
}

◆ clearDofIndices()

void MooseVariableFE< Real >::clearDofIndices ( )

overridevirtualinherited

Clear out the dof indices.

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

Implements MooseVariableFieldBase.

Definition at line 94 of file MooseVariableFE.C.

{
  _element_data->clearDofIndices();
}

◆ 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 175 of file MooseVariableBase.C.

{
  mooseAssert(dof_indices.size() % this->count() == 0,
              "The dof indices container must be a multiple of count");
  std::vector<dof_id_type> new_dof_indices(dof_indices.size() / this->count());
  for (const auto i : index_range(new_dof_indices))
    new_dof_indices[i] = dof_indices[component * new_dof_indices.size() + i];
  return new_dof_indices;
}

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

◆ componentName()

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

inherited

Get the variable name of a component in libMesh.

Definition at line 28 of file MooseVariableFieldBase.C.

{
  if (comp >= _count)
    mooseError("componentName(): Component index is not less than the number of components");
  if (isArray())
    return this->arrayVariableComponent(comp);
  else
    return name();
}

◆ computeElemValues()

void MooseVariableConstMonomial::computeElemValues ( )

overridevirtual

Actually compute variable values from the solution vectors.

Reimplemented from MooseVariableFE< Real >.

Definition at line 42 of file MooseVariableConstMonomial.C.

{
  _element_data->setGeometry(Moose::Volume);
  _element_data->computeConstantMonomialValues();
}

◆ computeElemValuesFace()

void MooseVariableConstMonomial::computeElemValuesFace ( )

overridevirtual

Compute values at facial quadrature points.

Reimplemented from MooseVariableFE< Real >.

Definition at line 49 of file MooseVariableConstMonomial.C.

{
  _element_data->setGeometry(Moose::Face);
  _element_data->computeConstantMonomialValues();
}

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

Definition at line 131 of file MooseVariableFieldBase.h.

131{ mooseError("not implemented"); }

◆ computeIncrementAtNode()

void MooseVariableFE< Real >::computeIncrementAtNode ( const libMesh::NumericVector< libMesh::Number > & increment_vec )

inherited

Compute and store incremental change at the current node based on increment_vec.

Definition at line 621 of file MooseVariableFE.C.

{
  _element_data->computeIncrementAtNode(increment_vec);
}

◆ computeIncrementAtQps()

void MooseVariableFE< Real >::computeIncrementAtQps ( const libMesh::NumericVector< libMesh::Number > & increment_vec )

inherited

Compute and store incremental change in solution at QPs based on increment_vec.

Definition at line 616 of file MooseVariableFE.C.

{
  _element_data->computeIncrementAtQps(increment_vec);
}

◆ computeLowerDValues()

void MooseVariableFE< Real >::computeLowerDValues ( )

overridevirtualinherited

compute values at quadrature points on the lower dimensional element

Implements MooseVariableFieldBase.

Definition at line 513 of file MooseVariableFE.C.

{
  _lower_data->setGeometry(Moose::Volume);
  _lower_data->computeValues();
}

◆ computeNeighborValues()

void MooseVariableConstMonomial::computeNeighborValues ( )

overridevirtual

Compute values at quadrature points for the neighbor.

Reimplemented from MooseVariableFE< Real >.

Definition at line 56 of file MooseVariableConstMonomial.C.

{
  _neighbor_data->setGeometry(Moose::Volume);
  _neighbor_data->computeConstantMonomialValues();
}

◆ computeNeighborValuesFace()

void MooseVariableConstMonomial::computeNeighborValuesFace ( )

overridevirtual

Compute values at facial quadrature points for the neighbor.

Reimplemented from MooseVariableFE< Real >.

Definition at line 63 of file MooseVariableConstMonomial.C.

{
  _neighbor_data->setGeometry(Moose::Face);
  _neighbor_data->computeConstantMonomialValues();
}

◆ computeNodalNeighborValues()

void MooseVariableFE< Real >::computeNodalNeighborValues ( )

overridevirtualinherited

Compute nodal values of this variable in the neighbor.

Implements MooseVariableFieldBase.

Definition at line 706 of file MooseVariableFE.C.

{
  _neighbor_data->computeNodalValues();
}

◆ computeNodalValues()

void MooseVariableFE< Real >::computeNodalValues ( )

overridevirtualinherited

Compute nodal values of this variable.

Implements MooseVariableFieldBase.

Definition at line 705 of file MooseVariableFE.C.

{
  _element_data->computeNodalValues();
}

◆ computeSolution() [1/2]

void MooseVariableFE< Real >::computeSolution	(	const Elem *const	elem,
		const unsigned int	n_qp,
		const StateArg &	state,
		const Shapes &	phi,
		Solution &	local_soln,
		const GradShapes &	grad_phi,
		GradSolution &	grad_local_soln,
		Solution &	dot_local_soln,
		GradSolution &	grad_dot_local_soln
	)		const

inherited

Definition at line 913 of file MooseVariableFE.C.

{
  std::vector<dof_id_type> dof_indices;
  this->_dof_map.dof_indices(elem, dof_indices, _var_num);
  std::vector<ADReal> dof_values;
  std::vector<ADReal> dof_values_dot;
  dof_values.reserve(dof_indices.size());
 
  const bool computing_dot = _time_integrator && _time_integrator->dt();
  if (computing_dot)
    dof_values_dot.reserve(dof_indices.size());
 
  const bool do_derivatives = Moose::doDerivatives(_subproblem, _sys);
  const auto & global_soln = getSolution(state);
  for (const auto dof_index : dof_indices)
  {
    dof_values.push_back(ADReal(global_soln(dof_index)));
    if (do_derivatives && state.state == 0)
      Moose::derivInsert(dof_values.back().derivatives(), dof_index, 1.);
    if (computing_dot)
    {
      if (_var_kind == Moose::VAR_SOLVER)
      {
        dof_values_dot.push_back(dof_values.back());
        _time_integrator->computeADTimeDerivatives(
            dof_values_dot.back(), dof_index, _ad_real_dummy);
      }
      else
        dof_values_dot.push_back((*this->_sys.solutionUDot())(dof_index));
    }
  }
 
  local_soln.resize(n_qp);
  grad_local_soln.resize(n_qp);
  if (computing_dot)
  {
    dot_local_soln.resize(n_qp);
    grad_dot_local_soln.resize(n_qp);
  }
 
  for (const auto qp : make_range(n_qp))
  {
    local_soln[qp] = 0;
    grad_local_soln[qp] = 0;
    if (computing_dot)
    {
      dot_local_soln[qp] = 0;
      grad_dot_local_soln[qp] = GradientType{};
    }
    for (const auto i : index_range(dof_indices))
    {
      local_soln[qp] += dof_values[i] * phi[i][qp];
      grad_local_soln[qp] += dof_values[i] * grad_phi[i][qp];
      if (computing_dot)
      {
        dot_local_soln[qp] += dof_values_dot[i] * phi[i][qp];
        grad_dot_local_soln[qp] += dof_values_dot[i] * grad_phi[i][qp];
      }
    }
  }
}

◆ computeSolution() [2/2]

void MooseVariableFE< Real >::computeSolution	(	const Elem *	elem,
		unsigned int	n_qp,
		const StateArg &	state,
		const Shapes &	phi,
		Solution &	local_soln,
		const GradShapes &	grad_phi,
		GradSolution &	grad_local_soln,
		Solution &	dot_local_soln,
		GradSolution &	grad_dot_local_soln
	)		const

privateinherited

Compute the solution, gradient, time derivative, and gradient of the time derivative with provided shape functions.

◆ computingCurl()

bool MooseVariableFE< Real >::computingCurl ( ) const

finaloverridevirtualinherited

Whether or not this variable is computing the curl.

Implements MooseVariableField< OutputType >.

Definition at line 142 of file MooseVariableFE.C.

{
  return _element_data->computingCurl();
}

◆ computingDiv()

bool MooseVariableFE< Real >::computingDiv ( ) const

finaloverridevirtualinherited

Whether or not this variable is computing the divergence.

Implements MooseVariableField< OutputType >.

Definition at line 147 of file MooseVariableFE.C.

{
  return _element_data->computingDiv();
}

◆ computingSecond()

bool MooseVariableFE< Real >::computingSecond ( ) const

inlinefinaloverridevirtualinherited

Whether or not this variable is computing any second derivatives.

Implements MooseVariableField< OutputType >.

Definition at line 137 of file MooseVariableFE.h.

137{ return usesSecondPhi(); }

MooseVariableFE< Real >::usesSecondPhi

bool usesSecondPhi() const

Whether or not this variable is computing any second derivatives.

Definition MooseVariableFE.C:800

◆ connectControllableParams()

void MooseBase::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 77 of file MooseBase.C.

{
  auto & factory = _app.getFactory();
  auto & ip_warehouse = _app.getInputParameterWarehouse();
 
  MooseObjectParameterName primary_name(uniqueName(), parameter);
  const auto base_type = factory.getValidParams(object_type).getBase();
  MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
  ip_warehouse.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, name(), parameter);
      ip_warehouse.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 114 of file MooseVariableBase.h.

114{ return _count; }

◆ curlPhi()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhi ( ) const

finaloverridevirtualinherited

Curl of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 204 of file MooseVariableFE.C.

{
  return _element_data->curlPhi();
}

◆ curlPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiFace ( ) const

inherited

Definition at line 217 of file MooseVariableFE.C.

{
  return _element_data->curlPhiFace();
}

◆ curlPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiFaceNeighbor ( ) const

inherited

Definition at line 246 of file MooseVariableFE.C.

{
  return _neighbor_data->curlPhiFace();
}

◆ curlPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiNeighbor ( ) const

inherited

Definition at line 230 of file MooseVariableFE.C.

{
  return _neighbor_data->curlPhi();
}

◆ curlSln()

const FieldVariableCurl & MooseVariableFE< Real >::curlSln ( ) const

inlineinherited

element curls

Definition at line 328 of file MooseVariableFE.h.

328{ return _element_data->curlSln(Moose::Current); }

Moose::Current

@ Current

Definition MooseTypes.h:263

◆ curlSlnNeighbor()

const FieldVariableCurl & MooseVariableFE< Real >::curlSlnNeighbor ( ) const

inlineinherited

neighbor solution curls

Definition at line 468 of file MooseVariableFE.h.

  {
    return _neighbor_data->curlSln(Moose::Current);
  }

◆ curlSlnOld()

const FieldVariableCurl & MooseVariableFE< Real >::curlSlnOld ( ) const

inlineinherited

Definition at line 329 of file MooseVariableFE.h.

329{ return _element_data->curlSln(Moose::Old); }

Moose::Old

@ Old

Definition MooseTypes.h:264

◆ curlSlnOlder()

const FieldVariableCurl & MooseVariableFE< Real >::curlSlnOlder ( ) const

inlineinherited

Definition at line 330 of file MooseVariableFE.h.

330{ return _element_data->curlSln(Moose::Older); }

Moose::Older

@ Older

Definition MooseTypes.h:265

◆ curlSlnOlderNeighbor()

const FieldVariableCurl & MooseVariableFE< Real >::curlSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 476 of file MooseVariableFE.h.

  {
    return _neighbor_data->curlSln(Moose::Older);
  }

◆ curlSlnOldNeighbor()

const FieldVariableCurl & MooseVariableFE< Real >::curlSlnOldNeighbor ( ) const

inlineinherited

Definition at line 472 of file MooseVariableFE.h.

  {
    return _neighbor_data->curlSln(Moose::Old);
  }

◆ currentElem()

const Elem *const & MooseVariableFE< Real >::currentElem ( ) const

inlineoverridevirtualinherited

Current element this variable is evaluated at.

Implements MooseVariableFieldBase.

Definition at line 165 of file MooseVariableFE.h.

165{ return _element_data->currentElem(); }

◆ currentSide()

const unsigned int & MooseVariableFE< Real >::currentSide ( ) const

inlineinherited

Current side this variable is being evaluated on.

Definition at line 170 of file MooseVariableFE.h.

170{ return _element_data->currentSide(); }

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

69{}

◆ customSetup() [2/2]

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

Definition at line 233 of file MooseFunctor.h.

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

◆ divPhi()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhi ( ) const

finaloverridevirtualinherited

Divergence of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 205 of file MooseVariableFE.C.

{
  return _element_data->divPhi();
}

◆ divPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiFace ( ) const

inherited

Definition at line 218 of file MooseVariableFE.C.

{
  return _element_data->divPhiFace();
}

◆ divPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiFaceNeighbor ( ) const

inherited

Definition at line 247 of file MooseVariableFE.C.

{
  return _neighbor_data->divPhiFace();
}

◆ divPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiNeighbor ( ) const

inherited

Definition at line 231 of file MooseVariableFE.C.

{
  return _neighbor_data->divPhi();
}

◆ divSln()

const FieldVariableDivergence & MooseVariableFE< Real >::divSln ( ) const

inlineinherited

element divergence

Definition at line 333 of file MooseVariableFE.h.

333{ return _element_data->divSln(Moose::Current); }

◆ divSlnNeighbor()

const FieldVariableDivergence & MooseVariableFE< Real >::divSlnNeighbor ( ) const

inlineinherited

neighbor solution divergence

Definition at line 482 of file MooseVariableFE.h.

  {
    return _neighbor_data->divSln(Moose::Current);
  }

◆ divSlnOld()

const FieldVariableDivergence & MooseVariableFE< Real >::divSlnOld ( ) const

inlineinherited

Definition at line 334 of file MooseVariableFE.h.

334{ return _element_data->divSln(Moose::Old); }

◆ divSlnOlder()

const FieldVariableDivergence & MooseVariableFE< Real >::divSlnOlder ( ) const

inlineinherited

Definition at line 335 of file MooseVariableFE.h.

  {
    return _element_data->divSln(Moose::Older);
  }

◆ divSlnOlderNeighbor()

const FieldVariableDivergence & MooseVariableFE< Real >::divSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 490 of file MooseVariableFE.h.

  {
    return _neighbor_data->divSln(Moose::Older);
  }

◆ divSlnOldNeighbor()

const FieldVariableDivergence & MooseVariableFE< Real >::divSlnOldNeighbor ( ) const

inlineinherited

Definition at line 486 of file MooseVariableFE.h.

  {
    return _neighbor_data->divSln(Moose::Old);
  }

◆ doDerivatives()

bool MooseVariableBase::doDerivatives ( ) const

protectedinherited

Returns: whether we should insert derivatives

◆ dofIndices()

const std::vector< dof_id_type > & MooseVariableFE< Real >::dofIndices ( ) const

inlinefinalvirtualinherited

Get local DoF indices.

Reimplemented from MooseVariableBase.

Definition at line 179 of file MooseVariableFE.h.

179{ return _element_data->dofIndices(); }

◆ dofIndicesLower()

const std::vector< dof_id_type > & MooseVariableFE< Real >::dofIndicesLower ( ) const

inlinefinalvirtualinherited

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

Returns: the lower dimensional element's dofs

Implements MooseVariableFieldBase.

Definition at line 185 of file MooseVariableFE.h.

  {
    return _lower_data->dofIndices();
  }

◆ dofIndicesNeighbor()

const std::vector< dof_id_type > & MooseVariableFE< Real >::dofIndicesNeighbor ( ) const

inlinefinalvirtualinherited

Get neighbor DOF indices for currently selected element.

Returns: the neighbor degree of freedom indices

Implements MooseVariableFieldBase.

Definition at line 181 of file MooseVariableFE.h.

  {
    return _neighbor_data->dofIndices();
  }

◆ dofMap()

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

inlineinherited

The DofMap associated with the system this variable is in.

Definition at line 151 of file MooseVariableBase.h.

151{ return _dof_map; }

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

◆ dofValue()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValue ( ) const

inherited

Definition at line 585 of file MooseVariableFE.C.

{
  mooseDeprecated("Use dofValues instead of dofValue");
  return dofValues();
}

◆ dofValues()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValues ( ) const

overridevirtualinherited

dof values getters

Implements MooseVariableField< OutputType >.

Definition at line 586 of file MooseVariableFE.C.

{
  return _element_data->dofValues();
}

◆ dofValuesDot()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDot ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 594 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDot();
}

◆ dofValuesDotDot()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotDot ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 599 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDotDot();
}

◆ dofValuesDotDotNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotDotNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 600 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDotDot();
}

◆ dofValuesDotDotNeighborResidual()

const DofValues & MooseVariableFE< Real >::dofValuesDotDotNeighborResidual ( ) const

inherited

◆ dofValuesDotDotOld()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotDotOld ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 602 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDotDotOld();
}

◆ dofValuesDotDotOldNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotDotOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 603 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDotDotOld();
}

◆ dofValuesDotNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 595 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDot();
}

◆ dofValuesDotNeighborResidual()

const DofValues & MooseVariableFE< Real >::dofValuesDotNeighborResidual ( ) const

inherited

◆ dofValuesDotOld()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotOld ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 597 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDotOld();
}

◆ dofValuesDotOldNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesDotOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 598 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDotOld();
}

◆ dofValuesDuDotDotDu()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDotDu ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 606 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDuDotDotDu();
}

◆ dofValuesDuDotDotDuNeighbor()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDotDuNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 607 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDuDotDotDu();
}

◆ dofValuesDuDotDu()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDu ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 604 of file MooseVariableFE.C.

{
  return _element_data->dofValuesDuDotDu();
}

◆ dofValuesDuDotDuNeighbor()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDuNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 605 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesDuDotDu();
}

◆ dofValuesNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 590 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValues();
}

◆ dofValuesOld()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesOld ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 587 of file MooseVariableFE.C.

{
  return _element_data->dofValuesOld();
}

◆ dofValuesOlder()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesOlder ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 588 of file MooseVariableFE.C.

{
  return _element_data->dofValuesOlder();
}

◆ dofValuesOlderNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesOlderNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 592 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesOlder();
}

◆ dofValuesOldNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 591 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesOld();
}

◆ dofValuesPreviousNL()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesPreviousNL ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 589 of file MooseVariableFE.C.

{
  return _element_data->dofValuesPreviousNL();
}

◆ dofValuesPreviousNLNeighbor()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::dofValuesPreviousNLNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 593 of file MooseVariableFE.C.

{
  return _neighbor_data->dofValuesPreviousNL();
}

◆ dot() [1/6]

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 209 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 ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 213 of file MooseFunctor.h.

{
  return evaluateDot(elem_point, 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 211 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 212 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 FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 210 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateDot(face, 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 214 of file MooseFunctor.h.

{
  return evaluateDot(node, state);
}

◆ duDotDotDu()

const VariableValue & MooseVariableFE< Real >::duDotDotDu ( ) const

inlineinherited

Definition at line 407 of file MooseVariableFE.h.

407{ return _element_data->duDotDotDu(); }

◆ duDotDotDuNeighbor()

const VariableValue & MooseVariableFE< Real >::duDotDotDuNeighbor ( ) const

inlineinherited

Definition at line 501 of file MooseVariableFE.h.

501{ return _neighbor_data->duDotDotDu(); }

◆ duDotDu()

const VariableValue & MooseVariableFE< Real >::duDotDu ( ) const

inlineinherited

Definition at line 406 of file MooseVariableFE.h.

406{ return _element_data->duDotDu(); }

◆ duDotDuNeighbor()

const VariableValue & MooseVariableFE< Real >::duDotDuNeighbor ( ) const

inlineinherited

Definition at line 500 of file MooseVariableFE.h.

500{ return _neighbor_data->duDotDu(); }

◆ eigen() [1/2]

bool MooseVariableBase::eigen ( ) const

inlineinherited

Whether or not this variable operates on an eigen kernel.

Definition at line 178 of file MooseVariableBase.h.

178{ return _is_eigen; }

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition MooseVariableBase.h:230

Referenced by EigenProblem::adjustEigenVector().

◆ eigen() [2/2]

void MooseVariableBase::eigen ( bool eigen )

inlineinherited

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

Definition at line 183 of file MooseVariableBase.h.

183{ _is_eigen = eigen; }

MooseVariableBase::eigen

bool eigen() const

Whether or not this variable operates on an eigen kernel.

Definition MooseVariableBase.h:178

Referenced by MooseVariableBase::eigen().

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 49 of file MooseObject.h.

49{ return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition MooseObject.h:71

Referenced by EigenKernel::enabled(), BlockRestrictionDebugOutput::printBlockRestrictionGroups(), BlockRestrictionDebugOutput::printBoundaryRestrictionGroups(), and NodeFaceConstraint::validParams().

◆ errorPrefix()

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

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 264 of file MooseBase.h.

264{ return messagePrefix(); }

◆ evaluate() [1/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor with a given element.

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

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 757 of file MooseVariableFE.C.

{
  const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
  // We can use whatever we want for the point argument since it won't be used
  const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
  evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
  return _current_elem_qp_functor_sln[0];
}

◆ evaluate() [2/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemPointArg &	elem_point_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

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

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 758 of file MooseVariableFE.C.

{
  mooseAssert(elem_point_arg.elem, "We need an Elem");
  const Elem & elem = *elem_point_arg.elem;
  const auto dim = elem.dim();
  ArbitraryQuadrature qrule(dim);
  const std::vector<Point> ref_point = {FEMap::inverse_map(dim, &elem, elem_point_arg.point)};
  qrule.setPoints(ref_point);
  // We can use whatever we want for the point argument since it won't be used
  const ElemQpArg elem_qp_arg{elem_point_arg.elem, /*qp=*/0, &qrule, elem_point_arg.point};
  evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
  return _current_elem_qp_functor_sln[0];
}

◆ evaluate() [3/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 754 of file MooseVariableFE.C.

{
  evaluateOnElement(elem_qp, state, /*query_cache=*/true);
  const auto qp = elem_qp.qp;
  mooseAssert(qp < _current_elem_qp_functor_sln.size(),
              "The requested " << qp << " is outside our solution size");
  return _current_elem_qp_functor_sln[qp];
}

◆ evaluate() [4/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 755 of file MooseVariableFE.C.

{
  evaluateOnElementSide(elem_side_qp, state, true);
  const auto qp = elem_side_qp.qp;
  mooseAssert(qp < _current_elem_side_qp_functor_sln.size(),
              "The requested " << qp << " is outside our solution size");
  return _current_elem_side_qp_functor_sln[qp];
}

◆ evaluate() [5/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const FaceArg &	face_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 760 of file MooseVariableFE.C.

{
  return faceEvaluate(face_arg, state, _current_elem_side_qp_functor_sln);
}

◆ evaluate() [6/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const NodeArg &	node_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 759 of file MooseVariableFE.C.

{
  mooseAssert(node_arg.node, "Must have a node");
  const Node & node = *node_arg.node;
  mooseAssert(node.n_dofs(this->_sys.number(), this->number()),
              "Our variable must have dofs on the requested node");
  const auto & soln = this->getSolution(state);
  if constexpr (std::is_same<OutputType, Real>::value)
  {
    const auto dof_number = node.dof_number(this->_sys.number(), this->number(), 0);
    ValueType ret = soln(dof_number);
    if (Moose::doDerivatives(_subproblem, _sys))
      Moose::derivInsert(ret.derivatives(), dof_number, 1);
    return ret;
  }
  else if constexpr (std::is_same<OutputType, RealVectorValue>::value)
  {
    ValueType ret;
    const auto do_derivatives = Moose::doDerivatives(_subproblem, _sys);
    for (const auto d : make_range(this->_mesh.dimension()))
    {
      const auto dof_number = node.dof_number(this->_sys.number(), this->number(), d);
      auto & component = ret(d);
      component = soln(dof_number);
      if (do_derivatives)
        Moose::derivInsert(component.derivatives(), dof_number, 1);
    }
    return ret;
  }
  else
    mooseError("RealEigenVector not yet supported for functors");
}

◆ evaluateDot() [1/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

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 from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 770 of file MooseVariableFE.C.

{
  mooseAssert(_time_integrator,
              "A time derivative is being requested but we do not have a time integrator so we'll "
              "have no idea how to compute it");
  mooseAssert(_time_integrator->dt(),
              "A time derivative is being requested but the time integrator wants to perform a 0s "
              "time step");
  const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
  // We can use whatever we want for the point argument since it won't be used
  const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
  evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
  return _current_elem_qp_functor_dot[0];
}

◆ evaluateDot() [2/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 431 of file MooseFunctor.h.

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

◆ evaluateDot() [3/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

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

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

Definition at line 767 of file MooseVariableFE.C.

{
  mooseAssert(_time_integrator,
              "A time derivative is being requested but we do not have a time integrator so we'll "
              "have no idea how to compute it");
  mooseAssert(_time_integrator->dt(),
              "A time derivative is being requested but the time integrator wants to perform a 0s "
              "time step");
  evaluateOnElement(elem_qp, state, /*query_cache=*/true);
  const auto qp = elem_qp.qp;
  mooseAssert(qp < _current_elem_qp_functor_dot.size(),
              "The requested " << qp << " is outside our dot size");
  return _current_elem_qp_functor_dot[qp];
}

◆ evaluateDot() [4/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

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 from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 768 of file MooseVariableFE.C.

{
  mooseAssert(_time_integrator && _time_integrator->dt(),
              "A time derivative is being requested but we do not have a time integrator so we'll "
              "have no idea how to compute it");
  evaluateOnElementSide(elem_side_qp, state, true);
  const auto qp = elem_side_qp.qp;
  mooseAssert(qp < _current_elem_side_qp_functor_dot.size(),
              "The requested " << qp << " is outside our dot size");
  return _current_elem_side_qp_functor_dot[qp];
}

◆ evaluateDot() [5/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const FaceArg &	face_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

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

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

Definition at line 771 of file MooseVariableFE.C.

{
  mooseAssert(_time_integrator && _time_integrator->dt(),
              "A time derivative is being requested but we do not have a time integrator so we'll "
              "have no idea how to compute it");
  return faceEvaluate(face_arg, state, _current_elem_side_qp_functor_dot);
}

◆ evaluateDot() [6/6]

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

inlineprotectedvirtualinherited

Definition at line 436 of file MooseFunctor.h.

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

◆ evaluateGradDot() [1/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradDot	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

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 from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 773 of file MooseVariableFE.C.

{
  mooseAssert(_time_integrator,
              "A time derivative is being requested but we do not have a time integrator so we'll "
              "have no idea how to compute it");
  mooseAssert(_time_integrator->dt(),
              "A time derivative is being requested but the time integrator wants to perform a 0s "
              "time step");
  const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
  // We can use whatever we want for the point argument since it won't be used
  const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
  evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
  return _current_elem_qp_functor_grad_dot[0];
}

◆ evaluateGradDot() [2/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 485 of file MooseFunctor.h.

  {
    mooseError("Element-point 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 465 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 476 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 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 455 of file MooseFunctor.h.

  {
    mooseError("Face 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 490 of file MooseFunctor.h.

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

◆ evaluateGradient() [1/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

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 from Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 765 of file MooseVariableFE.C.

{
  const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
  // We can use whatever we want for the point argument since it won't be used
  const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
  evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
  return _current_elem_qp_functor_gradient[0];
}

◆ evaluateGradient() [2/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 377 of file MooseFunctor.h.

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

◆ evaluateGradient() [3/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

overrideprotectedvirtualinherited

Parameters

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

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

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

Definition at line 762 of file MooseVariableFE.C.

{
  evaluateOnElement(elem_qp, state, /*query_cache=*/true);
  const auto qp = elem_qp.qp;
  mooseAssert(qp < _current_elem_qp_functor_gradient.size(),
              "The requested " << qp << " is outside our gradient size");
  return _current_elem_qp_functor_gradient[qp];
}

◆ evaluateGradient() [4/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

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

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

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

Definition at line 763 of file MooseVariableFE.C.

{
  evaluateOnElementSide(elem_side_qp, state, true);
  const auto qp = elem_side_qp.qp;
  mooseAssert(qp < _current_elem_side_qp_functor_gradient.size(),
              "The requested " << qp << " is outside our gradient size");
  return _current_elem_side_qp_functor_gradient[qp];
}

◆ evaluateGradient() [5/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 MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< T >.

Definition at line 348 of file MooseFunctor.h.

  {
    mooseError("Face 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 382 of file MooseFunctor.h.

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

◆ evaluateOnElement()

void MooseVariableFE< Real >::evaluateOnElement	(	const ElemQpArg &	elem_qp,
		const StateArg &	state,
		bool	cache_eligible
	)		const

privateinherited

Evaluate solution and gradient for the elem_qp argument.

Definition at line 795 of file MooseVariableFE.C.

{
  mooseAssert(this->hasBlocks(elem_qp.elem->subdomain_id()),
              "Variable " + this->name() + " doesn't exist on block " +
                  std::to_string(elem_qp.elem->subdomain_id()));
 
  const Elem * const elem = elem_qp.elem;
  if (!cache_eligible || (elem != _current_elem_qp_functor_elem))
  {
    const QBase * const qrule_template = elem_qp.qrule;
 
    using FEBaseType = typename FEBaseHelper<OutputType>::type;
    std::unique_ptr<FEBaseType> fe(FEBaseType::build(elem->dim(), _fe_type));
    auto qrule = qrule_template->clone();
 
    const auto & phi = fe->get_phi();
    const auto & dphi = fe->get_dphi();
    fe->attach_quadrature_rule(qrule.get());
    fe->reinit(elem);
 
    computeSolution(elem,
                    qrule->n_points(),
                    state,
                    phi,
                    _current_elem_qp_functor_sln,
                    dphi,
                    _current_elem_qp_functor_gradient,
                    _current_elem_qp_functor_dot,
                    _current_elem_qp_functor_grad_dot);
  }
  if (cache_eligible)
    _current_elem_qp_functor_elem = elem;
  else
    // These evaluations are not eligible for caching, e.g. maybe this is a single point quadrature
    // rule evaluation at an arbitrary point and we don't want those evaluations to potentially be
    // re-used when this function is called with a standard quadrature rule or a different point
    _current_elem_qp_functor_elem = nullptr;
}

◆ evaluateOnElementSide()

void MooseVariableFE< Real >::evaluateOnElementSide	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state,
		bool	cache_eligible
	)		const

privateinherited

Evaluate solution and gradient for the elem_side_qp argument.

Definition at line 800 of file MooseVariableFE.C.

{
  mooseAssert(this->hasBlocks(elem_side_qp.elem->subdomain_id()),
              "Variable " + this->name() + " doesn't exist on block " +
                  std::to_string(elem_side_qp.elem->subdomain_id()));
 
  const Elem * const elem = elem_side_qp.elem;
  const auto side = elem_side_qp.side;
  if (!cache_eligible || elem != _current_elem_side_qp_functor_elem_side.first ||
      side != _current_elem_side_qp_functor_elem_side.second)
  {
    const QBase * const qrule_template = elem_side_qp.qrule;
 
    using FEBaseType = typename FEBaseHelper<OutputType>::type;
    std::unique_ptr<FEBaseType> fe(FEBaseType::build(elem->dim(), _fe_type));
    auto qrule = qrule_template->clone();
 
    const auto & phi = fe->get_phi();
    const auto & dphi = fe->get_dphi();
    fe->attach_quadrature_rule(qrule.get());
    fe->reinit(elem, side);
 
    computeSolution(elem,
                    qrule->n_points(),
                    state,
                    phi,
                    _current_elem_side_qp_functor_sln,
                    dphi,
                    _current_elem_side_qp_functor_gradient,
                    _current_elem_side_qp_functor_dot,
                    _current_elem_side_qp_functor_grad_dot);
  }
  if (cache_eligible)
    _current_elem_side_qp_functor_elem_side = std::make_pair(elem, side);
  else
    // These evaluations are not eligible for caching, e.g. maybe this is a single point quadrature
    // rule evaluation at an arbitrary point and we don't want those evaluations to potentially be
    // re-used when this function is called with a standard quadrature rule or a different point
    _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
}

◆ faceEvaluate()

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::faceEvaluate	(	const FaceArg &	face_arg,
		const StateArg &	state,
		const std::vector< ValueType > &	cache_data
	)		const

protectedinherited

A common method that both evaluate(FaceArg) and evaluateDot(FaceArg) can call.

A value evaluation vs dot evaluation is delineated via the passed-in cache_data, e.g. if the passed-in cache data is the sln data member then this will return a value evaluation and if the cache data is the dot data member then this will return a dot evaluation

Definition at line 752 of file MooseVariableFE.C.

{
  const QMonomial qrule(face_arg.fi->elem().dim() - 1, CONSTANT);
  auto side_evaluate =
      [this, &qrule, &state, &cache_data](const Elem * const elem, const unsigned int side)
  {
    // We can use whatever we want for the point argument since it won't be used
    const ElemSideQpArg elem_side_qp_arg{elem, side, /*qp=*/0, &qrule, Point(0, 0, 0)};
    evaluateOnElementSide(elem_side_qp_arg, state, /*cache_eligible=*/false);
    return cache_data[0];
  };
 
  const auto continuity = this->getContinuity();
  bool on_elem;
  bool on_neighbor;
  if (!face_arg.face_side)
  {
    on_elem = this->hasBlocks(face_arg.fi->elemPtr()->subdomain_id());
    on_neighbor =
        face_arg.fi->neighborPtr() && this->hasBlocks(face_arg.fi->neighborPtr()->subdomain_id());
  }
  else
  {
    on_elem = face_arg.face_side == face_arg.fi->elemPtr();
    on_neighbor = face_arg.face_side == face_arg.fi->neighborPtr();
  }
 
  // Only do multiple evaluations if we are not continuous and we are on an internal face
  if ((continuity != C_ZERO && continuity != C_ONE) && on_elem && on_neighbor)
    return (side_evaluate(face_arg.fi->elemPtr(), face_arg.fi->elemSideID()) +
            side_evaluate(face_arg.fi->neighborPtr(), face_arg.fi->neighborSideID())) /
           2;
  else if (on_elem)
    return side_evaluate(face_arg.fi->elemPtr(), face_arg.fi->elemSideID());
  else if (on_neighbor)
    return side_evaluate(face_arg.fi->neighborPtr(), face_arg.fi->neighborSideID());
  else
    mooseError(
        "Attempted to evaluate a moose finite element variable on a face where it is not defined");
}

◆ feType()

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

inlineinherited

Get the type of finite element object.

Definition at line 65 of file MooseVariableBase.h.

65{ return _fe_type; }

Referenced by SetupResidualDebugAction::act(), ADDGKernel::ADDGKernel(), Assembly::adGradPhi(), Assembly::adGradPhi(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), AuxKernelBase::AuxKernelBase(), BoundsBase::BoundsBase(), BuildArrayVariableAux::BuildArrayVariableAux(), TagAuxBase< T >::checkCoupledVariable(), SamplerBase::checkForStandardFieldVariableType(), GapValueAux::computeValue(), CopyValueAux::CopyValueAux(), MultiAppGeneralFieldTransfer::correctSolutionVectorValues(), DGKernel::DGKernel(), MultiAppNearestNodeTransfer::execute(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::extractlibMeshNodePositions(), 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(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::projectlibMeshNodalValues(), MultiAppDofCopyTransfer::transfer(), and VectorNodalBC::VectorNodalBC().

◆ fieldType()

template<typename OutputType >

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

overridevirtualinherited

Field type of this variable.

Implements MooseVariableFieldBase.

Definition at line 60 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");
}

◆ flagInvalidSolutionInternal()

template<bool warning>

template void SolutionInvalidInterface::flagInvalidSolutionInternal< false > ( const InvalidSolutionID invalid_solution_id ) const

protectedinherited

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

{
  mooseAssert(
      warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
      "Inconsistent warning flag");
  auto & solution_invalidity = _si_moose_base.getMooseApp().solutionInvalidity();
  if constexpr (!warning)
    if (!_si_problem || _si_problem->immediatelyPrintInvalidSolution())
      solution_invalidity.printDebug(invalid_solution_id);
  return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
}

◆ functorName()

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

inlineinherited

Return the functor name.

Definition at line 176 of file MooseFunctor.h.

176{ return _functor_name; }

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

MooseFunctorName _functor_name

name of the functor

Definition MooseFunctor.h:570

◆ genericDofValues()

template<typename OutputType >

template<bool is_ad>

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

inherited

Definition at line 425 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 172 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);
}

◆ getBase()

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

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 147 of file MooseBase.h.

147{ return _pars.getBase(); }

InputParameters::getBase

const std::string & getBase() const

Definition InputParameters.C:505

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

◆ 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 336 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 MooseBase::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 450 of file MooseBase.h.

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

◆ getContinuity()

libMesh::FEContinuity MooseVariableFE< Real >::getContinuity ( ) const

inlineoverridevirtualinherited

Return the continuity of this variable.

Reimplemented from MooseVariableBase.

Definition at line 153 of file MooseVariableFE.h.

153{ return _element_data->getContinuity(); };

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

{
  // 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.");
 
  // This will search the data paths for this relative path
  std::optional<std::string> error;
  Moose::DataFileUtils::Path found_path;
  {
    // Throw on error so that if getPath() fails, we can throw an error
    // with the context of _parent.mooseError()
    Moose::ScopedThrowOnError scoped_throw_on_error;
 
    try
    {
      found_path = Moose::DataFileUtils::getPath(relative_path);
    }
    catch (std::exception & e)
    {
      error = e.what();
    }
  }
 
  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;
}

Referenced by DataFileInterface::getDataFileNameByName().

◆ getDofIndices()

void MooseVariableFE< Real >::getDofIndices	(	const Elem *	elem,
		std::vector< dof_id_type > &	dof_indices
	)		const

overridevirtualinherited

Reimplemented from MooseVariableBase.

Definition at line 177 of file MooseVariableFE.C.

{
  _element_data->getDofIndices(elem, dof_indices);
}

◆ getElementalValue()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getElementalValue	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the current value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 548 of file MooseVariableFE.C.

{
  return _element_data->getElementalValue(elem, Moose::Current, idx);
}

◆ getElementalValueOld()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getElementalValueOld	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the old value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 555 of file MooseVariableFE.C.

{
  return _element_data->getElementalValue(elem, Moose::Old, idx);
}

◆ getElementalValueOlder()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getElementalValueOlder	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the older value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 562 of file MooseVariableFE.C.

{
  return _element_data->getElementalValue(elem, Moose::Older, idx);
}

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 73 of file SetupInterface.C.

{
  return _execute_enum;
}

Referenced by ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), MultiAppTransfer::checkMultiAppExecuteOn(), Control::Control(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), ElementReporter::shouldStore(), GeneralReporter::shouldStore(), NodalReporter::shouldStore(), and PIDTransientControl::timestepSetup().

◆ getGradient()

OutputTools< Real >::OutputGradient MooseVariableFE< Real >::getGradient	(	const Elem *	elem,
		const std::vector< std::vector< typename OutputTools< Real >::OutputShapeGradient > > &	grad_phi
	)		const

inherited

Compute the variable gradient value at a point on an element.

Parameters

elem	The element we are computing on
phi	Evaluated shape functions at a point

Returns: The variable gradient value

Definition at line 637 of file MooseVariableFE.C.

{
  std::vector<dof_id_type> dof_indices;
  this->_dof_map.dof_indices(elem, dof_indices, _var_num);
 
  typename OutputTools<OutputType>::OutputGradient value;
  if (isNodal())
  {
    for (unsigned int i = 0; i < dof_indices.size(); ++i)
    {
      // The zero index is because we only have one point that the phis are evaluated at
      value += grad_phi[i][0] * (*this->_sys.currentSolution())(dof_indices[i]);
    }
  }
  else
  {
    mooseAssert(dof_indices.size() == 1, "Wrong size for dof indices");
    value = 0.0;
  }
 
  return value;
}

◆ getHitNode() [1/2]

const hit::Node * MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 136 of file MooseBase.h.

136{ return getHitNode(_pars); }

Referenced by MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

◆ getHitNode() [2/2]

const hit::Node * MooseBase::getHitNode ( const InputParameters & params )

staticprivateinherited

Internal method for getting a hit node (if available) given a set of parameters.

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 167 of file MooseBase.C.

{
  if (const auto hit_node = params.getHitNode())
    if (!hit_node->isRoot())
      return hit_node;
  return nullptr;
}

◆ getMooseApp()

MooseApp & MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

87{ return _app; }

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarInterfaceWarehouse::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), FEProblemBase::getDistribution(), FEProblemBase::getFunction(), FEProblemBase::getFVInterpolationMethod(), FEProblemBase::getMultiApp(), FEProblemBase::getSampler(), DefaultConvergenceBase::getSharedExecutionerParam(), FEProblemBase::getUserObjectBase(), FEProblemBase::getVectorPostprocessorObjectByName(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), Moose::PetscSupport::PetscOptionsScope::PetscOptionsScope(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

◆ getNodalValue()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getNodalValue ( const Node & node ) const

inherited

Get the value of this variable at given node.

Definition at line 533 of file MooseVariableFE.C.

{
  return _element_data->getNodalValue(node, Moose::Current);
}

◆ getNodalValueOld()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getNodalValueOld ( const Node & node ) const

inherited

Get the old value of this variable at given node.

Definition at line 537 of file MooseVariableFE.C.

{
  return _element_data->getNodalValue(node, Moose::Old);
}

◆ getNodalValueOlder()

MooseVariableFE< Real >::DofValue MooseVariableFE< Real >::getNodalValueOlder ( const Node & node ) const

inherited

Get the t-2 value of this variable at given node.

Definition at line 541 of file MooseVariableFE.C.

{
  return _element_data->getNodalValue(node, Moose::Older);
}

◆ 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 101 of file OutputInterface.C.

{
  return _oi_outputs;
}

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::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 406 of file MooseBase.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::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 443 of file MooseBase.h.

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

◆ getRenamedParam()

template<typename T >

const T & MooseBase::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 420 of file MooseBase.h.

{
  // Most important: accept new parameter
  if (isParamSetByUser(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Second most: accept old parameter
  if (isParamValid(old_name) && !isParamSetByUser(new_name))
    return getParam<T>(old_name);
  // Third most: accept default for new parameter
  if (isParamValid(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Refuse: no default, no value passed
  if (!isParamValid(old_name) && !isParamValid(new_name))
    mooseError("parameter '" + new_name +
               "' is being retrieved without being set.\nDid you misspell it?");
  // Refuse: both old and new parameters set by user
  else
    mooseError("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 70 of file MooseObject.C.

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

Referenced by MFEMProblem::addImagComponentToBC(), MFEMProblem::addImagComponentToKernel(), MFEMProblem::addRealComponentToBC(), MFEMProblem::addRealComponentToKernel(), and WebServerControl::addServerAction().

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 83 of file MooseObject.C.

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

◆ getSolution()

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

protectedinherited

Get the solution corresponding to the provided state.

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

Referenced by MooseVariableScalar::evaluate().

◆ getValue()

Real MooseVariableFE< Real >::getValue	(	const Elem *	elem,
		const std::vector< std::vector< OutputShape > > &	phi
	)		const

inherited

Compute the variable value at a point on an element.

Parameters

elem	The element we are computing on
phi	Evaluated shape functions at a point

Returns: The variable value

Definition at line 629 of file MooseVariableFE.C.

{
  std::vector<dof_id_type> dof_indices;
  this->_dof_map.dof_indices(elem, dof_indices, _var_num);
 
  OutputType value = 0;
  if (isNodal())
  {
    mooseAssert(dof_indices.size() == phi.size(),
                "The number of shapes does not match the number of dof indices on the elem");
 
    for (unsigned int i = 0; i < dof_indices.size(); ++i)
    {
      // The zero index is because we only have one point that the phis are evaluated at
      value += phi[i][0] * (*this->_sys.currentSolution())(dof_indices[i]);
    }
  }
  else
  {
    mooseAssert(dof_indices.size() == 1, "Wrong size for dof indices");
    value = (*this->_sys.currentSolution())(dof_indices[0]);
  }
 
  return value;
}

◆ 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 222 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 ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 226 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_point, 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 224 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 225 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 FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 223 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradDot(face, 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 227 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 196 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 ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 200 of file MooseFunctor.h.

{
  return evaluateGradient(elem_point, 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 198 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 199 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 FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 197 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradient(face, 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 201 of file MooseFunctor.h.

{
  return evaluateGradient(node, state);
}

◆ gradPhi()

const FieldVariablePhiGradient & MooseVariableFE< Real >::gradPhi ( ) const

inlinefinaloverridevirtualinherited

Return the gradients of the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 195 of file MooseVariableFE.h.

  {
    return _element_data->gradPhi();
  }

◆ gradPhiFace()

const FieldVariablePhiGradient & MooseVariableFE< Real >::gradPhiFace ( ) const

inlinefinaloverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 208 of file MooseVariableFE.h.

  {
    return _element_data->gradPhiFace();
  }

◆ gradPhiFaceNeighbor()

const FieldVariablePhiGradient & MooseVariableFE< Real >::gradPhiFaceNeighbor ( ) const

inlinefinaloverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 237 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradPhiFace();
  }

◆ gradPhiLower()

const FieldVariablePhiGradient & MooseVariableFE< Real >::gradPhiLower ( ) const

inlineinherited

Definition at line 250 of file MooseVariableFE.h.

250{ return _lower_data->gradPhi(); }

◆ gradPhiNeighbor()

const FieldVariablePhiGradient & MooseVariableFE< Real >::gradPhiNeighbor ( ) const

inlinefinaloverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 221 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradPhi();
  }

◆ gradSln()

const FieldVariableGradient & MooseVariableFE< Real >::gradSln ( ) const

inlineoverridevirtualinherited

element gradients

Implements MooseVariableField< OutputType >.

Definition at line 294 of file MooseVariableFE.h.

  {
    return _element_data->gradSln(Moose::Current);
  }

◆ gradSlnDot()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnDot ( ) const

inlineinherited

element gradient dots

Definition at line 312 of file MooseVariableFE.h.

312{ return _element_data->gradSlnDot(); }

◆ gradSlnDotDot()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnDotDot ( ) const

inlineinherited

Definition at line 313 of file MooseVariableFE.h.

313{ return _element_data->gradSlnDotDot(); }

◆ gradSlnNeighbor()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor solution gradients

Implements MooseVariableField< OutputType >.

Definition at line 425 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradSln(Moose::Current);
  }

◆ gradSlnNeighborDot()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnNeighborDot ( ) const

inlineinherited

neighbor grad dots

Definition at line 443 of file MooseVariableFE.h.

443{ return _neighbor_data->gradSlnDot(); }

◆ gradSlnNeighborDotDot()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnNeighborDotDot ( ) const

inlineinherited

Definition at line 444 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradSlnDotDot();
  }

◆ gradSlnOld()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnOld ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 298 of file MooseVariableFE.h.

  {
    return _element_data->gradSln(Moose::Old);
  }

◆ gradSlnOlder()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnOlder ( ) const

inlineinherited

Definition at line 302 of file MooseVariableFE.h.

  {
    return _element_data->gradSln(Moose::Older);
  }

◆ gradSlnOlderNeighbor()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 433 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradSln(Moose::Older);
  }

◆ gradSlnOldNeighbor()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnOldNeighbor ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 429 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradSln(Moose::Old);
  }

◆ gradSlnPreviousNL()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnPreviousNL ( ) const

inlineinherited

Definition at line 306 of file MooseVariableFE.h.

  {
    return _element_data->gradSln(Moose::PreviousNL);
  }

◆ gradSlnPreviousNLNeighbor()

const FieldVariableGradient & MooseVariableFE< Real >::gradSlnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 437 of file MooseVariableFE.h.

  {
    return _neighbor_data->gradSln(Moose::PreviousNL);
  }

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 142 of file MooseBase.h.

142{ return _pars.hasBase(); }

InputParameters::hasBase

bool hasBase() const

Definition InputParameters.C:499

◆ 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 360 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 300 of file BlockRestrictable.C.

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

Referenced by BlockRestrictable::hasBlockMaterialProperty().

◆ hasBlocks() [1/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 262 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() [2/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 240 of file BlockRestrictable.C.

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

◆ hasBlocks() [3/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 255 of file BlockRestrictable.C.

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

◆ hasBlocks() [4/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 234 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/6]

template<typename OutputType >

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

inlineoverridevirtualinherited

Returns whether the functor is defined on this block.

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

Definition at line 402 of file MooseVariableField.h.

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

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

◆ hasBlocks() [6/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 224 of file BlockRestrictable.C.

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

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

◆ hasDoFsOnNodes()

bool MooseVariableFE< Real >::hasDoFsOnNodes ( ) const

inlineoverridevirtualinherited

Does this variable have DoFs on nodes.

Returns: true if it does, false if not.

Reimplemented from MooseVariableBase.

Definition at line 150 of file MooseVariableFE.h.

150{ return _element_data->hasDoFsOnNodes(); }

◆ hasFaceSide()

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

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 268 of file MooseFunctor.h.

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

◆ increment()

const FieldVariableValue & MooseVariableFE< Real >::increment ( ) const

inlineinherited

Definition at line 268 of file MooseVariableFE.h.

268{ return _element_data->increment(); }

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject * moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 76 of file BlockRestrictable.C.

{
  // 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)
  {
#ifdef MOOSE_KOKKOS_ENABLED
    if (_moose_object->isKokkosObject())
      _blk_material_data = &_blk_feproblem->getKokkosMaterialData(Moose::BLOCK_MATERIAL_DATA);
    else
#endif
      _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();
 
#ifdef MOOSE_KOKKOS_ENABLED
  if (moose_object->isKokkosObject())
    _blk_feproblem->addKokkosMeshInitializationHook(
        std::bind(&BlockRestrictable::initializeKokkosBlockRestrictable, this));
#endif
}

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

◆ initializeKokkosBlockRestrictable()

void BlockRestrictable::initializeKokkosBlockRestrictable ( )

protectedinherited

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ 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< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< T >.

Definition at line 195 of file MooseVariableBase.C.

{
  // 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()

void MooseVariableFE< Real >::insert ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtualinherited

Set the current local DOF values to the input vector.

Implements MooseVariableFieldBase.

Definition at line 567 of file MooseVariableFE.C.

{
  _element_data->insert(vector);
}

◆ insertLower()

void MooseVariableFE< Real >::insertLower ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtualinherited

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

Implements MooseVariableFieldBase.

Definition at line 568 of file MooseVariableFE.C.

{
  _lower_data->insert(vector);
}

◆ insertNodalValue()

void MooseVariableFE< Real >::insertNodalValue	(	libMesh::NumericVector< libMesh::Number > &	residual,
		const DofValue &	v
	)

inherited

Write a nodal value to the passed-in solution vector.

Definition at line 528 of file MooseVariableFE.C.

{
  _element_data->insertNodalValue(residual, v);
}

◆ isArray()

template<typename OutputType >

bool MooseVariableField< OutputType >::isArray ( ) const

overridevirtualinherited

Returns: whether this is an array variable

Reimplemented from MooseVariableBase.

Definition at line 74 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 271 of file BlockRestrictable.C.

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

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

◆ 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 287 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 266 of file MooseFunctor.h.

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

Definition at line 253 of file MooseFunctor.h.

  {
    mooseError("not implemented");
  }

◆ isFV()

virtual bool MooseVariableFieldBase::isFV ( ) const

inlinevirtualinherited

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

Definition at line 81 of file MooseVariableFieldBase.h.

81{ return false; }

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

◆ 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 261 of file MooseFunctor.h.

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

◆ isKokkosObject()

bool MooseObject::isKokkosObject ( ) const

inlineinherited

Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

Definition at line 63 of file MooseObject.h.

63{ return parameters().isKokkosObject(); }

InputParameters::isKokkosObject

bool isKokkosObject() const

Returns whether this InputParameters belongs to a Kokkos object Checks whether MooseBase::kokkos_obje...

Definition InputParameters.C:433

Referenced by AttribKokkos::initFrom(), BlockRestrictable::initializeBlockRestrictable(), and BoundaryRestrictable::initializeBoundaryRestrictable().

◆ isNodal()

bool MooseVariableFE< Real >::isNodal ( ) const

inlineoverridevirtualinherited

Is this variable nodal.

Returns: true if it nodal, otherwise false

Reimplemented from MooseVariableBase.

Definition at line 149 of file MooseVariableFE.h.

149{ return _element_data->isNodal(); }

◆ isNodalDefined()

bool MooseVariableFE< Real >::isNodalDefined ( ) const

overridevirtualinherited

Is this variable defined at nodes.

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

Implements MooseVariableFieldBase.

Definition at line 156 of file MooseVariableFE.C.

{
  return _element_data->isNodalDefined();
}

◆ isNodalNeighborDefined()

bool MooseVariableFE< Real >::isNodalNeighborDefined ( ) const

inherited

Definition at line 163 of file MooseVariableFE.C.

{
  return _neighbor_data->isNodalDefined();
}

◆ isParamSetByUser()

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

inlineinherited

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

Parameters

name	The name of the parameter to test

Definition at line 205 of file MooseBase.h.

  {
    return _pars.isParamSetByUser(name);
  }

Referenced by DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MFEMMesh::buildMesh(), MFEMBoundarySubMesh::buildSubMesh(), MFEMDomainSubMesh::buildSubMesh(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< is_ad >::ConservativeAdvectionBCTempl(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), FileMesh::FileMesh(), FullSolveMultiApp::FullSolveMultiApp(), OrientSurfaceMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), MFEMVectorFESpace::getFECName(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), MFEMMesh::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MFEMVariable::MFEMVariable(), MortarConstraintBase::MortarConstraintBase(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), ReferenceResidualConvergence::ReferenceResidualConvergence(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::run(), MooseApp::runInputFile(), MooseApp::runInputs(), Moose::MFEM::LinearSolverBase::SetPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SmoothMeshGenerator::SmoothMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SurfaceSubdomainsFromAllNormalsGenerator::SurfaceSubdomainsFromAllNormalsGenerator(), TagVectorAux::TagVectorAux(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

◆ isParamValid()

bool MooseBase::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 199 of file MooseBase.h.

199{ return _pars.isParamValid(name); }

InputParameters::isParamValid

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

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

Definition InputParameters.C:386

◆ isVector()

template<typename OutputType >

bool MooseVariableField< OutputType >::isVector ( ) const

overridevirtualinherited

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

Implements MooseVariableFieldBase.

Definition at line 85 of file MooseVariableField.C.

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

◆ jacobianSetup()

void MooseVariableFE< Real >::jacobianSetup ( )

overridevirtualinherited

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

Reimplemented from MooseVariableField< OutputType >.

Definition at line 714 of file MooseVariableFE.C.

{
  _current_elem_qp_functor_elem = nullptr;
  _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
  MooseVariableField<OutputType>::jacobianSetup();
}

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const

inlineinherited

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

Definition at line 91 of file MooseVariableBase.h.

91{ return _var_kind; }

Referenced by ADPenaltyPeriodicSegmentalConstraint::ADPenaltyPeriodicSegmentalConstraint(), ADPeriodicSegmentalConstraint::ADPeriodicSegmentalConstraint(), FVFluxBC::FVFluxBC(), PenaltyPeriodicSegmentalConstraint::PenaltyPeriodicSegmentalConstraint(), and PeriodicSegmentalConstraint::PeriodicSegmentalConstraint().

◆ kokkosBlockElementID()

KOKKOS_FUNCTION ContiguousElementID BlockRestrictable::kokkosBlockElementID ( Moose::Kokkos::ThreadID tid ) const

inlineprotectedinherited

Get the contiguous element ID this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns: The contiguous element ID

Definition at line 280 of file BlockRestrictable.h.

  {
    return _kokkos_element_ids[tid];
  }

◆ kokkosBlockElementSideID()

KOKKOS_FUNCTION auto BlockRestrictable::kokkosBlockElementSideID ( Moose::Kokkos::ThreadID tid ) const

inlineprotectedinherited

Get the contiguous element ID - side index pair this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns: The contiguous element ID - side index pair

Definition at line 298 of file BlockRestrictable.h.

  {
    return _kokkos_element_side_ids[tid];
  }

◆ kokkosBlockNodeID()

KOKKOS_FUNCTION ContiguousElementID BlockRestrictable::kokkosBlockNodeID ( Moose::Kokkos::ThreadID tid ) const

inlineprotectedinherited

Get the contiguous node index this Kokkos thread is operating on.

Parameters

tid	The thread ID

Returns: the contiguous node ID

Definition at line 289 of file BlockRestrictable.h.

  {
    return _kokkos_node_ids[tid];
  }

Referenced by Moose::Kokkos::NodalUserObject::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::AuxKernel::operator()(), Moose::Kokkos::NodalKernel::operator()(), Moose::Kokkos::NodalReducer::operator()(), and Moose::Kokkos::NodalKernel::operator()().

◆ matrixTagValue()

const FieldVariableValue & MooseVariableFE< Real >::matrixTagValue ( TagID tag ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 282 of file MooseVariableFE.h.

  {
    return _element_data->matrixTagValue(tag);
  }

◆ 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 294 of file BlockRestrictable.C.

{
  return _blk_mesh->meshSubdomains();
}

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

◆ meshChanged()

void MooseVariableFE< Real >::meshChanged ( )

overridevirtualinherited

Called on this object when the mesh changes.

Reimplemented from MeshChangedInterface.

Definition at line 712 of file MooseVariableFE.C.

{
  _current_elem_qp_functor_elem = nullptr;
  _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
  MooseVariableField<OutputType>::meshChanged();
}

◆ messagePrefix() [1/2]

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

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

Definition at line 256 of file MooseBase.h.

  {
    return messagePrefix(_pars, hit_prefix);
  }

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::messagePrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

◆ messagePrefix() [2/2]

std::string MooseBase::messagePrefix	(	const InputParameters &	params,
		const bool	hit_prefix
	)

staticprivateinherited

Internal method for getting the message prefix for an object (object type, name, etc).

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 140 of file MooseBase.C.

{
  std::string prefix = "";
 
  if (hit_prefix)
    if (const auto node = MooseBase::getHitNode(params))
      prefix += Moose::hitMessagePrefix(*node);
 
  // Don't have context without type and name
  if (!params.isMooseBaseObject())
    return prefix;
 
  const auto & name = params.getObjectName();
  const std::string base = params.hasBase() ? params.getBase() : "object";
  const bool is_main_app = base == "Application" && name == AppFactory::main_app_name;
  prefix += "The following occurred in the ";
  if (is_main_app)
    prefix += "main " + base;
  else
    prefix += base;
  if (base != params.getObjectName() && name.size() && !is_main_app)
    prefix += " '" + name + "'";
  prefix += " of type " + params.getObjectType() + ".";
  return prefix + "\n\n";
}

◆ mooseDeprecated() [1/2]

template<typename... Args>

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

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and a stack trace.

Definition at line 317 of file MooseBase.h.

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

Referenced by MooseApp::addCapability(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), MooseApp::getRecoverFileBase(), MooseApp::hasRecoverFileBase(), and MooseApp::setupOptions().

◆ mooseDeprecated() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseDeprecated(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": deprecation");
  }

Referenced by MultiApp::appProblem(), AddVariableAction::determineType(), MooseMesh::elem(), MooseMesh::elem(), FunctionDT::FunctionDT(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), MooseMesh::isTranslatedPeriodic(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), MooseMesh::node(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), and MooseMesh::setBoundaryToNormalMap().

◆ mooseDeprecatedNoTrace()

template<typename... Args>

void MooseBase::mooseDeprecatedNoTrace ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and no stack trace.

Definition at line 327 of file MooseBase.h.

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

◆ mooseDocumentedError()

template<typename... Args>

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

inlineinherited

Definition at line 277 of file MooseBase.h.

  {
    callMooseError(moose::internal::formatMooseDocumentedError(
                       repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                   /* with_prefix = */ true);
  }

Referenced by ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 271 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
  }

◆ mooseErrorNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 290 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
  }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 334 of file MooseBase.h.

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

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), PIDTransientControl::execute(), Executioner::Executioner(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), ManifoldSubdomainGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), MultiAppTransfer::mapBackWithoutCollapsing(), SolutionInvalidityOutput::output(), MooseBase::paramInfo(), MooseApp::setupOptions(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ mooseWarning() [1/2]

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 299 of file MooseBase.h.

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

Referenced by DiracKernelInfo::findPoint(), DataFileInterface::getDataFilePath(), MooseApp::loadLibraryAndDependencies(), and MooseBase::paramWarning().

◆ mooseWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarning(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

Referenced by CopyMeshPartitioner::_do_partition(), AddFunctionAction::act(), AddKernelAction::act(), CommonOutputAction::act(), MaterialOutputAction::act(), MeshOnlyAction::act(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), Postprocessor::evaluateDotWarning(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), BSplineCurveGenerator::generate(), RenumberBySubdomainGenerator::generate(), SubdomainPerElementGenerator::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), MFEMRefinementMarker::initialSetup(), MaterialBase::initStatefulProperties(), IterationAdaptiveDT::limitDTToPostprocessorValue(), NewmarkBeta::NewmarkBeta(), Output::Output(), MaterialOutputAction::outputHelper(), Executioner::problem(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), MooseMesh::setCoordSystem(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

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

inlineinherited

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

Definition at line 308 of file MooseBase.h.

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

◆ mooseWarningNonPrefixed() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 80 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarningNonPrefixed(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 103 of file MooseBase.h.

  {
    mooseAssert(_name.size(), "Empty name");
    return _name;
  }

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

Definition at line 120 of file MooseVariableFieldBase.h.

120{ return false; }

◆ neighbor()

const Elem *const & MooseVariableFE< Real >::neighbor ( ) const

inlineinherited

Current neighboring element.

Definition at line 175 of file MooseVariableFE.h.

175{ return _neighbor_data->currentElem(); }

◆ nodalDofIndex()

const dof_id_type & MooseVariableFE< Real >::nodalDofIndex ( ) const

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 155 of file MooseVariableFE.h.

155{ return _element_data->nodalDofIndex(); }

◆ nodalDofIndexNeighbor()

const dof_id_type & MooseVariableFE< Real >::nodalDofIndexNeighbor ( ) const

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 159 of file MooseVariableFE.h.

  {
    return _neighbor_data->nodalDofIndex();
  }

◆ nodalMatrixTagValue()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::nodalMatrixTagValue ( TagID tag ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 701 of file MooseVariableFE.C.

{
  return _element_data->nodalMatrixTagValue(tag);
}

◆ nodalValue()

const Real & MooseVariableFE< Real >::nodalValue ( ) const

inherited

Methods for retrieving values of variables at the nodes.

Definition at line 664 of file MooseVariableFE.C.

{
  return _element_data->nodalValue(Moose::Current);
}

◆ nodalValueArray()

const MooseArray< Real > & MooseVariableFE< Real >::nodalValueArray ( ) const

inlineoverridevirtualinherited

Methods for retrieving values of variables at the nodes in a MooseArray for AuxKernelBase.

Implements MooseVariableField< OutputType >.

Definition at line 687 of file MooseVariableFE.h.

  {
    return _element_data->nodalValueArray(Moose::Current);
  }

◆ nodalValueDot()

const Real & MooseVariableFE< Real >::nodalValueDot ( ) const

inherited

Definition at line 668 of file MooseVariableFE.C.

{
  return _element_data->nodalValueDot();
}

◆ nodalValueDotDot()

const Real & MooseVariableFE< Real >::nodalValueDotDot ( ) const

inherited

Definition at line 669 of file MooseVariableFE.C.

{
  return _element_data->nodalValueDotDot();
}

◆ nodalValueDotDotNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotDotNeighbor ( ) const

inherited

◆ nodalValueDotDotNeighborResidual()

const Real & MooseVariableFE< Real >::nodalValueDotDotNeighborResidual ( ) const

inherited

◆ nodalValueDotDotOld()

const Real & MooseVariableFE< Real >::nodalValueDotDotOld ( ) const

inherited

Definition at line 671 of file MooseVariableFE.C.

{
  return _element_data->nodalValueDotDotOld();
}

◆ nodalValueDotDotOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotDotOldNeighbor ( ) const

inherited

◆ nodalValueDotNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotNeighbor ( ) const

inherited

◆ nodalValueDotNeighborResidual()

const Real & MooseVariableFE< Real >::nodalValueDotNeighborResidual ( ) const

inherited

◆ nodalValueDotOld()

const Real & MooseVariableFE< Real >::nodalValueDotOld ( ) const

inherited

Definition at line 670 of file MooseVariableFE.C.

{
  return _element_data->nodalValueDotOld();
}

◆ nodalValueDotOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotOldNeighbor ( ) const

inherited

◆ nodalValueDuDotDotDu()

const Real & MooseVariableFE< Real >::nodalValueDuDotDotDu ( ) const

inherited

◆ nodalValueDuDotDotDuNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDuDotDotDuNeighbor ( ) const

inherited

◆ nodalValueDuDotDu()

const Real & MooseVariableFE< Real >::nodalValueDuDotDu ( ) const

inherited

◆ nodalValueDuDotDuNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDuDotDuNeighbor ( ) const

inherited

◆ nodalValueNeighbor()

const Real & MooseVariableFE< Real >::nodalValueNeighbor ( ) const

inherited

Definition at line 674 of file MooseVariableFE.C.

{
  return _neighbor_data->nodalValue(Moose::Current);
}

◆ nodalValueOld()

const Real & MooseVariableFE< Real >::nodalValueOld ( ) const

inherited

Definition at line 665 of file MooseVariableFE.C.

{
  return _element_data->nodalValue(Moose::Old);
}

◆ nodalValueOldArray()

const MooseArray< Real > & MooseVariableFE< Real >::nodalValueOldArray ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 691 of file MooseVariableFE.h.

  {
    return _element_data->nodalValueArray(Moose::Old);
  }

◆ nodalValueOlder()

const Real & MooseVariableFE< Real >::nodalValueOlder ( ) const

inherited

Definition at line 666 of file MooseVariableFE.C.

{
  return _element_data->nodalValue(Moose::Older);
}

◆ nodalValueOlderArray()

const MooseArray< Real > & MooseVariableFE< Real >::nodalValueOlderArray ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 695 of file MooseVariableFE.h.

  {
    return _element_data->nodalValueArray(Moose::Older);
  }

◆ nodalValueOlderNeighbor()

const Real & MooseVariableFE< Real >::nodalValueOlderNeighbor ( ) const

inherited

Definition at line 676 of file MooseVariableFE.C.

{
  return _neighbor_data->nodalValue(Moose::Older);
}

◆ nodalValueOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueOldNeighbor ( ) const

inherited

Definition at line 675 of file MooseVariableFE.C.

{
  return _neighbor_data->nodalValue(Moose::Old);
}

◆ nodalValuePreviousNL()

const Real & MooseVariableFE< Real >::nodalValuePreviousNL ( ) const

inherited

Definition at line 667 of file MooseVariableFE.C.

{
  return _element_data->nodalValue(Moose::PreviousNL);
}

◆ nodalValuePreviousNLNeighbor()

const Real & MooseVariableFE< Real >::nodalValuePreviousNLNeighbor ( ) const

inherited

Definition at line 677 of file MooseVariableFE.C.

{
  return _neighbor_data->nodalValue(Moose::PreviousNL);
}

◆ nodalVectorTagValue()

const MooseVariableFE< Real >::DofValues & MooseVariableFE< Real >::nodalVectorTagValue ( TagID tag ) const

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 700 of file MooseVariableFE.C.

{
  return _element_data->nodalVectorTagValue(tag);
}

◆ node()

const Node *const & MooseVariableFE< Real >::node ( ) const

inlineinherited

Definition at line 154 of file MooseVariableFE.h.

154{ return _element_data->node(); }

◆ nodeNeighbor()

const Node *const & MooseVariableFE< Real >::nodeNeighbor ( ) const

inlineinherited

Definition at line 158 of file MooseVariableFE.h.

158{ return _neighbor_data->node(); }

◆ number()

unsigned int MooseVariableBase::number ( ) const

inlineinherited

Get variable number coming from libMesh.

Returns: the libmesh variable number

Definition at line 60 of file MooseVariableBase.h.

60{ return _var_num; }

◆ numberOfDofs()

unsigned int MooseVariableFE< Real >::numberOfDofs ( ) const

inlinefinalvirtualinherited

Get the number of local DoFs.

Reimplemented from MooseVariableBase.

Definition at line 180 of file MooseVariableFE.h.

180{ return _element_data->numberOfDofs(); }

◆ numberOfDofsNeighbor()

unsigned int MooseVariableFE< Real >::numberOfDofsNeighbor ( )

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 192 of file MooseVariableFE.h.

192{ return _neighbor_data->dofIndices().size(); }

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 218 of file BlockRestrictable.C.

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

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

◆ numKokkosBlockElements()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockElements ( ) const

inlineprotectedinherited

Get the number of elements this Kokkos object is operating on.

Returns: The number of elements local to this process

Definition at line 261 of file BlockRestrictable.h.

261{ return _kokkos_element_ids.size(); }

Moose::Kokkos::ArrayBase::size

KOKKOS_FUNCTION index_type size() const

Get the total array size.

Definition KokkosArray.h:294

Referenced by Moose::Kokkos::ElementReducer::numReducerThreads(), and Moose::Kokkos::ElementUserObject::numUserObjectThreads().

◆ numKokkosBlockNodes()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockNodes ( ) const

inlineprotectedinherited

Get the number of nodes this Kokkos object is operating on.

Returns: The number of nodes local to this process

Definition at line 266 of file BlockRestrictable.h.

266{ return _kokkos_node_ids.size(); }

Referenced by Moose::Kokkos::NodalReducer::numReducerThreads(), and Moose::Kokkos::NodalUserObject::numUserObjectThreads().

◆ numKokkosBlockSides()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockSides ( ) const

inlineprotectedinherited

Get the number of sides this Kokkos object is operating on.

Returns: The number of sides local to this process

Definition at line 271 of file BlockRestrictable.h.

  {
    return _kokkos_element_side_ids.size();
  }

◆ oldestSolutionStateRequested()

unsigned int MooseVariableFE< Real >::oldestSolutionStateRequested ( ) const

finaloverridevirtualinherited

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

Implements MooseVariableFieldBase.

Definition at line 708 of file MooseVariableFE.C.

{
  unsigned int state = 0;
  state = std::max(state, _element_data->oldestSolutionStateRequested());
  state = std::max(state, _neighbor_data->oldestSolutionStateRequested());
  state = std::max(state, _lower_data->oldestSolutionStateRequested());
  return state;
}

◆ 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 183 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 ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 187 of file MooseFunctor.h.

{
  return evaluate(elem_point, state);
}

◆ 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 185 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 186 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 FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 184 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()() [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 188 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 169 of file MooseVariableBase.C.

{
  return _fe_type.order;
}

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

◆ paramError()

template<typename... Args>

void MooseBase::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 457 of file MooseBase.h.

{
  _pars.paramError(param, std::forward<Args>(args)...);
}

◆ parameters()

const InputParameters & MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 131 of file MooseBase.h.

131{ return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseBase::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 471 of file MooseBase.h.

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

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

◆ paramWarning() [1/2]

template<typename... Args>

void MooseBase::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 464 of file MooseBase.h.

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

◆ paramWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::paramWarning(param, std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning for parameter '" +
                                            param + "'");
  }

Referenced by GridPartitioner::_do_partition(), CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), MooseMeshUtils::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), PlaneIDMeshGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), ReferenceResidualConvergence::initialSetup(), FullSolveMultiApp::initialSetup(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), PNGOutput::PNGOutput(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

◆ phi()

const FieldVariablePhiValue & MooseVariableFE< Real >::phi ( ) const

inlineoverridevirtualinherited

Return the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 194 of file MooseVariableFE.h.

194{ return _element_data->phi(); }

◆ phiFace()

const FieldVariablePhiValue & MooseVariableFE< Real >::phiFace ( ) const

inlinefinaloverridevirtualinherited

Return the variable's shape functions on an element face.

Implements MooseVariableField< OutputType >.

Definition at line 207 of file MooseVariableFE.h.

207{ return _element_data->phiFace(); }

◆ phiFaceNeighbor()

const FieldVariablePhiValue & MooseVariableFE< Real >::phiFaceNeighbor ( ) const

inlinefinaloverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 233 of file MooseVariableFE.h.

  {
    return _neighbor_data->phiFace();
  }

◆ phiFaceNeighborSize()

virtual std::size_t MooseVariableFE< Real >::phiFaceNeighborSize ( ) const

inlinefinalvirtualinherited

Return phiFaceNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 657 of file MooseVariableFE.h.

657{ return _neighbor_data->phiFaceSize(); }

◆ phiFaceSize()

virtual std::size_t MooseVariableFE< Real >::phiFaceSize ( ) const

inlinefinalvirtualinherited

Return phiFace size.

Implements MooseVariableFieldBase.

Definition at line 649 of file MooseVariableFE.h.

649{ return _element_data->phiFaceSize(); }

◆ phiLower()

virtual const FieldVariablePhiValue & MooseVariableFE< Real >::phiLower ( ) const

inlineoverridevirtualinherited

Return the variable's shape functions on a lower-dimensional element.

Implements MooseVariableField< OutputType >.

Definition at line 249 of file MooseVariableFE.h.

249{ return _lower_data->phi(); }

◆ phiLowerSize()

std::size_t MooseVariableFE< Real >::phiLowerSize ( ) const

inlinefinalvirtualinherited

Return the number of shape functions on the lower dimensional element for this variable.

Implements MooseVariableFieldBase.

Definition at line 659 of file MooseVariableFE.h.

659{ return _lower_data->phiSize(); }

◆ phiNeighbor()

const FieldVariablePhiValue & MooseVariableFE< Real >::phiNeighbor ( ) const

inlinefinaloverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 220 of file MooseVariableFE.h.

220{ return _neighbor_data->phi(); }

◆ phiNeighborSize()

virtual std::size_t MooseVariableFE< Real >::phiNeighborSize ( ) const

inlinefinalvirtualinherited

Return phiNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 653 of file MooseVariableFE.h.

653{ return _neighbor_data->phiSize(); }

◆ phiSize()

virtual std::size_t MooseVariableFE< Real >::phiSize ( ) const

inlinefinalvirtualinherited

Return phi size.

Implements MooseVariableFieldBase.

Definition at line 645 of file MooseVariableFE.h.

645{ return _element_data->phiSize(); }

◆ prepare()

void MooseVariableFE< Real >::prepare ( )

overridevirtualinherited

Prepare the elemental degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 96 of file MooseVariableFE.C.

{
  _element_data->prepare();
}

◆ prepareAux()

void MooseVariableFE< Real >::prepareAux ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 101 of file MooseVariableFE.C.

{
  _element_data->prepareAux();
  _neighbor_data->prepareAux();
  _lower_data->prepareAux();
}

◆ prepareIC()

void MooseVariableFE< Real >::prepareIC ( )

overridevirtualinherited

Prepare the initial condition.

Implements MooseVariableFieldBase.

Definition at line 99 of file MooseVariableFE.C.

{
  _element_data->prepareIC();
}

◆ prepareLowerD()

void MooseVariableFE< Real >::prepareLowerD ( )

overridevirtualinherited

Prepare a lower dimensional element's degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 98 of file MooseVariableFE.C.

{
  _lower_data->prepare();
}

◆ prepareNeighbor()

void MooseVariableFE< Real >::prepareNeighbor ( )

overridevirtualinherited

Prepare the neighbor element degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 97 of file MooseVariableFE.C.

{
  _neighbor_data->prepare();
}

◆ queryFVArgCache()

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::queryFVArgCache	(	std::map< SpaceArg, ValueType > &	cache_data,
		const SpaceArg &	space
	)		const

privateinherited

check a finite volume spatial argument cache and if invalid then evaluate

Definition at line 516 of file MooseFunctor.h.

{
  // We don't want to evaluate if the key already exists, so instead we value initialize
  auto [it, inserted] = cache_data.try_emplace(space, ValueType());
  auto & value = it->second;
 
  if (inserted)
    // value not ready to go
    // this function is only called from functions that assert we are in the current time state
    value = evaluate(space, currentState());
 
  return value;
}

◆ queryParam()

template<typename T >

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

inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or 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 413 of file MooseBase.h.

{
  return _pars.queryParam<T>(name);
}

Referenced by MFEMExecutedObject::getRequestedItems(), and MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver().

◆ queryQpCache()

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::queryQpCache	(	unsigned int	qp,
		const libMesh::QBase &	qrule,
		std::vector< std::pair< bool, Moose::ADType< OutputType >::type > > &	qp_cache_data,
		const SpaceArg &	space,
		const StateArg &	state
	)		const

privateinherited

check a qp cache and if invalid then evaluate

Definition at line 506 of file MooseFunctor.h.

{
  // Check and see whether we even have sized for this quadrature point. If we haven't then we
  // must evaluate
  if (qp >= qp_cache_data.size())
  {
    qp_cache_data.resize(qrule.n_points(), std::make_pair(false, ValueType()));
    auto & pr = qp_cache_data[qp];
    pr.second = evaluate(space, state);
    pr.first = true;
    return pr.second;
  }
 
  // We've already sized for this qp, so let's see whether we have a valid cache value
  auto & pr = qp_cache_data[qp];
  if (pr.first)
    return pr.second;
 
  // No valid cache value so evaluate
  pr.second = evaluate(space, state);
  pr.first = true;
  return pr.second;
}

◆ registerInvalidSolutionInternal()

InvalidSolutionID SolutionInvalidInterface::registerInvalidSolutionInternal	(	const std::string &	message,
		const bool	warning
	)		const

protectedinherited

Definition at line 55 of file SolutionInvalidInterface.C.

{
  return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
      _si_moose_base.type(), message, warning);
}

◆ reinitAux()

void MooseVariableFE< Real >::reinitAux ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 104 of file MooseVariableFE.C.

{
  _element_data->reinitAux();
}

◆ reinitAuxNeighbor()

void MooseVariableFE< Real >::reinitAuxNeighbor ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 105 of file MooseVariableFE.C.

{
  _neighbor_data->reinitAux();
}

◆ reinitNode()

void MooseVariableFE< Real >::reinitNode ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 103 of file MooseVariableFE.C.

{
  _element_data->reinitNode();
}

◆ reinitNodes()

void MooseVariableFE< Real >::reinitNodes ( const std::vector< dof_id_type > & nodes )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 107 of file MooseVariableFE.C.

{
  _element_data->reinitNodes(nodes);
}

◆ reinitNodesNeighbor()

void MooseVariableFE< Real >::reinitNodesNeighbor ( const std::vector< dof_id_type > & nodes )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 108 of file MooseVariableFE.C.

{
  _neighbor_data->reinitNodes(nodes);
}

◆ requireQpComputations()

virtual void MooseVariableFieldBase::requireQpComputations ( ) const

inlinevirtualinherited

Request that quadrature point data be (pre)computed.

FE variables (pre)compute quadrature point data by default, so this is a no-op for them. Some FV variables (e.g. linear FV variables) do not compute it by default and use this call to opt in.

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

Definition at line 225 of file MooseVariableFieldBase.h.

225{}

Referenced by AuxKernelBase::AuxKernelBase().

◆ residualSetup()

void MooseVariableFE< Real >::residualSetup ( )

overridevirtualinherited

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

Reimplemented from MooseVariableField< OutputType >.

Definition at line 713 of file MooseVariableFE.C.

{
  _current_elem_qp_functor_elem = nullptr;
  _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
  MooseVariableField<OutputType>::residualSetup();
}

◆ scalingFactor() [1/2]

Real MooseVariableBase::scalingFactor ( ) const

inlineinherited

Get the scaling factor for this variable.

Definition at line 101 of file MooseVariableBase.h.

101{ return _scaling_factor[0]; }

Referenced by MooseVariableBase::MooseVariableBase().

◆ scalingFactor() [2/2]

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

inherited

Set the scaling factor for this variable.

Definition at line 187 of file MooseVariableBase.C.

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

◆ secondPhi()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhi ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 203 of file MooseVariableFE.C.

{
  return _element_data->secondPhi();
}

◆ secondPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiFace ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face.

Implements MooseVariableField< OutputType >.

Definition at line 216 of file MooseVariableFE.C.

{
  return _element_data->secondPhiFace();
}

◆ secondPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiFaceNeighbor ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element face.

Implements MooseVariableField< OutputType >.

Definition at line 245 of file MooseVariableFE.C.

{
  return _neighbor_data->secondPhiFace();
}

◆ secondPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiNeighbor ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element.

Implements MooseVariableField< OutputType >.

Definition at line 229 of file MooseVariableFE.C.

{
  return _neighbor_data->secondPhi();
}

◆ secondSln()

const FieldVariableSecond & MooseVariableFE< Real >::secondSln ( ) const

inlineinherited

element seconds

Definition at line 316 of file MooseVariableFE.h.

316{ return _element_data->secondSln(Moose::Current); }

◆ secondSlnNeighbor()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnNeighbor ( ) const

inlineinherited

neighbor solution seconds

Definition at line 450 of file MooseVariableFE.h.

  {
    return _neighbor_data->secondSln(Moose::Current);
  }

◆ secondSlnOld()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnOld ( ) const

inlineinherited

Definition at line 317 of file MooseVariableFE.h.

317{ return _element_data->secondSln(Moose::Old); }

◆ secondSlnOlder()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnOlder ( ) const

inlineinherited

Definition at line 318 of file MooseVariableFE.h.

  {
    return _element_data->secondSln(Moose::Older);
  }

◆ secondSlnOlderNeighbor()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 458 of file MooseVariableFE.h.

  {
    return _neighbor_data->secondSln(Moose::Older);
  }

◆ secondSlnOldNeighbor()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnOldNeighbor ( ) const

inlineinherited

Definition at line 454 of file MooseVariableFE.h.

  {
    return _neighbor_data->secondSln(Moose::Old);
  }

◆ secondSlnPreviousNL()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnPreviousNL ( ) const

inlineinherited

Definition at line 322 of file MooseVariableFE.h.

  {
    return _element_data->secondSln(Moose::PreviousNL);
  }

◆ secondSlnPreviousNLNeighbor()

const FieldVariableSecond & MooseVariableFE< Real >::secondSlnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 462 of file MooseVariableFE.h.

  {
    return _neighbor_data->secondSln(Moose::PreviousNL);
  }

◆ setActiveTags()

void MooseVariableFE< Real >::setActiveTags ( const std::set< TagID > & vtags )

overridevirtualinherited

Set the active vector tags.

Parameters

vtags Additional vector tags that this variable will need to query at dof indices for, in addition to our own required solution tags

Reimplemented from MooseVariableBase.

Definition at line 710 of file MooseVariableFE.h.

{
  _element_data->setActiveTags(vtags);
  _neighbor_data->setActiveTags(vtags);
  _lower_data->setActiveTags(vtags);
}

◆ 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 238 of file MooseFunctor.h.

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

◆ setDofValue()

void MooseVariableFE< Real >::setDofValue	(	const DofValue &	value,
		unsigned int	index
	)

overridevirtualinherited

Degree of freedom value setters.

Implements MooseVariableField< OutputType >.

Definition at line 517 of file MooseVariableFE.C.

{
  _element_data->setDofValue(value, index);
}

◆ setDofValues()

void MooseVariableFE< Real >::setDofValues ( const DenseVector< DofValue > & values )

overridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 522 of file MooseVariableFE.C.

{
  _element_data->setDofValues(values);
}

◆ setLowerDofValues()

void MooseVariableFE< Real >::setLowerDofValues ( const DenseVector< DofValue > & values )

overridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 523 of file MooseVariableFE.C.

{
  _lower_data->setDofValues(values);
}

◆ setNodalValue()

void MooseVariableFE< Real >::setNodalValue	(	const Real &	value,
		unsigned int	idx = `0`
	)

overridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 515 of file MooseVariableFE.C.

{
  _element_data->setNodalValue(value, idx);
}

◆ sizeMatrixTagData()

void MooseVariableFE< Real >::sizeMatrixTagData ( )

overridevirtualinherited

Size data structures related to matrix tagging.

Reimplemented from MooseVariableBase.

Definition at line 716 of file MooseVariableFE.C.

{
  _element_data->sizeMatrixTagData();
  _neighbor_data->sizeMatrixTagData();
  _lower_data->sizeMatrixTagData();
}

◆ sln()

const FieldVariableValue & MooseVariableFE< Real >::sln ( ) const

inlineoverridevirtualinherited

element solutions

Implements MooseVariableField< OutputType >.

Definition at line 288 of file MooseVariableFE.h.

288{ return _element_data->sln(Moose::Current); }

◆ slnLower()

const FieldVariableValue & MooseVariableFE< Real >::slnLower ( ) const

inlineinherited

Definition at line 505 of file MooseVariableFE.h.

505{ return _lower_data->sln(Moose::Current); }

◆ slnLowerOld()

const FieldVariableValue & MooseVariableFE< Real >::slnLowerOld ( ) const

inlineinherited

Definition at line 506 of file MooseVariableFE.h.

506{ return _lower_data->sln(Moose::Old); }

◆ slnNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::slnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor solutions

Implements MooseVariableField< OutputType >.

Definition at line 410 of file MooseVariableFE.h.

  {
    return _neighbor_data->sln(Moose::Current);
  }

◆ slnOld()

const FieldVariableValue & MooseVariableFE< Real >::slnOld ( ) const

inlineoverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 289 of file MooseVariableFE.h.

289{ return _element_data->sln(Moose::Old); }

◆ slnOlder()

const FieldVariableValue & MooseVariableFE< Real >::slnOlder ( ) const

inlineoverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 290 of file MooseVariableFE.h.

290{ return _element_data->sln(Moose::Older); }

◆ slnOlderNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::slnOlderNeighbor ( ) const

inlineinherited

Definition at line 418 of file MooseVariableFE.h.

418{ return _neighbor_data->sln(Moose::Older); }

◆ slnOldNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::slnOldNeighbor ( ) const

inlineoverridevirtualinherited

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

Implements MooseVariableField< OutputType >.

Definition at line 414 of file MooseVariableFE.h.

  {
    return _neighbor_data->sln(Moose::Old);
  }

◆ slnPreviousNL()

const FieldVariableValue & MooseVariableFE< Real >::slnPreviousNL ( ) const

inlineinherited

Definition at line 291 of file MooseVariableFE.h.

291{ return _element_data->sln(Moose::PreviousNL); }

◆ slnPreviousNLNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::slnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 419 of file MooseVariableFE.h.

  {
    return _neighbor_data->sln(Moose::PreviousNL);
  }

◆ 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 Material, MaterialBase, GeneralUserObject, NodalUserObject, ThreadedGeneralUserObject, Constraint, Moose::Kokkos::AuxKernel, Moose::Kokkos::MaterialBase, and Moose::Kokkos::UserObject.

Definition at line 68 of file SetupInterface.C.

69{

70}

◆ supportsElemSideQpArg()

bool MooseVariableFE< Real >::supportsElemSideQpArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 719 of file MooseVariableFE.h.

719{ return true; }

◆ supportsFaceArg()

bool MooseVariableFE< Real >::supportsFaceArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< Moose::ADType< OutputType >::type >.

Definition at line 718 of file MooseVariableFE.h.

718{ return true; }

◆ supportsGeometricInfoBasedLoops()

bool MooseVariableFE< Real >::supportsGeometricInfoBasedLoops ( ) const

inlineoverridevirtualinherited

Whether this variable supports geometric-info-based loops, such as ElemInfo/FaceInfo loops.

Static, per-class property - never toggled by requireQpComputations().

Reimplemented from MooseVariableBase.

Definition at line 152 of file MooseVariableFE.h.

152{ return false; }

◆ supportsQpBasedLoops()

bool MooseVariableFE< Real >::supportsQpBasedLoops ( ) const

inlineoverridevirtualinherited

Whether this variable supports QP-indexed loops.

Returns true for FE variables and nonlinear FV variables. Returns false for linear FV variables by default and for scalar variables.

Reimplemented from MooseVariableBase.

Definition at line 151 of file MooseVariableFE.h.

151{ return true; }

◆ sys() [1/2]

SystemBase & MooseVariableBase::sys ( )

inlineinherited

Get the system this variable is part of.

Definition at line 70 of file MooseVariableBase.h.

70{ return _sys; }

◆ sys() [2/2]

const SystemBase & MooseVariableBase::sys ( ) const

inlineinherited

Get the system this variable is part of.

Definition at line 75 of file MooseVariableBase.h.

75{ return _sys; }

◆ timestepSetup()

template<typename OutputType >

void MooseVariableField< OutputType >::timestepSetup ( )

overridevirtualinherited

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

Reimplemented from SetupInterface.

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

Definition at line 52 of file MooseVariableField.C.

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

Referenced by MooseLinearVariableFV< OutputType >::timestepSetup(), and MooseVariableFV< OutputType >::timestepSetup().

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )

inlineinherited

Definition at line 86 of file MooseVariableBase.h.

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

MooseVariableBase::allDofIndices

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

Get all global dofindices for the variable.

Definition MooseVariableBase.C:157

◆ 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 93 of file MooseBase.h.

  {
    mooseAssert(_type.size(), "Empty type");
    return _type;
  }

◆ 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 57 of file MooseBase.C.

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

Referenced by MaterialPropertyStorage::addProperty(), FEProblemBase::checkUserObjectNameCollision(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< T >::finalize(), ReporterData::getReporterInfo(), MFEMSamplerBase::initialSetup(), MFEMVariableSamplerBase::initialSetup(), WebServerControl::outputMessage(), and Action::timedAct().

◆ uDot()

const FieldVariableValue & MooseVariableFE< Real >::uDot ( ) const

inlineinherited

element dots

Definition at line 402 of file MooseVariableFE.h.

402{ return _element_data->uDot(); }

◆ uDotDot()

const FieldVariableValue & MooseVariableFE< Real >::uDotDot ( ) const

inlineinherited

Definition at line 403 of file MooseVariableFE.h.

403{ return _element_data->uDotDot(); }

◆ uDotDotNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::uDotDotNeighbor ( ) const

inlineinherited

Definition at line 497 of file MooseVariableFE.h.

497{ return _neighbor_data->uDotDot(); }

◆ uDotDotOld()

const FieldVariableValue & MooseVariableFE< Real >::uDotDotOld ( ) const

inlineinherited

Definition at line 405 of file MooseVariableFE.h.

405{ return _element_data->uDotDotOld(); }

◆ uDotDotOldNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::uDotDotOldNeighbor ( ) const

inlineinherited

Definition at line 499 of file MooseVariableFE.h.

499{ return _neighbor_data->uDotDotOld(); }

◆ uDotNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::uDotNeighbor ( ) const

inlineinherited

neighbor dots

Definition at line 496 of file MooseVariableFE.h.

496{ return _neighbor_data->uDot(); }

◆ uDotOld()

const FieldVariableValue & MooseVariableFE< Real >::uDotOld ( ) const

inlineinherited

Definition at line 404 of file MooseVariableFE.h.

404{ return _element_data->uDotOld(); }

◆ uDotOldNeighbor()

const FieldVariableValue & MooseVariableFE< Real >::uDotOldNeighbor ( ) const

inlineinherited

Definition at line 498 of file MooseVariableFE.h.

498{ return _neighbor_data->uDotOld(); }

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 69 of file MooseBase.C.

{
  if (!_pars.have_parameter<std::string>(unique_name_param))
    mooseError("uniqueName(): Object does not have a unique name");
  return MooseObjectName(_pars.get<std::string>(unique_name_param));
}

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

◆ uniqueParameterName()

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

inherited

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

Definition at line 63 of file MooseBase.C.

{
  return MooseObjectParameterName(getBase(), name(), parameter_name);
}

◆ useDual()

bool MooseVariableBase::useDual ( ) const

inlineinherited

Get dual mortar option.

Definition at line 80 of file MooseVariableBase.h.

80{ return _use_dual; }

MooseVariableBase::_use_dual

bool _use_dual

If dual mortar approach is used.

Definition MooseVariableBase.h:263

Referenced by MortarConstraintBase::MortarConstraintBase().

◆ usesGradPhi()

bool MooseVariableFE< Real >::usesGradPhi ( ) const

inlineinherited

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 121 of file MooseVariableFE.h.

121{ return true; }

◆ usesGradPhiNeighbor()

template<typename OutputType >

bool MooseVariableField< OutputType >::usesGradPhiNeighbor ( ) const

inlineinherited

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 346 of file MooseVariableField.h.

346{ return true; }

Referenced by Assembly::copyNeighborShapes().

◆ usesPhi()

bool MooseVariableFE< Real >::usesPhi ( ) const

inlineinherited

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 115 of file MooseVariableFE.h.

115{ return true; }

◆ usesPhiNeighbor()

template<typename OutputType >

bool MooseVariableField< OutputType >::usesPhiNeighbor ( ) const

inlineinherited

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 339 of file MooseVariableField.h.

339{ return true; }

Referenced by Assembly::copyNeighborShapes().

◆ usesSecondPhi()

bool MooseVariableFE< Real >::usesSecondPhi ( ) const

inherited

Whether or not this variable is computing any second derivatives.

Definition at line 126 of file MooseVariableFE.C.

{
  return _element_data->usesSecondPhi();
}

◆ usesSecondPhiNeighbor()

bool MooseVariableFE< Real >::usesSecondPhiNeighbor ( ) const

finaloverridevirtualinherited

Whether or not this variable is actually using the shape function second derivative on a neighbor.

Implements MooseVariableField< OutputType >.

Definition at line 132 of file MooseVariableFE.C.

{
  return _neighbor_data->usesSecondPhi();
}

◆ validParams()

InputParameters MooseVariableConstMonomial::validParams ( )

static

Definition at line 21 of file MooseVariableConstMonomial.C.

{
  auto params = MooseVariableBase::validParams();
  params.addClassDescription("Specialization for constant monomials that avoids unnecessary loops");
  params.set<MooseEnum>("family") = "MONOMIAL";
  params.set<MooseEnum>("order") = "CONSTANT";
  return params;
}

◆ vectorTagDofValue()

const DofValues & MooseVariableFE< Real >::vectorTagDofValue ( TagID tag ) const

inlineoverridevirtualinherited

Implements MooseVariableField< OutputType >.

Definition at line 278 of file MooseVariableFE.h.

  {
    return _element_data->vectorTagDofValue(tag);
  }

◆ vectorTagGradient()

const FieldVariableGradient & MooseVariableFE< Real >::vectorTagGradient ( TagID tag ) const

inlineinherited

Definition at line 274 of file MooseVariableFE.h.

  {
    return _element_data->vectorTagGradient(tag);
  }

◆ vectorTagValue()

const FieldVariableValue & MooseVariableFE< Real >::vectorTagValue ( TagID tag ) const

inlineoverridevirtualinherited

tag values getters

Implements MooseVariableField< OutputType >.

Definition at line 270 of file MooseVariableFE.h.

  {
    return _element_data->vectorTagValue(tag);
  }

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.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

mutableprotectedinherited

A dummy ADReal variable.

Definition at line 409 of file MooseVariableField.h.

◆ _always_evaluate

bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::_always_evaluate

privateinherited

Boolean to check if we always need evaluation.

Definition at line 523 of file MooseFunctor.h.

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 375 of file MooseBase.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), FEProblemBase::acceptInvalidSolution(), FEProblemBase::addAnyRedistributers(), MeshGenerator::addChildMeshGenerator(), FEProblemBase::addMaterialHelper(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addOutput(), MeshGenerator::addParentMeshGenerator(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), DefaultNonlinearConvergence::checkConvergence(), MeshGenerator::checkGetMesh(), FEProblemBase::checkICRestartError(), FEProblemBase::checkProblemIntegrity(), LibmeshPartitioner::clone(), BlockWeightedPartitioner::clone(), CopyMeshPartitioner::clone(), GridPartitioner::clone(), HierarchicalGridPartitioner::clone(), PetscExternalPartitioner::clone(), RandomPartitioner::clone(), SingleRankPartitioner::clone(), ElementPointNeighborLayers::clone(), ElementSideNeighborLayers::clone(), GhostAllPointNeighbors::clone(), GhostBoundary::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), GhostPrimaryFace::clone(), ProxyRelationshipManager::clone(), RedistributeProperties::clone(), SampledOutput::cloneMesh(), FEProblemBase::computeJacobianSys(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualSys(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), Control::Control(), CopyMeshPartitioner::CopyMeshPartitioner(), MultiApp::createApp(), MultiApp::createApps(), FEProblemBase::customSetup(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), MooseMesh::determineUseDistributedMesh(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), PIDTransientControl::execute(), Eigenvalue::execute(), InversePowerMethod::execute(), NonlinearEigen::execute(), SteadyBase::execute(), TransientBase::execute(), MFEMSteady::execute(), PseudoTimestep::execute(), IterationInfo::execute(), EigenProblem::execute(), Executioner::Executioner(), Executioner::Executioner(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), NEML2Assembly::finalize(), ChangeOverFixedPointPostprocessor::finalize(), RadialAverage::finalize(), FixedPointSolve::FixedPointSolve(), FEProblemBase::forceOutput(), FullSolveMultiApp::FullSolveMultiApp(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVAdvection::FVAdvection(), FileMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), MeshGenerator::getCSGBaseByName(), FEProblemBase::getExecutor(), MeshGenerator::getMeshByName(), NumFixedPointIterations::getValue(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), Eigenvalue::init(), InversePowerMethod::init(), NonlinearEigen::init(), TransientBase::init(), MFEMMesh::init(), FEProblemBase::init(), CompositionDT::init(), SubProblem::initialSetup(), PIDTransientControl::initialSetup(), RealFunctionControl::initialSetup(), TimePeriod::initialSetup(), EigenProblemSolve::initialSetup(), FEProblemSolve::initialSetup(), Console::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), EigenProblem::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), FEProblemBase::meshChanged(), MeshGenerator::MeshGenerator(), MFEMProblemSolve::MFEMProblemSolve(), MooseMesh::MooseMesh(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), EigenExecutionerBase::normalizeSolution(), NumFailedTimeSteps::NumFailedTimeSteps(), Checkpoint::output(), Exodus::output(), Nemesis::output(), PerfGraphOutput::output(), Tecplot::output(), MortarNodalGeometryOutput::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), JSONOutput::outputReporters(), Output::outputStep(), SampledOutput::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), JSONOutput::outputSystemInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), MultiApp::parentOutputPositionChanged(), TransientBase::preExecute(), FEProblemBase::projectSolution(), AnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), FileMesh::safeClone(), GeneratedMesh::safeClone(), ImageMesh::safeClone(), MeshGeneratorMesh::safeClone(), PatternedMesh::safeClone(), RinglebMesh::safeClone(), SpiralAnnularMesh::safeClone(), StitchedMesh::safeClone(), TiledMesh::safeClone(), MFEMMesh::safeClone(), MultiApp::setAppOutputFileBase(), FileOutput::setFileBaseInternal(), MeshGenerator::setMeshProperty(), MeshGenerator::setMeshPropertyHelper(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), Output::setWallTimeIntervalFromCommandLineParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), SolutionInvalidityReporter::SolutionInvalidityReporter(), FixedPointSolve::solve(), FEProblemBase::solve(), EigenProblem::solve(), FEProblemBase::solveLinearSystem(), PetscOutput::solveSetup(), FixedPointSolve::solveStep(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), SubProblem::timestepSetup(), PIDTransientControl::timestepSetup(), FEProblemBase::timestepSetup(), TransientBase::TransientBase(), MooseMesh::update(), NEML2FEInterpolation::updateDofMap(), NEML2FEInterpolation::updateGradPhi(), NEML2FEInterpolation::updateInterpolations(), FEProblemBase::updateMortarMesh(), NEML2FEInterpolation::updatePhi(), Console::write(), and FEProblemBase::~FEProblemBase().

◆ _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 269 of file MooseVariableBase.h.

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

◆ _assembly

Assembly& MooseVariableBase::_assembly

protectedinherited

Assembly data.

Definition at line 242 of file MooseVariableBase.h.

Referenced by MooseVariableFE< OutputType >::MooseVariableFE().

◆ _blk_dim

unsigned int BlockRestrictable::_blk_dim

privateinherited

Largest mesh dimension of the elements in the blocks for this object.

Definition at line 336 of file BlockRestrictable.h.

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

◆ _blk_dual_restrictable

const bool BlockRestrictable::_blk_dual_restrictable

privateinherited

Flag for allowing dual restriction.

Definition at line 315 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blk_feproblem

FEProblemBase* BlockRestrictable::_blk_feproblem

privateinherited

Pointer to FEProblemBase.

Definition at line 318 of file BlockRestrictable.h.

Referenced by BlockRestrictable::getBlockCoordSystem(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and BlockRestrictable::initializeBlockRestrictable().

◆ _blk_ids

std::set<SubdomainID> BlockRestrictable::_blk_ids

privateinherited

Set of block ids supplied by the user via the input file (for error checking)

Definition at line 306 of file BlockRestrictable.h.

Referenced by BlockRestrictable::blockIDs(), BlockRestrictable::blockRestricted(), BlockRestrictable::checkVariable(), BlockRestrictable::hasBlocks(), BlockRestrictable::hasBlocks(), BlockRestrictable::initializeBlockRestrictable(), BlockRestrictable::isBlockSubset(), and BlockRestrictable::numBlocks().

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 232 of file BlockRestrictable.h.

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

◆ _blk_mesh

const MooseMesh* BlockRestrictable::_blk_mesh

privateinherited

Pointer to Mesh.

Definition at line 321 of file BlockRestrictable.h.

Referenced by BlockRestrictable::blockIDs(), BlockRestrictable::checkVariable(), BlockRestrictable::getBlockCoordSystem(), BlockRestrictable::hasBlocks(), BlockRestrictable::hasBlocks(), BlockRestrictable::hasBlocks(), BlockRestrictable::initializeBlockRestrictable(), BlockRestrictable::isBlockSubset(), and BlockRestrictable::meshBlockIDs().

◆ _blk_name

const std::string& BlockRestrictable::_blk_name

privateinherited

Name of the object.

Definition at line 333 of file BlockRestrictable.h.

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

◆ _blk_tid

THREAD_ID BlockRestrictable::_blk_tid

privateinherited

Thread id for this object.

Definition at line 330 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blocks

std::vector<SubdomainName> BlockRestrictable::_blocks

privateinherited

Vector the block names supplied by the user via the input file.

Definition at line 312 of file BlockRestrictable.h.

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

◆ _boundary_ids

const std::set<BoundaryID>& BlockRestrictable::_boundary_ids

privateinherited

Reference to the boundary_ids, defaults to an empty set if not provided.

Definition at line 327 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _clearance_schedule

std::set<ExecFlagType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_clearance_schedule

privateinherited

How often to clear the material property cache.

Definition at line 520 of file MooseFunctor.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _count

const unsigned int MooseVariableBase::_count

protectedinherited

Number of variables in the array.

Definition at line 257 of file MooseVariableBase.h.

Referenced by MooseVariableFieldBase::componentName(), MooseVariableBase::count(), MooseVariableBase::MooseVariableBase(), and MooseVariableBase::scalingFactor().

◆ _current_elem_qp_functor_dot

std::vector<DotType> MooseVariableFE< Real >::_current_elem_qp_functor_dot

mutableprivateinherited

The values of the time derivative for the _current_elem_qp_functor_elem.

Definition at line 816 of file MooseVariableFE.h.

◆ _current_elem_qp_functor_elem

const Elem* MooseVariableFE< Real >::_current_elem_qp_functor_elem

mutableprivateinherited

Keep track of the current elem-qp functor element in order to enable local caching (e.g.

if we call evaluate on the same element, but just with a different quadrature point, we can return previously computed results indexed at the different qp

Definition at line 807 of file MooseVariableFE.h.

◆ _current_elem_qp_functor_grad_dot

std::vector<GradientType> MooseVariableFE< Real >::_current_elem_qp_functor_grad_dot

mutableprivateinherited

The values of the gradient of the time derivative for the _current_elem_qp_functor_elem.

Definition at line 819 of file MooseVariableFE.h.

◆ _current_elem_qp_functor_gradient

std::vector<GradientType> MooseVariableFE< Real >::_current_elem_qp_functor_gradient

mutableprivateinherited

The values of the gradient for the _current_elem_qp_functor_elem.

Definition at line 813 of file MooseVariableFE.h.

◆ _current_elem_qp_functor_sln

std::vector<ValueType> MooseVariableFE< Real >::_current_elem_qp_functor_sln

mutableprivateinherited

The values of the solution for the _current_elem_qp_functor_elem.

Definition at line 810 of file MooseVariableFE.h.

◆ _current_elem_side_qp_functor_dot

std::vector<DotType> MooseVariableFE< Real >::_current_elem_side_qp_functor_dot

mutableprivateinherited

The values of the time derivative for the _current_elem_side_qp_functor_elem_side.

Definition at line 834 of file MooseVariableFE.h.

◆ _current_elem_side_qp_functor_elem_side

std::pair<const Elem *, unsigned int> MooseVariableFE< Real >::_current_elem_side_qp_functor_elem_side

mutableprivateinherited

Keep track of the current elem-side-qp functor element and side in order to enable local caching (e.g.

if we call evaluate with the same element and side, but just with a different quadrature point, we can return previously computed results indexed at the different qp

Definition at line 824 of file MooseVariableFE.h.

824 {

825 nullptr, libMesh::invalid_uint};

◆ _current_elem_side_qp_functor_grad_dot

std::vector<GradientType> MooseVariableFE< Real >::_current_elem_side_qp_functor_grad_dot

mutableprivateinherited

The values of the gradient of the time derivative for the _current_elem_side_qp_functor_elem_side.

Definition at line 838 of file MooseVariableFE.h.

◆ _current_elem_side_qp_functor_gradient

std::vector<GradientType> MooseVariableFE< Real >::_current_elem_side_qp_functor_gradient

mutableprivateinherited

The values of the gradient for the _current_elem_side_qp_functor_elem_side.

Definition at line 831 of file MooseVariableFE.h.

◆ _current_elem_side_qp_functor_sln

std::vector<ValueType> MooseVariableFE< Real >::_current_elem_side_qp_functor_sln

mutableprivateinherited

The values of the solution for the _current_elem_side_qp_functor_elem_side.

Definition at line 828 of file MooseVariableFE.h.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 86 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _current_qp_map_key

dof_id_type Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_qp_map_key

mutableprivateinherited

Current key for qp map cache.

Definition at line 529 of file MooseFunctor.h.

◆ _current_qp_map_value

std::vector<std::pair<bool, ValueType> >* Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_qp_map_value

mutableprivateinherited

Current value for qp map cache.

Definition at line 532 of file MooseFunctor.h.

◆ _current_side_qp_map_key

dof_id_type Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_side_qp_map_key

mutableprivateinherited

Current key for side-qp map cache.

Definition at line 545 of file MooseFunctor.h.

◆ _current_side_qp_map_value

std::vector<std::vector<std::pair<bool, ValueType> > >* Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_side_qp_map_value

mutableprivateinherited

Current value for side-qp map cache.

Definition at line 548 of file MooseFunctor.h.

◆ _dof_indices

std::vector<dof_id_type> MooseVariableBase::_dof_indices

protectedinherited

DOF indices.

Definition at line 248 of file MooseVariableBase.h.

Referenced by MooseVariableBase::clearAllDofIndices(), MooseVariableScalar::computeAD(), MooseVariableBase::dofIndices(), MooseVariableScalar::evaluate(), MooseVariableScalar::insert(), MooseVariableBase::numberOfDofs(), MooseVariableScalar::reinit(), MooseVariableScalar::setValue(), and MooseVariableScalar::setValues().

◆ _dof_map

const libMesh::DofMap& MooseVariableBase::_dof_map

protectedinherited

DOF map.

Definition at line 245 of file MooseVariableBase.h.

Referenced by MooseVariableBase::dofMap(), MooseVariableScalar::insert(), and MooseVariableScalar::reinit().

◆ _elem_arg_to_value

std::map<ElemArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_elem_arg_to_value

mutableprivateinherited

Map from element arguments to their cached evaluations.

Definition at line 561 of file MooseFunctor.h.

◆ _element_data

std::unique_ptr<MooseVariableData<Real > > MooseVariableFE< Real >::_element_data

protectedinherited

Holder for all the data associated with the "main" element.

Definition at line 725 of file MooseVariableFE.h.

◆ _empty_boundary_ids

const std::set<BoundaryID> BlockRestrictable::_empty_boundary_ids

privateinherited

An empty set for referencing when boundary_ids is not included.

Definition at line 324 of file BlockRestrictable.h.

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum

privateinherited

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

This is private because others should not be messing with it.

Definition at line 79 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 83 of file SetupInterface.h.

◆ _face_arg_to_value

std::map<FaceArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_face_arg_to_value

mutableprivateinherited

Map from face arguments to their cached evaluations.

Definition at line 564 of file MooseFunctor.h.

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

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

◆ _fe_type

libMesh::FEType MooseVariableBase::_fe_type

protectedinherited

The FEType associated with this variable.

Definition at line 221 of file MooseVariableBase.h.

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

◆ _functor_name

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

privateinherited

name of the functor

Definition at line 570 of file MooseFunctor.h.

◆ _index

unsigned int MooseVariableBase::_index

protectedinherited

variable number within MOOSE

Definition at line 227 of file MooseVariableBase.h.

◆ _is_eigen

bool MooseVariableBase::_is_eigen

protectedinherited

Whether or not this variable operates on eigen kernels.

Definition at line 230 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen(), and MooseVariableBase::eigen().

◆ _is_lower_d

bool MooseVariableBase::_is_lower_d

protectedinherited

Whether this variable lives on lower dimensional blocks.

Definition at line 266 of file MooseVariableBase.h.

◆ _kokkos_element_ids

Moose::Kokkos::Array<ContiguousElementID> BlockRestrictable::_kokkos_element_ids

privateinherited

List of contiguous element IDs this Kokkos object is operating on.

Definition at line 345 of file BlockRestrictable.h.

Referenced by BlockRestrictable::kokkosBlockElementID(), and BlockRestrictable::numKokkosBlockElements().

◆ _kokkos_element_side_ids

Moose::Kokkos::Array<Moose::Kokkos::Pair<ContiguousElementID, unsigned int> > BlockRestrictable::_kokkos_element_side_ids

privateinherited

List of contiguous local element ID - side index pairs this Kokkos object is operating on.

Definition at line 354 of file BlockRestrictable.h.

Referenced by BlockRestrictable::kokkosBlockElementSideID(), and BlockRestrictable::numKokkosBlockSides().

◆ _kokkos_node_ids

Moose::Kokkos::Array<ContiguousNodeID> BlockRestrictable::_kokkos_node_ids

privateinherited

List of contiguous node IDs this Kokkos object is operating on.

Definition at line 349 of file BlockRestrictable.h.

Referenced by BlockRestrictable::kokkosBlockNodeID(), and BlockRestrictable::numKokkosBlockNodes().

◆ _lower_data

std::unique_ptr<MooseVariableData<Real > > MooseVariableFE< Real >::_lower_data

protectedinherited

Holder for all the data associated with the lower dimeensional element.

Definition at line 731 of file MooseVariableFE.h.

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& MooseVariableBase::_mesh

protectedinherited

mesh the variable is active in

Definition at line 251 of file MooseVariableBase.h.

Referenced by MooseLinearVariableFV< OutputType >::evaluate(), MooseLinearVariableFV< OutputType >::evaluate(), MooseLinearVariableFV< OutputType >::evaluate(), MooseLinearVariableFV< OutputType >::evaluateGradient(), and MooseLinearVariableFV< OutputType >::evaluateGradient().

◆ _moose_object

const MooseObject* BlockRestrictable::_moose_object

privateinherited

Pointer to the MOOSE object.

Definition at line 339 of file BlockRestrictable.h.

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

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 381 of file MooseBase.h.

◆ _neighbor_data

std::unique_ptr<MooseVariableData<Real > > MooseVariableFE< Real >::_neighbor_data

protectedinherited

Holder for all the data associated with the neighbor element.

Definition at line 728 of file MooseVariableFE.h.

◆ _node_arg_to_value

std::map<NodeArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_node_arg_to_value

mutableprivateinherited

Map from nodal arguments to their cached evaluations.

Definition at line 567 of file MooseFunctor.h.

◆ _oi_moose_app

MooseApp& OutputInterface::_oi_moose_app

privateinherited

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

Definition at line 72 of file OutputInterface.h.

◆ _oi_output_warehouse

OutputWarehouse& OutputInterface::_oi_output_warehouse

privateinherited

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

Definition at line 75 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList().

◆ _oi_outputs

std::set<OutputName> OutputInterface::_oi_outputs

privateinherited

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

Definition at line 78 of file OutputInterface.h.

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

◆ _parent

const ParallelParamObject& DataFileInterface::_parent

privateinherited

Definition at line 58 of file DataFileInterface.h.

Referenced by DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), and DataFileInterface::getDataFilePath().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 384 of file MooseBase.h.

Referenced by AddAuxKernelAction::act(), AddFVICAction::act(), AddICAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MultiSystemSolveObject::MultiSystemSolveObject(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseBase::queryParam(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _qp_to_value

std::unordered_map<dof_id_type, std::vector<std::pair<bool, ValueType> > > Moose::FunctorBase< Moose::ADType< OutputType >::type >::_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values should have size corresponding to the number of quadrature points on the element. The vector elements are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 539 of file MooseFunctor.h.

◆ _scaling_factor

std::vector<Real> MooseVariableBase::_scaling_factor

protectedinherited

scaling factor for this variable

Definition at line 260 of file MooseVariableBase.h.

Referenced by MooseVariableBase::arrayScalingFactor(), MooseVariableBase::initialSetup(), MooseVariableBase::scalingFactor(), and MooseVariableBase::scalingFactor().

◆ _si_moose_base

const MooseBase& SolutionInvalidInterface::_si_moose_base

privateinherited

The MooseBase that owns this interface.

Definition at line 111 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal(), SolutionInvalidInterface::mooseDeprecated(), SolutionInvalidInterface::mooseWarning(), SolutionInvalidInterface::mooseWarningNonPrefixed(), SolutionInvalidInterface::paramWarning(), and SolutionInvalidInterface::registerInvalidSolutionInternal().

◆ _si_problem

const FEProblemBase* SolutionInvalidInterface::_si_problem

privateinherited

A pointer to FEProblem base.

Definition at line 114 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal().

◆ _side_qp_to_value

std::unordered_map<dof_id_type, std::vector<std::vector<std::pair<bool, ValueType> > > > Moose::FunctorBase< Moose::ADType< OutputType >::type >::_side_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values are a multi-dimensional vector (or vector of vectors) with the first index corresponding to the side and the second index corresponding to the quadrature point index. The elements returned after double indexing are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 558 of file MooseFunctor.h.

◆ _subproblem

SubProblem& MooseVariableBase::_subproblem

protectedinherited

Problem this variable is part of.

Definition at line 236 of file MooseVariableBase.h.

Referenced by MooseVariableScalar::computeAD(), MooseVariableScalar::evaluate(), and MooseVariableBase::initialSetup().

◆ _sys

SystemBase& MooseVariableBase::_sys

protectedinherited

◆ _tid

THREAD_ID MooseVariableBase::_tid

protectedinherited

Thread ID.

Definition at line 254 of file MooseVariableBase.h.

Referenced by MooseVariableFE< OutputType >::MooseVariableFE(), and MooseVariableScalar::reinit().

◆ _time_integrator

template<typename OutputType >

const TimeIntegrator* const MooseVariableField< OutputType >::_time_integrator

protectedinherited

the time integrator used for computing time derivatives

Definition at line 406 of file MooseVariableField.h.

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 378 of file MooseBase.h.

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

◆ _use_dual

bool MooseVariableBase::_use_dual

protectedinherited

If dual mortar approach is used.

Definition at line 263 of file MooseVariableBase.h.

Referenced by MooseVariableBase::useDual().

◆ _var_kind

Moose::VarKindType MooseVariableBase::_var_kind

protectedinherited

Variable type (see MooseTypes.h)

Definition at line 233 of file MooseVariableBase.h.

Referenced by MooseVariableBase::initialSetup(), and MooseVariableBase::kind().

◆ _var_num

unsigned int MooseVariableBase::_var_num

protectedinherited

variable number (from libMesh)

Definition at line 224 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 239 of file MooseVariableBase.h.

◆ _vec_ids

std::vector<SubdomainID> BlockRestrictable::_vec_ids

privateinherited

Vector of block ids supplied by the user via the input file (for error reporting)

Definition at line 309 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), ActionFactory::getValidParams(), Factory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"

staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), ActionUnitTest::buildMinimalObjects(), MooseObjectUnitTest::buildObjects(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

MooseObject::usingCombinedWarningSolutionWarnings

inherited

Definition at line 67 of file MooseObject.h.

◆ usingMooseVariableFieldMembers

MooseVariableFE< Real >::usingMooseVariableFieldMembers

protectedinherited

Definition at line 722 of file MooseVariableFE.h.

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

include/variables/MooseVariableConstMonomial.h
src/variables/MooseVariableConstMonomial.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ADDofValue

◆ ADDofValues

◆ DataFileParameterType

◆ DofValue

◆ DofValues

◆ DotType

◆ ElemArg

◆ ElemPointArg

◆ ElemQpArg

◆ ElemSideQpArg

◆ FaceArg

◆ FieldVariableCurl

◆ FieldVariableDivergence

◆ FieldVariableGradient

◆ FieldVariablePhiCurl

◆ FieldVariablePhiDivergence

◆ FieldVariablePhiGradient

◆ FieldVariablePhiSecond

◆ FieldVariablePhiValue

◆ FieldVariableSecond

◆ FieldVariableTestCurl

◆ FieldVariableTestDivergence

◆ FieldVariableTestGradient

◆ FieldVariableTestSecond

◆ FieldVariableTestValue

◆ FieldVariableValue

◆ FunctorArg

◆ FunctorType

◆ GradientType

◆ NodeArg

◆ OutputDivergence

◆ OutputGradient

◆ OutputSecond

◆ OutputShape

◆ OutputShapeDivergence

◆ OutputShapeGradient

◆ OutputShapeSecond

◆ StateArg

◆ ValueType

Constructor & Destructor Documentation

◆ MooseVariableConstMonomial()

Member Function Documentation

◆ activeOnSubdomain()

◆ activeOnSubdomains()

◆ activeSubdomains()

◆ adCurlSln()

◆ adCurlSlnNeighbor()

◆ add()

◆ adDofValues()

◆ adDofValuesDot()

◆ adDofValuesNeighbor()

◆ addSolution()

◆ addSolutionNeighbor()

◆ adGradPhi()

◆ adGradPhiFace()

◆ adGradPhiFaceNeighbor()

◆ adGradSln()

◆ adGradSlnDot()

◆ adGradSlnNeighbor()

◆ adGradSlnNeighborDot()

◆ adNodalValue()

◆ adSecondSln()

◆ adSecondSlnNeighbor()

◆ adSln()

◆ adSlnLower()

◆ adSlnNeighbor()

◆ adUDot()