This class provides variable solution interface for linear finite volume problems. More...

#include <FVUtils.h>

Inheritance diagram for MooseLinearVariableFV< OutputType >:

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

using	OutputSecond = typename MooseVariableField< OutputType >::OutputSecond

using	OutputDivergence = typename MooseVariableField< OutputType >::OutputDivergence

using	FieldVariableValue = typename MooseVariableField< OutputType >::FieldVariableValue

using	FieldVariableGradient = typename MooseVariableField< OutputType >::FieldVariableGradient

using	FieldVariableSecond = typename MooseVariableField< OutputType >::FieldVariableSecond

using	FieldVariableCurl = typename MooseVariableField< OutputType >::FieldVariableCurl

using	FieldVariableDivergence = typename MooseVariableField< OutputType >::FieldVariableDivergence

using	OutputShape = typename MooseVariableField< OutputType >::OutputShape

using	OutputShapeGradient = typename MooseVariableField< OutputType >::OutputShapeGradient

using	OutputShapeSecond = typename MooseVariableField< OutputType >::OutputShapeSecond

using	OutputShapeDivergence = typename MooseVariableField< OutputType >::OutputShapeDivergence

using	OutputData = typename MooseVariableField< OutputType >::OutputData

using	DoFValue = typename MooseVariableField< OutputType >::DoFValue

using	FieldVariablePhiValue = typename MooseVariableField< OutputType >::FieldVariablePhiValue

using	FieldVariablePhiGradient = typename MooseVariableField< OutputType >::FieldVariablePhiGradient

using	FieldVariablePhiSecond = typename MooseVariableField< OutputType >::FieldVariablePhiSecond

using	FieldVariablePhiDivergence = typename MooseVariableField< OutputType >::FieldVariablePhiDivergence

using	ElemQpArg = Moose::ElemQpArg

using	ElemSideQpArg = Moose::ElemSideQpArg

using	ElemArg = Moose::ElemArg

using	FaceArg = Moose::FaceArg

using	StateArg = Moose::StateArg

using	NodeArg = Moose::NodeArg

using	ElemPointArg = Moose::ElemPointArg

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

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

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

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

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

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

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

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

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

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

using	DotType = ValueType

Public Member Functions
	MooseLinearVariableFV (const InputParameters &parameters)

virtual bool	isFV () const override

virtual bool	isDirichletBoundaryFace (const FaceInfo &fi) const
	If the variable has a dirichlet boundary condition at face described by `fi` . More...

void	computeCellGradients ()
	Switch to request cell gradient computations. More...

virtual bool	needsGradientVectorStorage () const override
	Check if cell gradient computations were requested for this variable. More...

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

const VectorValue< Real >	gradSln (const ElemInfo &elem_info) const
	Get the variable gradient at a cell center. More...

VectorValue< Real >	gradSln (const FaceInfo &fi, const StateArg &state) const
	Compute interpolated gradient on the provided face. More...

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

Real	getElemValue (const ElemInfo &elem_info, const StateArg &state) const
	Get the solution value for the provided element and seed the derivative for the corresponding dof index. More...

LinearFVBoundaryCondition *	getBoundaryCondition (const BoundaryID bd_id) const
	Get the boundary condition object which corresponds to the given boundary ID. More...

const std::unordered_map< BoundaryID, LinearFVBoundaryCondition * > &	getBoundaryConditionMap ()

virtual void	prepareIC () override
	Prepare the initial condition. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual unsigned int	numberOfDofsNeighbor () override final

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

virtual void	clearAllDofIndices () override final

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

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

virtual void	residualSetup () override

virtual void	jacobianSetup () override

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

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

virtual const DoFValue &	nodalVectorTagValue (TagID) const override

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

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

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

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

virtual void	prepareAux () override final

virtual void	reinitNode () override final

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

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

virtual void	reinitAux () override final

virtual void	reinitAuxNeighbor () override final

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const MooseArray< OutputType > &	nodalValueOldArray () const override

virtual const MooseArray< OutputType > &	nodalValueOlderArray () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const DoFValue &	vectorTagDofValue (TagID tag) const override

virtual const DoFValue &	nodalMatrixTagValue (TagID tag) const override

virtual const FieldVariableValue &	matrixTagValue (TagID tag) const override

virtual const FieldVariableValue &	sln () const override

virtual const FieldVariableValue &	slnOld () const override

virtual const FieldVariableValue &	slnOlder () const override

virtual const FieldVariableGradient &	gradSln () const override
	element gradients More...

virtual const FieldVariableGradient &	gradSlnOld () const override

virtual const FieldVariableValue &	slnNeighbor () const override

virtual const FieldVariableValue &	slnOldNeighbor () const override

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

virtual const FieldVariableGradient &	gradSlnOldNeighbor () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const DoFValue &	dofValuesOld () const override

virtual const DoFValue &	dofValuesOlder () const override

virtual const DoFValue &	dofValuesPreviousNL () const override

virtual const DoFValue &	dofValuesNeighbor () const override

virtual const DoFValue &	dofValuesOldNeighbor () const override

virtual const DoFValue &	dofValuesOlderNeighbor () const override

virtual const DoFValue &	dofValuesPreviousNLNeighbor () const override

virtual const DoFValue &	dofValuesDot () const override

virtual const DoFValue &	dofValuesDotNeighbor () const override

virtual const DoFValue &	dofValuesDotOld () const override

virtual const DoFValue &	dofValuesDotOldNeighbor () const override

virtual const DoFValue &	dofValuesDotDot () const override

virtual const DoFValue &	dofValuesDotDotNeighbor () const override

virtual const DoFValue &	dofValuesDotDotOld () const override

virtual const DoFValue &	dofValuesDotDotOldNeighbor () const override

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

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

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

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

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

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

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

virtual const dof_id_type &	nodalDofIndex () const override final

virtual const dof_id_type &	nodalDofIndexNeighbor () const override final

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

unsigned int	totalVarDofs ()

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

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

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

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

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

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

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

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

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

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

bool	isLowerD () const

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

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

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

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

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

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

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

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

MooseObjectName	uniqueName () const

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

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

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

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

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

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	customSetup (const ExecFlagType &exec_type) override

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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


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

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

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

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

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

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


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

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

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

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

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

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


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

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

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

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

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

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

Static Public Member Functions
static InputParameters	validParams ()

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

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

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

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

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

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

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

Protected Member Functions
void	timeIntegratorError () const
	Throw an error when somebody requests time-related data from this variable. More...

void	lowerDError () const
	Throw and error when somebody requests lower-dimensional data from this variable. More...

void	nodalError () const
	Throw an error when somebody wants to use this variable as a nodal variable. More...

void	adError () const
	Throw an error when somebody wants to use this variable with automatic differentiation. More...

void	cacheBoundaryBCMap ()
	Setup the boundary to Dirichlet BC map. More...

bool	doDerivatives () const

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

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

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

Functor evaluation routines
These methods are all for evaluating functors with different kinds of spatial arguments. Each of these methods also takes a state argument. For a description of the state argument, please see the `StateArg` doxygen
virtual GradientType	evaluateGradient (const ElemSideQpArg &, const StateArg &) const

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
	usingMooseVariableBaseMembers

bool	_needs_cell_gradients
	Boolean to check if this variable needs gradient computations. More...

RealVectorValue	_cell_gradient
	Temporary storage for the cell gradient to avoid unnecessary allocations. More...

const std::vector< std::unique_ptr< libMesh::NumericVector< libMesh::Number > > > &	_grad_container
	Pointer to the cell gradients which are stored on the linear system. More...

std::unique_ptr< MooseVariableDataLinearFV< OutputType > >	_element_data
	Holder for all the data associated with the "main" element. More...

std::unique_ptr< MooseVariableDataLinearFV< OutputType > >	_neighbor_data
	Holder for all the data associated with the "neighbor" element. More...

std::unordered_map< BoundaryID, LinearFVBoundaryCondition * >	_boundary_id_to_bc
	Map for easily accessing the boundary conditions based on the boundary IDs. More...

const unsigned int	_sys_num
	Cache the number of the system this variable belongs to. More...

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

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

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

unsigned int	_index
	variable number within MOOSE More...

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

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

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

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

Assembly &	_assembly
	Assembly data. More...

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

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

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

THREAD_ID	_tid
	Thread ID. More...

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

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

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

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

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

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

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

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

ActionFactory &	_action_factory
	Builds Actions. More...

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

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

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

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

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

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

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

Private Member Functions
virtual ValueType	evaluate (const ElemArg &elem, const StateArg &) const override final
	Evaluate the functor with a given element. More...

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

virtual ValueType	evaluate (const NodeArg &node, const StateArg &) const override final

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

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

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

virtual GradientType	evaluateGradient (const ElemQpArg &qp_arg, const StateArg &) const override final

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

virtual GradientType	evaluateGradient (const FaceArg &face, const StateArg &) const override final

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

Private Attributes
const libMesh::NumericVector< libMesh::Number > *const &	_solution
	The current (ghosted) solution. More...

const FieldVariablePhiValue &	_phi
	Shape functions, only used when we are postprocessing or using this variable in an auxiliary system. More...

const FieldVariablePhiGradient &	_grad_phi

const FieldVariablePhiValue &	_phi_face

const FieldVariablePhiGradient &	_grad_phi_face

const FieldVariablePhiValue &	_phi_face_neighbor

const FieldVariablePhiGradient &	_grad_phi_face_neighbor

const FieldVariablePhiValue &	_phi_neighbor

const FieldVariablePhiGradient &	_grad_phi_neighbor

Friends
void	Moose::initDofIndices (MooseLinearVariableFV< OutputType > &, const Elem &)

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

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

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

virtual void	timestepSetup () override

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

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

Detailed Description

template<typename OutputType>
class MooseLinearVariableFV< OutputType >

This class provides variable solution interface for linear finite volume problems.

This class is designed to store gradient information when enabled.

Definition at line 24 of file FVUtils.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

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

Definition at line 27 of file DataFileInterface.h.

◆ DoFValue

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::DoFValue = typename MooseVariableField<OutputType>::DoFValue

Definition at line 62 of file MooseLinearVariableFV.h.

◆ DotType

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

inherited

Definition at line 150 of file MooseFunctor.h.

◆ ElemArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::ElemArg = Moose::ElemArg

Definition at line 72 of file MooseLinearVariableFV.h.

◆ ElemPointArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::ElemPointArg = Moose::ElemPointArg

Definition at line 76 of file MooseLinearVariableFV.h.

◆ ElemQpArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::ElemQpArg = Moose::ElemQpArg

Definition at line 70 of file MooseLinearVariableFV.h.

◆ ElemSideQpArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::ElemSideQpArg = Moose::ElemSideQpArg

Definition at line 71 of file MooseLinearVariableFV.h.

◆ FaceArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FaceArg = Moose::FaceArg

Definition at line 73 of file MooseLinearVariableFV.h.

◆ FieldVariableCurl

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariableCurl = typename MooseVariableField<OutputType>::FieldVariableCurl

Definition at line 53 of file MooseLinearVariableFV.h.

◆ FieldVariableDivergence

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariableDivergence = typename MooseVariableField<OutputType>::FieldVariableDivergence

Definition at line 54 of file MooseLinearVariableFV.h.

◆ FieldVariableGradient

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariableGradient = typename MooseVariableField<OutputType>::FieldVariableGradient

Definition at line 51 of file MooseLinearVariableFV.h.

◆ FieldVariablePhiCurl

template<typename OutputType>

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

inherited

Definition at line 69 of file MooseVariableField.h.

◆ FieldVariablePhiDivergence

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariablePhiDivergence = typename MooseVariableField<OutputType>::FieldVariablePhiDivergence

Definition at line 69 of file MooseLinearVariableFV.h.

◆ FieldVariablePhiGradient

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariablePhiGradient = typename MooseVariableField<OutputType>::FieldVariablePhiGradient

Definition at line 66 of file MooseLinearVariableFV.h.

◆ FieldVariablePhiSecond

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariablePhiSecond = typename MooseVariableField<OutputType>::FieldVariablePhiSecond

Definition at line 67 of file MooseLinearVariableFV.h.

◆ FieldVariablePhiValue

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariablePhiValue = typename MooseVariableField<OutputType>::FieldVariablePhiValue

Definition at line 64 of file MooseLinearVariableFV.h.

◆ FieldVariableSecond

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariableSecond = typename MooseVariableField<OutputType>::FieldVariableSecond

Definition at line 52 of file MooseLinearVariableFV.h.

◆ FieldVariableTestCurl

template<typename OutputType>

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

inherited

Definition at line 77 of file MooseVariableField.h.

◆ FieldVariableTestDivergence

template<typename OutputType>

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

inherited

Definition at line 78 of file MooseVariableField.h.

◆ FieldVariableTestGradient

template<typename OutputType>

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

inherited

Definition at line 75 of file MooseVariableField.h.

◆ FieldVariableTestSecond

template<typename OutputType>

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

inherited

Definition at line 76 of file MooseVariableField.h.

◆ FieldVariableTestValue

template<typename OutputType>

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

inherited

Definition at line 74 of file MooseVariableField.h.

◆ FieldVariableValue

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::FieldVariableValue = typename MooseVariableField<OutputType>::FieldVariableValue

Definition at line 50 of file MooseLinearVariableFV.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

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::NodeArg = Moose::NodeArg

Definition at line 75 of file MooseLinearVariableFV.h.

◆ OutputData

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputData = typename MooseVariableField<OutputType>::OutputData

Definition at line 61 of file MooseLinearVariableFV.h.

◆ OutputDivergence

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputDivergence = typename MooseVariableField<OutputType>::OutputDivergence

Definition at line 48 of file MooseLinearVariableFV.h.

◆ OutputGradient

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputGradient = typename MooseVariableField<OutputType>::OutputGradient

Definition at line 46 of file MooseLinearVariableFV.h.

◆ OutputSecond

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputSecond = typename MooseVariableField<OutputType>::OutputSecond

Definition at line 47 of file MooseLinearVariableFV.h.

◆ OutputShape

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputShape = typename MooseVariableField<OutputType>::OutputShape

Definition at line 56 of file MooseLinearVariableFV.h.

◆ OutputShapeDivergence

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputShapeDivergence = typename MooseVariableField<OutputType>::OutputShapeDivergence

Definition at line 59 of file MooseLinearVariableFV.h.

◆ OutputShapeGradient

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputShapeGradient = typename MooseVariableField<OutputType>::OutputShapeGradient

Definition at line 57 of file MooseLinearVariableFV.h.

◆ OutputShapeSecond

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::OutputShapeSecond = typename MooseVariableField<OutputType>::OutputShapeSecond

Definition at line 58 of file MooseLinearVariableFV.h.

◆ StateArg

template<typename OutputType>

using MooseLinearVariableFV< OutputType >::StateArg = Moose::StateArg

Definition at line 74 of file MooseLinearVariableFV.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

◆ MooseLinearVariableFV()

template<typename OutputType >

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

Definition at line 48 of file MooseLinearVariableFV.C.

   : MooseVariableField<OutputType>(parameters),
     _needs_cell_gradients(false),
     _grad_container(this->_sys.gradientContainer()),
     _sys_num(this->_sys.number()),
     _solution(this->_sys.currentSolution()),
     // The following members are needed to be able to interface with the postprocessor and
     // auxiliary systems
     _phi(this->_assembly.template fePhi<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _grad_phi(this->_assembly.template feGradPhi<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _phi_face(this->_assembly.template fePhiFace<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _grad_phi_face(this->_assembly.template feGradPhiFace<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _phi_face_neighbor(
         this->_assembly.template fePhiFaceNeighbor<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _grad_phi_face_neighbor(
         this->_assembly.template feGradPhiFaceNeighbor<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _phi_neighbor(this->_assembly.template fePhiNeighbor<OutputShape>(FEType(CONSTANT, MONOMIAL))),
     _grad_phi_neighbor(
         this->_assembly.template feGradPhiNeighbor<OutputShape>(FEType(CONSTANT, MONOMIAL)))
 {
   if (!dynamic_cast<LinearSystem *>(&_sys) && !dynamic_cast<AuxiliarySystem *>(&_sys))
     this->paramError("solver_sys",
                      "The assigned system is not a linear or an auxiliary system! Linear variables "
                      "can only be assigned to linear or auxiliary systems!");
   _element_data = std::make_unique<MooseVariableDataLinearFV<OutputType>>(
       *this, _sys, _tid, Moose::ElementType::Element, this->_assembly.elem());
   _neighbor_data = std::make_unique<MooseVariableDataLinearFV<OutputType>>(
       *this, _sys, _tid, Moose::ElementType::Neighbor, this->_assembly.neighbor());
 
   if (libMesh::n_threads() > 1)
     mooseError("MooseLinearVariableFV does not support threading at the moment!");
 }

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 44 of file MooseVariableFieldBase.C.

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

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

◆ activeOnSubdomains()

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

inherited

Is the variable active on the subdomains?

Parameters

subdomains The subdomain ids in question

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

Definition at line 50 of file MooseVariableFieldBase.C.

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

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

◆ activeSubdomains()

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

inherited

The subdomains the variable is active on.

Definition at line 38 of file MooseVariableFieldBase.C.

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

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

◆ adCurlSln()

template<typename OutputType >

const ADTemplateVariableCurl< OutputType > & MooseLinearVariableFV< OutputType >::adCurlSln ( ) const

overridevirtual

AD curl solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 848 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adCurlSlnNeighbor()

template<typename OutputType >

const ADTemplateVariableCurl< OutputType > & MooseLinearVariableFV< OutputType >::adCurlSlnNeighbor ( ) const

overridevirtual

AD curl neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 855 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ add()

template<typename OutputType>

void MooseLinearVariableFV< OutputType >::add ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtual

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

Implements MooseVariableFieldBase.

Definition at line 595 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't support value addition to residuals in MooseLinearVariableFV!");
 }

◆ adDofValues()

template<typename OutputType >

const MooseArray< ADReal > & MooseLinearVariableFV< OutputType >::adDofValues ( ) const

overridevirtual

Return the AD dof values.

Implements MooseVariableField< OutputType >.

Definition at line 862 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adDofValuesDot()

template<typename OutputType >

const MooseArray< ADReal > & MooseLinearVariableFV< OutputType >::adDofValuesDot ( ) const

overridevirtual

Return the AD time derivatives at dofs.

Implements MooseVariableField< OutputType >.

Definition at line 876 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adDofValuesNeighbor()

template<typename OutputType >

const MooseArray< ADReal > & MooseLinearVariableFV< OutputType >::adDofValuesNeighbor ( ) const

overridevirtual

Return the AD neighbor dof values.

Implements MooseVariableField< OutputType >.

Definition at line 869 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adError()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::adError ( ) const

protected

Throw an error when somebody wants to use this variable with automatic differentiation.

Definition at line 520 of file MooseLinearVariableFV.h.

 {
   mooseError("Linear FV variable does not support automatic differentiation, the variable which is "
              "attempting it is: ",
              this->name());
 }

◆ adGradSln()

template<typename OutputType >

const ADTemplateVariableGradient< OutputType > & MooseLinearVariableFV< OutputType >::adGradSln ( ) const

overridevirtual

AD grad solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 841 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adGradSlnDot()

template<typename OutputType >

const ADTemplateVariableGradient< OutputType > & MooseLinearVariableFV< OutputType >::adGradSlnDot ( ) const

overridevirtual

AD grad of time derivative solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 785 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adGradSlnNeighbor()

template<typename OutputType >

const ADTemplateVariableGradient< OutputType > & MooseLinearVariableFV< OutputType >::adGradSlnNeighbor ( ) const

overridevirtual

AD grad neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 799 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adGradSlnNeighborDot()

template<typename OutputType >

const ADTemplateVariableGradient< OutputType > & MooseLinearVariableFV< OutputType >::adGradSlnNeighborDot ( ) const

overridevirtual

AD grad of time derivative neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 827 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adSecondSln()

template<typename OutputType >

const ADTemplateVariableSecond< OutputType > & MooseLinearVariableFV< OutputType >::adSecondSln ( ) const

overridevirtual

AD second solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 764 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adSecondSlnNeighbor()

template<typename OutputType >

const ADTemplateVariableSecond< OutputType > & MooseLinearVariableFV< OutputType >::adSecondSlnNeighbor ( ) const

overridevirtual

AD second neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 806 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adSln()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adSln ( ) const

overridevirtual

AD solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 834 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adSlnNeighbor()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adSlnNeighbor ( ) const

overridevirtual

AD neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 792 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adUDot()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adUDot ( ) const

overridevirtual

AD time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 771 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adUDotDot()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adUDotDot ( ) const

overridevirtual

AD second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 778 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adUDotDotNeighbor()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adUDotDotNeighbor ( ) const

overridevirtual

AD neighbor second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 820 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ adUDotNeighbor()

template<typename OutputType >

const ADTemplateVariableValue< OutputType > & MooseLinearVariableFV< OutputType >::adUDotNeighbor ( ) const

overridevirtual

AD neighbor time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 813 of file MooseLinearVariableFV.C.

 {
   adError();
 }

◆ allDofIndices()

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

inherited

Get all global dofindices for the variable.

Definition at line 197 of file MooseVariableBase.C.

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

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

◆ arrayScalingFactor()

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

inlineinherited

Definition at line 101 of file MooseVariableBase.h.

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

101 { return _scaling_factor; }

MooseVariableBase::_scaling_factor

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition: MooseVariableBase.h:247

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

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

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

◆ blockIDs()

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

virtualinherited

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

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

Definition at line 194 of file BlockRestrictable.C.

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

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

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 182 of file BlockRestrictable.C.

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

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

◆ blocks()

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

inherited

Return the block names for this object.

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

Returns: vector of SubdomainNames that are valid for this object

Definition at line 188 of file BlockRestrictable.C.

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

 {
   return _blocks;
 }

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

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

Definition at line 371 of file BlockRestrictable.C.

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

◆ buildOutputHideVariableList()

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

inherited

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

Parameters

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

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

Definition at line 61 of file OutputInterface.C.

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

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

◆ cacheBoundaryBCMap()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::cacheBoundaryBCMap ( )

protected

Setup the boundary to Dirichlet BC map.

Definition at line 216 of file MooseLinearVariableFV.C.

 {
   _boundary_id_to_bc.clear();
   std::vector<LinearFVBoundaryCondition *> bcs;
 
   // I believe because query() returns by value but condition returns by reference that binding to a
   // const lvalue reference results in the query() getting destructed and us holding onto a dangling
   // reference. I think that condition returned by value we would be able to bind to a const lvalue
   // reference here. But as it is we'll bind to a regular lvalue
   auto base_query = this->_subproblem.getMooseApp()
                         .theWarehouse()
                         .query()
                         .template condition<AttribSystem>("LinearFVBoundaryCondition")
                         .template condition<AttribThread>(_tid)
                         .template condition<AttribVar>(_var_num)
                         .template condition<AttribSysNum>(this->_sys.number());
 
   for (const auto bnd_id : this->_mesh.getBoundaryIDs())
   {
     auto base_query_copy = base_query;
     base_query_copy.template condition<AttribBoundaries>(std::set<BoundaryID>({bnd_id}))
         .queryInto(bcs);
     mooseAssert(bcs.size() <= 1, "cannot have multiple BCs on the same boundary");
     if (!bcs.empty())
       _boundary_id_to_bc.emplace(bnd_id, bcs[0]);
   }
 }

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`
	)		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

Definition at line 102 of file MooseBase.C.

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

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

◆ callMooseError() [2/2]

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

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

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

◆ checkFace()

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

inherited

Examines the incoming face argument.

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

Parameters

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

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

Definition at line 732 of file MooseFunctor.h.

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

◆ checkVariable()

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

virtualinherited

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

Parameters

variable The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 343 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

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

◆ clearAllDofIndices()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::clearAllDofIndices ( )

finaloverridevirtual

Reimplemented from MooseVariableBase.

Definition at line 538 of file MooseLinearVariableFV.C.

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

◆ clearDofIndices()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::clearDofIndices ( )

overridevirtual

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 307 of file MooseLinearVariableFV.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 215 of file MooseVariableBase.C.

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

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

◆ componentName()

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

inherited

Get the variable name of a component in libMesh.

Definition at line 27 of file MooseVariableFieldBase.C.

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

◆ computeCellGradients()

template<typename OutputType>

void MooseLinearVariableFV< OutputType >::computeCellGradients ( )

inline

Switch to request cell gradient computations.

Definition at line 94 of file MooseLinearVariableFV.h.

Referenced by LinearFVAdvectionDiffusionExtrapolatedBC::LinearFVAdvectionDiffusionExtrapolatedBC(), LinearFVAdvectionDiffusionFunctorNeumannBC::LinearFVAdvectionDiffusionFunctorNeumannBC(), LinearFVAdvectionDiffusionFunctorRobinBC::LinearFVAdvectionDiffusionFunctorRobinBC(), LinearFVAnisotropicDiffusion::LinearFVAnisotropicDiffusion(), and LinearFVDiffusion::LinearFVDiffusion().

94 { _needs_cell_gradients = true; }

MooseLinearVariableFV::_needs_cell_gradients

bool _needs_cell_gradients

Boolean to check if this variable needs gradient computations.

Definition: MooseLinearVariableFV.h:182

◆ computeElemValues()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeElemValues ( )

overridevirtual

Compute values at interior quadrature points.

Implements MooseVariableFieldBase.

Definition at line 454 of file MooseLinearVariableFV.C.

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

◆ computeElemValuesFace()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeElemValuesFace ( )

overridevirtual

Compute values at facial quadrature points.

Implements MooseVariableFieldBase.

Definition at line 462 of file MooseLinearVariableFV.C.

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

◆ computeFaceValues()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::computeFaceValues ( const FaceInfo & )

inlineoverridevirtual

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

Reimplemented from MooseVariableFieldBase.

Definition at line 312 of file MooseLinearVariableFV.h.

312 {}

◆ computeLowerDValues()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeLowerDValues ( )

finaloverridevirtual

compute values at quadrature points on the lower dimensional element

Implements MooseVariableFieldBase.

Definition at line 486 of file MooseLinearVariableFV.C.

 {
   lowerDError();
 }

◆ computeNeighborValues()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeNeighborValues ( )

overridevirtual

Compute values at quadrature points for the neighbor.

Implements MooseVariableFieldBase.

Definition at line 478 of file MooseLinearVariableFV.C.

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

◆ computeNeighborValuesFace()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeNeighborValuesFace ( )

overridevirtual

Compute values at facial quadrature points for the neighbor.

Implements MooseVariableFieldBase.

Definition at line 470 of file MooseLinearVariableFV.C.

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

◆ computeNodalNeighborValues()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeNodalNeighborValues ( )

finaloverridevirtual

Compute nodal values of this variable in the neighbor.

Implements MooseVariableFieldBase.

Definition at line 493 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ computeNodalValues()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::computeNodalValues ( )

finaloverridevirtual

Compute nodal values of this variable.

Implements MooseVariableFieldBase.

Definition at line 500 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ computingCurl()

template<typename OutputType>

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

inlinefinaloverridevirtual

Whether or not this variable is computing any curl quantities.

Implements MooseVariableField< OutputType >.

Definition at line 155 of file MooseLinearVariableFV.h.

155 { return false; }

◆ computingDiv()

template<typename OutputType>

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

inlinefinaloverridevirtual

Whether or not this variable is computing any divergence quantities.

Implements MooseVariableField< OutputType >.

Definition at line 156 of file MooseLinearVariableFV.h.

156 { return false; }

◆ computingSecond()

template<typename OutputType>

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

inlinefinaloverridevirtual

Whether or not this variable is computing any second derivatives.

Implements MooseVariableField< OutputType >.

Definition at line 154 of file MooseLinearVariableFV.h.

154 { return false; }

◆ 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 74 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 113 of file MooseVariableBase.h.

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

113 { return _count; }

MooseVariableBase::_count

const unsigned int _count

Number of variables in the array.

Definition: MooseVariableBase.h:244

◆ curlPhi()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiValue & MooseLinearVariableFV< OutputType >::curlPhi ( ) const

finaloverridevirtual

Curl of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 666 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement curl for FV");
 }

◆ currentElem()

template<typename OutputType >

const Elem *const & MooseLinearVariableFV< OutputType >::currentElem ( ) const

overridevirtual

Current element this variable is evaluated at.

Implements MooseVariableFieldBase.

Definition at line 257 of file MooseLinearVariableFV.C.

 {
   return this->_assembly.elem();
 }

◆ customSetup() [1/2]

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ customSetup() [2/2]

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

Definition at line 839 of file MooseFunctor.h.

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

◆ divPhi()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiDivergence & MooseLinearVariableFV< OutputType >::divPhi ( ) const

finaloverridevirtual

Divergence of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 673 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement divergence for FV");
 }

◆ doDerivatives()

bool MooseVariableBase::doDerivatives ( ) const

protectedinherited

Returns: whether we should insert derivatives

◆ dofIndices()

template<typename OutputType >

const std::vector< dof_id_type > & MooseLinearVariableFV< OutputType >::dofIndices ( ) const

finalvirtual

Get local DoF indices.

Reimplemented from MooseVariableBase.

Definition at line 507 of file MooseLinearVariableFV.C.

 {
   return _element_data->dofIndices();
 }

◆ dofIndicesLower()

template<typename OutputType >

const std::vector< dof_id_type > & MooseLinearVariableFV< OutputType >::dofIndicesLower ( ) const

finaloverridevirtual

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 567 of file MooseLinearVariableFV.C.

 {
   lowerDError();
 }

◆ dofIndicesNeighbor()

template<typename OutputType >

const std::vector< dof_id_type > & MooseLinearVariableFV< OutputType >::dofIndicesNeighbor ( ) const

finalvirtual

Get neighbor DOF indices for currently selected element.

Returns: the neighbor degree of freedom indices

Implements MooseVariableFieldBase.

Definition at line 514 of file MooseLinearVariableFV.C.

 {
   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 138 of file MooseVariableBase.h.

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

138 { return _dof_map; }

MooseVariableBase::_dof_map

const libMesh::DofMap & _dof_map

DOF map.

Definition: MooseVariableBase.h:232

◆ dofValues()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValues ( ) const

overridevirtual

dof values getters

Implements MooseVariableField< OutputType >.

Definition at line 314 of file MooseLinearVariableFV.C.

 {
   return _element_data->dofValues();
 }

◆ dofValuesDot()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDot ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 370 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotDot()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotDot ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 377 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotDotNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotDotNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 405 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotDotOld()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotDotOld ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 391 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotDotOldNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotDotOldNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 419 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 398 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotOld()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotOld ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 384 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDotOldNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesDotOldNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 412 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDuDotDotDu()

template<typename OutputType >

const MooseArray< Number > & MooseLinearVariableFV< OutputType >::dofValuesDuDotDotDu ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 433 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDuDotDotDuNeighbor()

template<typename OutputType >

const MooseArray< Number > & MooseLinearVariableFV< OutputType >::dofValuesDuDotDotDuNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 447 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDuDotDu()

template<typename OutputType >

const MooseArray< Number > & MooseLinearVariableFV< OutputType >::dofValuesDuDotDu ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 426 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesDuDotDuNeighbor()

template<typename OutputType >

const MooseArray< Number > & MooseLinearVariableFV< OutputType >::dofValuesDuDotDuNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 440 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ dofValuesNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 321 of file MooseLinearVariableFV.C.

 {
   return _neighbor_data->dofValues();
 }

◆ dofValuesOld()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesOld ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 328 of file MooseLinearVariableFV.C.

 {
   return _element_data->dofValuesOld();
 }

◆ dofValuesOlder()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesOlder ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 335 of file MooseLinearVariableFV.C.

 {
   return _element_data->dofValuesOlder();
 }

◆ dofValuesOlderNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesOlderNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 356 of file MooseLinearVariableFV.C.

 {
   return _neighbor_data->dofValuesOlder();
 }

◆ dofValuesOldNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesOldNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 349 of file MooseLinearVariableFV.C.

 {
   return _neighbor_data->dofValuesOld();
 }

◆ dofValuesPreviousNL()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesPreviousNL ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 342 of file MooseLinearVariableFV.C.

 {
   return _element_data->dofValuesPreviousNL();
 }

◆ dofValuesPreviousNLNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::dofValuesPreviousNLNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 363 of file MooseLinearVariableFV.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 890 of file MooseFunctor.h.

 {
   return evaluateDot(elem, state);
 }

◆ dot() [2/6]

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

inherited

Definition at line 897 of file MooseFunctor.h.

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

◆ dot() [3/6]

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

inherited

Definition at line 905 of file MooseFunctor.h.

 {
   return evaluateDot(elem_qp, state);
 }

◆ dot() [4/6]

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

inherited

Definition at line 912 of file MooseFunctor.h.

 {
   return evaluateDot(elem_side_qp, state);
 }

◆ dot() [5/6]

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

inherited

Definition at line 919 of file MooseFunctor.h.

 {
   return evaluateDot(elem_point, state);
 }

◆ dot() [6/6]

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

inherited

Definition at line 926 of file MooseFunctor.h.

 {
   return evaluateDot(node, state);
 }

◆ eigen() [1/2]

bool MooseVariableBase::eigen ( ) const

inlineinherited

Whether or not this variable operates on an eigen kernel.

Definition at line 165 of file MooseVariableBase.h.

Referenced by EigenProblem::adjustEigenVector().

165 { return _is_eigen; }

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:217

◆ eigen() [2/2]

void MooseVariableBase::eigen ( bool eigen )

inlineinherited

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

Definition at line 170 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen().

170 { _is_eigen = eigen; }

MooseVariableBase::eigen

bool eigen() const

Whether or not this variable operates on an eigen kernel.

Definition: MooseVariableBase.h:165

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:217

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 39 of file MooseObject.h.

Referenced by EigenKernel::enabled().

39 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:50

◆ errorPrefix()

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

inlineinherited

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

Definition at line 260 of file MooseBase.h.

260 { return messagePrefix(); }

MooseBase::messagePrefix

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

Definition: MooseBase.h:252

◆ evaluate() [1/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

finaloverrideprivatevirtual

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 433 of file MooseLinearVariableFV.h.

 {
   const auto & elem_info = this->_mesh.elemInfo(elem_arg.elem->id());
   return getElemValue(elem_info, state);
 }

◆ evaluate() [2/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const FaceArg &	face,
		const StateArg &	state
	)		const

finaloverrideprivatevirtual

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 159 of file MooseLinearVariableFV.C.

 {
   const FaceInfo * const fi = face.fi;
 
   mooseAssert(fi, "The face information must be non-null");
 
   const auto face_type = fi->faceType(std::make_pair(this->_var_num, this->_sys_num));
 
   if (face_type == FaceInfo::VarFaceNeighbors::BOTH)
     return Moose::FV::interpolate(*this, face, state);
   else if (auto * bc_pointer = this->getBoundaryCondition(*fi->boundaryIDs().begin()))
   {
     mooseAssert(fi->boundaryIDs().size() == 1, "We should only have one boundary on every face.");
     bc_pointer->setupFaceData(fi, face_type);
     return bc_pointer->computeBoundaryValue();
   }
   // If no boundary condition is defined but we are evaluating on a boundary, just return the
   // element value
   else if (face_type == FaceInfo::VarFaceNeighbors::ELEM)
   {
     const auto & elem_info = this->_mesh.elemInfo(fi->elemPtr()->id());
     return getElemValue(elem_info, state);
   }
   else if (face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR)
   {
     const auto & elem_info = this->_mesh.elemInfo(fi->neighborPtr()->id());
     return getElemValue(elem_info, state);
   }
   else
     mooseError("We should never get here!");
 }

◆ evaluate() [3/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const NodeArg &	node,
		const StateArg &
	)		const

finaloverrideprivatevirtual

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

Definition at line 193 of file MooseLinearVariableFV.C.

 {
   mooseError("Not implemented yet");
 }

◆ evaluate() [4/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

finaloverrideprivatevirtual

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 441 of file MooseLinearVariableFV.h.

 {
   const auto & elem_info = this->_mesh.elemInfo(elem_point.elem->id());
   return getElemValue(elem_info, state);
 }

◆ evaluate() [5/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

finaloverrideprivatevirtual

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 450 of file MooseLinearVariableFV.h.

 {
   const auto & elem_info = this->_mesh.elemInfo(elem_qp.elem->id());
   return getElemValue(elem_info, state);
 }

◆ evaluate() [6/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::ValueType MooseLinearVariableFV< OutputType >::evaluate	(	const ElemSideQpArg &	side_qp,
		const StateArg &	state
	)		const

finaloverrideprivatevirtual

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 458 of file MooseLinearVariableFV.h.

 {
   return (*this)(ElemPointArg{elem_side_qp.elem, elem_side_qp.point, false}, state);
 }

◆ evaluateDot() [1/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::DotType MooseLinearVariableFV< OutputType >::evaluateDot	(	const ElemArg &	,
		const StateArg &
	)		const

finaloverrideprivatevirtual

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 201 of file MooseLinearVariableFV.C.

 {
   timeIntegratorError();
 }

◆ evaluateDot() [2/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

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

Definition at line 395 of file MooseFunctor.h.

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

◆ evaluateDot() [3/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

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

Definition at line 405 of file MooseFunctor.h.

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

◆ evaluateDot() [4/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

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

Definition at line 416 of file MooseFunctor.h.

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

◆ evaluateDot() [5/6]

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

inlineprotectedvirtualinherited

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

Definition at line 425 of file MooseFunctor.h.

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

◆ evaluateDot() [6/6]

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

inlineprotectedvirtualinherited

Definition at line 430 of file MooseFunctor.h.

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

◆ evaluateGradDot() [1/6]

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

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element.

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

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

Definition at line 439 of file MooseFunctor.h.

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

◆ evaluateGradDot() [2/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 449 of file MooseFunctor.h.

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

◆ evaluateGradDot() [3/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 459 of file MooseFunctor.h.

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

◆ evaluateGradDot() [4/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 470 of file MooseFunctor.h.

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

◆ evaluateGradDot() [5/6]

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

inlineprotectedvirtualinherited

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

Definition at line 479 of file MooseFunctor.h.

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

◆ evaluateGradDot() [6/6]

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

inlineprotectedvirtualinherited

Definition at line 484 of file MooseFunctor.h.

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

◆ evaluateGradient() [1/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::GradientType MooseLinearVariableFV< OutputType >::evaluateGradient	(	const ElemQpArg &	,
		const StateArg &
	)		const

finaloverrideprivatevirtual

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 466 of file MooseLinearVariableFV.h.

 {
   const auto & elem_info = this->_mesh.elemInfo(qp_arg.elem->id());
   return gradSln(elem_info);
 }

◆ evaluateGradient() [2/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::GradientType MooseLinearVariableFV< OutputType >::evaluateGradient	(	const ElemArg &	,
		const StateArg &
	)		const

finaloverrideprivatevirtual

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 475 of file MooseLinearVariableFV.h.

 {
   const auto & elem_info = this->_mesh.elemInfo(elem_arg.elem->id());
   return gradSln(elem_info);
 }

◆ evaluateGradient() [3/6]

template<typename OutputType >

MooseLinearVariableFV< OutputType >::GradientType MooseLinearVariableFV< OutputType >::evaluateGradient	(	const FaceArg &	,
		const StateArg &
	)		const

finaloverrideprivatevirtual

Parameters

face	See the `FaceArg` 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 484 of file MooseLinearVariableFV.h.

 {
   mooseAssert(face.fi, "We must have a non-null face information");
   return gradSln(*face.fi, state);
 }

◆ evaluateGradient() [4/6]

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

inlineprotectedvirtualinherited

Parameters

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

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

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

Definition at line 362 of file MooseFunctor.h.

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

◆ evaluateGradient() [5/6]

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

inlineprotectedvirtualinherited

Evaluate the functor gradient with a given element and point.

Definition at line 371 of file MooseFunctor.h.

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

◆ evaluateGradient() [6/6]

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

inlineprotectedvirtualinherited

Definition at line 376 of file MooseFunctor.h.

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

◆ feType()

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

inlineinherited

Get the type of finite element object.

Definition at line 64 of file MooseVariableBase.h.

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

64 { return _fe_type; }

MooseVariableBase::_fe_type

libMesh::FEType _fe_type

The FEType associated with this variable.

Definition: MooseVariableBase.h:208

◆ fieldType()

template<typename OutputType >

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

overridevirtualinherited

Field type of this variable.

Implements MooseVariableFieldBase.

Definition at line 72 of file MooseVariableField.C.

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

◆ functorName()

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

inlineinherited

Return the functor name.

Definition at line 170 of file MooseFunctor.h.

170 { return _functor_name; }

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

MooseFunctorName _functor_name

name of the functor

Definition: MooseFunctor.h:564

◆ genericDofValues()

template<typename OutputType >

template<bool is_ad>

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

inherited

Definition at line 428 of file MooseVariableField.h.

 {
   return adDofValues();
 }

◆ genericEvaluate()

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

inherited

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

Definition at line 987 of file MooseFunctor.h.

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

◆ getBase()

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

inlineinherited

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

Definition at line 143 of file MooseBase.h.

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

143 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:497

◆ getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )

protectedinherited

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

Definition at line 321 of file BlockRestrictable.C.

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

◆ getBoundaryCondition()

template<typename OutputType >

LinearFVBoundaryCondition * MooseLinearVariableFV< OutputType >::getBoundaryCondition ( const BoundaryID bd_id ) const

Get the boundary condition object which corresponds to the given boundary ID.

Parameters

bd_id The boundary ID whose condition should be fetched

Definition at line 246 of file MooseLinearVariableFV.C.

Referenced by LinearFVFluxKernel::addMatrixContribution(), LinearFVFluxKernel::addRightHandSideContribution(), and ComputeLinearFVGreenGaussGradientFaceThread::operator()().

 {
   const auto iter = _boundary_id_to_bc.find(bd_id);
   if (iter == _boundary_id_to_bc.end())
     return nullptr;
   else
     return iter->second;
 }

◆ getBoundaryConditionMap()

template<typename OutputType>

const std::unordered_map<BoundaryID, LinearFVBoundaryCondition *>& MooseLinearVariableFV< OutputType >::getBoundaryConditionMap ( )

inline

Definition at line 136 of file MooseLinearVariableFV.h.

Referenced by LinearFVAdvection::initialSetup(), LinearFVDiffusion::initialSetup(), and LinearFVAnisotropicDiffusion::initialSetup().

   {
     return _boundary_id_to_bc;
   }

◆ 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 428 of file MooseBase.h.

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

◆ getContinuity()

template<typename OutputType>

virtual libMesh::FEContinuity MooseLinearVariableFV< OutputType >::getContinuity ( ) const

inlineoverridevirtual

Return the continuity of this variable.

Reimplemented from MooseVariableBase.

Definition at line 281 of file MooseLinearVariableFV.h.

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

Referenced by DataFileInterface::getDataFileNameByName().

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

◆ getDofIndices()

template<typename OutputType >

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

overridevirtual

Reimplemented from MooseVariableBase.

Definition at line 283 of file MooseLinearVariableFV.C.

 {
   dof_indices.clear();
   const auto & elem_info = this->_mesh.elemInfo(elem->id());
   dof_indices.push_back(elem_info.dofIndices()[this->_sys_num][this->number()]);
 }

◆ getElemValue()

template<typename OutputType >

Real MooseLinearVariableFV< OutputType >::getElemValue	(	const ElemInfo &	elem_info,
		const StateArg &	state
	)		const

Get the solution value for the provided element and seed the derivative for the corresponding dof index.

Parameters

elem_info	The element to retrieve the solution value for
state	State argument which describes at what time / solution iteration state we want to evaluate the variable

Definition at line 92 of file MooseLinearVariableFV.C.

Referenced by LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryValue(), MooseLinearVariableFV< Real >::evaluate(), and ComputeLinearFVGreenGaussGradientVolumeThread::operator()().

 {
   mooseAssert(
       this->hasBlocks(elem_info.subdomain_id()),
       "The variable should be defined on the element's subdomain! This typically occurs when the "
       "user wants to evaluate the elements right next to the boundary of two variables (block "
       "boundary). The subdomain which is queried: " +
           Moose::stringify(this->activeSubdomains()) + " the subdomain of the element " +
           std::to_string(elem_info.subdomain_id()));
 
   // 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
   const auto & global_soln = (state.state == 0)
                                  ? *this->_sys.currentSolution()
                                  : this->_sys.solutionState(state.state, state.iteration_type);
 
   return global_soln(elem_info.dofIndices()[this->_sys_num][this->_var_num]);
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

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

 {
   return _execute_enum;
 }

◆ getHitNode()

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

inlineinherited

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

Definition at line 132 of file MooseBase.h.

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

132 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:132

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 83 of file MooseBase.h.

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(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

83 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:353

◆ getOutputs()

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

inherited

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

Returns: A set of OutputNames

Definition at line 94 of file OutputInterface.C.

 {
   return _oi_outputs;
 }

◆ getParam() [1/2]

template<typename T >

const T & 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 384 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 421 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 398 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 61 of file MooseObject.C.

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

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

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 74 of file MooseObject.C.

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

◆ getSolution()

template<typename OutputType >

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

protectedinherited

Get the solution corresponding to the provided state.

Definition at line 60 of file MooseVariableField.C.

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

◆ gradDot() [1/6]

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

inherited

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

These are the methods a user will call in their code

Definition at line 933 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem, state);
 }

◆ gradDot() [2/6]

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

inherited

Definition at line 940 of file MooseFunctor.h.

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

◆ gradDot() [3/6]

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

inherited

Definition at line 948 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_qp, state);
 }

◆ gradDot() [4/6]

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

inherited

Definition at line 955 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_side_qp, state);
 }

◆ gradDot() [5/6]

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

inherited

Definition at line 962 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_point, state);
 }

◆ gradDot() [6/6]

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

inherited

Definition at line 969 of file MooseFunctor.h.

 {
   return evaluateGradDot(node, state);
 }

◆ gradient() [1/6]

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

inherited

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

These are the methods a user will call in their code

Definition at line 847 of file MooseFunctor.h.

 {
   return evaluateGradient(elem, state);
 }

◆ gradient() [2/6]

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

inherited

Definition at line 854 of file MooseFunctor.h.

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

◆ gradient() [3/6]

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

inherited

Definition at line 862 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_qp, state);
 }

◆ gradient() [4/6]

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

inherited

Definition at line 869 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_side_qp, state);
 }

◆ gradient() [5/6]

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

inherited

Definition at line 876 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_point, state);
 }

◆ gradient() [6/6]

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

inherited

Definition at line 883 of file MooseFunctor.h.

 {
   return evaluateGradient(node, state);
 }

◆ gradPhi()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 327 of file MooseLinearVariableFV.h.

327 { return _grad_phi; }

MooseLinearVariableFV::_grad_phi

const FieldVariablePhiGradient & _grad_phi

Definition: MooseLinearVariableFV.h:239

◆ gradPhiFace()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 333 of file MooseLinearVariableFV.h.

   {
     return _grad_phi_face;
   }

◆ gradPhiFaceNeighbor()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 343 of file MooseLinearVariableFV.h.

   {
     return _grad_phi_face_neighbor;
   }

◆ gradPhiNeighbor()

template<typename OutputType>

virtual const FieldVariablePhiGradient& MooseLinearVariableFV< OutputType >::gradPhiNeighbor ( ) const

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 350 of file MooseLinearVariableFV.h.

   {
     return _grad_phi_neighbor;
   }

◆ gradSln() [1/3]

template<typename OutputType >

const VectorValue< Real > MooseLinearVariableFV< OutputType >::gradSln ( const ElemInfo & elem_info ) const

Get the variable gradient at a cell center.

Parameters

elem_info The ElemInfo of the cell where we need the gradient

Definition at line 116 of file MooseLinearVariableFV.C.

 {
   if (_needs_cell_gradients)
   {
     _cell_gradient.zero();
     for (const auto i : make_range(this->_mesh.dimension()))
       _cell_gradient(i) =
           (*_grad_container[i])(elem_info.dofIndices()[this->_sys_num][this->_var_num]);
   }
 
   return _cell_gradient;
 }

◆ gradSln() [2/3]

template<typename OutputType >

VectorValue< Real > MooseLinearVariableFV< OutputType >::gradSln	(	const FaceInfo &	fi,
		const StateArg &	state
	)		const

Compute interpolated gradient on the provided face.

Parameters

face	The face for which to retrieve the gradient.
state	State argument which describes at what time / solution iteration state we want to evaluate the variable

Definition at line 131 of file MooseLinearVariableFV.C.

 {
   const bool var_defined_on_elem = this->hasBlocks(fi.elem().subdomain_id());
   const auto * const elem_one = var_defined_on_elem ? fi.elemInfo() : fi.neighborInfo();
   const auto * const elem_two = var_defined_on_elem ? fi.neighborInfo() : fi.elemInfo();
 
   const auto elem_one_grad = gradSln(*elem_one);
 
   // If we have a neighbor then we interpolate between the two to the face.
   if (elem_two && this->hasBlocks(elem_two->subdomain_id()))
   {
     const auto elem_two_grad = gradSln(*elem_two);
     return Moose::FV::linearInterpolation(elem_one_grad, elem_two_grad, fi, var_defined_on_elem);
   }
   else
     return elem_one_grad;
 }

◆ gradSln() [3/3]

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableGradient & MooseLinearVariableFV< OutputType >::gradSln ( ) const

overridevirtual

element gradients

Implements MooseVariableField< OutputType >.

Definition at line 722 of file MooseLinearVariableFV.C.

Referenced by MooseLinearVariableFV< Real >::evaluateGradient().

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

◆ gradSlnNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableGradient & MooseLinearVariableFV< OutputType >::gradSlnNeighbor ( ) const

overridevirtual

neighbor solution gradients

Implements MooseVariableField< OutputType >.

Definition at line 750 of file MooseLinearVariableFV.C.

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

◆ gradSlnOld()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableGradient & MooseLinearVariableFV< OutputType >::gradSlnOld ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 729 of file MooseLinearVariableFV.C.

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

◆ gradSlnOldNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableGradient & MooseLinearVariableFV< OutputType >::gradSlnOldNeighbor ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 757 of file MooseLinearVariableFV.C.

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

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

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

Definition at line 138 of file MooseBase.h.

138 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:491

◆ hasBlockMaterialProperty()

template<typename T , bool is_ad>

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

inherited

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

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

Template Parameters

T	The type of material property

Parameters

prop_name the name of the property to query

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

See also: Material::hasBlockMaterialProperty

Definition at line 271 of file BlockRestrictable.h.

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

◆ hasBlockMaterialPropertyHelper()

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

protectedvirtualinherited

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

It also avoid circular #include problems.

See also: hasBlockMaterialProperty

Definition at line 285 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

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

◆ hasBlocks() [1/6]

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

inherited

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

Parameters

name	A SubdomainName to check

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

Definition at line 209 of file BlockRestrictable.C.

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

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

◆ hasBlocks() [2/6]

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

inherited

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

Parameters

names A vector of SubdomainNames to check

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

Definition at line 219 of file BlockRestrictable.C.

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

◆ hasBlocks() [3/6]

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

inherited

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

Parameters

names A set of SubdomainNames to check

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

Definition at line 225 of file BlockRestrictable.C.

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

◆ hasBlocks() [4/6]

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

inherited

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

Parameters

ids	A vector of SubdomainIDs ids to check

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

Definition at line 240 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/6]

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

inherited

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

Parameters

ids	A std::set of SubdomainIDs to check

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

See also: isSubset

Definition at line 247 of file BlockRestrictable.C.

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

◆ hasBlocks() [6/6]

template<typename OutputType>

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

inlineoverridevirtualinherited

Returns whether the functor is defined on this block.

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

Definition at line 400 of file MooseVariableField.h.

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

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

BlockRestrictable::hasBlocks

bool hasBlocks(const SubdomainName &name) const

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

Definition: BlockRestrictable.C:209

◆ hasDoFsOnNodes()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::hasDoFsOnNodes ( ) const

inlinefinaloverridevirtual

Does this variable have DoFs on nodes.

Returns: true if it does, false if not.

Reimplemented from MooseVariableBase.

Definition at line 145 of file MooseLinearVariableFV.h.

145 { return false; }

◆ hasFaceSide()

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

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 976 of file MooseFunctor.h.

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

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject * moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 74 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

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

◆ initialSetup()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::initialSetup ( )

overridevirtual

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

Reimplemented from SetupInterface.

Definition at line 151 of file MooseLinearVariableFV.C.

 {
   MooseVariableField<OutputType>::initialSetup();
   cacheBoundaryBCMap();
 }

◆ insert()

template<typename OutputType>

void MooseLinearVariableFV< OutputType >::insert ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtual

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

Implements MooseVariableFieldBase.

Definition at line 581 of file MooseLinearVariableFV.C.

 {
   _element_data->insert(vector);
 }

◆ insertLower()

template<typename OutputType>

void MooseLinearVariableFV< OutputType >::insertLower ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtual

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

Implements MooseVariableFieldBase.

Definition at line 588 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't support value insertion to residuals in MooseLinearVariableFV!");
 }

◆ isArray()

template<typename OutputType >

bool MooseVariableField< OutputType >::isArray ( ) const

overridevirtualinherited

Returns: whether this is an array variable

Reimplemented from MooseVariableBase.

Definition at line 86 of file MooseVariableField.C.

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

◆ isBlockSubset() [1/2]

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

inherited

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

Parameters

ids	A std::set of Subdomains to check

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

See also: hasBlocks

Definition at line 256 of file BlockRestrictable.C.

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

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

◆ isBlockSubset() [2/2]

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

inherited

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

Parameters

ids	A std::vector of Subdomains to check

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

See also: hasBlocks

Definition at line 272 of file BlockRestrictable.C.

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

◆ isConstant()

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

inlinevirtualinherited

Returns true if this functor is a constant.

Definition at line 260 of file MooseFunctor.h.

260 { return false; }

◆ isDirichletBoundaryFace()

template<typename OutputType >

bool MooseLinearVariableFV< OutputType >::isDirichletBoundaryFace ( const FaceInfo & fi ) const

virtual

If the variable has a dirichlet boundary condition at face described by fi .

Definition at line 264 of file MooseLinearVariableFV.C.

 {
   for (const auto bnd_id : fi.boundaryIDs())
     if (auto it = _boundary_id_to_bc.find(bnd_id); it != _boundary_id_to_bc.end())
       if (dynamic_cast<LinearFVAdvectionDiffusionFunctorDirichletBC *>(it->second))
         return true;
 
   return false;
 }

◆ isExtrapolatedBoundaryFace()

template<typename OutputType >

bool MooseLinearVariableFV< OutputType >::isExtrapolatedBoundaryFace	(	const FaceInfo &	,
		const Elem *	,
		const Moose::StateArg &
	)		const

overridevirtual

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

This is not used by this variable at this point.

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

Definition at line 83 of file MooseLinearVariableFV.C.

 {
   return false;
 }

◆ isFV()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::isFV ( ) const

inlineoverridevirtual

Reimplemented from MooseVariableFieldBase.

Definition at line 84 of file MooseLinearVariableFV.h.

84 { return true; }

◆ isInternalFace()

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

inherited

Returns true if the face is an internal face.

Definition at line 569 of file MooseFunctor.h.

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

◆ isLowerD()

bool MooseVariableBase::isLowerD ( ) const

inlineinherited

Returns: whether this variable lives on lower dimensional blocks

Definition at line 191 of file MooseVariableBase.h.

191 { return _is_lower_d; }

MooseVariableBase::_is_lower_d

bool _is_lower_d

Whether this variable lives on lower dimensional blocks.

Definition: MooseVariableBase.h:253

◆ isNodal()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::isNodal ( ) const

inlinefinaloverridevirtual

Is this variable nodal.

Returns: true if it nodal, otherwise false

Reimplemented from MooseVariableBase.

Definition at line 143 of file MooseLinearVariableFV.h.

143 { return false; }

◆ isNodalDefined()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::isNodalDefined ( ) const

inlinefinaloverridevirtual

Is this variable defined at nodes.

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

Implements MooseVariableFieldBase.

Definition at line 147 of file MooseLinearVariableFV.h.

147 { return false; }

◆ 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 201 of file MooseBase.h.

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

   {
     return _pars.isParamSetByUser(name);
   }

◆ 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 195 of file MooseBase.h.

195 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

InputParameters::isParamValid

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

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

Definition: InputParameters.C: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 97 of file MooseVariableField.C.

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

◆ jacobianSetup()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::jacobianSetup ( )

inlineoverridevirtual

Reimplemented from MooseVariableField< OutputType >.

Definition at line 279 of file MooseLinearVariableFV.h.

279 {}

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const

inlineinherited

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

Definition at line 90 of file MooseVariableBase.h.

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

90 { return _var_kind; }

MooseVariableBase::_var_kind

Moose::VarKindType _var_kind

Variable type (see MooseTypes.h)

Definition: MooseVariableBase.h:220

◆ lowerDError()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::lowerDError ( ) const

protected

Throw and error when somebody requests lower-dimensional data from this variable.

Definition at line 502 of file MooseLinearVariableFV.h.

 {
   mooseError("Lower dimensional element support not implemented for finite volume variables!The "
              "variable which is causing the issue: ",
              this->name());
 }

◆ matrixTagValue()

template<typename OutputType >

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

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 652 of file MooseLinearVariableFV.C.

 {
   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 279 of file BlockRestrictable.C.

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

 {
   return _blk_mesh->meshSubdomains();
 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

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

Definition at line 30 of file MeshChangedInterface.h.

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

30 {}

◆ messagePrefix()

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 252 of file MooseBase.h.

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

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 310 of file MooseBase.h.

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

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, 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 273 of file MooseBase.h.

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

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

◆ 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 267 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 286 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 317 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 295 of file MooseBase.h.

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

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 304 of file MooseBase.h.

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

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 99 of file MooseBase.h.

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

◆ needsGradientVectorStorage()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::needsGradientVectorStorage ( ) const

inlineoverridevirtual

Check if cell gradient computations were requested for this variable.

Reimplemented from MooseVariableFieldBase.

Definition at line 99 of file MooseLinearVariableFV.h.

Referenced by ComputeLinearFVGreenGaussGradientFaceThread::operator()(), and ComputeLinearFVGreenGaussGradientVolumeThread::operator()().

99 { return _needs_cell_gradients; }

MooseLinearVariableFV::_needs_cell_gradients

bool _needs_cell_gradients

Boolean to check if this variable needs gradient computations.

Definition: MooseLinearVariableFV.h:182

◆ nodalDofIndex()

template<typename OutputType >

const dof_id_type & MooseLinearVariableFV< OutputType >::nodalDofIndex ( ) const

finaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 883 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalDofIndexNeighbor()

template<typename OutputType >

const dof_id_type & MooseLinearVariableFV< OutputType >::nodalDofIndexNeighbor ( ) const

finaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 890 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalError()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::nodalError ( ) const

protected

Throw an error when somebody wants to use this variable as a nodal variable.

Definition at line 511 of file MooseLinearVariableFV.h.

 {
   mooseError("FV variables don't support nodal variable treatment! The variable which is causing "
              "the issue: ",
              this->name());
 }

◆ nodalMatrixTagValue()

template<typename OutputType >

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

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 560 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalValueArray()

template<typename OutputType >

const MooseArray< OutputType > & MooseLinearVariableFV< OutputType >::nodalValueArray ( ) const

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 610 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalValueOldArray()

template<typename OutputType >

const MooseArray< OutputType > & MooseLinearVariableFV< OutputType >::nodalValueOldArray ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 617 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalValueOlderArray()

template<typename OutputType >

const MooseArray< OutputType > & MooseLinearVariableFV< OutputType >::nodalValueOlderArray ( ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 624 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ nodalVectorTagValue()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::DoFValue & MooseLinearVariableFV< OutputType >::nodalVectorTagValue ( TagID ) const

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 553 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ number()

unsigned int MooseVariableBase::number ( ) const

inlineinherited

Get variable number coming from libMesh.

Returns: the libmesh variable number

Definition at line 59 of file MooseVariableBase.h.

59 { return _var_num; }

MooseVariableBase::_var_num

unsigned int _var_num

variable number (from libMesh)

Definition: MooseVariableBase.h:211

◆ numberOfDofs()

template<typename OutputType>

virtual unsigned int MooseLinearVariableFV< OutputType >::numberOfDofs ( ) const

inlinefinaloverridevirtual

Get the number of local DoFs.

Reimplemented from MooseVariableBase.

Definition at line 265 of file MooseLinearVariableFV.h.

265 { return 1; }

◆ numberOfDofsNeighbor()

template<typename OutputType>

virtual unsigned int MooseLinearVariableFV< OutputType >::numberOfDofsNeighbor ( )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 266 of file MooseLinearVariableFV.h.

266 { return 1; }

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 203 of file BlockRestrictable.C.

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

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

◆ oldestSolutionStateRequested()

template<typename OutputType >

unsigned int MooseLinearVariableFV< OutputType >::oldestSolutionStateRequested ( ) const

finaloverridevirtual

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

Implements MooseVariableFieldBase.

Definition at line 528 of file MooseLinearVariableFV.C.

 {
   unsigned int state = 0;
   state = std::max(state, _element_data->oldestSolutionStateRequested());
   state = std::max(state, _neighbor_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 597 of file MooseFunctor.h.

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

◆ operator()() [2/6]

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

inherited

Definition at line 610 of file MooseFunctor.h.

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

◆ operator()() [3/6]

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

inherited

Definition at line 656 of file MooseFunctor.h.

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

◆ operator()() [4/6]

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

inherited

Definition at line 677 of file MooseFunctor.h.

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

◆ operator()() [5/6]

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

inherited

Definition at line 707 of file MooseFunctor.h.

 {
   return evaluate(elem_point, state);
 }

◆ operator()() [6/6]

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

inherited

Definition at line 724 of file MooseFunctor.h.

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

◆ order()

Order MooseVariableBase::order ( ) const

inherited

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

Definition at line 209 of file MooseVariableBase.C.

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

 {
   return _fe_type.order;
 }

◆ paramError()

template<typename... Args>

void 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 435 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 127 of file MooseBase.h.

127 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

◆ 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 449 of file MooseBase.h.

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

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

◆ paramWarning()

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 442 of file MooseBase.h.

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

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

◆ phi()

template<typename OutputType>

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

inlinefinaloverridevirtual

Return the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 326 of file MooseLinearVariableFV.h.

326 { return _phi; }

MooseLinearVariableFV::_phi

const FieldVariablePhiValue & _phi

Shape functions, only used when we are postprocessing or using this variable in an auxiliary system...

Definition: MooseLinearVariableFV.h:238

◆ phiFace()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 332 of file MooseLinearVariableFV.h.

332 { return _phi_face; }

MooseLinearVariableFV::_phi_face

const FieldVariablePhiValue & _phi_face

Definition: MooseLinearVariableFV.h:240

◆ phiFaceNeighbor()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 339 of file MooseLinearVariableFV.h.

   {
     return _phi_face_neighbor;
   }

◆ phiFaceNeighborSize()

template<typename OutputType>

virtual std::size_t MooseLinearVariableFV< OutputType >::phiFaceNeighborSize ( ) const

inlinefinaloverridevirtual

Return phiFaceNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 424 of file MooseLinearVariableFV.h.

   {
     return _phi_face_neighbor.size();
   }

◆ phiFaceSize()

template<typename OutputType>

virtual std::size_t MooseLinearVariableFV< OutputType >::phiFaceSize ( ) const

inlinefinaloverridevirtual

Return phiFace size.

Implements MooseVariableFieldBase.

Definition at line 422 of file MooseLinearVariableFV.h.

422 { return _phi_face.size(); }

MooseLinearVariableFV::_phi_face

const FieldVariablePhiValue & _phi_face

Definition: MooseLinearVariableFV.h:240

◆ phiLower()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiValue & MooseLinearVariableFV< OutputType >::phiLower ( ) const

overridevirtual

Return the variable's shape functions on a lower-dimensional element.

Implements MooseVariableField< OutputType >.

Definition at line 574 of file MooseLinearVariableFV.C.

 {
   lowerDError();
 }

◆ phiLowerSize()

template<typename OutputType >

std::size_t MooseLinearVariableFV< OutputType >::phiLowerSize ( ) const

finaloverridevirtual

Return the number of shape functions on the lower dimensional element for this variable.

Implements MooseVariableFieldBase.

Definition at line 631 of file MooseLinearVariableFV.C.

 {
   lowerDError();
 }

◆ phiNeighbor()

template<typename OutputType>

virtual const FieldVariablePhiValue& MooseLinearVariableFV< OutputType >::phiNeighbor ( ) const

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 349 of file MooseLinearVariableFV.h.

349 { return _phi_neighbor; }

MooseLinearVariableFV::_phi_neighbor

const FieldVariablePhiValue & _phi_neighbor

Definition: MooseLinearVariableFV.h:244

◆ phiNeighborSize()

template<typename OutputType>

virtual std::size_t MooseLinearVariableFV< OutputType >::phiNeighborSize ( ) const

inlinefinaloverridevirtual

Return phiNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 423 of file MooseLinearVariableFV.h.

423 { return _phi_neighbor.size(); }

MooseLinearVariableFV::_phi_neighbor

const FieldVariablePhiValue & _phi_neighbor

Definition: MooseLinearVariableFV.h:244

◆ phiSize()

template<typename OutputType>

virtual std::size_t MooseLinearVariableFV< OutputType >::phiSize ( ) const

inlinefinaloverridevirtual

Return phi size.

Implements MooseVariableFieldBase.

Definition at line 421 of file MooseLinearVariableFV.h.

421 { return _phi.size(); }

MooseLinearVariableFV::_phi

const FieldVariablePhiValue & _phi

Shape functions, only used when we are postprocessing or using this variable in an auxiliary system...

Definition: MooseLinearVariableFV.h:238

◆ prepare()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::prepare ( )

inlinefinaloverridevirtual

Prepare the elemental degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 293 of file MooseLinearVariableFV.h.

293 {}

◆ prepareAux()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::prepareAux ( )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 295 of file MooseLinearVariableFV.h.

295 {}

◆ prepareIC()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::prepareIC ( )

inlineoverridevirtual

Prepare the initial condition.

Implements MooseVariableFieldBase.

Definition at line 141 of file MooseLinearVariableFV.h.

141 {}

◆ prepareLowerD()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::prepareLowerD ( )

inlinefinaloverridevirtual

Prepare a lower dimensional element's degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 301 of file MooseLinearVariableFV.h.

301 {}

◆ prepareNeighbor()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::prepareNeighbor ( )

inlinefinaloverridevirtual

Prepare the neighbor element degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 294 of file MooseLinearVariableFV.h.

294 {}

◆ queryParam()

template<typename T >

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

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

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

Definition at line 391 of file MooseBase.h.

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

◆ reinitAux()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::reinitAux ( )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 299 of file MooseLinearVariableFV.h.

299 {}

◆ reinitAuxNeighbor()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::reinitAuxNeighbor ( )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 300 of file MooseLinearVariableFV.h.

300 {}

◆ reinitNode()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::reinitNode ( )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 296 of file MooseLinearVariableFV.h.

296 {}

◆ reinitNodes()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::reinitNodes ( const std::vector< dof_id_type > & )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 297 of file MooseLinearVariableFV.h.

297 {}

◆ reinitNodesNeighbor()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::reinitNodesNeighbor ( const std::vector< dof_id_type > & )

inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 298 of file MooseLinearVariableFV.h.

298 {}

◆ residualSetup()

template<typename OutputType>

virtual void MooseLinearVariableFV< OutputType >::residualSetup ( )

inlineoverridevirtual

Reimplemented from MooseVariableField< OutputType >.

Definition at line 278 of file MooseLinearVariableFV.h.

278 {}

◆ scalingFactor() [1/2]

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

inherited

Set the scaling factor for this variable.

Definition at line 235 of file MooseVariableBase.C.

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

◆ scalingFactor() [2/2]

Real MooseVariableBase::scalingFactor ( ) const

inlineinherited

Get the scaling factor for this variable.

Definition at line 100 of file MooseVariableBase.h.

Referenced by MooseVariableBase::MooseVariableBase().

100 { return _scaling_factor[0]; }

MooseVariableBase::_scaling_factor

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition: MooseVariableBase.h:247

◆ secondPhi()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiSecond & MooseLinearVariableFV< OutputType >::secondPhi ( ) const

finaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 659 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement second derivatives for FV");
 }

◆ secondPhiFace()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiSecond & MooseLinearVariableFV< OutputType >::secondPhiFace ( ) const

finaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face.

Implements MooseVariableField< OutputType >.

Definition at line 680 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement second derivatives for FV");
 }

◆ secondPhiFaceNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiSecond & MooseLinearVariableFV< OutputType >::secondPhiFaceNeighbor ( ) const

finaloverridevirtual

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 687 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement second derivatives for FV");
 }

◆ secondPhiNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariablePhiSecond & MooseLinearVariableFV< OutputType >::secondPhiNeighbor ( ) const

finaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element.

Implements MooseVariableField< OutputType >.

Definition at line 694 of file MooseLinearVariableFV.C.

 {
   mooseError("We don't currently implement second derivatives for FV");
 }

◆ setActiveTags()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::setActiveTags ( const std::set< TagID > & vtags )

overridevirtual

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 602 of file MooseLinearVariableFV.C.

 {
   _element_data->setActiveTags(vtags);
   _neighbor_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 714 of file MooseFunctor.h.

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

◆ setDofValue()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::setDofValue	(	const OutputData &	value,
		unsigned	index
	)

overridevirtual

Degree of freedom value setters.

Implements MooseVariableField< OutputType >.

Definition at line 293 of file MooseLinearVariableFV.C.

 {
   _element_data->setDofValue(value, index);
 }

◆ setDofValues()

template<typename OutputType >

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

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 300 of file MooseLinearVariableFV.C.

 {
   _element_data->setDofValues(values);
 }

◆ setLowerDofValues()

template<typename OutputType >

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

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 521 of file MooseLinearVariableFV.C.

 {
   lowerDError();
 }

◆ setNodalValue()

template<typename OutputType>

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

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 546 of file MooseLinearVariableFV.C.

 {
   nodalError();
 }

◆ sizeMatrixTagData()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::sizeMatrixTagData ( )

overridevirtual

Size data structures related to matrix tagging.

Reimplemented from MooseVariableBase.

Definition at line 897 of file MooseLinearVariableFV.C.

 {
   _element_data->sizeMatrixTagData();
 }

◆ sln()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableValue & MooseLinearVariableFV< OutputType >::sln ( ) const

overridevirtual

Returns: the current elemental solution

Implements MooseVariableField< OutputType >.

Definition at line 701 of file MooseLinearVariableFV.C.

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

◆ slnNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableValue & MooseLinearVariableFV< OutputType >::slnNeighbor ( ) const

overridevirtual

Returns: the current neighbor solution

Implements MooseVariableField< OutputType >.

Definition at line 736 of file MooseLinearVariableFV.C.

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

◆ slnOld()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableValue & MooseLinearVariableFV< OutputType >::slnOld ( ) const

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 708 of file MooseLinearVariableFV.C.

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

◆ slnOlder()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableValue & MooseLinearVariableFV< OutputType >::slnOlder ( ) const

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 715 of file MooseLinearVariableFV.C.

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

◆ slnOldNeighbor()

template<typename OutputType >

const MooseLinearVariableFV< OutputType >::FieldVariableValue & MooseLinearVariableFV< OutputType >::slnOldNeighbor ( ) const

overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 743 of file MooseLinearVariableFV.C.

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

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ supportsElemSideQpArg()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::supportsElemSideQpArg ( ) const

inlinefinaloverridevirtual

Whether this functor supports evaluation with ElemSideQpArg.

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

Definition at line 150 of file MooseLinearVariableFV.h.

150 { return false; }

◆ supportsFaceArg()

template<typename OutputType>

virtual bool MooseLinearVariableFV< OutputType >::supportsFaceArg ( ) const

inlinefinaloverridevirtual

Whether this functor supports evaluation with FaceArg.

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

Definition at line 149 of file MooseLinearVariableFV.h.

149 { return true; }

◆ sys() [1/2]

SystemBase& MooseVariableBase::sys ( )

inlineinherited

Get the system this variable is part of.

Definition at line 69 of file MooseVariableBase.h.

69 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:205

◆ sys() [2/2]

const SystemBase& MooseVariableBase::sys ( ) const

inlineinherited

Get the system this variable is part of.

Definition at line 74 of file MooseVariableBase.h.

74 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:205

◆ timeIntegratorError()

template<typename OutputType >

void MooseLinearVariableFV< OutputType >::timeIntegratorError ( ) const

protected

Throw an error when somebody requests time-related data from this variable.

Definition at line 493 of file MooseLinearVariableFV.h.

 {
   mooseError("MooseLinearVariableFV does not support time integration at the moment! The variable "
              "which is causing the issue: ",
              this->name());
 }

◆ timestepSetup()

template<typename OutputType >

void MooseVariableField< OutputType >::timestepSetup ( )

overridevirtualinherited

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

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

Definition at line 52 of file MooseVariableField.C.

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

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

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )

inlineinherited

Definition at line 85 of file MooseVariableBase.h.

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

MooseVariableBase::allDofIndices

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

Get all global dofindices for the variable.

Definition: MooseVariableBase.C:197

◆ 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 89 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 54 of file MooseBase.C.

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

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

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 66 of file MooseBase.C.

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

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

◆ 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 60 of file MooseBase.C.

 {
   return MooseObjectParameterName(getBase(), name(), parameter_name);
 }

◆ useDual()

bool MooseVariableBase::useDual ( ) const

inlineinherited

Get dual mortar option.

Definition at line 79 of file MooseVariableBase.h.

Referenced by MortarConstraintBase::MortarConstraintBase().

79 { return _use_dual; }

MooseVariableBase::_use_dual

bool _use_dual

If dual mortar approach is used.

Definition: MooseVariableBase.h:250

◆ 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 344 of file MooseVariableField.h.

Referenced by Assembly::copyNeighborShapes().

344 { 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 337 of file MooseVariableField.h.

Referenced by Assembly::copyNeighborShapes().

337 { return true; }

◆ usesSecondPhiNeighbor()

template<typename OutputType>

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

inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 157 of file MooseLinearVariableFV.h.

157 { return false; }

◆ validParams()

template<typename OutputType >

InputParameters MooseLinearVariableFV< OutputType >::validParams ( )

static

Definition at line 38 of file MooseLinearVariableFV.C.

 {
   InputParameters params = MooseVariableField<OutputType>::validParams();
   params.set<bool>("fv") = true;
   params.set<MooseEnum>("family") = "MONOMIAL";
   params.set<MooseEnum>("order") = "CONSTANT";
   return params;
 }

◆ vectorTagDofValue()

template<typename OutputType >

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

overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 645 of file MooseLinearVariableFV.C.

 {
   return _element_data->vectorTagDofValue(tag);
 }

◆ vectorTagValue()

template<typename OutputType >

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

overridevirtual

tag values getters

Implements MooseVariableField< OutputType >.

Definition at line 638 of file MooseLinearVariableFV.C.

 {
   return _element_data->vectorTagValue(tag);
 }

Friends And Related Function Documentation

◆ Moose::initDofIndices

template<typename OutputType>

void Moose::initDofIndices	(	MooseLinearVariableFV< OutputType > &	,
		const Elem &
	)

friend

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 412 of file MooseVariableField.h.

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 353 of file MooseBase.h.

◆ _array_var_component_names

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

protectedinherited

Array variable names when the variable is an array variable.

Definition at line 256 of file MooseVariableBase.h.

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

◆ _assembly

Assembly& MooseVariableBase::_assembly

protectedinherited

Assembly data.

Definition at line 229 of file MooseVariableBase.h.

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

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data

protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 214 of file BlockRestrictable.h.

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

◆ _boundary_id_to_bc

template<typename OutputType>

std::unordered_map<BoundaryID, LinearFVBoundaryCondition *> MooseLinearVariableFV< OutputType >::_boundary_id_to_bc

protected

Map for easily accessing the boundary conditions based on the boundary IDs.

We assume that each boundary has one boundary condition only.

Definition at line 202 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::getBoundaryConditionMap().

◆ _cell_gradient

template<typename OutputType>

RealVectorValue MooseLinearVariableFV< OutputType >::_cell_gradient

mutableprotected

Temporary storage for the cell gradient to avoid unnecessary allocations.

Definition at line 185 of file MooseLinearVariableFV.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 244 of file MooseVariableBase.h.

Referenced by MooseVariableFieldBase::componentName(), MooseVariableBase::count(), MooseVariableBase::MooseVariableBase(), and MooseVariableBase::scalingFactor().

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 78 of file SetupInterface.h.

Referenced by PseudoTimestep::execute().

◆ _dof_indices

std::vector<dof_id_type> MooseVariableBase::_dof_indices

protectedinherited

DOF indices.

Definition at line 235 of file MooseVariableBase.h.

Referenced by MooseVariableBase::clearAllDofIndices(), MooseVariableScalar::computeAD(), MooseVariableBase::dofIndices(), 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 232 of file MooseVariableBase.h.

Referenced by MooseVariableBase::dofMap(), MooseVariableScalar::insert(), and MooseVariableScalar::reinit().

◆ _element_data

template<typename OutputType>

std::unique_ptr<MooseVariableDataLinearFV<OutputType> > MooseLinearVariableFV< OutputType >::_element_data

protected

Holder for all the data associated with the "main" element.

The data in this is mainly used by finite element-based loops such as the postprocessor and auxkernel loops

Definition at line 193 of file MooseLinearVariableFV.h.

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

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 50 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), PartitionerAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), 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 208 of file MooseVariableBase.h.

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

◆ _grad_container

template<typename OutputType>

const std::vector<std::unique_ptr<libMesh::NumericVector<libMesh::Number> > >& MooseLinearVariableFV< OutputType >::_grad_container

protected

Pointer to the cell gradients which are stored on the linear system.

Definition at line 188 of file MooseLinearVariableFV.h.

◆ _grad_phi

template<typename OutputType>

const FieldVariablePhiGradient& MooseLinearVariableFV< OutputType >::_grad_phi

private

Definition at line 239 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::gradPhi().

◆ _grad_phi_face

template<typename OutputType>

const FieldVariablePhiGradient& MooseLinearVariableFV< OutputType >::_grad_phi_face

private

Definition at line 241 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::gradPhiFace().

◆ _grad_phi_face_neighbor

template<typename OutputType>

const FieldVariablePhiGradient& MooseLinearVariableFV< OutputType >::_grad_phi_face_neighbor

private

Definition at line 243 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::gradPhiFaceNeighbor().

◆ _grad_phi_neighbor

template<typename OutputType>

const FieldVariablePhiGradient& MooseLinearVariableFV< OutputType >::_grad_phi_neighbor

private

Definition at line 245 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::gradPhiNeighbor().

◆ _index

unsigned int MooseVariableBase::_index

protectedinherited

variable number within MOOSE

Definition at line 214 of file MooseVariableBase.h.

◆ _is_eigen

bool MooseVariableBase::_is_eigen

protectedinherited

Whether or not this variable operates on eigen kernels.

Definition at line 217 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen().

◆ _is_lower_d

bool MooseVariableBase::_is_lower_d

protectedinherited

Whether this variable lives on lower dimensional blocks.

Definition at line 253 of file MooseVariableBase.h.

Referenced by MooseVariableBase::isLowerD(), and MooseVariableBase::MooseVariableBase().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 34 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& MooseVariableBase::_mesh

protectedinherited

mesh the variable is active in

Definition at line 238 of file MooseVariableBase.h.

Referenced by MooseLinearVariableFV< Real >::evaluate(), MooseLinearVariableFV< Real >::evaluateGradient(), and MooseVariableBase::MooseVariableBase().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 359 of file MooseBase.h.

◆ _needs_cell_gradients

template<typename OutputType>

bool MooseLinearVariableFV< OutputType >::_needs_cell_gradients

protected

Boolean to check if this variable needs gradient computations.

Definition at line 182 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::computeCellGradients(), and MooseLinearVariableFV< Real >::needsGradientVectorStorage().

◆ _neighbor_data

template<typename OutputType>

std::unique_ptr<MooseVariableDataLinearFV<OutputType> > MooseLinearVariableFV< OutputType >::_neighbor_data

protected

Holder for all the data associated with the "neighbor" element.

The data in this is mainly used by finite element-based loops such as the postprocessor and auxkernel loops

Definition at line 198 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::MooseLinearVariableFV().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 362 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), GlobalParamsAction::parameters(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _phi

template<typename OutputType>

const FieldVariablePhiValue& MooseLinearVariableFV< OutputType >::_phi

private

Shape functions, only used when we are postprocessing or using this variable in an auxiliary system.

Definition at line 238 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::phi(), and MooseLinearVariableFV< Real >::phiSize().

◆ _phi_face

template<typename OutputType>

const FieldVariablePhiValue& MooseLinearVariableFV< OutputType >::_phi_face

private

Definition at line 240 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::phiFace(), and MooseLinearVariableFV< Real >::phiFaceSize().

◆ _phi_face_neighbor

template<typename OutputType>

const FieldVariablePhiValue& MooseLinearVariableFV< OutputType >::_phi_face_neighbor

private

Definition at line 242 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::phiFaceNeighbor(), and MooseLinearVariableFV< Real >::phiFaceNeighborSize().

◆ _phi_neighbor

template<typename OutputType>

const FieldVariablePhiValue& MooseLinearVariableFV< OutputType >::_phi_neighbor

private

Definition at line 244 of file MooseLinearVariableFV.h.

Referenced by MooseLinearVariableFV< Real >::phiNeighbor(), and MooseLinearVariableFV< Real >::phiNeighborSize().

◆ _scaling_factor

std::vector<Real> MooseVariableBase::_scaling_factor

protectedinherited

scaling factor for this variable

Definition at line 247 of file MooseVariableBase.h.

Referenced by MooseVariableBase::arrayScalingFactor(), MooseVariableBase::initialSetup(), and MooseVariableBase::scalingFactor().

◆ _solution

template<typename OutputType>

const libMesh::NumericVector<libMesh::Number>* const& MooseLinearVariableFV< OutputType >::_solution

private

The current (ghosted) solution.

Note that this needs to be stored as a reference to a pointer because the solution might not exist at the time that this variable is constructed, so we cannot safely dereference at that time

Definition at line 234 of file MooseLinearVariableFV.h.

◆ _subproblem

SubProblem& MooseVariableBase::_subproblem

protectedinherited

Problem this variable is part of.

Definition at line 223 of file MooseVariableBase.h.

Referenced by MooseVariableScalar::computeAD(), and MooseVariableBase::initialSetup().

◆ _sys

SystemBase& MooseVariableBase::_sys

protectedinherited

◆ _sys_num

template<typename OutputType>

const unsigned int MooseLinearVariableFV< OutputType >::_sys_num

protected

Cache the number of the system this variable belongs to.

Definition at line 205 of file MooseLinearVariableFV.h.

◆ _tid

THREAD_ID MooseVariableBase::_tid

protectedinherited

Thread ID.

Definition at line 241 of file MooseVariableBase.h.

Referenced by MooseLinearVariableFV< Real >::MooseLinearVariableFV(), MooseVariableFE< Real >::MooseVariableFE(), MooseVariableFV< Real >::MooseVariableFV(), 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 409 of file MooseVariableField.h.

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 356 of file MooseBase.h.

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

◆ _use_dual

bool MooseVariableBase::_use_dual

protectedinherited

If dual mortar approach is used.

Definition at line 250 of file MooseVariableBase.h.

Referenced by MooseVariableBase::useDual().

◆ _var_kind

Moose::VarKindType MooseVariableBase::_var_kind

protectedinherited

Variable type (see MooseTypes.h)

Definition at line 220 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 211 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 226 of file MooseVariableBase.h.

◆ 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(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ 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(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), 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(), 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().

◆ usingMooseVariableBaseMembers

template<typename OutputType>

MooseLinearVariableFV< OutputType >::usingMooseVariableBaseMembers

protected

Definition at line 179 of file MooseLinearVariableFV.h.

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

include/utils/FVUtils.h
include/variables/MooseLinearVariableFV.h
src/variables/MooseLinearVariableFV.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

template<typename OutputType> class MooseLinearVariableFV< OutputType >

Member Typedef Documentation

◆ DataFileParameterType

◆ DoFValue

◆ DotType

◆ ElemArg

◆ ElemPointArg

◆ ElemQpArg

◆ ElemSideQpArg

◆ FaceArg

◆ FieldVariableCurl

◆ FieldVariableDivergence

◆ FieldVariableGradient

◆ FieldVariablePhiCurl

◆ FieldVariablePhiDivergence

◆ FieldVariablePhiGradient

◆ FieldVariablePhiSecond

◆ FieldVariablePhiValue

◆ FieldVariableSecond

◆ FieldVariableTestCurl

◆ FieldVariableTestDivergence

◆ FieldVariableTestGradient

◆ FieldVariableTestSecond

◆ FieldVariableTestValue

◆ FieldVariableValue

◆ FunctorType

◆ GradientType

◆ NodeArg

◆ OutputData

◆ OutputDivergence

◆ OutputGradient

◆ OutputSecond

◆ OutputShape

◆ OutputShapeDivergence

◆ OutputShapeGradient

◆ OutputShapeSecond

◆ StateArg

◆ ValueType

Constructor & Destructor Documentation

◆ MooseLinearVariableFV()

Member Function Documentation

◆ activeOnSubdomain()

◆ activeOnSubdomains()

◆ activeSubdomains()

◆ adCurlSln()

◆ adCurlSlnNeighbor()

◆ add()

◆ adDofValues()

◆ adDofValuesDot()

◆ adDofValuesNeighbor()

◆ adError()

◆ adGradSln()

◆ adGradSlnDot()

◆ adGradSlnNeighbor()

◆ adGradSlnNeighborDot()

◆ adSecondSln()

◆ adSecondSlnNeighbor()

◆ adSln()

◆ adSlnNeighbor()

◆ adUDot()

◆ adUDotDot()

◆ adUDotDotNeighbor()

◆ adUDotNeighbor()

◆ allDofIndices()

◆ arrayScalingFactor()

◆ arrayVariableComponent()

◆ blockIDs()

◆ blockRestricted()

◆ blocks()

template<typename OutputType>
class MooseLinearVariableFV< OutputType >