https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
MooseVariableFV< OutputType > Class Template Reference

This class provides variable solution values for other classes/objects to bind to when looping over faces or elements. More...

#include <MooseVariableFV.h>

Inheritance diagram for MooseVariableFV< OutputType >:
[legend]

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 FieldVariablePhiValue = typename MooseVariableField< OutputType >::FieldVariablePhiValue
 
using FieldVariablePhiDivergence = typename MooseVariableField< OutputType >::FieldVariablePhiDivergence
 
using FieldVariablePhiGradient = typename MooseVariableField< OutputType >::FieldVariablePhiGradient
 
using FieldVariablePhiSecond = typename MooseVariableField< OutputType >::FieldVariablePhiSecond
 
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 DofValue = typename MooseVariableDataBase< OutputType >::DofValue
 
using DofValues = typename MooseVariableDataBase< OutputType >::DofValues
 
using ADDofValue = typename MooseVariableDataBase< OutputType >::ADDofValue
 
using ADDofValues = typename MooseVariableDataBase< OutputType >::ADDofValues
 
using DataFileParameterType = DataFileName
 The parameter type this interface expects for a data file name.
 
using FunctorType = FunctorBase< Moose::ADType< OutputType >::type >
 
using ValueType = Moose::ADType< OutputType >::type
 
using GradientType = typename FunctorReturnType< Moose::ADType< OutputType >::type, FunctorEvaluationKind::Gradient >::type
 This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).
 
using DotType = ValueType
 

Public Member Functions

 MooseVariableFV (const InputParameters &parameters)
 
virtual bool isFV () const override
 
virtual void prepare () override final
 Prepare the elemental degrees of freedom.
 
virtual void prepareNeighbor () override final
 Prepare the neighbor element degrees of freedom.
 
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.
 
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.
 
virtual std::size_t phiFaceSize () const override final
 Return phiFace size.
 
virtual std::size_t phiNeighborSize () const override final
 Return phiNeighbor size.
 
virtual std::size_t phiFaceNeighborSize () const override final
 Return phiFaceNeighbor size.
 
virtual std::size_t phiLowerSize () const override final
 Return the number of shape functions on the lower dimensional element for this variable.
 
virtual void computeElemValuesFace () override
 Compute values at facial quadrature points.
 
virtual void computeNeighborValuesFace () override
 Compute values at facial quadrature points for the neighbor.
 
virtual void computeNeighborValues () override
 Compute values at quadrature points for the neighbor.
 
virtual void computeLowerDValues () override final
 compute values at quadrature points on the lower dimensional element
 
virtual void computeNodalNeighborValues () override final
 Compute nodal values of this variable in the neighbor.
 
virtual void computeNodalValues () override final
 Compute nodal values of this variable.
 
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)
 
unsigned int numberOfDofs () const override final
 Get the number of local DoFs.
 
virtual unsigned int numberOfDofsNeighbor () override final
 
virtual bool isNodal () const override final
 Is this variable nodal.
 
bool hasDoFsOnNodes () const override final
 Does this variable have DoFs on nodes.
 
libMesh::FEContinuity getContinuity () const override final
 Return the continuity of this variable.
 
virtual bool isNodalDefined () const override final
 Is this variable defined at nodes.
 
virtual void setNodalValue (const OutputType &value) override
 
virtual void setDofValue (const DofValue &value, unsigned int index) override
 Degree of freedom value setters.
 
void clearDofIndices () override
 Clear out the dof indices.
 
virtual void prepareIC () override
 Prepare the initial condition.
 
virtual const Elem *const & currentElem () const override
 Current element this variable is evaluated at.
 
virtual void getDofIndices (const Elem *elem, std::vector< dof_id_type > &dof_indices) const override
 
virtual const std::vector< dof_id_type > & dofIndices () const final
 Get local DoF indices.
 
virtual const std::vector< dof_id_type > & dofIndicesNeighbor () const final
 Get neighbor DOF indices for currently selected element.
 
Moose::FV::InterpMethod faceInterpolationMethod () const
 
void clearAllDofIndices () final
 
const DofValues & nodalVectorTagValue (TagID) const override
 
const DofValues & nodalMatrixTagValue (TagID) const override
 
const FieldVariableValue & vectorTagValue (TagID tag) const override
 tag values getters
 
const DofValues & vectorTagDofValue (TagID tag) const override
 
const FieldVariableValue & matrixTagValue (TagID tag) const override
 
const FieldVariableValue & vectorTagValueNeighbor (TagID tag)
 
const FieldVariableValue & matrixTagValueNeighbor (TagID tag)
 
const FieldVariableValue & uDot () const
 
const FieldVariableValue & sln () const override
 
const FieldVariableValue & slnOld () const override
 
const FieldVariableValue & slnOlder () const override
 
const FieldVariableGradient & gradSln () const override
 element gradients
 
const FieldVariableGradient & gradSlnOld () const override
 
const FieldVariableValue & uDotNeighbor () const
 
const FieldVariableValue & slnNeighbor () const override
 
const FieldVariableValue & slnOldNeighbor () const override
 
const FieldVariableGradient & gradSlnNeighbor () const override
 neighbor solution gradients
 
const FieldVariableGradient & gradSlnOldNeighbor () const override
 
const VariableValue & duDotDu () const
 
const VariableValue & duDotDotDu () const
 
const VariableValue & duDotDuNeighbor () const
 
const VariableValue & duDotDotDuNeighbor () const
 
const ADTemplateVariableValue< OutputType > & adSln () const override
 AD.
 
const ADTemplateVariableGradient< OutputType > & adGradSln () const override
 AD grad solution getter.
 
virtual const VectorValue< ADReal > & adGradSln (const Elem *const elem, const StateArg &state, const bool correct_skewness=false) const
 Retrieve (or potentially compute) the gradient on the provided element.
 
virtual VectorValue< ADReal > adGradSln (const FaceInfo &fi, const StateArg &state, const bool correct_skewness=false) const
 Retrieve (or potentially compute) a cross-diffusion-corrected gradient on the provided face.
 
virtual VectorValue< ADReal > uncorrectedAdGradSln (const FaceInfo &fi, const StateArg &state, const bool correct_skewness=false) const
 Retrieve (or potentially compute) the uncorrected gradient on the provided face.
 
ADReal getBoundaryFaceValue (const FaceInfo &fi, const StateArg &state, bool correct_skewness=false) const
 Retrieve the solution value at a boundary face.
 
const ADTemplateVariableSecond< OutputType > & adSecondSln () const override
 AD second solution getter.
 
const ADTemplateVariableValue< OutputType > & adUDot () const override
 AD time derivative getter.
 
const ADTemplateVariableValue< OutputType > & adUDotDot () const override
 AD second time derivative getter.
 
const ADTemplateVariableGradient< OutputType > & adGradSlnDot () const override
 AD grad of time derivative solution getter.
 
const ADTemplateVariableCurl< OutputType > & adCurlSln () const override
 AD curl solution getter.
 
const ADTemplateVariableValue< OutputType > & adSlnNeighbor () const override
 neighbor AD
 
const ADTemplateVariableGradient< OutputType > & adGradSlnNeighbor () const override
 AD grad neighbor solution getter.
 
const ADTemplateVariableSecond< OutputType > & adSecondSlnNeighbor () const override
 AD second neighbor solution getter.
 
const ADTemplateVariableValue< OutputType > & adUDotNeighbor () const override
 AD neighbor time derivative getter.
 
const ADTemplateVariableValue< OutputType > & adUDotDotNeighbor () const override
 AD neighbor second time derivative getter.
 
const ADTemplateVariableGradient< OutputType > & adGradSlnNeighborDot () const override
 AD grad of time derivative neighbor solution getter.
 
const ADTemplateVariableCurl< OutputType > & adCurlSlnNeighbor () const override
 AD curl neighbor solution getter.
 
virtual void computeElemValues () override
 Initializes/computes variable values from the solution vectors for the current element being operated on in assembly.
 
virtual void computeFaceValues (const FaceInfo &fi) override
 Initializes/computes variable values from the solution vectors for the face represented by fi.
 
virtual void setDofValues (const DenseVector< DofValue > &values) override
 Set local DOF values and evaluate the values on quadrature points.
 
virtual void setLowerDofValues (const DenseVector< DofValue > &values) override
 Set local DOF values for a lower dimensional element and evaluate the values on quadrature points.
 
DofValue getElementalValue (const Elem *elem, unsigned int idx=0) const
 Get the current value of this variable on an element.
 
DofValue getElementalValueOld (const Elem *elem, unsigned int idx=0) const
 Get the old value of this variable on an element.
 
DofValue getElementalValueOlder (const Elem *elem, unsigned int idx=0) const
 Get the older value of this variable on an element.
 
virtual void insert (libMesh::NumericVector< libMesh::Number > &vector) override
 Insert the currently cached degree of freedom values into the provided vector.
 
virtual void insertLower (libMesh::NumericVector< libMesh::Number > &vector) override
 Insert the currently cached degree of freedom values for a lower-dimensional element into the provided vector.
 
virtual void add (libMesh::NumericVector< libMesh::Number > &vector) override
 Add the currently cached degree of freedom values into the provided vector.
 
const DofValues & dofValues () const override
 dof values getters
 
const DofValues & dofValuesOld () const override
 
const DofValues & dofValuesOlder () const override
 
const DofValues & dofValuesPreviousNL () const override
 
const DofValues & dofValuesNeighbor () const override
 
const DofValues & dofValuesOldNeighbor () const override
 
const DofValues & dofValuesOlderNeighbor () const override
 
const DofValues & dofValuesPreviousNLNeighbor () const override
 
const DofValues & dofValuesDot () const override
 
const DofValues & dofValuesDotNeighbor () const override
 
const DofValues & dofValuesDotOld () const override
 
const DofValues & dofValuesDotOldNeighbor () const override
 
const DofValues & dofValuesDotDot () const override
 
const DofValues & dofValuesDotDotNeighbor () const override
 
const DofValues & dofValuesDotDotOld () const override
 
const DofValues & dofValuesDotDotOldNeighbor () const override
 
const MooseArray< libMesh::Number > & dofValuesDuDotDu () const override
 
const MooseArray< libMesh::Number > & dofValuesDuDotDuNeighbor () const override
 
const MooseArray< libMesh::Number > & dofValuesDuDotDotDu () const override
 
const MooseArray< libMesh::Number > & dofValuesDuDotDotDuNeighbor () const override
 
const ADDofValues & adDofValues () const override
 Return the AD dof values.
 
const ADDofValues & adDofValuesNeighbor () const override
 Return the AD neighbor dof values.
 
const ADDofValues & adDofValuesDot () const override
 Return the AD time derivatives at dofs.
 
OutputType getValue (const Elem *elem) const
 Note: const monomial is always the case - higher order solns are reconstructed - so this is simpler func than FE equivalent.
 
OutputTools< OutputType >::OutputGradient getGradient (const Elem *elem) const
 Compute the variable gradient value at a point on an element.
 
bool hasDirichletBC () const
 Returns true if a Dirichlet BC exists on the current face.
 
std::pair< bool, const FVDirichletBCBase * > getDirichletBC (const FaceInfo &fi) const
 
std::pair< bool, std::vector< const FVFluxBC * > > getFluxBCs (const FaceInfo &fi) const
 
virtual void residualSetup () override
 Gets called just before the residual is computed and before this object is asked to do its job.
 
virtual void initialSetup () override
 Gets called at the beginning of the simulation before this object is asked to do its job.
 
virtual void jacobianSetup () override
 Gets called just before the Jacobian is computed and before this object is asked to do its job.
 
virtual void timestepSetup () override
 Gets called at the beginning of the timestep before this object is asked to do its job.
 
virtual void meshChanged () override
 Called on this object when the mesh changes.
 
ADReal getElemValue (const Elem *elem, const StateArg &state) const
 Get the solution value for the provided element and seed the derivative for the corresponding dof index.
 
void setActiveTags (const std::set< TagID > &vtags) override
 Set the active vector tags.
 
bool supportsQpBasedLoops () const override
 Whether this variable supports QP-indexed loops.
 
bool supportsGeometricInfoBasedLoops () const override
 Whether this variable supports geometric-info-based loops, such as ElemInfo/FaceInfo loops.
 
virtual bool isDirichletBoundaryFace (const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const
 Determine whether a specified face side is a Dirichlet boundary face.
 
bool supportsFaceArg () const override final
 Whether this functor supports evaluation with FaceArg.
 
bool supportsElemSideQpArg () const override final
 Whether this functor supports evaluation with ElemSideQpArg.
 
virtual void sizeMatrixTagData () override
 Size data structures related to matrix tagging.
 
const MooseArray< OutputType > & nodalValueArray () const override
 Methods for retrieving values of variables at the nodes in a MooseArray for AuxKernelBase.
 
const MooseArray< OutputType > & nodalValueOldArray () const override
 
const MooseArray< OutputType > & nodalValueOlderArray () const override
 
bool computingSecond () const override final
 Whether or not this variable is computing any second derivatives.
 
bool computingCurl () const override final
 Whether or not this variable is computing any curl quantities.
 
bool computingDiv () const override final
 Whether or not this variable is computing any divergence quantities.
 
bool usesSecondPhiNeighbor () const override final
 Whether or not this variable is actually using the shape function second derivatives.
 
const FieldVariablePhiValue & phi () const override final
 Return the variable's elemental shape functions.
 
const FieldVariablePhiGradient & gradPhi () const override final
 Return the gradients of the variable's elemental shape functions.
 
const FieldVariablePhiSecond & secondPhi () const override final
 Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.
 
const FieldVariablePhiValue & curlPhi () const override final
 Curl of the shape functions.
 
const FieldVariablePhiDivergence & divPhi () const override final
 Divergence of the shape functions.
 
const FieldVariablePhiValue & phiFace () const override final
 Return the variable's shape functions on an element face.
 
const FieldVariablePhiGradient & gradPhiFace () const override final
 Return the gradients of the variable's shape functions on an element face.
 
const FieldVariablePhiSecond & secondPhiFace () const override final
 Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face.
 
const FieldVariablePhiValue & phiFaceNeighbor () const override final
 Return the variable's shape functions on a neighboring element face.
 
const FieldVariablePhiGradient & gradPhiFaceNeighbor () const override final
 Return the gradients of the variable's shape functions on a neighboring element face.
 
const FieldVariablePhiSecond & secondPhiFaceNeighbor () const override final
 Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element face.
 
const FieldVariablePhiValue & phiNeighbor () const override final
 Return the variable's shape functions on a neighboring element.
 
const FieldVariablePhiGradient & gradPhiNeighbor () const override final
 Return the gradients of the variable's shape functions on a neighboring element.
 
const FieldVariablePhiSecond & secondPhiNeighbor () const override final
 Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element.
 
virtual const FieldVariablePhiValue & phiLower () const override
 Return the variable's shape functions on a lower-dimensional element.
 
unsigned int oldestSolutionStateRequested () const override final
 The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc).
 
virtual ADReal getExtrapolatedBoundaryFaceValue (const FaceInfo &fi, bool two_term_expansion, bool correct_skewness, const Elem *elem_side_to_extrapolate_from, const StateArg &state) const
 Retrieves an extrapolated boundary value for the provided face.
 
const bool & getTwoTermBoundaryExpansion () const
 Function to get wether two term boundary expansion is used for the variable.
 
virtual Moose::VarFieldType fieldType () const override
 Field type of this variable.
 
virtual bool isArray () const override
 
virtual bool isVector () const override
 
bool usesPhiNeighbor () const
 Whether or not this variable is actually using the shape function value.
 
bool usesGradPhiNeighbor () const
 Whether or not this variable is actually using the shape function gradient.
 
bool hasBlocks (const SubdomainName &name) const
 Test if the supplied block name is valid for this object.
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 Test if the supplied vector of block names are valid for this object.
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 Test if the supplied set of block names are valid for this object.
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 Test if the supplied vector block ids are valid for this object.
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 Test if the supplied set of block ids are valid for this object.
 
const std::string & componentName (const unsigned int comp) const
 Get the variable name of a component in libMesh.
 
virtual bool needsGradientVectorStorage () const
 Check if this variable needs a raw vector of gradients at dof-values.
 
virtual void requireQpComputations () const
 Request that quadrature point data be (pre)computed.
 
const std::string & arrayVariableComponent (const unsigned int i) const
 Returns the variable name of a component of an array variable.
 
unsigned int number () const
 Get variable number coming from libMesh.
 
const libMesh::FEType & feType () const
 Get the type of finite element object.
 
SystemBase & sys ()
 Get the system this variable is part of.
 
const SystemBase & sys () const
 Get the system this variable is part of.
 
const std::set< SubdomainID > & activeSubdomains () const
 The subdomains the variable is active on.
 
bool activeOnSubdomain (SubdomainID subdomain) const
 Is the variable active on the subdomain?
 
bool activeOnSubdomains (const std::set< SubdomainID > &subdomains) const
 Is the variable active on the subdomains?
 
bool useDual () const
 Get dual mortar option.
 
const std::vector< dof_id_type > & allDofIndices () const
 Get all global dofindices for the variable.
 
unsigned int totalVarDofs ()
 
Moose::VarKindType kind () const
 Kind of the variable (Nonlinear, Auxiliary, ...)
 
void scalingFactor (const std::vector< Real > &factor)
 Set the scaling factor for this variable.
 
Real scalingFactor () const
 Get the scaling factor for this variable.
 
const std::vector< Real > & arrayScalingFactor () const
 
libMesh::Order order () const
 Get the order of this variable Note: Order enum can be implicitly converted to unsigned int.
 
unsigned int count () const
 Get the number of components Note: For standard and vector variables, the number is one.
 
const libMesh::DofMap & dofMap () const
 The DofMap associated with the system this variable is in.
 
std::vector< dof_id_type > componentDofIndices (const std::vector< dof_id_type > &dof_indices, unsigned int component) const
 Obtain DoF indices of a component with the indices of the 0th component.
 
bool eigen () const
 Whether or not this variable operates on an eigen kernel.
 
void eigen (bool eigen)
 Mark this variable as an eigen var or non-eigen var.
 
virtual bool enabled () const
 Return the enabled status of the object.
 
std::shared_ptr< MooseObject > getSharedPtr ()
 Get another shared pointer to this object that has the same ownership group.
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.
 
MooseApp & getMooseApp () const
 Get the MooseApp this class is associated with.
 
const std::string & type () const
 Get the type of this class.
 
const std::string & name () const
 Get the name of the class.
 
std::string typeAndName () const
 Get the class's combined type and name; useful in error handling.
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 Get the parameters of the object.
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
template<typename T >
const T & getParam (const std::string &name) const
 Retrieve a parameter for the object.
 
template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 Retrieve two parameters and provide pair of parameters for the object.
 
template<typename T >
const T * queryParam (const std::string &name) const
 Query a parameter for the object.
 
template<typename T >
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 Retrieve a renamed parameter for the object.
 
template<typename T >
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 Verifies that the requested parameter exists and is not NULL and returns it to the caller.
 
bool isParamValid (const std::string &name) const
 Test if the supplied parameter is valid.
 
bool isParamSetByUser (const std::string &name) const
 Test if the supplied parameter is set by a user, as opposed to not set or set to default.
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 Connect controllable parameter of this action with the controllable parameters of the objects added by this action.
 
template<typename... Args>
void paramError (const std::string &param, Args... args) const
 Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.
 
template<typename... Args>
void paramWarning (const std::string &param, Args... args) const
 Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.
 
template<typename... Args>
void paramWarning (const std::string &param, Args... args) const
 
template<typename... Args>
void paramInfo (const std::string &param, Args... args) const
 Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 Deprecated message prefix; the error type is no longer used.
 
template<typename... Args>
void mooseError (Args &&... args) const
 Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.
 
template<typename... Args>
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
template<typename... Args>
void mooseErrorNonPrefixed (Args &&... args) const
 Emits an error without the prefixing included in mooseError().
 
template<typename... Args>
void mooseWarning (Args &&... args) const
 Emits a warning prefixed with object name and type.
 
template<typename... Args>
void mooseWarning (Args &&... args) const
 
template<typename... Args>
void mooseWarningNonPrefixed (Args &&... args) const
 Emits a warning without the prefixing included in mooseWarning().
 
template<typename... Args>
void mooseWarningNonPrefixed (Args &&... args) const
 
template<typename... Args>
void mooseDeprecated (Args &&... args) const
 Emits a deprecation warning prefixed with the object name and type, and a stack trace.
 
template<typename... Args>
void mooseDeprecated (Args &&... args) const
 
template<typename... Args>
void mooseDeprecatedNoTrace (Args &&... args) const
 Emits a deprecation warning prefixed with the object name and type, and no stack trace.
 
template<typename... Args>
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 External method for calling moose error with added object context.
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
std::string getDataFileName (const std::string &param) const
 Deprecated method.
 
std::string getDataFileNameByName (const std::string &relative_path) const
 Deprecated method.
 
std::string getDataFilePath (const std::string &relative_path) const
 Returns the path of a data file for a given relative file path.
 
const std::vector< SubdomainName > & blocks () const
 Return the block names for this object.
 
unsigned int numBlocks () const
 Return the number of blocks for this object.
 
virtual const std::set< SubdomainID > & blockIDs () const
 Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids.
 
unsigned int blocksMaxDimension () const
 Return the largest mesh dimension of the elements in the blocks for this object.
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 Test if the class block ids are a subset of the supplied objects.
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 Test if the class block ids are a subset of the supplied objects.
 
template<typename T , bool is_ad = false>
bool hasBlockMaterialProperty (const std::string &prop_name)
 Check if a material property is valid for all blocks of this object.
 
const std::set< SubdomainID > & meshBlockIDs () const
 Return all of the SubdomainIDs for the mesh.
 
virtual bool blockRestricted () const
 Returns true if this object has been restricted to a block.
 
virtual void checkVariable (const MooseVariableBase &variable) const
 Helper for checking that the ids for this object are in agreement with the variables on the supplied variable.
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 Builds hide lists for output objects NOT listed in the 'outputs' parameter.
 
const std::set< OutputName > & getOutputs ()
 Get the list of output objects that this class is restricted.
 
virtual void subdomainSetup ()
 Gets called when the subdomain changes (i.e.
 
virtual void customSetup (const ExecFlagType &)
 Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.
 
virtual void customSetup (const ExecFlagType &exec_type) override
 
const ExecFlagEnum & getExecuteOnEnum () const
 Return the execute on MultiMooseEnum for this object.
 
FunctorReturnType< Moose::ADType< OutputType >::type, FET >::type genericEvaluate (const Space &r, const State &state) const
 Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.
 
const MooseFunctorName & functorName () const
 Return the functor name.
 
void setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
 Set how often to clear the functor evaluation cache.
 
bool isInternalFace (const FaceInfo &) const
 Returns true if the face is an internal face.
 
virtual bool isConstant () const
 Returns true if this functor is a constant.
 
virtual bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
void checkFace (const Moose::FaceArg &face) const
 Examines the incoming face argument.
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 Same as their evaluate overloads with the same arguments but allows for caching implementation.
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 Same as their evaluateGradient overloads with the same arguments but allows for caching implementation.
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 Same as their evaluateDot overloads with the same arguments but allows for caching implementation.
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation.
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static const std::string type_param = "_type"
 The name of the parameter that contains the object type.
 
static const std::string name_param = "_object_name"
 The name of the parameter that contains the object name.
 
static const std::string unique_name_param = "_unique_name"
 The name of the parameter that contains the unique object name.
 
static const std::string app_param = "_moose_app"
 The name of the parameter that contains the MooseApp.
 
static const std::string moose_base_param = "_moose_base"
 The name of the parameter that contains the moose system base.
 
static const std::string kokkos_object_param = "_kokkos_object"
 The name of the parameter that indicates an object is a Kokkos functor.
 

Protected Member Functions

virtual ADReal getDirichletBoundaryFaceValue (const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const
 Retrieves a Dirichlet boundary value for the provided face.
 
bool isExtrapolatedBoundaryFace (const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const override
 Returns whether this is an extrapolated boundary face.
 
void clearCaches ()
 clear finite volume caches
 
const libMesh::NumericVector< libMesh::Number > & getSolution (const Moose::StateArg &state) const
 Get the solution corresponding to the provided state.
 
bool doDerivatives () const
 
template<bool warning>
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 Set solution invalid mark for the given solution ID.
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 An initialization routine needed for dual constructors.
 
void initializeKokkosBlockRestrictable ()
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 Check if the blocks this object operates on all have the same coordinate system, and if so return it.
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockElements () const
 Get the number of elements this Kokkos object is operating on.
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockNodes () const
 Get the number of nodes this Kokkos object is operating on.
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockSides () const
 Get the number of sides this Kokkos object is operating on.
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
 Get the contiguous element ID this Kokkos thread is operating on.
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
 Get the contiguous node index this Kokkos thread is operating on.
 
KOKKOS_FUNCTION auto kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
 Get the contiguous element ID - side index pair this Kokkos thread is operating on.
 
Functor evaluation routines

These methods are all for evaluating functors with different kinds of spatial arguments.

Each of these methods also takes a state argument. For a description of the state argument, please see the StateArg doxygen

virtual GradientType evaluateGradient (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemPointArg &, const StateArg &) const
 Evaluate the functor gradient with a given element and point.
 
virtual GradientType evaluateGradient (const NodeArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemSideQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemPointArg &, const StateArg &) const
 Evaluate the functor time derivative with a given element and point.
 
virtual DotType evaluateDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 Evaluate the functor gradient-dot with a given element.
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 Evaluate the functor gradient-dot with a given element and point.
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 

Protected Attributes

 usingMooseVariableFieldMembers
 
std::unique_ptr< MooseVariableDataFV< OutputType > > _element_data
 Holder for all the data associated with the "main" element.
 
std::unique_ptr< MooseVariableDataFV< OutputType > > _neighbor_data
 Holder for all the data associated with the neighbor element.
 
std::unordered_map< const Elem *, VectorValue< ADReal > > _elem_to_grad
 A cache for storing gradients on elements.
 
bool _two_term_boundary_expansion
 Whether to use a two term expansion for computing boundary face values.
 
VectorValue< ADReal > _temp_cell_gradient
 A member to hold the cell gradient when not caching, used to return a reference (due to expensive ADReal copy)
 
const bool _cache_cell_gradients
 Whether to cache cell gradients.
 
Moose::FV::InterpMethod _face_interp_method
 Decides if an average or skewed corrected average is used for the face interpolation.
 
SystemBase & _sys
 System this variable is part of.
 
libMesh::FEType _fe_type
 The FEType associated with this variable.
 
unsigned int _var_num
 variable number (from libMesh)
 
unsigned int _index
 variable number within MOOSE
 
bool _is_eigen
 Whether or not this variable operates on eigen kernels.
 
Moose::VarKindType _var_kind
 Variable type (see MooseTypes.h)
 
SubProblem & _subproblem
 Problem this variable is part of.
 
const libMesh::Variable & _variable
 libMesh variable object for this variable
 
Assembly & _assembly
 Assembly data.
 
const libMesh::DofMap & _dof_map
 DOF map.
 
std::vector< dof_id_type > _dof_indices
 DOF indices.
 
MooseMesh & _mesh
 mesh the variable is active in
 
THREAD_ID _tid
 Thread ID.
 
const unsigned int _count
 Number of variables in the array.
 
std::vector< Real > _scaling_factor
 scaling factor for this variable
 
bool _use_dual
 If dual mortar approach is used.
 
bool _is_lower_d
 Whether this variable lives on lower dimensional blocks.
 
std::vector< std::string > _array_var_component_names
 Array variable names when the variable is an array variable.
 
const bool & _enabled
 Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.
 
MooseApp & _app
 The MOOSE application this is associated with.
 
Factory & _factory
 The Factory associated with the MooseApp.
 
ActionFactory & _action_factory
 Builds Actions.
 
const std::string & _type
 The type of this class.
 
const std::string & _name
 The name of this class.
 
const InputParameters & _pars
 The object's parameters.
 
const Parallel::Communicator & _communicator
 
const MaterialData * _blk_material_data
 Pointer to the MaterialData class for this object.
 
const ExecFlagEnum & _execute_enum
 Execute settings for this object.
 
const ExecFlagType & _current_execute_flag
 Reference to FEProblemBase.
 
FEProblemBase & _mci_feproblem
 Reference to FEProblemBase instance.
 

Private Member Functions

ValueType evaluate (const ElemArg &elem, const StateArg &) const override final
 Evaluate the functor with a given element.
 
ValueType evaluate (const FaceArg &face, const StateArg &) const override final
 
ValueType evaluate (const NodeArg &node, const StateArg &) const override final
 
ValueType evaluate (const ElemPointArg &elem_point, const StateArg &state) const override final
 Evaluate the functor with a given element and point.
 
ValueType evaluate (const ElemQpArg &elem_qp, const StateArg &state) const override final
 
ValueType evaluate (const ElemSideQpArg &elem_side_qp, const StateArg &state) const override final
 
GradientType evaluateGradient (const ElemQpArg &qp_arg, const StateArg &) const override final
 
GradientType evaluateGradient (const ElemArg &elem_arg, const StateArg &) const override final
 Evaluate the functor gradient with a given element.
 
GradientType evaluateGradient (const FaceArg &face, const StateArg &) const override final
 
DotType evaluateDot (const ElemArg &elem, const StateArg &) const override final
 Evaluate the functor time derivative with a given element.
 
DotType evaluateDot (const FaceArg &face, const StateArg &) const override final
 
DotType evaluateDot (const ElemQpArg &elem_qp, const StateArg &) const override final
 
void determineBoundaryToDirichletBCMap ()
 Setup the boundary to Dirichlet BC map.
 
void determineBoundaryToFluxBCMap ()
 Setup the boundary to Flux BC map.
 
void lowerDError () const
 Emit an error message for unsupported lower-d ops.
 
void clearCacheData ()
 clear cache data
 
ValueType queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Moose::ADType< OutputType >::type > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
 check a qp cache and if invalid then evaluate
 
ValueType queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
 check a finite volume spatial argument cache and if invalid then evaluate
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 Internal method for getting a hit node (if available) given a set of parameters.
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 Internal method for getting the message prefix for an object (object type, name, etc).
 

Private Attributes

bool _dirichlet_map_setup = false
 Whether the boundary to Dirichlet cache map has been setup yet.
 
bool _flux_map_setup = false
 Whether the boundary to fluxBC cache map has been setup yet.
 
const libMesh::NumericVector< libMesh::Number > *const & _solution
 The current (ghosted) solution.
 
const FieldVariablePhiValue & _phi
 Shape functions.
 
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
 
const Elem * _prev_elem
 A member used to help determine when we can return cached data as opposed to computing new data.
 
std::unordered_map< BoundaryID, const FVDirichletBCBase * > _boundary_id_to_dirichlet_bc
 Map from boundary ID to Dirichlet boundary conditions.
 
std::unordered_map< BoundaryID, std::vector< const FVFluxBC * > > _boundary_id_to_flux_bc
 Map from boundary ID to flux boundary conditions.
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 The MooseBase that owns this interface.
 
const FEProblemBase * _si_problem
 A pointer to FEProblem base.
 
std::set< SubdomainID > _blk_ids
 Set of block ids supplied by the user via the input file (for error checking)
 
std::vector< SubdomainID > _vec_ids
 Vector of block ids supplied by the user via the input file (for error reporting)
 
std::vector< SubdomainName > _blocks
 Vector the block names supplied by the user via the input file.
 
const bool _blk_dual_restrictable
 Flag for allowing dual restriction.
 
FEProblemBase * _blk_feproblem
 Pointer to FEProblemBase.
 
const MooseMesh * _blk_mesh
 Pointer to Mesh.
 
const std::set< BoundaryID > _empty_boundary_ids
 An empty set for referencing when boundary_ids is not included.
 
const std::set< BoundaryID > & _boundary_ids
 Reference to the boundary_ids, defaults to an empty set if not provided.
 
THREAD_ID _blk_tid
 Thread id for this object.
 
const std::string & _blk_name
 Name of the object.
 
unsigned int _blk_dim
 Largest mesh dimension of the elements in the blocks for this object.
 
const MooseObject * _moose_object
 Pointer to the MOOSE object.
 
Moose::Kokkos::Array< ContiguousElementID > _kokkos_element_ids
 List of contiguous element IDs this Kokkos object is operating on.
 
Moose::Kokkos::Array< ContiguousNodeID > _kokkos_node_ids
 List of contiguous node IDs this Kokkos object is operating on.
 
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > > _kokkos_element_side_ids
 List of contiguous local element ID - side index pairs this Kokkos object is operating on.
 
MooseApp & _oi_moose_app
 Reference the the MooseApp; neede for access to the OutputWarehouse.
 
OutputWarehouse & _oi_output_warehouse
 Reference to the OutputWarehouse for populating the Output object hide lists.
 
std::set< OutputName > _oi_outputs
 The set of Output object names listed in the 'outputs' parameter.
 
ExecFlagEnum _empty_execute_enum
 Empty ExecFlagEnum for the case when the "execute_on" parameter is not included.
 
std::set< ExecFlagType > _clearance_schedule
 How often to clear the material property cache.
 
bool _always_evaluate
 Boolean to check if we always need evaluation.
 
dof_id_type _current_qp_map_key
 Current key for qp map cache.
 
std::vector< std::pair< bool, ValueType > > * _current_qp_map_value
 Current value for qp map cache.
 
std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > > _qp_to_value
 Cached element quadrature point functor property evaluations.
 
dof_id_type _current_side_qp_map_key
 Current key for side-qp map cache.
 
std::vector< std::vector< std::pair< bool, ValueType > > > * _current_side_qp_map_value
 Current value for side-qp map cache.
 
std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > > _side_qp_to_value
 Cached element quadrature point functor property evaluations.
 
std::map< ElemArg, ValueType > _elem_arg_to_value
 Map from element arguments to their cached evaluations.
 
std::map< FaceArg, ValueType > _face_arg_to_value
 Map from face arguments to their cached evaluations.
 
std::map< NodeArg, ValueType > _node_arg_to_value
 Map from nodal arguments to their cached evaluations.
 
MooseFunctorName _functor_name
 name of the functor
 

Friends

void Moose::initDofIndices (MooseVariableFV< OutputType > &, const Elem &)
 
const TimeIntegrator *const _time_integrator
 the time integrator used for computing time derivatives
 
ADReal _ad_real_dummy = 0
 A dummy ADReal variable.
 
template<bool is_ad>
const MooseArray< GenericReal< is_ad > > & genericDofValues () const
 
bool hasBlocks (const SubdomainID id) const override
 Returns whether the functor is defined on this block.
 

Detailed Description

template<typename OutputType>
class MooseVariableFV< OutputType >

This class provides variable solution values for other classes/objects to bind to when looping over faces or elements.

It provides both elem and neighbor values when accessed in flux/face object calculations. The templating is to enable support for both vector and scalar variables. Gradient reconstruction (when enabled) occurs transparently within this class and kernels coupling to these values will naturally "see" according to the selected reconstruction methods.

OutputType OutputShape DofValue

Real Real Real RealVectorValue RealVectorValue Real RealEigenVector Real RealEigenVector

Definition at line 52 of file MooseVariableFV.h.

Member Typedef Documentation

◆ ADDofValue

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

Definition at line 83 of file MooseVariableField.h.

◆ ADDofValues

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

Definition at line 84 of file MooseVariableField.h.

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName
inherited

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

Definition at line 27 of file DataFileInterface.h.

◆ DofValue

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

Definition at line 81 of file MooseVariableField.h.

◆ DofValues

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

Definition at line 82 of file MooseVariableField.h.

◆ DotType

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

Definition at line 150 of file MooseFunctor.h.

◆ ElemArg

template<typename OutputType >
using MooseVariableFV< OutputType >::ElemArg = Moose::ElemArg

Definition at line 83 of file MooseVariableFV.h.

◆ ElemPointArg

template<typename OutputType >
using MooseVariableFV< OutputType >::ElemPointArg = Moose::ElemPointArg

Definition at line 87 of file MooseVariableFV.h.

◆ ElemQpArg

template<typename OutputType >
using MooseVariableFV< OutputType >::ElemQpArg = Moose::ElemQpArg

Definition at line 81 of file MooseVariableFV.h.

◆ ElemSideQpArg

template<typename OutputType >
using MooseVariableFV< OutputType >::ElemSideQpArg = Moose::ElemSideQpArg

Definition at line 82 of file MooseVariableFV.h.

◆ FaceArg

template<typename OutputType >
using MooseVariableFV< OutputType >::FaceArg = Moose::FaceArg

Definition at line 84 of file MooseVariableFV.h.

◆ FieldVariableCurl

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariableCurl = typename MooseVariableField<OutputType>::FieldVariableCurl

Definition at line 62 of file MooseVariableFV.h.

◆ FieldVariableDivergence

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariableDivergence = typename MooseVariableField<OutputType>::FieldVariableDivergence

Definition at line 63 of file MooseVariableFV.h.

◆ FieldVariableGradient

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariableGradient = typename MooseVariableField<OutputType>::FieldVariableGradient

Definition at line 60 of file MooseVariableFV.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 MooseVariableFV< OutputType >::FieldVariablePhiDivergence = typename MooseVariableField<OutputType>::FieldVariablePhiDivergence

Definition at line 76 of file MooseVariableFV.h.

◆ FieldVariablePhiGradient

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariablePhiGradient = typename MooseVariableField<OutputType>::FieldVariablePhiGradient

Definition at line 78 of file MooseVariableFV.h.

◆ FieldVariablePhiSecond

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariablePhiSecond = typename MooseVariableField<OutputType>::FieldVariablePhiSecond

Definition at line 80 of file MooseVariableFV.h.

◆ FieldVariablePhiValue

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariablePhiValue = typename MooseVariableField<OutputType>::FieldVariablePhiValue

Definition at line 75 of file MooseVariableFV.h.

◆ FieldVariableSecond

template<typename OutputType >
using MooseVariableFV< OutputType >::FieldVariableSecond = typename MooseVariableField<OutputType>::FieldVariableSecond

Definition at line 61 of file MooseVariableFV.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 MooseVariableFV< OutputType >::FieldVariableValue = typename MooseVariableField<OutputType>::FieldVariableValue

Definition at line 59 of file MooseVariableFV.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 MooseVariableFV< OutputType >::NodeArg = Moose::NodeArg

Definition at line 86 of file MooseVariableFV.h.

◆ OutputDivergence

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputDivergence = typename MooseVariableField<OutputType>::OutputDivergence

Definition at line 57 of file MooseVariableFV.h.

◆ OutputGradient

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputGradient = typename MooseVariableField<OutputType>::OutputGradient

Definition at line 55 of file MooseVariableFV.h.

◆ OutputSecond

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputSecond = typename MooseVariableField<OutputType>::OutputSecond

Definition at line 56 of file MooseVariableFV.h.

◆ OutputShape

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputShape = typename MooseVariableField<OutputType>::OutputShape

Definition at line 65 of file MooseVariableFV.h.

◆ OutputShapeDivergence

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputShapeDivergence = typename MooseVariableField<OutputType>::OutputShapeDivergence

Definition at line 68 of file MooseVariableFV.h.

◆ OutputShapeGradient

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputShapeGradient = typename MooseVariableField<OutputType>::OutputShapeGradient

Definition at line 66 of file MooseVariableFV.h.

◆ OutputShapeSecond

template<typename OutputType >
using MooseVariableFV< OutputType >::OutputShapeSecond = typename MooseVariableField<OutputType>::OutputShapeSecond

Definition at line 67 of file MooseVariableFV.h.

◆ StateArg

template<typename OutputType >
using MooseVariableFV< OutputType >::StateArg = Moose::StateArg

Definition at line 85 of file MooseVariableFV.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

◆ MooseVariableFV()

template<typename OutputType >
MooseVariableFV< OutputType >::MooseVariableFV ( const InputParameters &  parameters)

Definition at line 77 of file MooseVariableFV.C.

80 _phi(this->_assembly.template fePhi<OutputShape>(this->_fe_type)),
81 _grad_phi(this->_assembly.template feGradPhi<OutputShape>(this->_fe_type)),
82 _phi_face(this->_assembly.template fePhiFace<OutputShape>(this->_fe_type)),
83 _grad_phi_face(this->_assembly.template feGradPhiFace<OutputShape>(this->_fe_type)),
84 _phi_face_neighbor(this->_assembly.template fePhiFaceNeighbor<OutputShape>(this->_fe_type)),
86 this->_assembly.template feGradPhiFaceNeighbor<OutputShape>(this->_fe_type)),
87 _phi_neighbor(this->_assembly.template fePhiNeighbor<OutputShape>(this->_fe_type)),
88 _grad_phi_neighbor(this->_assembly.template feGradPhiNeighbor<OutputShape>(this->_fe_type)),
89 _prev_elem(nullptr),
90 _two_term_boundary_expansion(this->isParamValid("two_term_boundary_expansion")
91 ? this->template getParam<bool>("two_term_boundary_expansion")
92 : true),
93 _cache_cell_gradients(this->isParamValid("cache_cell_gradients")
94 ? this->template getParam<bool>("cache_cell_gradients")
95 : true)
96{
97 _element_data = std::make_unique<MooseVariableDataFV<OutputType>>(
99 _neighbor_data = std::make_unique<MooseVariableDataFV<OutputType>>(
101
102 if (this->isParamValid("face_interp_method"))
103 {
104 const auto & interp_method = this->template getParam<MooseEnum>("face_interp_method");
105 if (interp_method == "average")
107 else if (interp_method == "skewness-corrected")
109 }
110 else
112}
const Elem *const & elem() const
Return the current element.
Definition Assembly.h:405
const Elem *const & neighbor() const
Return the neighbor element.
Definition Assembly.h:461
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition MooseBase.h:406
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition MooseBase.h:199
THREAD_ID _tid
Thread ID.
Assembly & _assembly
Assembly data.
SystemBase & _sys
System this variable is part of.
const FieldVariablePhiValue & _phi
Shape functions.
std::unique_ptr< MooseVariableDataFV< OutputType > > _element_data
Holder for all the data associated with the "main" element.
const Elem * _prev_elem
A member used to help determine when we can return cached data as opposed to computing new data.
Moose::FV::InterpMethod _face_interp_method
Decides if an average or skewed corrected average is used for the face interpolation.
const FieldVariablePhiGradient & _grad_phi
const FieldVariablePhiGradient & _grad_phi_face_neighbor
const FieldVariablePhiGradient & _grad_phi_face
const FieldVariablePhiValue & _phi_face_neighbor
bool _two_term_boundary_expansion
Whether to use a two term expansion for computing boundary face values.
const FieldVariablePhiValue & _phi_neighbor
std::unique_ptr< MooseVariableDataFV< OutputType > > _neighbor_data
Holder for all the data associated with the neighbor element.
const FieldVariablePhiValue & _phi_face
const bool _cache_cell_gradients
Whether to cache cell gradients.
const libMesh::NumericVector< libMesh::Number > *const & _solution
The current (ghosted) solution.
const FieldVariablePhiGradient & _grad_phi_neighbor
Class for stuff related to variables.
virtual const NumericVector< Number > *const & currentSolution() const =0
The solution vector that is currently being operated on.
@ SkewCorrectedAverage
(gc*elem+(1-gc)*neighbor)+gradient*(rf-rf')
@ Average
gc*elem+(1-gc)*neighbor

Member Function Documentation

◆ activeOnSubdomain()

bool MooseVariableBase::activeOnSubdomain ( SubdomainID  subdomain) const
inherited

Is the variable active on the subdomain?

Parameters
subdomainThe subdomain id in question
Returns
true if active on subdomain, false otherwise

Definition at line 240 of file MooseVariableBase.C.

241{
242 return this->_sys.system().variable(_var_num).active_on_subdomain(subdomain);
243}
unsigned int _var_num
variable number (from libMesh)
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const Variable & variable(unsigned int var) const
bool active_on_subdomain(subdomain_id_type sid) const

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

◆ activeOnSubdomains()

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

Is the variable active on the subdomains?

Parameters
subdomainsThe subdomain ids in question
Returns
true if active on all provided subdomains, false otherwise

Definition at line 246 of file MooseVariableBase.C.

247{
248 const auto & active_subs = activeSubdomains();
249 return std::includes(
250 active_subs.begin(), active_subs.end(), subdomains.begin(), subdomains.end());
251}
const std::set< SubdomainID > & activeSubdomains() const
The subdomains the variable is active on.

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

◆ activeSubdomains()

const std::set< SubdomainID > & MooseVariableBase::activeSubdomains ( ) const
inherited

◆ adCurlSln()

template<typename OutputType >
const ADTemplateVariableCurl< OutputType > & MooseVariableFV< OutputType >::adCurlSln ( ) const
inlineoverridevirtual

AD curl solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 342 of file MooseVariableFV.h.

343 {
344 mooseError("We don't currently implement curl for FV");
345 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application.
Definition MooseError.h:311

◆ adCurlSlnNeighbor()

template<typename OutputType >
const ADTemplateVariableCurl< OutputType > & MooseVariableFV< OutputType >::adCurlSlnNeighbor ( ) const
inlineoverridevirtual

AD curl neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 372 of file MooseVariableFV.h.

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

◆ add()

template<typename OutputType >
void MooseVariableFV< 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 158 of file MooseVariableFV.C.

159{
160 _element_data->add(residual);
161}

◆ adDofValues()

template<typename OutputType >
const MooseVariableFV< OutputType >::ADDofValues & MooseVariableFV< OutputType >::adDofValues ( ) const
inlineoverridevirtual

Return the AD dof values.

Implements MooseVariableField< OutputType >.

Definition at line 748 of file MooseVariableFV.h.

749{
750 return _element_data->adDofValues();
751}

◆ adDofValuesDot()

template<typename OutputType >
const MooseVariableFV< OutputType >::ADDofValues & MooseVariableFV< OutputType >::adDofValuesDot ( ) const
inlineoverridevirtual

Return the AD time derivatives at dofs.

Implements MooseVariableField< OutputType >.

Definition at line 762 of file MooseVariableFV.h.

763{
764 return _element_data->adDofValuesDot();
765}

◆ adDofValuesNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::ADDofValues & MooseVariableFV< OutputType >::adDofValuesNeighbor ( ) const
inlineoverridevirtual

Return the AD neighbor dof values.

Implements MooseVariableField< OutputType >.

Definition at line 755 of file MooseVariableFV.h.

756{
757 return _neighbor_data->adDofValues();
758}

◆ adGradSln() [1/3]

template<typename OutputType >
const ADTemplateVariableGradient< OutputType > & MooseVariableFV< OutputType >::adGradSln ( ) const
inlineoverridevirtual

◆ adGradSln() [2/3]

template<typename OutputType >
const VectorValue< ADReal > & MooseVariableFV< OutputType >::adGradSln ( const Elem *const  elem,
const StateArg &  state,
const bool  correct_skewness = false 
) const
virtual

Retrieve (or potentially compute) the gradient on the provided element.

Overriders of this method cannot call getBoundaryFaceValue because that method itself may lead to a call to adGradSln(const Elem * const) resulting in infinite recursion

Parameters
elemThe element for which to retrieve the gradient
stateState argument which describes at what time / solution iteration state we want to evaluate the variable
correct_skewnessWhether to perform skew corrections
Returns
The gradient at the element centroid

Definition at line 587 of file MooseVariableFV.C.

590{
591 // We ensure that no caching takes place when we compute skewness-corrected
592 // quantities.
593 if (_cache_cell_gradients && !correct_skewness && state.state == 0)
594 {
595 auto it = _elem_to_grad.find(elem);
596
597 if (it != _elem_to_grad.end())
598 return it->second;
599 }
600
601 auto grad = FV::greenGaussGradient(
602 ElemArg({elem, correct_skewness}), state, *this, _two_term_boundary_expansion, this->_mesh);
603
604 if (_cache_cell_gradients && !correct_skewness && state.state == 0)
605 {
606 auto pr = _elem_to_grad.emplace(elem, std::move(grad));
607 mooseAssert(pr.second, "Insertion should have just happened.");
608 return pr.first->second;
609 }
610 else
611 {
612 _temp_cell_gradient = std::move(grad);
613 return _temp_cell_gradient;
614 }
615}
MooseMesh & _mesh
mesh the variable is active in
std::unordered_map< const Elem *, VectorValue< ADReal > > _elem_to_grad
A cache for storing gradients on elements.
Moose::ElemArg ElemArg
VectorValue< ADReal > _temp_cell_gradient
A member to hold the cell gradient when not caching, used to return a reference (due to expensive ADR...
libMesh::VectorValue< T > greenGaussGradient(const ElemArg &elem_arg, const StateArg &state_arg, const FunctorBase< T > &functor, const bool two_term_boundary_expansion, const MooseMesh &mesh, const bool force_green_gauss=false)
Compute a cell gradient using the method of Green-Gauss.
unsigned int state
The state.

◆ adGradSln() [3/3]

template<typename OutputType >
VectorValue< ADReal > MooseVariableFV< OutputType >::adGradSln ( const FaceInfo &  fi,
const StateArg &  state,
const bool  correct_skewness = false 
) const
virtual

Retrieve (or potentially compute) a cross-diffusion-corrected gradient on the provided face.

"Correcting" the face gradient involves weighting the gradient stencil more heavily on the solution values on the face-neighbor cells than a linear interpolation between cell center gradients does

Parameters
faceThe face for which to retrieve the gradient.
stateState argument which describes at what time / solution iteration state we want to evaluate the variable
correct_skewnessWhether to perform skew corrections

Definition at line 651 of file MooseVariableFV.C.

654{
655 const bool var_defined_on_elem = this->hasBlocks(fi.elem().subdomain_id());
656 const Elem * const elem = &fi.elem();
657 const Elem * const neighbor = fi.neighborPtr();
658
659 const bool is_internal_face = this->isInternalFace(fi);
660
661 const ADReal side_one_value = (!is_internal_face && !var_defined_on_elem)
662 ? getBoundaryFaceValue(fi, state, correct_skewness)
663 : getElemValue(elem, state);
664 const ADReal side_two_value = (var_defined_on_elem && !is_internal_face)
665 ? getBoundaryFaceValue(fi, state, correct_skewness)
666 : getElemValue(neighbor, state);
667
668 const auto delta =
669 this->isInternalFace(fi)
670 ? fi.dCNMag()
671 : (fi.faceCentroid() - (var_defined_on_elem ? fi.elemCentroid() : fi.neighborCentroid()))
672 .norm();
673
674 // This is the component of the gradient which is parallel to the line connecting
675 // the cell centers. Therefore, we can use our second order, central difference
676 // scheme to approximate it.
677 auto face_grad = ((side_two_value - side_one_value) / delta) * fi.eCN();
678
679 // We only need non-orthogonal correctors in 2+ dimensions
680 if (this->_mesh.dimension() > 1)
681 {
682 // We are using an orthogonal approach for the non-orthogonal correction, for more information
683 // see Hrvoje Jasak's PhD Thesis (Imperial College, 1996)
684 const auto & interpolated_gradient = uncorrectedAdGradSln(fi, state, correct_skewness);
685 face_grad += interpolated_gradient - (interpolated_gradient * fi.eCN()) * fi.eCN();
686 }
687
688 return face_grad;
689}
const Point & eCN() const
Definition FaceInfo.h:155
const Elem & elem() const
Definition FaceInfo.h:85
const Elem * neighborPtr() const
Definition FaceInfo.h:88
Real dCNMag() const
Definition FaceInfo.h:148
const Point & neighborCentroid() const
Definition FaceInfo.h:247
const Point & elemCentroid() const
Returns the element centroids of the elements on the elem and neighbor sides of the face.
Definition FaceInfo.h:99
const Point & faceCentroid() const
Returns the coordinates of the face centroid.
Definition FaceInfo.h:75
virtual unsigned int dimension() const
Returns MeshBase::mesh_dimension(), (not MeshBase::spatial_dimension()!) of the underlying libMesh me...
Definition MooseMesh.C:2949
virtual VectorValue< ADReal > uncorrectedAdGradSln(const FaceInfo &fi, const StateArg &state, const bool correct_skewness=false) const
Retrieve (or potentially compute) the uncorrected gradient on the provided face.
ADReal getElemValue(const Elem *elem, const StateArg &state) const
Get the solution value for the provided element and seed the derivative for the corresponding dof ind...
ADReal getBoundaryFaceValue(const FaceInfo &fi, const StateArg &state, bool correct_skewness=false) const
Retrieve the solution value at a boundary face.
bool hasBlocks(const SubdomainID id) const override
Returns whether the functor is defined on this block.
bool isInternalFace(const FaceInfo &) const
Returns true if the face is an internal face.

◆ adGradSlnDot()

template<typename OutputType >
const ADTemplateVariableGradient< OutputType > & MooseVariableFV< OutputType >::adGradSlnDot ( ) const
inlineoverridevirtual

AD grad of time derivative solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 338 of file MooseVariableFV.h.

339 {
340 return _element_data->adGradSlnDot();
341 }

◆ adGradSlnNeighbor()

template<typename OutputType >
const ADTemplateVariableGradient< OutputType > & MooseVariableFV< OutputType >::adGradSlnNeighbor ( ) const
inlineoverridevirtual

AD grad neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 352 of file MooseVariableFV.h.

353 {
354 return _neighbor_data->adGradSln();
355 }

◆ adGradSlnNeighborDot()

template<typename OutputType >
const ADTemplateVariableGradient< OutputType > & MooseVariableFV< OutputType >::adGradSlnNeighborDot ( ) const
inlineoverridevirtual

AD grad of time derivative neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 368 of file MooseVariableFV.h.

369 {
370 return _neighbor_data->adGradSlnDot();
371 }

◆ adSecondSln()

template<typename OutputType >
const ADTemplateVariableSecond< OutputType > & MooseVariableFV< OutputType >::adSecondSln ( ) const
inlineoverridevirtual

AD second solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 326 of file MooseVariableFV.h.

327 {
328 return _element_data->adSecondSln();
329 }

◆ adSecondSlnNeighbor()

template<typename OutputType >
const ADTemplateVariableSecond< OutputType > & MooseVariableFV< OutputType >::adSecondSlnNeighbor ( ) const
inlineoverridevirtual

AD second neighbor solution getter.

Implements MooseVariableField< OutputType >.

Definition at line 356 of file MooseVariableFV.h.

357 {
358 return _neighbor_data->adSecondSln();
359 }

◆ adSln()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adSln ( ) const
inlineoverridevirtual

AD.

Implements MooseVariableField< OutputType >.

Definition at line 264 of file MooseVariableFV.h.

265 {
266 return _element_data->adSln();
267 }

◆ adSlnNeighbor()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adSlnNeighbor ( ) const
inlineoverridevirtual

neighbor AD

Implements MooseVariableField< OutputType >.

Definition at line 348 of file MooseVariableFV.h.

349 {
350 return _neighbor_data->adSln();
351 }

◆ adUDot()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adUDot ( ) const
inlineoverridevirtual

AD time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 330 of file MooseVariableFV.h.

331 {
332 return _element_data->adUDot();
333 }

◆ adUDotDot()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adUDotDot ( ) const
inlineoverridevirtual

AD second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 334 of file MooseVariableFV.h.

335 {
336 return _element_data->adUDotDot();
337 }

◆ adUDotDotNeighbor()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adUDotDotNeighbor ( ) const
inlineoverridevirtual

AD neighbor second time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 364 of file MooseVariableFV.h.

365 {
366 return _neighbor_data->adUDotDot();
367 }

◆ adUDotNeighbor()

template<typename OutputType >
const ADTemplateVariableValue< OutputType > & MooseVariableFV< OutputType >::adUDotNeighbor ( ) const
inlineoverridevirtual

AD neighbor time derivative getter.

Implements MooseVariableField< OutputType >.

Definition at line 360 of file MooseVariableFV.h.

361 {
362 return _neighbor_data->adUDot();
363 }

◆ allDofIndices()

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

Get all global dofindices for the variable.

Definition at line 150 of file MooseVariableBase.C.

151{
152 const auto it = _sys.subproblem()._var_dof_map.find(name());
153 if (it != _sys.subproblem()._var_dof_map.end())
154 return it->second;
155 else
156 mooseError("VariableAllDoFMap not prepared for ",
157 name(),
158 " . Check nonlocal coupling requirement for the variable.");
159}
const std::string & name() const
Get the name of the class.
Definition MooseBase.h:103
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type and optionally a file path to the top-level block p...
Definition MooseBase.h:271
std::map< std::string, std::vector< dof_id_type > > _var_dof_map
Definition SubProblem.h:682
SubProblem & subproblem()
Definition SystemBase.h:102

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

◆ arrayScalingFactor()

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

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

142{
143 mooseAssert(
145 "Requested array variable component number is greater than the number of component names.");
147}
std::vector< std::string > _array_var_component_names
Array variable names when the variable is an array variable.

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

◆ blockIDs()

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

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

Returns
a set of SubdomainIDs that are valid for this object

Definition at line 209 of file BlockRestrictable.C.

210{
211 if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
212 return _blk_mesh->meshSubdomains();
213 else
214 return _blk_ids;
215}
std::set< SubdomainID > _blk_ids
Set of block ids supplied by the user via the input file (for error checking)
const MooseMesh * _blk_mesh
Pointer to Mesh.
const std::set< SubdomainID > & meshSubdomains() const
Returns a read-only reference to the set of subdomains currently present in the Mesh.
Definition MooseMesh.C:3235
const SubdomainID ANY_BLOCK_ID
Definition MooseTypes.C:19

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

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const
virtualinherited

◆ blocks()

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

Return the block names for this object.

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

Returns
vector of SubdomainNames that are valid for this object

Definition at line 203 of file BlockRestrictable.C.

204{
205 return _blocks;
206}
std::vector< SubdomainName > _blocks
Vector the block names supplied by the user via the input file.

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

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const
inherited

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

Definition at line 386 of file BlockRestrictable.C.

387{
388 mooseAssert(_blk_dim != libMesh::invalid_uint, "Block restriction not initialized");
389 return _blk_dim;
390}
unsigned int _blk_dim
Largest mesh dimension of the elements in the blocks for this object.
const unsigned int invalid_uint

◆ 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_namesA set of variables for which the 'outputs' parameter controls

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

Definition at line 68 of file OutputInterface.C.

69{
70 // Set of available names
71 const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();
72
73 // Check for 'none'; hide variables on all outputs
74 if (_oi_outputs.find("none") != _oi_outputs.end())
75 for (const auto & name : avail)
76 _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
77
78 // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
79 // these cases
80 else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
81 return;
82
83 // Limit the variable output to Output objects listed
84 else
85 {
86 // Create a list of outputs where the variable should be hidden
87 std::set<OutputName> hide;
88 std::set_difference(avail.begin(),
89 avail.end(),
90 _oi_outputs.begin(),
91 _oi_outputs.end(),
92 std::inserter(hide, hide.begin()));
93
94 // If 'outputs' is specified add the object name to the list of items to hide
95 for (const auto & name : hide)
96 _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
97 }
98}
OutputWarehouse & _oi_output_warehouse
Reference to the OutputWarehouse for populating the Output object hide lists.
std::set< OutputName > _oi_outputs
The set of Output object names listed in the 'outputs' parameter.
const std::set< OutputName > & getOutputNames()
Get a complete set of all output object names.
std::string name(const ElemQuality q)

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

◆ callMooseError() [1/2]

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

External method for calling moose error with added object context.

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

Parameters
appThe app pointer (if available); adds multiapp context and clears the console
paramsThe parameters, needed to obtain object information
msgThe message
with_prefixIf true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
nodeOptional hit node to add file path context as a prefix
show_traceWhether or not to show a stack trace, defaults to true

Definition at line 114 of file MooseBase.C.

120{
121 if (!node)
122 node = MooseBase::getHitNode(params);
123
124 std::string multiapp_prefix = "";
125 if (app)
126 {
127 if (!app->isUltimateMaster())
128 multiapp_prefix = app->name();
130 }
131
132 if (with_prefix)
133 // False here because the hit context will get processed by the node
134 msg = messagePrefix(params, false) + msg;
135
136 moose::internal::mooseErrorRaw(msg, multiapp_prefix, node, show_trace);
137}
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
Definition MooseApp.C:2414
bool isUltimateMaster() const
Whether or not this app is the ultimate master app.
Definition MooseApp.h:866
const hit::Node * getHitNode() const
Definition MooseBase.h:136
std::string messagePrefix(const bool hit_prefix=true) const
Definition MooseBase.h:256
void mooseConsole()
Send current output buffer to Console output objects.
void mooseErrorRaw(std::string msg, const std::string &prefix="", const hit::Node *node=nullptr, const bool show_trace=true)
Main callback for emitting a moose error.
Definition MooseError.C:51

◆ callMooseError() [2/2]

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

External method for calling moose error with added object context.

Parameters
msgThe message
with_prefixIf true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
nodeOptional hit node to add file path context as a prefix
show_traceWhether or not to show a stack trace, defaults to true

Definition at line 105 of file MooseBase.C.

109{
110 callMooseError(&_app, _pars, msg, with_prefix, node, show_trace);
111}
MooseApp & _app
The MOOSE application this is associated with.
Definition MooseBase.h:375
void callMooseError(std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
External method for calling moose error with added object context.
Definition MooseBase.C:105
const InputParameters & _pars
The object's parameters.
Definition MooseBase.h:384

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

◆ checkFace()

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

Examines the incoming face argument.

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

Parameters
faceThe face argument created by the face argument producer, likely a residual object
Returns
A face with possibly changed sidedness depending on whether we aren't defined on both sides of the face

Definition at line 280 of file MooseFunctor.h.

743{
744#if DEBUG
745 const Elem * const elem = face.face_side;
746 const FaceInfo * const fi = face.fi;
747 mooseAssert(fi, "face info should be non-null");
748 bool check_elem_def = false;
749 bool check_neighbor_def = false;
750 // We check if the functor is defined on both sides of the face
751 if (!elem)
752 {
753 if (!hasFaceSide(*fi, true))
754 check_neighbor_def = true;
755 else if (!hasFaceSide(*fi, false))
756 check_elem_def = true;
757 }
758 else if (elem == fi->elemPtr())
759 check_elem_def = true;
760 else
761 {
762 mooseAssert(elem == fi->neighborPtr(), "This has to match something");
763 check_neighbor_def = true;
764 }
765
766 if (check_elem_def && !hasFaceSide(*fi, true))
767 {
768 std::string additional_message = "It is not defined on the neighbor side either.";
769 if (hasFaceSide(*fi, false))
770 additional_message = "It is however defined on the neighbor side.";
771 additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
772 mooseError(_functor_name,
773 " is not defined on the element side of the face information, but a face argument "
774 "producer "
775 "(e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
776 additional_message);
777 }
778 if (check_neighbor_def && !hasFaceSide(*fi, false))
779 {
780 std::string additional_message = "It is not defined on the element side either.";
781 if (hasFaceSide(*fi, true))
782 additional_message = "It is however defined on the element side.";
783 additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
785 _functor_name,
786 " is not defined on the neighbor side of the face information, but a face argument "
787 "producer (e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
788 additional_message);
789 }
790#endif
791}
This data structure is used to store geometric and variable related metadata about each cell face in ...
Definition FaceInfo.h:38
const Elem * elemPtr() const
Definition FaceInfo.h:86
virtual bool hasFaceSide(const FaceInfo &fi, const bool fi_elem_side) const override
std::string stringify(const T &t)
conversion to string
Definition Conversion.h:65
const libMesh::Elem * face_side
A member that can be used to indicate whether there is a sidedness to this face.
const FaceInfo * fi
a face information object which defines our location in space

◆ checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableBase &  variable) const
virtualinherited

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

Parameters
variableThe variable to check against.

Reimplemented in DomainUserObject.

Definition at line 358 of file BlockRestrictable.C.

359{
360 // a variable defined on all internal sides does not need this check because
361 // it can be coupled with other variables in DG kernels
362 if (!_blk_mesh->interiorLowerDBlocks().empty() &&
364 return;
365
366 if (!isBlockSubset(variable.activeSubdomains()))
367 {
368 std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
369 std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
370 mooseError("The 'block' parameter of the object '",
371 _blk_name,
372 "' must be a subset of the 'block' parameter of the variable '",
373 variable.name(),
374 "':\n Object '",
375 _blk_name,
376 "': ",
377 obj_ids,
378 "\n Variable '",
379 variable.name(),
380 "': ",
381 var_ids);
382 }
383}
bool isBlockSubset(const std::set< SubdomainID > &ids) const
Test if the class block ids are a subset of the supplied objects.
const std::string & _blk_name
Name of the object.
const std::set< SubdomainID > & meshBlockIDs() const
Return all of the SubdomainIDs for the mesh.
virtual bool blockRestricted() const
Returns true if this object has been restricted to a block.
const std::set< SubdomainID > & interiorLowerDBlocks() const
Definition MooseMesh.h:1550
bool activeOnSubdomains(const std::set< SubdomainID > &subdomains) const
Is the variable active on the subdomains?

Referenced by DomainUserObject::checkVariable().

◆ clearAllDofIndices()

template<typename OutputType >
void MooseVariableFV< OutputType >::clearAllDofIndices ( )
finalvirtual

Reimplemented from MooseVariableBase.

Definition at line 729 of file MooseVariableFV.C.

730{
731 _element_data->clearDofIndices();
732 _neighbor_data->clearDofIndices();
733}

◆ clearCacheData()

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

clear cache data

Definition at line 500 of file MooseFunctor.h.

796{
797 for (auto & map_pr : _qp_to_value)
798 for (auto & pr : map_pr.second)
799 pr.first = false;
800
801 for (auto & map_pr : _side_qp_to_value)
802 {
803 auto & side_vector = map_pr.second;
804 for (auto & qp_vector : side_vector)
805 for (auto & pr : qp_vector)
806 pr.first = false;
807 }
808
810 _current_qp_map_value = nullptr;
813
814 _elem_arg_to_value.clear();
815 _face_arg_to_value.clear();
816 _node_arg_to_value.clear();
817}
for(PetscInt i=0;i< nvars;++i)
dof_id_type _current_qp_map_key
Current key for qp map cache.
std::map< ElemArg, ValueType > _elem_arg_to_value
Map from element arguments to their cached evaluations.
std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > > _qp_to_value
Cached element quadrature point functor property evaluations.
std::map< FaceArg, ValueType > _face_arg_to_value
Map from face arguments to their cached evaluations.
std::vector< std::vector< std::pair< bool, ValueType > > > * _current_side_qp_map_value
Current value for side-qp map cache.
std::map< NodeArg, ValueType > _node_arg_to_value
Map from nodal arguments to their cached evaluations.
std::vector< std::pair< bool, ValueType > > * _current_qp_map_value
Current value for qp map cache.
dof_id_type _current_side_qp_map_key
Current key for side-qp map cache.
std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > > _side_qp_to_value
Cached element quadrature point functor property evaluations.
static constexpr dof_id_type invalid_id

◆ clearCaches()

template<typename OutputType >
void MooseVariableFV< OutputType >::clearCaches ( )
protected

clear finite volume caches

Definition at line 712 of file MooseVariableFV.C.

713{
714 _elem_to_grad.clear();
715}

◆ clearDofIndices()

template<typename OutputType >
void MooseVariableFV< 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 116 of file MooseVariableFV.C.

117{
118 _element_data->clearDofIndices();
119}

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

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

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

◆ componentName()

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

Get the variable name of a component in libMesh.

Definition at line 25 of file MooseVariableFieldBase.C.

26{
27 if (comp >= _count)
28 mooseError("componentName(): Component index is not less than the number of components");
29 if (isArray())
30 return this->arrayVariableComponent(comp);
31 else
32 return name();
33}
virtual bool isArray() const
const std::string & arrayVariableComponent(const unsigned int i) const
Returns the variable name of a component of an array variable.
const unsigned int _count
Number of variables in the array.

◆ computeElemValues()

template<typename OutputType >
void MooseVariableFV< OutputType >::computeElemValues ( )
overridevirtual

Initializes/computes variable values from the solution vectors for the current element being operated on in assembly.

This must be called every time the current element (as defined by the assembly data structure changes in order for objects that bind to sln, adSln, uDot, etc. to be updated/correct.

Implements MooseVariableFieldBase.

Definition at line 312 of file MooseVariableFV.C.

313{
314 _element_data->setGeometry(Moose::Volume);
315 _element_data->computeValues();
316}

◆ computeElemValuesFace()

template<typename OutputType >
void MooseVariableFV< OutputType >::computeElemValuesFace ( )
overridevirtual

Compute values at facial quadrature points.

Implements MooseVariableFieldBase.

Definition at line 320 of file MooseVariableFV.C.

321{
322 _element_data->setGeometry(Moose::Face);
323 _element_data->computeValues();
324}

◆ computeFaceValues()

template<typename OutputType >
void MooseVariableFV< OutputType >::computeFaceValues ( const FaceInfo &  fi)
overridevirtual

Initializes/computes variable values from the solution vectors for the face represented by fi.

This includes initializing data for elements on both sides of the face (elem and neighbor) and handles the case where there is no element on one side of the face gracefully - i.e. you call this uniformly for every face regardless of whether you are on a boundary or not - or whether the variable is only defined on one side of the face or not.

Reimplemented from MooseVariableFieldBase.

Definition at line 344 of file MooseVariableFV.C.

345{
346 _element_data->setGeometry(Moose::Face);
347 _neighbor_data->setGeometry(Moose::Face);
348
349 const auto facetype = fi.faceType(std::make_pair(this->number(), this->sys().number()));
351 return;
352 else if (facetype == FaceInfo::VarFaceNeighbors::BOTH)
353 {
354 _element_data->computeValuesFace(fi);
355 _neighbor_data->computeValuesFace(fi);
356 }
357 else if (facetype == FaceInfo::VarFaceNeighbors::ELEM)
358 _element_data->computeValuesFace(fi);
359 else if (facetype == FaceInfo::VarFaceNeighbors::NEIGHBOR)
360 _neighbor_data->computeValuesFace(fi);
361 else
362 mooseError("robert wrote broken MooseVariableFV code");
363}
VarFaceNeighbors faceType(const std::pair< unsigned int, unsigned int > &var_sys) const
Returns which side(s) the given variable-system number pair is defined on for this face.
Definition FaceInfo.h:229
SystemBase & sys()
Get the system this variable is part of.
unsigned int number() const
Get variable number coming from libMesh.

◆ computeLowerDValues()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::computeLowerDValues ( )
inlinefinaloverridevirtual

compute values at quadrature points on the lower dimensional element

Implements MooseVariableFieldBase.

Definition at line 137 of file MooseVariableFV.h.

138 {
139 // mooseError("computeLowerDValues not supported by MooseVariableFVBase");
140 }

◆ computeNeighborValues()

template<typename OutputType >
void MooseVariableFV< OutputType >::computeNeighborValues ( )
overridevirtual

Compute values at quadrature points for the neighbor.

Implements MooseVariableFieldBase.

Definition at line 336 of file MooseVariableFV.C.

337{
338 _neighbor_data->setGeometry(Moose::Volume);
339 _neighbor_data->computeValues();
340}

◆ computeNeighborValuesFace()

template<typename OutputType >
void MooseVariableFV< OutputType >::computeNeighborValuesFace ( )
overridevirtual

Compute values at facial quadrature points for the neighbor.

Implements MooseVariableFieldBase.

Definition at line 328 of file MooseVariableFV.C.

329{
330 _neighbor_data->setGeometry(Moose::Face);
331 _neighbor_data->computeValues();
332}

◆ computeNodalNeighborValues()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::computeNodalNeighborValues ( )
inlinefinaloverridevirtual

Compute nodal values of this variable in the neighbor.

Implements MooseVariableFieldBase.

Definition at line 141 of file MooseVariableFV.h.

142 {
143 // mooseError("computeNodalNeighborValues not supported by MooseVariableFVBase");
144 }

◆ computeNodalValues()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::computeNodalValues ( )
inlinefinaloverridevirtual

Compute nodal values of this variable.

Implements MooseVariableFieldBase.

Definition at line 145 of file MooseVariableFV.h.

146 {
147 // mooseError("computeNodalValues not supported by MooseVariableFVBase");
148 }

◆ computingCurl()

template<typename OutputType >
bool MooseVariableFV< OutputType >::computingCurl ( ) const
inlinefinaloverridevirtual

Whether or not this variable is computing any curl quantities.

Implements MooseVariableField< OutputType >.

Definition at line 594 of file MooseVariableFV.h.

594{ return false; }

◆ computingDiv()

template<typename OutputType >
bool MooseVariableFV< OutputType >::computingDiv ( ) const
inlinefinaloverridevirtual

Whether or not this variable is computing any divergence quantities.

Implements MooseVariableField< OutputType >.

Definition at line 595 of file MooseVariableFV.h.

595{ return false; }

◆ computingSecond()

template<typename OutputType >
bool MooseVariableFV< OutputType >::computingSecond ( ) const
inlinefinaloverridevirtual

Whether or not this variable is computing any second derivatives.

Implements MooseVariableField< OutputType >.

Definition at line 593 of file MooseVariableFV.h.

593{ 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
parameterName of the controllable parameter of this action
object_typeType of the object added by this action.
object_nameName of the object added by this action.
object_parameterName of the parameter of the object.

Definition at line 77 of file MooseBase.C.

81{
82 auto & factory = _app.getFactory();
83 auto & ip_warehouse = _app.getInputParameterWarehouse();
84
85 MooseObjectParameterName primary_name(uniqueName(), parameter);
86 const auto base_type = factory.getValidParams(object_type).getBase();
87 MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
88 ip_warehouse.addControllableParameterConnection(primary_name, secondary_name);
89
90 const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
91 for (const auto & tag : tags)
92 {
93 if (!tag.empty())
94 {
95 // Only adds the parameter with the different control tags if the derived class
96 // properly registers the parameter to its own syntax
97 MooseObjectParameterName tagged_name(tag, name(), parameter);
98 ip_warehouse.addControllableParameterConnection(
99 tagged_name, secondary_name, /*error_on_empty=*/false);
100 }
101 }
102}
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
Factory & getFactory()
Retrieve a writable reference to the Factory associated with this App.
Definition MooseApp.h:407
InputParameterWarehouse & getInputParameterWarehouse()
Get the InputParameterWarehouse for MooseObjects.
Definition MooseApp.C:2872
MooseObjectName uniqueName() const
Definition MooseBase.C:69
A class for storing an input parameter name.

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

133{ return _count; }

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

◆ curlPhi()

template<typename OutputType >
const FieldVariablePhiValue & MooseVariableFV< OutputType >::curlPhi ( ) const
inlinefinaloverridevirtual

Curl of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 604 of file MooseVariableFV.h.

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

◆ currentElem()

template<typename OutputType >
virtual const Elem *const & MooseVariableFV< OutputType >::currentElem ( ) const
inlineoverridevirtual

Current element this variable is evaluated at.

Implements MooseVariableFieldBase.

Definition at line 177 of file MooseVariableFV.h.

177{ return _element_data->currentElem(); }

◆ customSetup() [1/2]

virtual void SetupInterface::customSetup ( const ExecFlagType &  )
inlinevirtualinherited

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

Reimplemented in Function.

Definition at line 69 of file SetupInterface.h.

69{}

◆ customSetup() [2/2]

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

Implements Moose::FunctorAbstract.

Definition at line 233 of file MooseFunctor.h.

846{
847 if (_clearance_schedule.count(exec_type))
849}
std::set< ExecFlagType > _clearance_schedule
How often to clear the material property cache.

◆ determineBoundaryToDirichletBCMap()

template<typename OutputType >
void MooseVariableFV< OutputType >::determineBoundaryToDirichletBCMap ( )
private

Setup the boundary to Dirichlet BC map.

Definition at line 868 of file MooseVariableFV.C.

869{
870 mooseAssert(!Threads::in_threads,
871 "This routine has not been implemented for threads. Please query this routine before "
872 "a threaded region or contact a MOOSE developer to discuss.");
873
875 std::vector<FVDirichletBCBase *> bcs;
876
877 // I believe because query() returns by value but condition returns by reference that binding to a
878 // const lvalue reference results in the query() getting destructed and us holding onto a dangling
879 // reference. I think that condition returned by value we would be able to bind to a const lvalue
880 // reference here. But as it is we'll bind to a regular lvalue
881 const auto base_query = this->_subproblem.getMooseApp()
882 .theWarehouse()
883 .query()
884 .template condition<AttribSystem>("FVDirichletBC")
885 .template condition<AttribThread>(_tid)
886 .template condition<AttribVar>(_var_num)
887 .template condition<AttribSysNum>(this->_sys.number());
888
889 for (const auto bnd_id : this->_mesh.getBoundaryIDs())
890 {
891 auto base_query_copy = base_query;
892 base_query_copy.template condition<AttribBoundaries>(std::set<BoundaryID>({bnd_id}))
893 .queryInto(bcs);
894 mooseAssert(bcs.size() <= 1, "cannot have multiple dirichlet BCs on the same boundary");
895 if (!bcs.empty())
896 _boundary_id_to_dirichlet_bc.emplace(bnd_id, bcs[0]);
897 }
898
900}
TheWarehouse & theWarehouse()
Definition MooseApp.h:143
MooseApp & getMooseApp() const
Get the MooseApp this class is associated with.
Definition MooseBase.h:87
SubProblem & _subproblem
Problem this variable is part of.
bool _dirichlet_map_setup
Whether the boundary to Dirichlet cache map has been setup yet.
std::unordered_map< BoundaryID, const FVDirichletBCBase * > _boundary_id_to_dirichlet_bc
Map from boundary ID to Dirichlet boundary conditions.
unsigned int number() const
Gets the number of this system.
Query query()
query creates and returns an initialized a query object for querying objects from the warehouse.
std::vector< BoundaryID > getBoundaryIDs(const libMesh::MeshBase &mesh, const std::vector< BoundaryName > &boundary_name, bool generate_unknown, const std::set< BoundaryID > &mesh_boundary_ids)
Gets the boundary IDs with their names.

◆ determineBoundaryToFluxBCMap()

template<typename OutputType >
void MooseVariableFV< OutputType >::determineBoundaryToFluxBCMap ( )
private

Setup the boundary to Flux BC map.

Definition at line 904 of file MooseVariableFV.C.

905{
906 mooseAssert(!Threads::in_threads,
907 "This routine has not been implemented for threads. Please query this routine before "
908 "a threaded region or contact a MOOSE developer to discuss.");
909
911 std::vector<const FVFluxBC *> bcs;
912
913 // I believe because query() returns by value but condition returns by reference that binding to a
914 // const lvalue reference results in the query() getting destructed and us holding onto a dangling
915 // reference. I think that condition returned by value we would be able to bind to a const lvalue
916 // reference here. But as it is we'll bind to a regular lvalue
917 const auto base_query = this->_subproblem.getMooseApp()
918 .theWarehouse()
919 .query()
920 .template condition<AttribSystem>("FVFluxBC")
921 .template condition<AttribThread>(_tid)
922 .template condition<AttribVar>(_var_num)
923 .template condition<AttribSysNum>(this->_sys.number());
924
925 for (const auto bnd_id : this->_mesh.getBoundaryIDs())
926 {
927 auto base_query_copy = base_query;
928 base_query_copy.template condition<AttribBoundaries>(std::set<BoundaryID>({bnd_id}))
929 .queryInto(bcs);
930 if (!bcs.empty())
931 _boundary_id_to_flux_bc.emplace(bnd_id, bcs);
932 }
933
934 _flux_map_setup = true;
935}
std::unordered_map< BoundaryID, std::vector< const FVFluxBC * > > _boundary_id_to_flux_bc
Map from boundary ID to flux boundary conditions.
bool _flux_map_setup
Whether the boundary to fluxBC cache map has been setup yet.

◆ divPhi()

template<typename OutputType >
const FieldVariablePhiDivergence & MooseVariableFV< OutputType >::divPhi ( ) const
inlinefinaloverridevirtual

Divergence of the shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 608 of file MooseVariableFV.h.

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

◆ doDerivatives()

bool MooseVariableBase::doDerivatives ( ) const
protectedinherited
Returns
whether we should insert derivatives

◆ dofIndices()

template<typename OutputType >
virtual const std::vector< dof_id_type > & MooseVariableFV< OutputType >::dofIndices ( ) const
inlinefinalvirtual

◆ dofIndicesLower()

template<typename OutputType >
const std::vector< dof_id_type > & MooseVariableFV< 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 839 of file MooseVariableFV.h.

840{
841 static const std::vector<dof_id_type> empty;
842 return empty;
843}

◆ dofIndicesNeighbor()

template<typename OutputType >
virtual const std::vector< dof_id_type > & MooseVariableFV< OutputType >::dofIndicesNeighbor ( ) const
inlinefinalvirtual

Get neighbor DOF indices for currently selected element.

Returns
the neighbor degree of freedom indices

Implements MooseVariableFieldBase.

Definition at line 189 of file MooseVariableFV.h.

190 {
191 return _neighbor_data->dofIndices();
192 }

Referenced by FVInterfaceKernel::addResidualAndJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), and FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian().

◆ dofMap()

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

The DofMap associated with the system this variable is in.

Definition at line 170 of file MooseVariableBase.h.

170{ return _dof_map; }
const libMesh::DofMap & _dof_map
DOF map.

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

◆ dofValues()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValues ( ) const
overridevirtual

dof values getters

Implements MooseVariableField< OutputType >.

Definition at line 165 of file MooseVariableFV.C.

166{
167 return _element_data->dofValues();
168}

◆ dofValuesDot()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDot ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 221 of file MooseVariableFV.C.

222{
223 return _element_data->dofValuesDot();
224}

◆ dofValuesDotDot()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotDot ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 228 of file MooseVariableFV.C.

229{
230 return _element_data->dofValuesDotDot();
231}

◆ dofValuesDotDotNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotDotNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 256 of file MooseVariableFV.C.

257{
258 return _neighbor_data->dofValuesDotDot();
259}

◆ dofValuesDotDotOld()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotDotOld ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 242 of file MooseVariableFV.C.

243{
244 return _element_data->dofValuesDotDotOld();
245}

◆ dofValuesDotDotOldNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotDotOldNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 270 of file MooseVariableFV.C.

271{
272 return _neighbor_data->dofValuesDotDotOld();
273}

◆ dofValuesDotNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 249 of file MooseVariableFV.C.

250{
251 return _neighbor_data->dofValuesDot();
252}

◆ dofValuesDotOld()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotOld ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 235 of file MooseVariableFV.C.

236{
237 return _element_data->dofValuesDotOld();
238}

◆ dofValuesDotOldNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesDotOldNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 263 of file MooseVariableFV.C.

264{
265 return _neighbor_data->dofValuesDotOld();
266}

◆ dofValuesDuDotDotDu()

template<typename OutputType >
const MooseArray< Number > & MooseVariableFV< OutputType >::dofValuesDuDotDotDu ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 284 of file MooseVariableFV.C.

285{
286 return _element_data->dofValuesDuDotDotDu();
287}

◆ dofValuesDuDotDotDuNeighbor()

template<typename OutputType >
const MooseArray< Number > & MooseVariableFV< OutputType >::dofValuesDuDotDotDuNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 298 of file MooseVariableFV.C.

299{
300 return _neighbor_data->dofValuesDuDotDotDu();
301}

◆ dofValuesDuDotDu()

template<typename OutputType >
const MooseArray< Number > & MooseVariableFV< OutputType >::dofValuesDuDotDu ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 277 of file MooseVariableFV.C.

278{
279 return _element_data->dofValuesDuDotDu();
280}

◆ dofValuesDuDotDuNeighbor()

template<typename OutputType >
const MooseArray< Number > & MooseVariableFV< OutputType >::dofValuesDuDotDuNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 291 of file MooseVariableFV.C.

292{
293 return _neighbor_data->dofValuesDuDotDu();
294}

◆ dofValuesNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 193 of file MooseVariableFV.C.

194{
195 return _neighbor_data->dofValues();
196}

◆ dofValuesOld()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesOld ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 172 of file MooseVariableFV.C.

173{
174 return _element_data->dofValuesOld();
175}

◆ dofValuesOlder()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesOlder ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 179 of file MooseVariableFV.C.

180{
181 return _element_data->dofValuesOlder();
182}

◆ dofValuesOlderNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesOlderNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 207 of file MooseVariableFV.C.

208{
209 return _neighbor_data->dofValuesOlder();
210}

◆ dofValuesOldNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesOldNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 200 of file MooseVariableFV.C.

201{
202 return _neighbor_data->dofValuesOld();
203}

◆ dofValuesPreviousNL()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesPreviousNL ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 186 of file MooseVariableFV.C.

187{
188 return _element_data->dofValuesPreviousNL();
189}

◆ dofValuesPreviousNLNeighbor()

template<typename OutputType >
const MooseVariableFV< OutputType >::DofValues & MooseVariableFV< OutputType >::dofValuesPreviousNLNeighbor ( ) const
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 214 of file MooseVariableFV.C.

215{
216 return _neighbor_data->dofValuesPreviousNL();
217}

◆ dot() [1/6]

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

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

These are the methods a user will call in their code

Definition at line 209 of file MooseFunctor.h.

897{
898 return evaluateDot(elem, state);
899}
virtual DotType evaluateDot(const ElemArg &, const StateArg &) const
Evaluate the functor time derivative with a given element.

◆ dot() [2/6]

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

Definition at line 213 of file MooseFunctor.h.

926{
927 return evaluateDot(elem_point, state);
928}

◆ dot() [3/6]

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

Definition at line 211 of file MooseFunctor.h.

912{
913 return evaluateDot(elem_qp, state);
914}

◆ dot() [4/6]

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

Definition at line 212 of file MooseFunctor.h.

919{
920 return evaluateDot(elem_side_qp, state);
921}

◆ dot() [5/6]

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

Definition at line 210 of file MooseFunctor.h.

904{
905 checkFace(face);
906 return evaluateDot(face, state);
907}
void checkFace(const Moose::FaceArg &face) const
Examines the incoming face argument.

◆ dot() [6/6]

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

Definition at line 214 of file MooseFunctor.h.

933{
934 return evaluateDot(node, state);
935}

◆ duDotDotDu()

template<typename OutputType >
const VariableValue & MooseVariableFV< OutputType >::duDotDotDu ( ) const
inline

Definition at line 259 of file MooseVariableFV.h.

259{ return _element_data->duDotDotDu(); }

◆ duDotDotDuNeighbor()

template<typename OutputType >
const VariableValue & MooseVariableFV< OutputType >::duDotDotDuNeighbor ( ) const
inline

Definition at line 261 of file MooseVariableFV.h.

261{ return _neighbor_data->duDotDotDu(); }

◆ duDotDu()

template<typename OutputType >
const VariableValue & MooseVariableFV< OutputType >::duDotDu ( ) const
inline

Definition at line 258 of file MooseVariableFV.h.

258{ return _element_data->duDotDu(); }

◆ duDotDuNeighbor()

template<typename OutputType >
const VariableValue & MooseVariableFV< OutputType >::duDotDuNeighbor ( ) const
inline

Definition at line 260 of file MooseVariableFV.h.

260{ return _neighbor_data->duDotDu(); }

◆ eigen() [1/2]

bool MooseVariableBase::eigen ( ) const
inlineinherited

Whether or not this variable operates on an eigen kernel.

Definition at line 197 of file MooseVariableBase.h.

197{ return _is_eigen; }
bool _is_eigen
Whether or not this variable operates on eigen kernels.

Referenced by EigenProblem::adjustEigenVector().

◆ eigen() [2/2]

void MooseVariableBase::eigen ( bool  eigen)
inlineinherited

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

Definition at line 202 of file MooseVariableBase.h.

202{ _is_eigen = eigen; }
bool eigen() const
Whether or not this variable operates on an eigen kernel.

Referenced by MooseVariableBase::eigen().

◆ enabled()

virtual bool MooseObject::enabled ( ) const
inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 49 of file MooseObject.h.

49{ return _enabled; }
const bool & _enabled
Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.
Definition MooseObject.h:71

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

◆ errorPrefix()

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

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

Definition at line 264 of file MooseBase.h.

264{ return messagePrefix(); }

◆ evaluate() [1/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< 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 769 of file MooseVariableFV.h.

770{
771 return getElemValue(elem_arg.elem, state);
772}

◆ evaluate() [2/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< 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 776 of file MooseVariableFV.h.

777{
778 return (*this)(elem_point.makeElem(), state) +
779 (elem_point.point - elem_point.elem->vertex_average()) *
780 this->gradient(elem_point.makeElem(), state);
781}
GradientType gradient(const ElemArg &elem, const StateArg &state) const
Same as their evaluateGradient overloads with the same arguments but allows for caching implementatio...

◆ evaluate() [3/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< OutputType >::evaluate ( const ElemQpArg &  qp,
const StateArg &  state 
) const
finaloverrideprivatevirtual
Parameters
qpSee the ElemQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor evaluated at the requested state and space

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

Definition at line 785 of file MooseVariableFV.h.

786{
787 return (*this)(ElemPointArg{elem_qp.elem,
788 elem_qp.point,
790 state);
791}
Moose::ElemPointArg ElemPointArg
const Point & point(const unsigned int i) const
const libMesh::Elem * elem

◆ evaluate() [4/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< OutputType >::evaluate ( const ElemSideQpArg &  side_qp,
const StateArg &  state 
) const
finaloverrideprivatevirtual
Parameters
side_qpSee the ElemSideQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor evaluated at the requested state and space

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

Definition at line 795 of file MooseVariableFV.h.

797{
798 return (*this)(ElemPointArg{elem_side_qp.elem,
799 elem_side_qp.point,
801 state);
802}

◆ evaluate() [5/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< OutputType >::evaluate ( const FaceArg &  face,
const StateArg &  state 
) const
finaloverrideprivatevirtual
Parameters
faceSee the FaceArg doxygen
stateSee the StateArg doxygen
Returns
The functor evaluated at the requested state and space

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

Definition at line 737 of file MooseVariableFV.C.

738{
739 const FaceInfo * const fi = face.fi;
740 mooseAssert(fi, "The face information must be non-null");
741 if (isDirichletBoundaryFace(*fi, face.face_side, state))
742 return getDirichletBoundaryFaceValue(*fi, face.face_side, state);
743 else if (isExtrapolatedBoundaryFace(*fi, face.face_side, state))
744 {
745 bool two_term_boundary_expansion = _two_term_boundary_expansion;
747 if ((face.elem_is_upwind && face.face_side == fi->elemPtr()) ||
748 (!face.elem_is_upwind && face.face_side == fi->neighborPtr()))
749 two_term_boundary_expansion = false;
751 *fi, two_term_boundary_expansion, face.correct_skewness, face.face_side, state);
752 }
753 else
754 {
755 mooseAssert(this->isInternalFace(*fi),
756 "We must be either Dirichlet, extrapolated, or internal");
757 return Moose::FV::interpolate(*this, face, state);
758 }
759}
bool isExtrapolatedBoundaryFace(const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const override
Returns whether this is an extrapolated boundary face.
virtual bool isDirichletBoundaryFace(const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const
Determine whether a specified face side is a Dirichlet boundary face.
virtual ADReal getExtrapolatedBoundaryFaceValue(const FaceInfo &fi, bool two_term_expansion, bool correct_skewness, const Elem *elem_side_to_extrapolate_from, const StateArg &state) const
Retrieves an extrapolated boundary value for the provided face.
virtual ADReal getDirichletBoundaryFaceValue(const FaceInfo &fi, const Elem *elem, const Moose::StateArg &state) const
Retrieves a Dirichlet boundary value for the provided face.
void interpolate(InterpMethod m, T &result, const T2 &value1, const T3 &value2, const FaceInfo &fi, const bool one_is_elem)
Provides interpolation of face values for non-advection-specific purposes (although it can/will still...
bool elem_is_upwind
a boolean which states whether the face information element is upwind of the face
bool correct_skewness
Whether to perform skew correction.
Moose::FV::LimiterType limiter_type
a limiter which defines how the functor evaluated on either side of the face should be interpolated t...

◆ evaluate() [6/6]

template<typename OutputType >
MooseVariableFV< OutputType >::ValueType MooseVariableFV< OutputType >::evaluate ( const NodeArg &  node,
const StateArg &  state 
) const
finaloverrideprivatevirtual

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

Definition at line 763 of file MooseVariableFV.C.

764{
765 const auto & node_to_elem_map = this->_mesh.nodeToElemMap();
766 const auto & elem_ids = libmesh_map_find(node_to_elem_map, node_arg.node->id());
767 ValueType sum = 0;
768 Real total_weight = 0;
769 mooseAssert(elem_ids.size(), "There should always be at least one element connected to a node");
770 for (const auto elem_id : elem_ids)
771 {
772 const Elem * const elem = this->_mesh.queryElemPtr(elem_id);
773 mooseAssert(elem, "We should have this element available");
774 if (!this->hasBlocks(elem->subdomain_id()))
775 continue;
776 const ElemPointArg elem_point{
778 const auto weight = 1 / (*node_arg.node - elem->vertex_average()).norm();
779 sum += weight * (*this)(elem_point, state);
781 }
782 return sum / total_weight;
783}
const std::unordered_map< dof_id_type, std::vector< dof_id_type > > & nodeToElemMap()
If not already created, creates a map from every node to all elements to which they are connected.
Definition MooseMesh.C:1241
virtual Elem * queryElemPtr(const dof_id_type i)
Definition MooseMesh.C:3189
dof_id_type weight(const MeshBase &mesh, const processor_id_type pid)
dof_id_type total_weight(const MeshBase &mesh)
auto norm(const T &a)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
A structure that is used to evaluate Moose functors at an arbitrary physical point contained within a...

◆ evaluateDot() [1/6]

template<typename OutputType >
MooseVariableFV< OutputType >::DotType MooseVariableFV< 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 787 of file MooseVariableFV.C.

788{
789 mooseError("evaluateDot not implemented for this class of finite volume variables");
790}

◆ evaluateDot() [2/6]

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

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

Definition at line 431 of file MooseFunctor.h.

432 {
433 mooseError("Element-point time derivative not implemented for functor " + functorName());
434 }
const MooseFunctorName & functorName() const
Return the functor name.

◆ evaluateDot() [3/6]

template<typename OutputType >
DotType MooseVariableFV< OutputType >::evaluateDot ( const ElemQpArg &  ,
const StateArg &   
) const
finaloverrideprivatevirtual
Parameters
qpSee the ElemQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor time derivative evaluated at the requested state and space

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

◆ evaluateDot() [4/6]

virtual DotType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateDot ( const ElemSideQpArg &  ,
const StateArg &   
) const
inlineprotectedvirtualinherited
Parameters
side_qpSee the ElemSideQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor time derivative evaluated at the requested state and space

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

Definition at line 422 of file MooseFunctor.h.

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

◆ evaluateDot() [5/6]

template<typename OutputType >
DotType MooseVariableFV< OutputType >::evaluateDot ( const FaceArg &  ,
const StateArg &   
) const
finaloverrideprivatevirtual
Parameters
faceSee the FaceArg doxygen
stateSee the StateArg doxygen
Returns
The functor time derivative evaluated at the requested state and space

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

◆ evaluateDot() [6/6]

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

Definition at line 436 of file MooseFunctor.h.

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

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

Definition at line 445 of file MooseFunctor.h.

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

◆ evaluateGradDot() [2/6]

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

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

Definition at line 485 of file MooseFunctor.h.

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

◆ evaluateGradDot() [3/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot ( const ElemQpArg &  ,
const StateArg &   
) const
inlineprotectedvirtualinherited
Parameters
qpSee the ElemQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor gradient-dot evaluated at the requested state and space

Definition at line 465 of file MooseFunctor.h.

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

◆ evaluateGradDot() [4/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot ( const ElemSideQpArg &  ,
const StateArg &   
) const
inlineprotectedvirtualinherited
Parameters
side_qpSee the ElemSideQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor gradient-dot evaluated at the requested state and space

Definition at line 476 of file MooseFunctor.h.

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

◆ evaluateGradDot() [5/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradDot ( const FaceArg &  ,
const StateArg &   
) const
inlineprotectedvirtualinherited
Parameters
faceSee the FaceArg doxygen
stateSee the StateArg doxygen
Returns
The functor gradient-dot evaluated at the requested state and space

Definition at line 455 of file MooseFunctor.h.

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

◆ evaluateGradDot() [6/6]

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

Definition at line 490 of file MooseFunctor.h.

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

◆ evaluateGradient() [1/6]

template<typename OutputType >
MooseVariableFV< OutputType >::GradientType MooseVariableFV< 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 815 of file MooseVariableFV.h.

817{
818 return adGradSln(elem_arg.elem, state, elem_arg.correct_skewness);
819}
const ADTemplateVariableGradient< OutputType > & adGradSln() const override
AD grad solution getter.

◆ evaluateGradient() [2/6]

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

Evaluate the functor gradient with a given element and point.

Definition at line 377 of file MooseFunctor.h.

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

◆ evaluateGradient() [3/6]

template<typename OutputType >
MooseVariableFV< OutputType >::GradientType MooseVariableFV< OutputType >::evaluateGradient ( const ElemQpArg &  ,
const StateArg &   
) const
finaloverrideprivatevirtual
Parameters
qpSee the ElemQpArg doxygen
stateSee 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 806 of file MooseVariableFV.h.

808{
809 return adGradSln(
811}

◆ evaluateGradient() [4/6]

virtual GradientType Moose::FunctorBase< Moose::ADType< OutputType >::type >::evaluateGradient ( const ElemSideQpArg &  ,
const StateArg &   
) const
inlineprotectedvirtualinherited
Parameters
side_qpSee the ElemSideQpArg doxygen
stateSee the StateArg doxygen
Returns
The functor gradient evaluated at the requested state and space

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

Definition at line 368 of file MooseFunctor.h.

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

◆ evaluateGradient() [5/6]

template<typename OutputType >
MooseVariableFV< OutputType >::GradientType MooseVariableFV< OutputType >::evaluateGradient ( const FaceArg &  ,
const StateArg &   
) const
finaloverrideprivatevirtual
Parameters
faceSee the FaceArg doxygen
stateSee 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 823 of file MooseVariableFV.h.

824{
825 mooseAssert(face.fi, "We must have a non-null face information");
826 return adGradSln(*face.fi, state, face.correct_skewness);
827}

◆ evaluateGradient() [6/6]

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

Definition at line 382 of file MooseFunctor.h.

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

◆ faceInterpolationMethod()

template<typename OutputType >
Moose::FV::InterpMethod MooseVariableFV< OutputType >::faceInterpolationMethod ( ) const
inline

Definition at line 194 of file MooseVariableFV.h.

194{ return _face_interp_method; }

◆ feType()

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

Get the type of finite element object.

Definition at line 65 of file MooseVariableBase.h.

65{ return _fe_type; }
libMesh::FEType _fe_type
The FEType associated with this variable.

Referenced by SetupResidualDebugAction::act(), ADDGKernel::ADDGKernel(), Assembly::adGradPhi(), Assembly::adGradPhi(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), AuxKernelBase::AuxKernelBase(), BoundsBase::BoundsBase(), BuildArrayVariableAux::BuildArrayVariableAux(), TagAuxBase< T >::checkCoupledVariable(), SamplerBase::checkForStandardFieldVariableType(), GapValueAux::computeValue(), CopyValueAux::CopyValueAux(), MultiAppGeneralFieldTransfer::correctSolutionVectorValues(), DGKernel::DGKernel(), ElementAdaptivityLevelAux::ElementAdaptivityLevelAux(), ElementLpNormAux::ElementLpNormAux(), MultiAppNearestNodeTransfer::execute(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::extractlibMeshNodePositions(), moose::internal::incompatVarMsg(), AdvancedOutput::initAvailableLists(), MultiAppProjectionTransfer::initialSetup(), AdvancedOutput::initShowHideLists(), IntegratedBC::IntegratedBC(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InternalSideIndicatorBase::InternalSideIndicatorBase(), Kernel::Kernel(), MeshDivisionAux::MeshDivisionAux(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NodalBC::NodalBC(), NodalKernel::NodalKernel(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::projectlibMeshNodalValues(), MultiAppDofCopyTransfer::transfer(), VectorNodalBC::VectorNodalBC(), and VolumeAux::VolumeAux().

◆ fieldType()

template<typename OutputType >
Moose::VarFieldType MooseVariableField< OutputType >::fieldType ( ) const
overridevirtualinherited

Field type of this variable.

Implements MooseVariableFieldBase.

Definition at line 60 of file MooseVariableField.C.

61{
62 if (std::is_same<OutputType, Real>::value)
64 else if (std::is_same<OutputType, RealVectorValue>::value)
66 else if (std::is_same<OutputType, RealEigenVector>::value)
68 else
69 mooseError("Unknown variable field type");
70}
@ VAR_FIELD_STANDARD
Definition MooseTypes.h:777
@ VAR_FIELD_ARRAY
Definition MooseTypes.h:780
@ VAR_FIELD_VECTOR
Definition MooseTypes.h:779

◆ flagInvalidSolutionInternal()

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

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

43{
44 mooseAssert(
45 warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
46 "Inconsistent warning flag");
47 auto & solution_invalidity = _si_moose_base.getMooseApp().solutionInvalidity();
48 if constexpr (!warning)
50 solution_invalidity.printDebug(invalid_solution_id);
51 return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
52}
bool immediatelyPrintInvalidSolution() const
Whether or not the solution invalid warnings are printed out immediately.
SolutionInvalidity & solutionInvalidity()
Get the SolutionInvalidity for this app.
Definition MooseApp.h:185
const FEProblemBase * _si_problem
A pointer to FEProblem base.
const MooseBase & _si_moose_base
The MooseBase that owns this interface.
void printDebug(InvalidSolutionID _invalid_solution_id) const
Immediately print the section and message for debug purpose.
SolutionInvalidityRegistry & getSolutionInvalidityRegistry()
Get the global SolutionInvalidityRegistry singleton.

◆ functorName()

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

Return the functor name.

Definition at line 176 of file MooseFunctor.h.

176{ return _functor_name; }
MooseFunctorName _functor_name
name of the functor

◆ genericDofValues()

template<typename OutputType >
template<bool is_ad>
const MooseArray< GenericReal< is_ad > > & MooseVariableField< OutputType >::genericDofValues ( ) const
inherited

Definition at line 425 of file MooseVariableField.h.

426{
427 return adDofValues();
428}
virtual const ADDofValues & adDofValues() const =0
Return the AD dof values.

◆ genericEvaluate()

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

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

Definition at line 172 of file MooseFunctor.h.

994{
995 if constexpr (FET == FunctorEvaluationKind::Value)
996 return (*this)(r, state);
997 else if constexpr (FET == FunctorEvaluationKind::Gradient)
998 return gradient(r, state);
999 else if constexpr (FET == FunctorEvaluationKind::Dot)
1000 return dot(r, state);
1001 else
1002 return gradDot(r, state);
1003}
DotType dot(const ElemArg &elem, const StateArg &state) const
Same as their evaluateDot overloads with the same arguments but allows for caching implementation.
GradientType gradDot(const ElemArg &elem, const StateArg &state) const
Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation...

◆ getBase()

const std::string & MooseBase::getBase ( ) const
inlineinherited
Returns
The registered base for this object (set via InputParameters::registerBase())

Definition at line 147 of file MooseBase.h.

147{ return _pars.getBase(); }
const std::string & getBase() const

Referenced by MooseBase::uniqueParameterName().

◆ getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )
protectedinherited

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

Definition at line 336 of file BlockRestrictable.C.

337{
338 if (!_blk_mesh)
339 mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
340 if (!_blk_feproblem)
341 mooseError("No problem available in BlockRestrictable::checkCoordSystem()");
342
343 const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();
344
345 if (subdomains.empty())
346 mooseError("No subdomains found in the problem.");
347
348 // make sure all subdomains are using the same coordinate system
349 auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
350 for (auto subdomain : subdomains)
351 if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
352 mooseError("This object requires all subdomains to have the same coordinate system.");
353
354 return coord_system;
355}
if(!dmm->_nl) SETERRQ(PETSC_COMM_WORLD
virtual const std::set< SubdomainID > & blockIDs() const
Return the block subdomain ids for this object Note, if this is not block restricted,...
FEProblemBase * _blk_feproblem
Pointer to FEProblemBase.
Moose::CoordinateSystemType getCoordSystem(SubdomainID sid) const

◆ getBoundaryFaceValue()

template<typename OutputType >
ADReal MooseVariableFV< OutputType >::getBoundaryFaceValue ( const FaceInfo &  fi,
const StateArg &  state,
bool  correct_skewness = false 
) const

Retrieve the solution value at a boundary face.

If we're using a one term Taylor series expansion we'll simply return the ajacent element centroid value. If we're doing two terms, then we will compute the gradient if necessary to help us interpolate from the element centroid value to the face

Definition at line 569 of file MooseVariableFV.C.

572{
573 mooseAssert(!this->isInternalFace(fi),
574 "A boundary face value has been requested on an internal face.");
575
576 if (isDirichletBoundaryFace(fi, nullptr, state))
577 return getDirichletBoundaryFaceValue(fi, nullptr, state);
578 else if (isExtrapolatedBoundaryFace(fi, nullptr, state))
580 fi, _two_term_boundary_expansion, correct_skewness, nullptr, state);
581
582 mooseError("Unknown boundary face type!");
583}

Referenced by InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), SideIntegralVariableUserObject::computeQpIntegral(), and FVTwoVarContinuityConstraint::computeQpResidual().

◆ getCheckedPointerParam()

template<typename T >
T MooseBase::getCheckedPointerParam ( const std::string &  name,
const std::string &  error_string = "" 
) const
inherited

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

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

Definition at line 450 of file MooseBase.h.

451{
452 return _pars.getCheckedPointerParam<T>(name, error_string);
453}
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.

◆ getContinuity()

template<typename OutputType >
libMesh::FEContinuity MooseVariableFV< OutputType >::getContinuity ( ) const
inlinefinaloverridevirtual

Return the continuity of this variable.

Reimplemented from MooseVariableBase.

Definition at line 162 of file MooseVariableFV.h.

163 {
164 return _element_data->getContinuity();
165 };

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

22{
23 _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
24 "within the InputParameters.\nUse getParam<DataFileName>(\"",
25 param,
26 "\") instead.");
27 return _parent.getParam<DataFileName>(param);
28}
const ParallelParamObject & _parent
void mooseDeprecated(Args &&... args) const
Emits a deprecation warning prefixed with the object name and type, and a stack trace.
Definition MooseBase.h:317

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

32{
33 _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
34 relative_path,
35 "\") instead.");
36 return getDataFilePath(relative_path);
37}
std::string getDataFilePath(const std::string &relative_path) const
Returns the path of a data file for a given relative file 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.

41{
42 // This should only ever be used with relative paths. There is no point to
43 // use this search path with an absolute path.
44 if (std::filesystem::path(relative_path).is_absolute())
45 _parent.mooseWarning("While using getDataFilePath(\"",
46 relative_path,
47 "\"): This API should not be used for absolute paths.");
48
49 // This will search the data paths for this relative path
50 std::optional<std::string> error;
52 {
53 // Throw on error so that if getPath() fails, we can throw an error
54 // with the context of _parent.mooseError()
55 Moose::ScopedThrowOnError scoped_throw_on_error;
56
57 try
58 {
59 found_path = Moose::DataFileUtils::getPath(relative_path);
60 }
61 catch (std::exception & e)
62 {
63 error = e.what();
64 }
65 }
66
67 if (error)
68 _parent.mooseError(*error);
69
70 mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
71 "Should only ever obtain data");
72 mooseAssert(found_path.data_name, "Should be set");
73
74 const std::string msg =
75 "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
76 _parent.mooseInfo(msg);
77
78 return found_path.path;
79}
void mooseWarning(Args &&... args) const
Emits a warning prefixed with object name and type.
Definition MooseBase.h:299
void mooseInfo(Args &&... args) const
Definition MooseBase.h:334
Scoped helper for setting Moose::_throw_on_error during this scope.
Definition Moose.h:308
@ DATA
From installed/in-tree data.
Path getPath(std::string path, const GetPathOptions &options={})
Get the data path for a given path, searching the registered data.
Representation of a data file path.
std::optional< std::string > data_name
The name of the data registry the file came from (with context == DATA)
Context context
Context for the file (where it came from)

Referenced by DataFileInterface::getDataFileNameByName().

◆ getDirichletBC()

template<typename OutputType >
std::pair< bool, const FVDirichletBCBase * > MooseVariableFV< OutputType >::getDirichletBC ( const FaceInfo &  fi) const

Definition at line 412 of file MooseVariableFV.C.

413{
414 for (const auto bnd_id : fi.boundaryIDs())
415 if (auto it = _boundary_id_to_dirichlet_bc.find(bnd_id);
417 return {true, it->second};
418
419 return {false, nullptr};
420}
KOKKOS_INLINE_FUNCTION const T * find(const T &target, const T *const begin, const T *const end)
Find a value in an array.
Definition KokkosUtils.h:40

Referenced by FVFluxKernel::skipForBoundary().

◆ getDirichletBoundaryFaceValue()

template<typename OutputType >
ADReal MooseVariableFV< OutputType >::getDirichletBoundaryFaceValue ( const FaceInfo &  fi,
const Elem *  elem,
const Moose::StateArg &  state 
) const
protectedvirtual

Retrieves a Dirichlet boundary value for the provided face.

Callers of this method should be sure that isDirichletBoundaryFace returns true. In the base implementation we only inspect the face information object for the Dirichlet value. However, derived classes may allow discontinuities between + and - side face values, e.g. one side may have a Dirichlet condition and the other side may perform extrapolation to determine its value. This is the reason for the existence of the elem parameter, to indicate sidedness

Parameters
fiThe face information object
elemAn element that can be used to indicate sidedness of the face
stateState argument which describes at what time / solution iteration state we want to evaluate the variable
Returns
The Dirichlet value on the boundary face associated with fi (and potentially elem)

Definition at line 488 of file MooseVariableFV.C.

491{
492 mooseAssert(isDirichletBoundaryFace(fi, elem, state),
493 "This function should only be called on Dirichlet boundary faces.");
494
495 const auto & diri_pr = getDirichletBC(fi);
496
497 mooseAssert(diri_pr.first,
498 "This functor should only be called if we are on a Dirichlet boundary face.");
499
500 const FVDirichletBCBase & bc = *diri_pr.second;
501
502 return ADReal(bc.boundaryValue(fi, state));
503}
DualNumber< Real, DNDerivativeType, true > ADReal
Base class for finite volume Dirichlet boundaray conditions.
virtual ADReal boundaryValue(const FaceInfo &fi, const Moose::StateArg &state) const =0
std::pair< bool, const FVDirichletBCBase * > getDirichletBC(const FaceInfo &fi) const
virtual const OutputTools< T >::VariableSecond & second()
The second derivative of the variable this object is operating on.

◆ getDofIndices()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::getDofIndices ( const Elem *  elem,
std::vector< dof_id_type > &  dof_indices 
) const
inlineoverridevirtual

Reimplemented from MooseVariableBase.

Definition at line 179 of file MooseVariableFV.h.

181 {
182 return _element_data->getDofIndices(elem, dof_indices);
183 }

◆ getElementalValue()

template<typename OutputType >
MooseVariableFV< OutputType >::DofValue MooseVariableFV< OutputType >::getElementalValue ( const Elem *  elem,
unsigned int  idx = 0 
) const

Get the current value of this variable on an element.

Parameters
[in]elemElement at which to get value
[in]idxLocal index of this variable's element DoFs
Returns
Variable value

Definition at line 123 of file MooseVariableFV.C.

124{
125 return _element_data->getElementalValue(elem, Moose::Current, idx);
126}
@ Current
Definition MooseTypes.h:263

◆ getElementalValueOld()

template<typename OutputType >
MooseVariableFV< OutputType >::DofValue MooseVariableFV< OutputType >::getElementalValueOld ( const Elem *  elem,
unsigned int  idx = 0 
) const

Get the old value of this variable on an element.

Parameters
[in]elemElement at which to get value
[in]idxLocal index of this variable's element DoFs
Returns
Variable value

Definition at line 130 of file MooseVariableFV.C.

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

◆ getElementalValueOlder()

template<typename OutputType >
MooseVariableFV< OutputType >::DofValue MooseVariableFV< OutputType >::getElementalValueOlder ( const Elem *  elem,
unsigned int  idx = 0 
) const

Get the older value of this variable on an element.

Parameters
[in]elemElement at which to get value
[in]idxLocal index of this variable's element DoFs
Returns
Variable value

Definition at line 137 of file MooseVariableFV.C.

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

◆ getElemValue()

template<typename OutputType >
ADReal MooseVariableFV< OutputType >::getElemValue ( const Elem *  elem,
const StateArg &  state 
) const

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

Parameters
elemThe element to retrieive the solution value for
stateState argument which describes at what time / solution iteration state we want to evaluate the variable

Definition at line 435 of file MooseVariableFV.C.

436{
437 mooseAssert(elem,
438 "The elem shall exist! This typically occurs when the "
439 "user wants to evaluate non-existing elements (nullptr) at physical boundaries.");
440 mooseAssert(
441 this->hasBlocks(elem->subdomain_id()),
442 "The variable should be defined on the element's subdomain! This typically occurs when the "
443 "user wants to evaluate the elements right next to the boundary of two variables (block "
444 "boundary). The subdomain which is queried: " +
445 Moose::stringify(this->activeSubdomains()) + " the subdomain of the element " +
446 std::to_string(elem->subdomain_id()));
447
448 Moose::initDofIndices(const_cast<MooseVariableFV<OutputType> &>(*this), *elem);
449
450 mooseAssert(
451 this->_dof_indices.size() == 1,
452 "There should only be one dof-index for a constant monomial variable on any given element");
453
454 const dof_id_type index = this->_dof_indices[0];
455
456 // It's not safe to use solutionState(0) because it returns the libMesh System solution member
457 // which is wrong during things like finite difference Jacobian evaluation, e.g. when PETSc
458 // perturbs the solution vector we feed these perturbations into the current_local_solution
459 // while the libMesh solution is frozen in the non-perturbed state
460 const auto & global_soln =
461 (state.state == 0)
462 ? *this->_sys.currentSolution()
463 : std::as_const(this->_sys).solutionState(state.state, state.iteration_type);
464
465 ADReal value = global_soln(index);
466
467 if (ADReal::do_derivatives && state.state == 0 &&
468 this->_sys.number() == this->_subproblem.currentNlSysNum())
469 Moose::derivInsert(value.derivatives(), index, 1.);
470
471 return value;
472}
std::vector< dof_id_type > _dof_indices
DOF indices.
This class provides variable solution values for other classes/objects to bind to when looping over f...
void initDofIndices(T &data, const Elem &elem)
void derivInsert(SemiDynamicSparseNumberArray< Real, libMesh::dof_id_type, NWrapper< N > > &derivs, libMesh::dof_id_type index, Real value)
Definition ADReal.h:21
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
uint8_t dof_id_type
SolutionIterationType iteration_type
The solution iteration type, e.g. time or nonlinear.

Referenced by FVDiffusionInterface::computeQpResidual().

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const
inherited

◆ getExtrapolatedBoundaryFaceValue()

template<typename OutputType >
ADReal MooseVariableFV< OutputType >::getExtrapolatedBoundaryFaceValue ( const FaceInfo &  fi,
bool  two_term_expansion,
bool  correct_skewness,
const Elem *  elem_side_to_extrapolate_from,
const StateArg &  state 
) const
virtual

Retrieves an extrapolated boundary value for the provided face.

Callers of this method should be sure that isExtrapolatedBoundaryFace returns true. In the base implementation we only inspect the face information object for the extrapolated value. However, derived classes may allow discontinuities between + and - side face values, e.g. one side may have a Dirichlet condition and the other side may perform extrapolation to determine its value. This is the reason for the existence of the elem parameter, to indicate sidedness

Parameters
fiThe face information object
two_term_expansionWhether to use the cell gradient in addition to the cell center value to compute the extrapolated boundary face value. If this is false, then the cell center value will be used
correct_skewnessWhether to perform skew corrections. This is relevant when performing two term expansions as the gradient evaluation may involve evaluating face values on internal skewed faces
elem_side_to_extrapolate_fromAn element that can be used to indicate sidedness of the face
stateState argument which describes at what time / solution iteration state we want to evaluate the variable
Returns
The extrapolated value on the boundary face associated with fi (and potentially elem_side_to_extrapolate_from)

Definition at line 519 of file MooseVariableFV.C.

524{
525 mooseAssert(
526 isExtrapolatedBoundaryFace(fi, elem_to_extrapolate_from, state) || !two_term_expansion,
527 "We allow Dirichlet boundary conditions to call this method. However, the only way to "
528 "ensure we don't have infinite recursion, with Green Gauss gradients calling back to the "
529 "Dirichlet boundary condition calling back to this method, is to do a one term expansion");
530
531 ADReal boundary_value;
532 bool elem_to_extrapolate_from_is_fi_elem;
533 std::tie(elem_to_extrapolate_from, elem_to_extrapolate_from_is_fi_elem) =
534 [this, &fi, elem_to_extrapolate_from]() -> std::pair<const Elem *, bool>
535 {
536 if (elem_to_extrapolate_from)
537 // Somebody already specified the element to extropolate from
538 return {elem_to_extrapolate_from, elem_to_extrapolate_from == fi.elemPtr()};
539 else
540 {
541 const auto [elem_guaranteed_to_have_dofs,
542 other_elem,
543 elem_guaranteed_to_have_dofs_is_fi_elem] =
545 // We only care about the element guaranteed to have degrees of freedom and current C++
546 // doesn't allow us to not assign one of the returned items like python does
547 libmesh_ignore(other_elem);
548 // We will extrapolate from the element guaranteed to have degrees of freedom
549 return {elem_guaranteed_to_have_dofs, elem_guaranteed_to_have_dofs_is_fi_elem};
550 }
551 }();
552
553 if (two_term_expansion)
554 {
555 const Point vector_to_face = elem_to_extrapolate_from_is_fi_elem
556 ? (fi.faceCentroid() - fi.elemCentroid())
557 : (fi.faceCentroid() - fi.neighborCentroid());
558 boundary_value = adGradSln(elem_to_extrapolate_from, state, correct_skewness) * vector_to_face +
559 getElemValue(elem_to_extrapolate_from, state);
560 }
561 else
562 boundary_value = getElemValue(elem_to_extrapolate_from, state);
563
564 return boundary_value;
565}
std::tuple< const Elem *, const Elem *, bool > determineElemOneAndTwo(const FaceInfo &fi, const FVVar &var)
This utility determines element one and element two given a FaceInfo fi and variable var.
Definition FVUtils.h:130
void libmesh_ignore(const Args &...)

◆ getFluxBCs()

template<typename OutputType >
std::pair< bool, std::vector< const FVFluxBC * > > MooseVariableFV< OutputType >::getFluxBCs ( const FaceInfo &  fi) const

Definition at line 424 of file MooseVariableFV.C.

425{
426 for (const auto bnd_id : fi.boundaryIDs())
427 if (auto it = _boundary_id_to_flux_bc.find(bnd_id); it != _boundary_id_to_flux_bc.end())
428 return {true, it->second};
429
430 return std::make_pair(false, std::vector<const FVFluxBC *>());
431}

Referenced by FVFluxKernel::skipForBoundary().

◆ getGradient()

template<typename OutputType >
OutputTools< OutputType >::OutputGradient MooseVariableFV< OutputType >::getGradient ( const Elem *  elem) const

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

Parameters
elemThe element we are computing on
phiEvaluated shape functions at a point
Returns
The variable gradient value

Definition at line 377 of file MooseVariableFV.C.

378{
379 return {};
380}

◆ getHitNode() [1/2]

const hit::Node * MooseBase::getHitNode ( ) const
inlineinherited
Returns
The block-level hit node for this object, if any

Definition at line 136 of file MooseBase.h.

136{ return getHitNode(_pars); }

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

◆ getHitNode() [2/2]

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

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

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

Definition at line 167 of file MooseBase.C.

168{
169 if (const auto hit_node = params.getHitNode())
170 if (!hit_node->isRoot())
171 return hit_node;
172 return nullptr;
173}
const hit::Node * getHitNode(const std::string &param) const

◆ getMooseApp()

MooseApp & MooseBase::getMooseApp ( ) const
inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

87{ return _app; }

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

◆ getOutputs()

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

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

Returns
A set of OutputNames

Definition at line 101 of file OutputInterface.C.

102{
103 return _oi_outputs;
104}

◆ getParam() [1/2]

template<typename T >
const T & MooseBase::getParam ( const std::string &  name) const
inherited

Retrieve a parameter for the object.

Parameters
nameThe name of the parameter
Returns
The value of the parameter

Definition at line 406 of file MooseBase.h.

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

Referenced by CommonOutputAction::act(), CreateDisplacedProblemAction::act(), DiffusionCG::addFEKernels(), DiffusionFV::addFVKernels(), CylinderComponent::addMeshGenerators(), FEProblemBase::addOutput(), ArrayParsedAux::ArrayParsedAux(), BicubicSplineFunction::BicubicSplineFunction(), SurfaceDelaunayGeneratorBase::checkBoundaryAndHolesParams(), Console::Console(), CutMeshByLevelSetGenerator::CutMeshByLevelSetGenerator(), DebugResidualAux::DebugResidualAux(), DerivativeParsedMaterialTempl< is_ad >::DerivativeParsedMaterialTempl(), DiffusionPhysicsBase::DiffusionPhysicsBase(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), EigenKernel::EigenKernel(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), MFEMEigenvaluesPostprocessor::execute(), FEProblemSolve::FEProblemSolve(), SurfaceDelaunayGeneratorBase::fillDelaunayOptions(), ParsedVectorReporter::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), ParsedSubdomainGeneratorBase::functionInitialize(), BlockDeletionGenerator::generate(), BoundaryLayerSubdomainGenerator::generate(), BreakMeshByBlockGenerator::generate(), CoarsenBlockGenerator::generate(), FileMeshGenerator::generate(), MeshExtruderGenerator::generate(), RefineBlockGenerator::generate(), RefineSidesetGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), GenericConstantRankTwoTensorTempl< is_ad >::GenericConstantRankTwoTensorTempl(), GenericConstantSymmetricRankTwoTensorTempl< is_ad >::GenericConstantSymmetricRankTwoTensorTempl(), GeometricSearchInterface::GeometricSearchInterface(), MooseApp::getCheckpointDirectories(), DataFileInterface::getDataFileName(), ExecutorInterface::getExecutor(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), AdvancedOutput::init(), FixedPointIterationAdaptiveDT::init(), TimeSequenceStepper::init(), AdvancedOutput::initAvailableLists(), AttribThread::initFrom(), AttribExecutionOrderGroup::initFrom(), AttribSysNum::initFrom(), AttribResidualObject::initFrom(), AttribDisplaced::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), SampledOutput::initSample(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseMesh::MooseMesh(), MooseVariableBase::MooseVariableBase(), MoveNodesByParsedExpressionModifier::MoveNodesByParsedExpressionModifier(), MultiPostprocessorConvergence::MultiPostprocessorConvergence(), PerfGraphOutput::output(), Console::outputSystemInformation(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedElementDeletionGenerator::ParsedElementDeletionGenerator(), ParsedGenerateNodeset::ParsedGenerateNodeset(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterialTempl< is_ad >::ParsedMaterialTempl(), ParsedNodeTransformGenerator::ParsedNodeTransformGenerator(), ParsedODEKernel::ParsedODEKernel(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ParsedVectorReporter::ParsedVectorReporter(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), ReferenceResidualInterface::ReferenceResidualInterface(), Moose::FV::setInterpolationMethod(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), Output::setWallTimeIntervalFromCommandLineParam(), PetscOutput::solveSetup(), TimePeriod::TimePeriod(), UniqueExtraIDMeshGenerator::UniqueExtraIDMeshGenerator(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorOfPostprocessors::VectorOfPostprocessors(), and XYQuadrilateralMeshFromBoundaryCurve::XYQuadrilateralMeshFromBoundaryCurve().

◆ 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
param1The name of first parameter
param2The name of second parameter
Returns
Vector of pairs of first and second parameters

Definition at line 443 of file MooseBase.h.

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

◆ 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_namethe old name for the parameter
new_namethe new name for the parameter

Definition at line 420 of file MooseBase.h.

421{
422 // Most important: accept new parameter
423 if (isParamSetByUser(new_name) && !isParamValid(old_name))
424 return getParam<T>(new_name);
425 // Second most: accept old parameter
426 if (isParamValid(old_name) && !isParamSetByUser(new_name))
427 return getParam<T>(old_name);
428 // Third most: accept default for new parameter
429 if (isParamValid(new_name) && !isParamValid(old_name))
430 return getParam<T>(new_name);
431 // Refuse: no default, no value passed
432 if (!isParamValid(old_name) && !isParamValid(new_name))
433 mooseError("parameter '" + new_name +
434 "' is being retrieved without being set.\nDid you misspell it?");
435 // Refuse: both old and new parameters set by user
436 else
437 mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
438 old_name + "'");
439}
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.
Definition MooseBase.h:205

◆ getSharedPtr() [1/2]

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

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

Wrapper around shared_from_this().

Definition at line 70 of file MooseObject.C.

71{
72 try
73 {
74 return shared_from_this();
75 }
76 catch (std::bad_weak_ptr &)
77 {
78 mooseError(not_shared_error);
79 }
80}

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

◆ getSharedPtr() [2/2]

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

Definition at line 83 of file MooseObject.C.

84{
85 try
86 {
87 return shared_from_this();
88 }
89 catch (std::bad_weak_ptr &)
90 {
91 mooseError(not_shared_error);
92 }
93}

◆ getSolution()

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

Get the solution corresponding to the provided state.

Definition at line 203 of file MooseVariableBase.C.

204{
205 // It's not safe to use solutionState(0) because it returns the libMesh System solution member
206 // which is wrong during things like finite difference Jacobian evaluation, e.g. when PETSc
207 // perturbs the solution vector we feed these perturbations into the current_local_solution
208 // while the libMesh solution is frozen in the non-perturbed state
209 return (state.state == 0) ? *this->_sys.currentSolution()
210 : this->_sys.solutionState(state.state, state.iteration_type);
211}
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).

Referenced by MooseVariableScalar::evaluate().

◆ getTwoTermBoundaryExpansion()

template<typename OutputType >
const bool & MooseVariableFV< OutputType >::getTwoTermBoundaryExpansion ( ) const
inline

Function to get wether two term boundary expansion is used for the variable.

Definition at line 675 of file MooseVariableFV.h.

◆ getValue()

template<typename OutputType >
OutputType MooseVariableFV< OutputType >::getValue ( const Elem *  elem) const

Note: const monomial is always the case - higher order solns are reconstructed - so this is simpler func than FE equivalent.

Definition at line 367 of file MooseVariableFV.C.

368{
369 Moose::initDofIndices(const_cast<MooseVariableFV<OutputType> &>(*this), *elem);
370 mooseAssert(this->_dof_indices.size() == 1, "Wrong size for dof indices");
371 OutputType value = (*this->_sys.currentSolution())(this->_dof_indices[0]);
372 return value;
373}

◆ gradDot() [1/6]

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

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

These are the methods a user will call in their code

Definition at line 222 of file MooseFunctor.h.

940{
941 return evaluateGradDot(elem, state);
942}
virtual GradientType evaluateGradDot(const ElemArg &, const StateArg &) const
Evaluate the functor gradient-dot with a given element.

◆ gradDot() [2/6]

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

Definition at line 226 of file MooseFunctor.h.

969{
970 return evaluateGradDot(elem_point, state);
971}

◆ gradDot() [3/6]

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

Definition at line 224 of file MooseFunctor.h.

955{
956 return evaluateGradDot(elem_qp, state);
957}

◆ gradDot() [4/6]

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

Definition at line 225 of file MooseFunctor.h.

962{
963 return evaluateGradDot(elem_side_qp, state);
964}

◆ gradDot() [5/6]

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

Definition at line 223 of file MooseFunctor.h.

947{
948 checkFace(face);
949 return evaluateGradDot(face, state);
950}

◆ gradDot() [6/6]

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

Definition at line 227 of file MooseFunctor.h.

976{
977 return evaluateGradDot(node, state);
978}

◆ gradient() [1/6]

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

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

These are the methods a user will call in their code

Definition at line 196 of file MooseFunctor.h.

854{
855 return evaluateGradient(elem, state);
856}
virtual GradientType evaluateGradient(const ElemArg &, const StateArg &) const
Evaluate the functor gradient with a given element.

◆ gradient() [2/6]

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

Definition at line 200 of file MooseFunctor.h.

883{
884 return evaluateGradient(elem_point, state);
885}

◆ gradient() [3/6]

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

Definition at line 198 of file MooseFunctor.h.

869{
870 return evaluateGradient(elem_qp, state);
871}

◆ gradient() [4/6]

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

Definition at line 199 of file MooseFunctor.h.

876{
877 return evaluateGradient(elem_side_qp, state);
878}

◆ gradient() [5/6]

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

Definition at line 197 of file MooseFunctor.h.

861{
862 checkFace(face);
863 return evaluateGradient(face, state);
864}

◆ gradient() [6/6]

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

Definition at line 201 of file MooseFunctor.h.

890{
891 return evaluateGradient(node, state);
892}

◆ gradPhi()

template<typename OutputType >
const FieldVariablePhiGradient & MooseVariableFV< OutputType >::gradPhi ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 599 of file MooseVariableFV.h.

599{ return _grad_phi; }

◆ gradPhiFace()

template<typename OutputType >
const FieldVariablePhiGradient & MooseVariableFV< OutputType >::gradPhiFace ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 614 of file MooseVariableFV.h.

614{ return _grad_phi_face; }

◆ gradPhiFaceNeighbor()

template<typename OutputType >
const FieldVariablePhiGradient & MooseVariableFV< OutputType >::gradPhiFaceNeighbor ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 624 of file MooseVariableFV.h.

625 {
627 }

◆ gradPhiNeighbor()

template<typename OutputType >
const FieldVariablePhiGradient & MooseVariableFV< OutputType >::gradPhiNeighbor ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 634 of file MooseVariableFV.h.

635 {
636 return _grad_phi_neighbor;
637 }

◆ gradSln()

template<typename OutputType >
const FieldVariableGradient & MooseVariableFV< OutputType >::gradSln ( ) const
inlineoverridevirtual

element gradients

Implements MooseVariableField< OutputType >.

Definition at line 232 of file MooseVariableFV.h.

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

◆ gradSlnNeighbor()

template<typename OutputType >
const FieldVariableGradient & MooseVariableFV< OutputType >::gradSlnNeighbor ( ) const
inlineoverridevirtual

neighbor solution gradients

Implements MooseVariableField< OutputType >.

Definition at line 249 of file MooseVariableFV.h.

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

◆ gradSlnOld()

template<typename OutputType >
const FieldVariableGradient & MooseVariableFV< OutputType >::gradSlnOld ( ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 236 of file MooseVariableFV.h.

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

◆ gradSlnOldNeighbor()

template<typename OutputType >
const FieldVariableGradient & MooseVariableFV< OutputType >::gradSlnOldNeighbor ( ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 253 of file MooseVariableFV.h.

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

◆ hasBase()

bool MooseBase::hasBase ( ) const
inlineinherited
Returns
Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 142 of file MooseBase.h.

142{ return _pars.hasBase(); }
bool hasBase() const

◆ 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
TThe type of material property
Parameters
prop_namethe name of the property to query
Returns
true if the property exists for all block ids of the object, otherwise false
See also
Material::hasBlockMaterialProperty

Definition at line 360 of file BlockRestrictable.h.

361{
362 mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
363 return hasBlockMaterialPropertyHelper(prop_name) &&
364 _blk_material_data->haveGenericProperty<T, is_ad>(prop_name);
365}
const MaterialData * _blk_material_data
Pointer to the MaterialData class for this object.
virtual bool hasBlockMaterialPropertyHelper(const std::string &prop_name)
A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.
bool haveGenericProperty(const std::string &prop_name) const

◆ hasBlockMaterialPropertyHelper()

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

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

It also avoid circular #include problems.

See also
hasBlockMaterialProperty

Definition at line 300 of file BlockRestrictable.C.

301{
302
303 // Reference to MaterialWarehouse for testing and retrieving block ids
305
306 // Complete set of ids that this object is active
307 const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();
308
309 // Loop over each id for this object
310 for (const auto & id : ids)
311 {
312 // Storage of material properties that have been DECLARED on this id
313 std::set<std::string> declared_props;
314
315 // If block materials exist, populated the set of properties that were declared
316 if (warehouse.hasActiveBlockObjects(id))
317 {
318 const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
319 for (const auto & mat : mats)
320 {
321 const std::set<std::string> & mat_props = mat->getSuppliedItems();
322 declared_props.insert(mat_props.begin(), mat_props.end());
323 }
324 }
325
326 // If the supplied property is not in the list of properties on the current id, return false
327 if (declared_props.find(prop_name) == declared_props.end())
328 return false;
329 }
330
331 // If you get here the supplied property is defined on all blocks
332 return true;
333}
const MaterialWarehouse & getMaterialWarehouse() const
MaterialBase objects are special in that they have additional objects created automatically (see FEPr...
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
bool hasActiveBlockObjects(THREAD_ID tid=0) const

Referenced by BlockRestrictable::hasBlockMaterialProperty().

◆ hasBlocks() [1/6]

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

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

Parameters
idsA std::set of SubdomainIDs to check
Returns
True if all of the given ids are found within the ids for this object
See also
isSubset

Definition at line 262 of file BlockRestrictable.C.

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

◆ hasBlocks() [2/6]

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

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

Parameters
namesA set of SubdomainNames to check
Returns
True if the given ids are valid for this object

Definition at line 240 of file BlockRestrictable.C.

241{
242 return hasBlocks(_blk_mesh->getSubdomainIDs(names));
243}
bool hasBlocks(const SubdomainName &name) const
Test if the supplied block name is valid for this object.
std::vector< SubdomainID > getSubdomainIDs(const std::vector< SubdomainName > &subdomain_names) const
Get the associated subdomainIDs for the subdomain names that are passed in.
Definition MooseMesh.C:1684

◆ hasBlocks() [3/6]

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

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

Parameters
idsA vector of SubdomainIDs ids to check
Returns
True if all of the given ids are found within the ids for this object

Definition at line 255 of file BlockRestrictable.C.

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

◆ hasBlocks() [4/6]

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

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

Parameters
namesA vector of SubdomainNames to check
Returns
True if the given ids are valid for this object

Definition at line 234 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/6]

template<typename OutputType >
bool MooseVariableField< OutputType >::hasBlocks ( const SubdomainID  ) const
inlineoverridevirtualinherited

◆ hasBlocks() [6/6]

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

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

Parameters
nameA SubdomainName to check
Returns
True if the given id is valid for this object

Definition at line 224 of file BlockRestrictable.C.

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

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

◆ hasDirichletBC()

template<typename OutputType >
bool MooseVariableFV< OutputType >::hasDirichletBC ( ) const
inline

Returns true if a Dirichlet BC exists on the current face.

This only works if the variable has been initialized on a face with computeFaceValues. Its return value is nonsense if initialized on a single element via computeElemValues.

Definition at line 457 of file MooseVariableFV.h.

458 {
459 return _element_data->hasDirichletBC() || _neighbor_data->hasDirichletBC();
460 }

◆ hasDoFsOnNodes()

template<typename OutputType >
bool MooseVariableFV< 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 160 of file MooseVariableFV.h.

160{ 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 268 of file MooseFunctor.h.

983{
984 if (fi_elem_side)
985 return hasBlocks(fi.elem().subdomain_id());
986 else
987 return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
988}
const Elem & neighbor() const
Definition FaceInfo.h:220
virtual bool hasBlocks(SubdomainID) const
Returns whether the functor is defined on this block.

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject *  moose_object)
protectedinherited

An initialization routine needed for dual constructors.

Definition at line 76 of file BlockRestrictable.C.

77{
78 // If the mesh pointer is not defined, but FEProblemBase is, get it from there
79 if (_blk_feproblem != NULL && _blk_mesh == NULL)
81
82 // Check that the mesh pointer was defined, it is required for this class to operate
83 if (_blk_mesh == NULL)
84 mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
85 "pointer to the MooseMesh via '_mesh'");
86
87 // Populate the MaterialData pointer
88 if (_blk_feproblem != NULL)
89 {
90#ifdef MOOSE_KOKKOS_ENABLED
93 else
94#endif
96 }
97
98 // The 'block' input is defined
99 if (moose_object->isParamValid("block"))
100 {
101 // Extract the blocks from the input
102 _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");
103
104 // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
105 if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
107 else
108 {
109 // Get the IDs from the supplied names
111 _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
112 }
113 }
114
115 // When 'blocks' is not set and there is a "variable", use the blocks from the variable
116 else if (moose_object->isParamValid("variable"))
117 {
118 std::string variable_name = moose_object->parameters().getMooseType("variable");
119 if (!variable_name.empty())
121 ->getVariable(_blk_tid,
122 variable_name,
125 .activeSubdomains();
126 }
127
128 // Produce error if the object is not allowed to be both block and boundary restricted
129 if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
131 moose_object->paramError("block",
132 "Attempted to restrict the object '",
133 _blk_name,
134 "' to a block, but the object is already restricted by boundary");
135
136 // If no blocks were defined above, specify that it is valid on all blocks
137 if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
138 {
140 _blocks = {"ANY_BLOCK_ID"};
141 }
142
143 // If this object is block restricted, check that defined blocks exist on the mesh
144 if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
145 {
146 const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
147 std::vector<SubdomainID> diff;
148
149 std::set_difference(_blk_ids.begin(),
150 _blk_ids.end(),
151 valid_ids.begin(),
152 valid_ids.end(),
153 std::back_inserter(diff));
154
155 if (!diff.empty())
156 {
157 std::ostringstream msg;
158 auto sep = " ";
159 msg << "the following blocks (ids) do not exist on the mesh:";
160 for (const auto & id : diff)
161 {
162 if (_blk_name.size() > 0)
163 {
164 auto & name =
165 _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
166 if (std::to_string(id) != name)
167 msg << sep << name << " (" << id << ")";
168 else
169 msg << sep << id;
170 }
171 else
172 msg << sep << id;
173 sep = ", ";
174 }
175 std::vector<SubdomainID> valid_ids_vec(valid_ids.begin(), valid_ids.end());
176 auto valid_names = _blk_mesh->getSubdomainNames(valid_ids_vec);
177 msg << "\nBlocks names (resp. ids) that do exist: " << Moose::stringify(valid_names) << " ("
178 << Moose::stringify(valid_ids) << ")";
179 moose_object->paramError("block", msg.str());
180 }
181 }
182
183 // Get the mesh dimension for the blocks
184 if (blockRestricted())
186 else
188
189#ifdef MOOSE_KOKKOS_ENABLED
190 if (moose_object->isKokkosObject())
193#endif
194}
THREAD_ID _blk_tid
Thread id for this object.
const bool _blk_dual_restrictable
Flag for allowing dual restriction.
std::vector< SubdomainID > _vec_ids
Vector of block ids supplied by the user via the input file (for error reporting)
const MooseObject * _moose_object
Pointer to the MOOSE object.
void initializeKokkosBlockRestrictable()
const std::set< BoundaryID > & _boundary_ids
Reference to the boundary_ids, defaults to an empty set if not provided.
MaterialData & getMaterialData(Moose::MaterialDataType type, const THREAD_ID tid=0, const MooseObject *object=nullptr) const
MaterialData & getKokkosMaterialData(Moose::MaterialDataType type, const MooseObject *object=nullptr) const
void addKokkosMeshInitializationHook(std::function< void()> function)
Add a function hook that needs to be called after Kokkos mesh initialization.
virtual MooseMesh & mesh() override
std::string getMooseType(const std::string &name) const
Utility functions for retrieving one of the MooseTypes variables into the common "string" base class.
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 ...
Definition MooseBase.h:457
std::vector< SubdomainName > getSubdomainNames(const std::vector< SubdomainID > &subdomain_ids) const
Get the associated subdomainNames for the subdomain ids that are passed in.
Definition MooseMesh.C:1720
unsigned int getBlocksMaxDimension(const std::vector< SubdomainName > &blocks) const
Returns the maximum element dimension on the given blocks.
Definition MooseMesh.C:2970
bool isKokkosObject() const
Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by th...
Definition MooseObject.h:63
@ VAR_FIELD_ANY
Definition MooseTypes.h:781
@ BLOCK_MATERIAL_DATA
Definition MooseTypes.h:747
@ VAR_ANY
Definition MooseTypes.h:772
const BoundaryID ANY_BOUNDARY_ID
Definition MooseTypes.C:21

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

◆ initializeKokkosBlockRestrictable()

void BlockRestrictable::initializeKokkosBlockRestrictable ( )
protectedinherited

◆ initialSetup()

template<typename OutputType >
void MooseVariableFV< OutputType >::initialSetup ( )
overridevirtual

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

Reimplemented from MooseVariableBase.

Definition at line 847 of file MooseVariableFV.h.

848{
852}
void determineBoundaryToDirichletBCMap()
Setup the boundary to Dirichlet BC map.
void determineBoundaryToFluxBCMap()
Setup the boundary to Flux BC map.
virtual void initialSetup()
Gets called at the beginning of the simulation before this object is asked to do its job.

◆ insert()

template<typename OutputType >
void MooseVariableFV< 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 144 of file MooseVariableFV.C.

145{
146 _element_data->insert(residual);
147}

◆ insertLower()

template<typename OutputType >
void MooseVariableFV< 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 151 of file MooseVariableFV.C.

152{
153 lowerDError();
154}
void lowerDError() const
Emit an error message for unsupported lower-d ops.

◆ isArray()

template<typename OutputType >
bool MooseVariableField< OutputType >::isArray ( ) const
overridevirtualinherited
Returns
whether this is an array variable

Reimplemented from MooseVariableBase.

Definition at line 74 of file MooseVariableField.C.

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

◆ 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
idsA std::set of Subdomains to check
Returns
True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)
See also
hasBlocks

Definition at line 271 of file BlockRestrictable.C.

272{
273 // An empty input is assumed to be ANY_BLOCK_ID
274 if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
275 return true;
276
277 if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
278 return std::includes(ids.begin(),
279 ids.end(),
280 _blk_mesh->meshSubdomains().begin(),
281 _blk_mesh->meshSubdomains().end());
282 else
283 return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
284}

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

◆ isBlockSubset() [2/2]

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

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

Parameters
idsA std::vector of Subdomains to check
Returns
True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)
See also
hasBlocks

Definition at line 287 of file BlockRestrictable.C.

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

◆ isConstant()

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

Returns true if this functor is a constant.

Definition at line 266 of file MooseFunctor.h.

266{ return false; }

◆ isDirichletBoundaryFace()

template<typename OutputType >
bool MooseVariableFV< OutputType >::isDirichletBoundaryFace ( const FaceInfo &  fi,
const Elem *  elem,
const Moose::StateArg &  state 
) const
virtual

Determine whether a specified face side is a Dirichlet boundary face.

In the base implementation we only inspect the face information object for whether there are Dirichlet conditions. However, derived classes may allow discontinuities between + and - side face values, e.g. one side may have a Dirichlet condition and the other side may perform extrapolation to determine its value

Parameters
fiThe face information object
elemAn element that can be used to indicate sidedness of the face
stateThe state at which to determine whether the face is a Dirichlet face or not
Returns
Whether the potentially sided (as indicated by elem) fi is a Dirichlet boundary face for this variable

Definition at line 476 of file MooseVariableFV.C.

479{
480 const auto & pr = getDirichletBC(fi);
481
482 // First member of this pair indicates whether we have a DirichletBC
483 return pr.first;
484}

◆ isExtrapolatedBoundaryFace()

template<typename OutputType >
bool MooseVariableFV< OutputType >::isExtrapolatedBoundaryFace ( const FaceInfo &  fi,
const Elem *  elem,
const Moose::StateArg &  state 
) const
overrideprotectedvirtual

Returns whether this is an extrapolated boundary face.

An extrapolated boundary face is boundary face for which is not a corresponding Dirichlet condition, e.g. we need to compute some approximation for the boundary face value using the adjacent cell centroid information. In the base implementation we only inspect the face information object for whether we should perform extrapolation. However, derived classes may allow discontinuities between + and - side face values, e.g. one side may have a Dirichlet condition and the other side may perform extrapolation to determine its value

Parameters
fiThe face information object
elemAn element that can be used to indicate sidedness of the face
stateThe state at which to determine whether the face is extrapolated or not
Returns
Whether the potentially sided (as indicated by elem) fi is an extrapolated boundary face for this variable

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

Definition at line 507 of file MooseVariableFV.C.

510{
511 if (isDirichletBoundaryFace(fi, elem, state))
512 return false;
513 else
514 return !this->isInternalFace(fi);
515}

◆ isFV()

template<typename OutputType >
virtual bool MooseVariableFV< OutputType >::isFV ( ) const
inlineoverridevirtual

Reimplemented from MooseVariableFieldBase.

Definition at line 96 of file MooseVariableFV.h.

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

576{
577 if (!fi.neighborPtr())
578 return false;
579
580 return hasBlocks(fi.elem().subdomain_id()) && hasBlocks(fi.neighborPtr()->subdomain_id());
581}

◆ isKokkosObject()

bool MooseObject::isKokkosObject ( ) const
inlineinherited

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

Definition at line 63 of file MooseObject.h.

63{ return parameters().isKokkosObject(); }
bool isKokkosObject() const
Returns whether this InputParameters belongs to a Kokkos object Checks whether MooseBase::kokkos_obje...

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

◆ isNodal()

template<typename OutputType >
virtual bool MooseVariableFV< OutputType >::isNodal ( ) const
inlinefinaloverridevirtual

Is this variable nodal.

Returns
true if it nodal, otherwise false

Reimplemented from MooseVariableBase.

Definition at line 158 of file MooseVariableFV.h.

158{ return false; }

◆ isNodalDefined()

template<typename OutputType >
virtual bool MooseVariableFV< 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 167 of file MooseVariableFV.h.

167{ 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
nameThe name of the parameter to test

Definition at line 205 of file MooseBase.h.

206 {
208 }
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was set by the user.

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

◆ isParamValid()

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

Test if the supplied parameter is valid.

Parameters
nameThe name of the parameter to test

Definition at line 199 of file MooseBase.h.

199{ return _pars.isParamValid(name); }
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another,...

Referenced by GridPartitioner::_do_partition(), HierarchicalGridPartitioner::_do_partition(), AddVariableAction::act(), AutoCheckpointAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CopyNodalVarsAction::act(), CreateDisplacedProblemAction::act(), SetAdaptivityOptionsAction::act(), SetupDebugAction::act(), SetupMeshCompleteAction::act(), DiffusionCG::addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), ComponentJunction::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), AdvectiveFluxAux::AdvectiveFluxAux(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayVarReductionAux::ArrayVarReductionAux(), BicubicSplineFunction::BicubicSplineFunction(), BlockDeletionGenerator::BlockDeletionGenerator(), BSplineCurveGenerator::BSplineCurveGenerator(), TimedSubdomainModifier::buildFromFile(), ParsedChainControl::buildFunction(), GeneratedMesh::buildMesh(), MooseMesh::buildTypedMesh(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), SurfaceDelaunayGeneratorBase::checkBoundaryAndHolesParams(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), LibmeshPartitioner::clone(), SampledOutput::cloneMesh(), CombinedVectorPostprocessor::CombinedVectorPostprocessor(), CombinerGenerator::CombinerGenerator(), ComponentJunction::ComponentJunction(), ConservativeAdvectionBCTempl< is_ad >::ConservativeAdvectionBCTempl(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), FEProblemSolve::convergenceSetup(), CopyMeshPartitioner::CopyMeshPartitioner(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), CutMeshByLevelSetGeneratorBase::CutMeshByLevelSetGeneratorBase(), ConstantReporter::declareConstantReporterValue(), ConstantReporter::declareConstantReporterValues(), DGKernelBase::DGKernelBase(), DiffusionFluxAux::DiffusionFluxAux(), DiffusionPhysicsBase::DiffusionPhysicsBase(), DomainUserObject::DomainUserObject(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), EigenProblemSolve::EigenProblemSolve(), ElementGenerator::ElementGenerator(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), PIDTransientControl::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), Exodus::Exodus(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FileOutput::FileOutput(), SurfaceDelaunayGeneratorBase::fillDelaunayOptions(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), FunctionDT::FunctionDT(), FunctionValuePostprocessor::FunctionValuePostprocessor(), FVInterfaceKernel::FVInterfaceKernel(), FVMassMatrix::FVMassMatrix(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), AddMetaDataGenerator::generate(), BlockDeletionGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), BSplineCurveGenerator::generate(), ConcentricCircleMeshGenerator::generate(), DistributedRectilinearMeshGenerator::generate(), ElementGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), GeneratedMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), ManifoldSubdomainGenerator::generate(), MeshExtruderGenerator::generate(), OrientSurfaceMeshGenerator::generate(), ParsedExtraElementIDGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), RenumberBySubdomainGenerator::generate(), SideSetsFromNodeSetsGenerator::generate(), SphereMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), SubdomainPerElementGenerator::generate(), XYDelaunayGenerator::generate(), XYMeshLineCutter::generate(), XYZDelaunayGenerator::generate(), PropertyReadFile::getFileNames(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getRenamedParam(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), AddPeriodicBCAction::getVariables(), Terminator::handleMessage(), HFEMDirichletBC::HFEMDirichletBC(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), AdvancedOutput::initAvailableLists(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionAux::initialSetup(), SolutionScalarAux::initialSetup(), PIDTransientControl::initialSetup(), ParsedConvergence::initialSetup(), EigenProblemSolve::initialSetup(), MooseParsedFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedVectorFunction::initialSetup(), PiecewiseTabularBase::initialSetup(), SolutionIC::initialSetup(), Console::initialSetup(), MultiAppCloneReporterTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppVariableValueSampleTransfer::initialSetup(), SampledOutput::initSample(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), PNGOutput::makePNG(), MassMatrix::MassMatrix(), MatCoupledForce::MatCoupledForce(), MeshGeneratorComponent::MeshGeneratorComponent(), MFEMProblemSolve::MFEMProblemSolve(), MooseMesh::MooseMesh(), MoosePreconditioner::MoosePreconditioner(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MooseVariableFV< RealEigenVector >::MooseVariableFV(), MortarConstraintBase::MortarConstraintBase(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppCloneReporterTransfer::MultiAppCloneReporterTransfer(), MultiAppGeneralFieldKDTreeTransferBase::MultiAppGeneralFieldKDTreeTransferBase(), MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiPostprocessorConvergence::MultiPostprocessorConvergence(), MultiSystemSolveObject::MultiSystemSolveObject(), NodeSetsGeneratorBase::NodeSetsGeneratorBase(), EigenExecutionerBase::normalizeSolution(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), Output::Output(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedSubdomainGeneratorBase::ParsedSubdomainGeneratorBase(), PetscOutput::PetscOutput(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), EqualValueBoundaryConstraint::pickPrimaryNode(), PIDTransientControl::PIDTransientControl(), PiecewiseTabularBase::PiecewiseTabularBase(), PlaneIDMeshGenerator::PlaneIDMeshGenerator(), EqualValueBoundaryConstraint::populateSecondaryNodes(), MooseMesh::prepare(), MultiApp::readCommandLineArguments(), SolutionUserObjectBase::readExodusIIOrNemesis(), ReferenceResidualInterface::ReferenceResidualInterface(), RenameBlockGenerator::RenameBlockGenerator(), ReporterPointSource::ReporterPointSource(), PhysicsBase::reportPotentiallyMissedParameters(), ParsedSubdomainMeshGenerator::setBlockName(), MooseMesh::setCoordSystem(), FileOutput::setFileBaseInternal(), SideSetsGeneratorBase::setup(), SurfaceMeshGeneratorBase::setup(), Split::setup(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), Output::setWallTimeIntervalFromCommandLineParam(), SideDiffusiveFluxIntegralTempl< is_ad, T >::SideDiffusiveFluxIntegralTempl(), SideSetsGeneratorBase::SideSetsGeneratorBase(), SolutionUserObjectBase::SolutionUserObjectBase(), Terminator::Terminator(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), PIDTransientControl::timestepSetup(), MultiAppDofCopyTransfer::transfer(), TransformGenerator::TransformGenerator(), TransientBase::TransientBase(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), XYQuadrilateralMeshFromBoundaryCurve::XYQuadrilateralMeshFromBoundaryCurve(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

◆ isVector()

template<typename OutputType >
bool MooseVariableField< OutputType >::isVector ( ) const
overridevirtualinherited
Returns
true if this is a vector-valued element, false otherwise.

Implements MooseVariableFieldBase.

Definition at line 85 of file MooseVariableField.C.

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

◆ jacobianSetup()

template<typename OutputType >
void MooseVariableFV< OutputType >::jacobianSetup ( )
overridevirtual

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

Reimplemented from MooseVariableField< OutputType >.

Definition at line 705 of file MooseVariableFV.C.

706{
707 clearCaches();
708}
void clearCaches()
clear finite volume caches

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const
inlineinherited

◆ kokkosBlockElementID()

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

◆ kokkosBlockElementSideID()

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

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

Parameters
tidThe thread ID
Returns
The contiguous element ID - side index pair

Definition at line 298 of file BlockRestrictable.h.

299 {
300 return _kokkos_element_side_ids[tid];
301 }
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > > _kokkos_element_side_ids
List of contiguous local element ID - side index pairs this Kokkos object is operating on.

◆ kokkosBlockNodeID()

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

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

Parameters
tidThe thread ID
Returns
the contiguous node ID

Definition at line 289 of file BlockRestrictable.h.

290 {
291 return _kokkos_node_ids[tid];
292 }
Moose::Kokkos::Array< ContiguousNodeID > _kokkos_node_ids
List of contiguous node IDs this Kokkos object is operating on.

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

◆ lowerDError()

template<typename OutputType >
void MooseVariableFV< OutputType >::lowerDError ( ) const
private

Emit an error message for unsupported lower-d ops.

Definition at line 882 of file MooseVariableFV.h.

883{
884 mooseError("Lower dimensional element support not implemented for finite volume variables");
885}

◆ matrixTagValue()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::matrixTagValue ( TagID  tag) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 215 of file MooseVariableFV.h.

216 {
217 return _element_data->matrixTagValue(tag);
218 }

◆ matrixTagValueNeighbor()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::matrixTagValueNeighbor ( TagID  tag)
inline

Definition at line 223 of file MooseVariableFV.h.

224 {
225 return _neighbor_data->matrixTagValue(tag);
226 }

◆ meshBlockIDs()

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

Return all of the SubdomainIDs for the mesh.

Returns
A set of all subdomians for the entire mesh

Definition at line 294 of file BlockRestrictable.C.

295{
296 return _blk_mesh->meshSubdomains();
297}

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

◆ meshChanged()

template<typename OutputType >
void MooseVariableFV< OutputType >::meshChanged ( )
overridevirtual

Called on this object when the mesh changes.

Reimplemented from MeshChangedInterface.

Definition at line 856 of file MooseVariableFV.h.

857{
858 _prev_elem = nullptr;
859 _dirichlet_map_setup = false;
860 _flux_map_setup = false;
862}
virtual void meshChanged()
Called on this object when the mesh changes.

◆ messagePrefix() [1/2]

std::string MooseBase::messagePrefix ( const bool  hit_prefix = true) const
inlineinherited
Returns
A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 256 of file MooseBase.h.

257 {
258 return messagePrefix(_pars, hit_prefix);
259 }

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

◆ messagePrefix() [2/2]

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

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

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

Definition at line 140 of file MooseBase.C.

141{
142 std::string prefix = "";
143
144 if (hit_prefix)
145 if (const auto node = MooseBase::getHitNode(params))
146 prefix += Moose::hitMessagePrefix(*node);
147
148 // Don't have context without type and name
149 if (!params.isMooseBaseObject())
150 return prefix;
151
152 const auto & name = params.getObjectName();
153 const std::string base = params.hasBase() ? params.getBase() : "object";
154 const bool is_main_app = base == "Application" && name == AppFactory::main_app_name;
155 prefix += "The following occurred in the ";
156 if (is_main_app)
157 prefix += "main " + base;
158 else
159 prefix += base;
160 if (base != params.getObjectName() && name.size() && !is_main_app)
161 prefix += " '" + name + "'";
162 prefix += " of type " + params.getObjectType() + ".";
163 return prefix + "\n\n";
164}
static const std::string main_app_name
The name for the "main" moose application.
Definition AppFactory.h:68
bool isMooseBaseObject() const
const std::string & getObjectType() const
const std::string & getObjectName() const
std::string hitMessagePrefix(const hit::Node &node)
Get the prefix to be associated with a hit node for a message.
Definition Moose.C:898

◆ mooseDeprecated() [1/2]

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

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

Definition at line 317 of file MooseBase.h.

318 {
320 _console, false, true, true, messagePrefix(true), std::forward<Args>(args)...);
321 }
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
void mooseDeprecatedStream(S &oss, const bool expired, const bool print_title, const bool show_trace, Args &&... args)
Definition MooseError.h:252

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

◆ mooseDeprecated() [2/2]

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

◆ mooseDeprecatedNoTrace()

template<typename... Args>
void MooseBase::mooseDeprecatedNoTrace ( Args &&...  args) const
inlineinherited

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

Definition at line 327 of file MooseBase.h.

328 {
330 _console, false, true, false, messagePrefix(true), std::forward<Args>(args)...);
331 }

◆ mooseDocumentedError()

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

Definition at line 277 of file MooseBase.h.

280 {
282 repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
283 /* with_prefix = */ true);
284 }
std::string formatMooseDocumentedError(const std::string &repo_name, const unsigned int issue_num, const std::string &msg)
Formats a documented error.
Definition MooseError.C:140

Referenced by ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

◆ mooseError()

template<typename... Args>
void MooseBase::mooseError ( Args &&...  args) const
inlineinherited

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

Definition at line 271 of file MooseBase.h.

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

Referenced by CopyMeshPartitioner::_do_partition(), GridPartitioner::_do_partition(), HierarchicalGridPartitioner::_do_partition(), PetscExternalPartitioner::_do_partition(), AdaptivityAction::act(), AddBoundsVectorsAction::act(), AddFVICAction::act(), AddICAction::act(), AddMeshGeneratorAction::act(), AddPeriodicBCAction::act(), AddTimeStepperAction::act(), AddVectorPostprocessorAction::act(), ChainControlSetupAction::act(), CheckFVBCAction::act(), CheckIntegrityAction::act(), CombineComponentsMeshes::act(), CommonOutputAction::act(), CreateDisplacedProblemAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CSGOnlyAction::act(), DeprecatedBlockAction::act(), InitProblemAction::act(), MaterialDerivativeTestAction::act(), MaterialOutputAction::act(), SetAdaptivityOptionsAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), SetupMeshCompleteAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SplitMeshAction::act(), Action::Action(), AddActionComponentAction::AddActionComponentAction(), PhysicsComponentInterface::addBoundaryConditionsFromComponents(), MooseApp::addCapabilityInternal(), DistributedRectilinearMeshGenerator::addElement(), MooseApp::addExecutor(), SubProblem::addFunctor(), PhysicsComponentInterface::addInitialConditionsFromComponents(), ComponentJunction::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), SubProblem::addPiecewiseByBlockLambdaFunctor(), DistributedRectilinearMeshGenerator::addPoint(), DiracKernelBase::addPointWithValidId(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), MooseMesh::addQuadratureNode(), AddActionComponentAction::addRelationshipManagers(), WebServerControl::addServerAction(), AddVariableAction::addVariable(), SubProblem::addVectorTag(), MooseVariableScalar::adUDot(), Output::advancedExecuteOn(), MooseVariableBase::allDofIndices(), MooseApp::appNameToLibName(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), MooseApp::attachRelationshipManagers(), MooseApp::attachRelationshipManagers(), Function::average(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), MooseMesh::buildCoarseningMap(), MultiApp::buildComm(), DistributedRectilinearMeshGenerator::buildCube(), PiecewiseTabularInterface::buildFromFile(), PiecewiseTabularInterface::buildFromJSON(), PiecewiseTabularInterface::buildFromXY(), MooseMesh::buildLowerDMesh(), GeneratedMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), TiledMesh::buildMesh(), MooseMesh::buildRefinementMap(), MaterialBase::buildRequiredMaterials(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), PhysicsBase::checkBlockRestrictionIdentical(), ComponentBoundaryConditionInterface::checkBoundaryConditionsAllRequested(), SubProblem::checkBoundaryMatProps(), PhysicsBase::checkComponentType(), IterationCountConvergence::checkConvergence(), MooseMesh::checkCoordinateSystems(), DiffusionLHDGAssemblyHelper::checkCoupling(), DefaultConvergenceBase::checkDuplicateSetSharedExecutionerParams(), MooseMesh::checkDuplicateSubdomainNames(), MaterialBase::checkExecutionStage(), FVFluxBC::checkFaceIntegrity(), FVInterfaceKernel::checkFaceIntegrity(), MeshGenerator::checkGetMesh(), ReporterTransferInterface::checkHasReporterValue(), EigenExecutionerBase::checkIntegrity(), Eigenvalue::checkIntegrity(), ExplicitTimeIntegrator::checkLinearConvergence(), MooseApp::checkMetaDataIntegrity(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), PostprocessorInterface::checkParam(), Moose::PeriodicBCHelper::checkPeriodicParams(), Sampler::checkReinitStatus(), MultiAppTransfer::checkSiblingsTransferSupported(), MaterialBase::checkStatefulSanity(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Moose::PetscSupport::checkUserProvidedPetscOption(), MultiAppTransfer::checkVariable(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), MooseMesh::clone(), LibmeshPartitioner::clone(), CombinerGenerator::CombinerGenerator(), MooseVariableFieldBase::componentName(), VariableCondensationPreconditioner::computeDInverseDiag(), CompositionDT::computeDT(), MooseVariableFieldBase::computeFaceValues(), TimeStepper::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), MooseMesh::computeFiniteVolumeCoords(), Moose::Kokkos::ResidualObject::computeOffDiagJacobian(), MaterialBase::computeProperties(), ResidualObject::computeResidualAndJacobian(), TimeStepper::computeStep(), AStableDirk4::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), ExplicitEuler::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), ConcentricCircleMesh::ConcentricCircleMesh(), ConditionalEnableControl::ConditionalEnableControl(), TimeStepper::constrainStep(), LibtorchNeuralNetControl::controlNeuralNet(), TransientBase::convergedToSteadyState(), ParsedConvergence::convertRealToBool(), MooseApp::copyInputs(), CopyMeshPartitioner::CopyMeshPartitioner(), MultiApp::createApp(), MooseApp::createExecutors(), AddVariableAction::createInitialConditionAction(), MooseApp::createRMFromTemplateAndInit(), Function::curl(), ReporterTransferInterface::declareClone(), Moose::Kokkos::MaterialBase::declareKokkosPropertyInternal(), MeshGenerator::declareMeshProperty(), ReporterTransferInterface::declareVectorClone(), FunctorRelationshipManager::delete_remote_elements(), MooseMesh::deleteRemoteElements(), MooseApp::determineLibtorchDeviceType(), MeshDiagnosticsGenerator::diagnosticsLog(), Function::div(), FunctorBinnedValuesDivision::divisionIndex(), FunctorRelationshipManager::dofmap_reinit(), MooseApp::dynamicAllRegistration(), MooseApp::dynamicAppRegistration(), DistributedRectilinearMeshGenerator::elemId(), MooseApp::errorCheck(), MooseMesh::errorIfDistributedMesh(), MultiAppTransfer::errorIfObjectExecutesOnTransferInSourceApp(), FixedPointSolve::examineFixedPointConvergence(), Eigenvalue::execute(), TransientBase::execute(), WebServerControl::execute(), MooseApp::executeExecutioner(), FVInterfaceKernel::faceArg1(), FVInterfaceKernel::faceArg2(), MultiApp::fillPositions(), MooseApp::finalizeRestore(), Transfer::find_sys(), DiracKernelInfo::findPoint(), FixedPointSolve::findTransformedSystem(), FixedPointSolve::FixedPointSolve(), FunctionDT::FunctionDT(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), LinearFVBoundaryCondition::functorFaceArg(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), FVScalarLagrangeMultiplierInterface::FVScalarLagrangeMultiplierInterface(), AdvancedExtruderGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), CoarsenBlockGenerator::generate(), CombinerGenerator::generate(), CutMeshByLevelSetGeneratorBase::generate(), DistributedRectilinearMeshGenerator::generate(), ElementOrderConversionGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), FlipSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MeshCollectionGenerator::generate(), MeshDiagnosticsGenerator::generate(), MeshExtruderGenerator::generate(), MeshRepairGenerator::generate(), MoveNodeGenerator::generate(), PlaneIDMeshGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), ProjectSideSetOntoLevelSetGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), RenumberBySubdomainGenerator::generate(), SmoothMeshGenerator::generate(), SpiralAnnularMeshGenerator::generate(), StackGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), SubdomainPerElementGenerator::generate(), TiledMeshGenerator::generate(), XYMeshLineCutter::generate(), XYZDelaunayGenerator::generate(), PatternedMeshGenerator::generate(), MeshGenerator::generateCSG(), MeshGenerator::generateData(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), CircularBoundaryCorrectionGenerator::generateRadialCorrectionFactor(), MooseMesh::getAxisymmetricRadialCoord(), MooseMesh::getBlockConnectedBlocks(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), ChainControl::getChainControlDataByName(), WebServerControl::getClientInfo(), MooseMesh::getCoarseningMap(), MultiApp::getCommandLineArgs(), MooseVariableBase::getContinuity(), Control::getControllableParameterByName(), MooseMesh::getCoordSystem(), PhysicsBase::getCoupledPhysics(), PhysicsBase::getCoupledPhysics(), DataFileInterface::getDataFilePath(), TransfiniteMeshGenerator::getDiscreteEdge(), MooseVariableBase::getDofIndices(), VariableCondensationPreconditioner::getDofToCondense(), TransfiniteMeshGenerator::getEdge(), EigenExecutionerBase::getEigenSystemConvergence(), MooseMesh::getElementIDIndex(), Material::getElementIDNeighbor(), Material::getElementIDNeighborByName(), MooseMesh::getElemIDMapping(), MooseMesh::getElemIDsOnBlocks(), WebServerControl::Response::getError(), MultiApp::getExecutioner(), MooseApp::getExecutor(), MultiAppTransfer::getFromMultiApp(), MultiAppTransfer::getFromMultiAppInfo(), SubProblem::getFunctor(), MooseMesh::getGeneralAxisymmetricCoordAxis(), MaterialPropertyInterface::getGenericMaterialPropertyByName(), DistributedRectilinearMeshGenerator::getGhostNeighbors(), DistributedRectilinearMeshGenerator::getIndices(), MaterialPropertyInterface::getKokkosBlockMaterialProperty(), FunctionInterface::getKokkosFunctionByName(), MaterialPropertyInterface::getKokkosMaterialPropertyByName(), Material::getMaterialByName(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), AnnularMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MultiAppTransfer::getMultiApp(), DistributedRectilinearMeshGenerator::getNeighbors(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), MooseMesh::getPairedBoundaryMapping(), MaterialOutputAction::getParams(), PlaneIDMeshGenerator::getPlaneID(), PostprocessorInterface::getPostprocessorValueByNameInternal(), ComponentMaterialPropertyInterface::getPropertyValue(), MooseMesh::getRefinementMap(), MooseBase::getRenamedParam(), ReporterInterface::getReporterContextBaseByName(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), MooseApp::getRestartableDataMap(), MooseApp::getRestartableDataMapName(), MooseApp::getRestartableMetaData(), MooseApp::getRMClone(), MooseObject::getSharedPtr(), MooseObject::getSharedPtr(), PhysicsBase::getSolverSystem(), MooseMesh::getSubdomainBoundaryIds(), TransientBase::getTimeIntegratorNames(), MultiAppTransfer::getToMultiApp(), MultiAppTransfer::getToMultiAppInfo(), MooseMesh::getUniqueCoordSystem(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectName(), SubProblem::getVariableHelper(), AddPeriodicBCAction::getVariables(), VectorPostprocessorInterface::getVectorPostprocessorName(), SubProblem::getVectorTag(), SubProblem::getVectorTagID(), MultiApp::globalAppToLocal(), Function::gradient(), MooseVariableBase::hasDoFsOnNodes(), PostprocessorInterface::hasPostprocessor(), PostprocessorInterface::hasPostprocessorByName(), ReporterInterface::hasReporterValue(), ReporterInterface::hasReporterValueByName(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::hasVectorPostprocessorByName(), VectorPostprocessorInterface::hasVectorPostprocessorByName(), TransientBase::incrementStepOrReject(), NEML2Action::inferMOOSEIOType(), AddVariableAction::init(), MooseMesh::init(), Sampler::init(), EigenExecutionerBase::init(), TransientBase::init(), MFEMMesh::init(), CrankNicolson::init(), ExplicitTimeIntegrator::init(), FixedPointIterationAdaptiveDT::init(), IterationAdaptiveDT::init(), MultiApp::init(), NestedDivision::initialize(), ParsedConvergence::initializeConstantSymbol(), PhysicsBase::initializePhysics(), SubProblem::initialSetup(), AuxKernelBase::initialSetup(), SolutionScalarAux::initialSetup(), FullSolveMultiApp::initialSetup(), ExplicitTimeIntegrator::initialSetup(), Function::integral(), InternalSideIndicatorBase::InternalSideIndicatorBase(), EigenExecutionerBase::inversePowerIteration(), Sampler::isAdaptiveSamplingCompleted(), MooseMesh::isBoundaryFullyExternalToSubdomains(), MooseVariableBase::isNodal(), IterationAdaptiveDT::IterationAdaptiveDT(), IterationCountConvergence::IterationCountConvergence(), LibmeshPartitioner::LibmeshPartitioner(), MooseApp::libNameToAppName(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), LineSearch::lineSearch(), MooseApp::loadLibraryAndDependencies(), ReporterPointMarker::markerSetup(), Material::Material(), Distribution::median(), FunctorRelationshipManager::mesh_reinit(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshRepairGenerator::MeshRepairGenerator(), SetupMeshAction::modifyParamsForUseSplit(), MeshMetaDataInterface::mooseErrorInternal(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), UserObjectInterface::mooseObjectError(), MooseVariableBase::MooseVariableBase(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppTransfer::MultiAppTransfer(), NewmarkBeta::NewmarkBeta(), DistributedRectilinearMeshGenerator::nodeId(), DistributedRectilinearMeshGenerator::numNeighbors(), Output::onInterval(), FunctorRelationshipManager::operator()(), RelationshipManager::operator==(), ActionComponent::outerSurfaceArea(), ActionComponent::outerSurfaceBoundaries(), MortarNodalGeometryOutput::output(), Output::Output(), MooseApp::outputMachineReadableData(), DistributedRectilinearMeshGenerator::paritionSquarely(), ParsedConvergence::ParsedConvergence(), ParsedCurveGenerator::ParsedCurveGenerator(), ExplicitTimeIntegrator::performExplicitSolve(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PIDTransientControl::PIDTransientControl(), PiecewiseTabularInterface::PiecewiseTabularInterface(), CutMeshByLevelSetGeneratorBase::pointPairLevelSetInterception(), ProjectSideSetOntoLevelSetGenerator::pointPairLevelSetInterception(), ReporterInterface::possiblyCheckHasReporter(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName(), AStableDirk4::postResidual(), ExplicitRK2::postResidual(), ExplicitTVDRK2::postResidual(), ImplicitMidpoint::postResidual(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), LStableDirk4::postResidual(), VariableCondensationPreconditioner::preallocateCondensedJacobian(), Predictor::Predictor(), TransientBase::preExecute(), MooseMesh::prepare(), MooseMesh::prepared(), FixedPointSolve::printFixedPointConvergenceReason(), MFEMFunctorMaterial::processLiterals(), MultiApp::readCommandLineArguments(), CoarsenBlockGenerator::recursiveCoarsen(), MooseApp::recursivelyCreateExecutors(), FunctorRelationshipManager::redistribute(), MooseApp::registerRestartableData(), MooseApp::registerRestartableNameWithFilter(), Sampler::reinit(), MooseApp::removeRelationshipManager(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::restore(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), MooseApp::run(), MooseApp::runInputs(), ScalarComponentIC::ScalarComponentIC(), DistributedRectilinearMeshGenerator::scaleNodalPositions(), FunctorRelationshipManager::set_mesh(), MooseVariableBase::setActiveTags(), DistributedRectilinearMeshGenerator::setBoundaryNames(), MooseMesh::setCoordSystem(), MooseMesh::setGeneralAxisymmetricCoordAxes(), MeshGenerator::setMeshProperty(), MooseApp::setMFEMDevice(), Sampler::setNumberOfCols(), Sampler::setNumberOfRandomSeeds(), Sampler::setNumberOfRows(), Moose::MFEM::LinearSolverBase::SetPreconditioner(), Split::setup(), TransientMultiApp::setupApp(), Moose::PeriodicBCHelper::setupAutoPeriodicBoundaries(), Moose::PeriodicBCHelper::setupManualPeriodicBoundaries(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), PhysicsBase::shouldCreateIC(), PhysicsBase::shouldCreateTimeDerivative(), PhysicsBase::shouldCreateVariable(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), MooseVariableBase::sizeMatrixTagData(), SmoothMeshGenerator::SmoothMeshGenerator(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), Moose::MFEM::LinearSolverBase::Solve(), TimeIntegrator::solve(), ExplicitRK2::solve(), ExplicitTVDRK2::solve(), FullSolveMultiApp::solveStep(), UserObject::spatialPoints(), UserObject::spatialValue(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), MeshRepairGenerator::splitNonConvexPolygons(), WebServerControl::startServer(), StitchedMesh::StitchedMesh(), MaterialBase::subdomainSetup(), CutMeshByLevelSetGeneratorBase::tet4ElemCutter(), Action::timedAct(), Function::timeDerivative(), Function::timeIntegral(), ParsedCurveGenerator::tSectionSpaceDefiner(), MooseVariableScalar::uDot(), MooseVariableScalar::uDotDot(), MooseVariableScalar::uDotDotOld(), MooseVariableScalar::uDotOld(), MooseBase::uniqueName(), AuxScalarKernel::uOld(), ScalarKernelBase::uOld(), Function::value(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), PhysicsBase::variableExists(), MultiAppTransfer::variableIntegrityCheck(), AddVariableAction::variableType(), SubProblem::vectorTagName(), SubProblem::vectorTagType(), Function::vectorValue(), SubProblem::verifyVectorTags(), ActionComponent::volume(), WebServerControl::WebServerControl(), WebServerControl::writePortFile(), MFEMMesh::writeRecoveryFiles(), and MooseApp::writeRestartableMetaData().

◆ mooseErrorNonPrefixed()

template<typename... Args>
void MooseBase::mooseErrorNonPrefixed ( Args &&...  args) const
inlineinherited

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

Definition at line 290 of file MooseBase.h.

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

◆ mooseInfo()

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

◆ mooseWarning() [1/2]

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

Emits a warning prefixed with object name and type.

Definition at line 299 of file MooseBase.h.

300 {
301 moose::internal::mooseWarningStream(_console, messagePrefix(true), std::forward<Args>(args)...);
302 }
void mooseWarningStream(S &oss, Args &&... args)
Definition MooseError.h:197

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

◆ mooseWarning() [2/2]

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

Definition at line 73 of file SolutionInvalidInterface.h.

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

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

◆ mooseWarningNonPrefixed() [1/2]

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

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

Definition at line 308 of file MooseBase.h.

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

◆ mooseWarningNonPrefixed() [2/2]

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

Definition at line 80 of file SolutionInvalidInterface.h.

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

◆ name()

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

Get the name of the class.

Returns
The name of the class

Definition at line 103 of file MooseBase.h.

104 {
105 mooseAssert(_name.size(), "Empty name");
106 return _name;
107 }
const std::string & _name
The name of this class.
Definition MooseBase.h:381

Referenced by AdaptivityAction::act(), AddActionComponentAction::act(), AddElementalFieldAction::act(), AddPeriodicBCAction::act(), AddTimeStepperAction::act(), CommonOutputAction::act(), CopyNodalVarsAction::act(), CSGOnlyAction::act(), DeprecatedBlockAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), SetupResidualDebugAction::act(), SetupTimeIntegratorAction::act(), FEProblemBase::addAnyRedistributers(), Executioner::addAttributeReporter(), FEProblemBase::addAuxKernel(), MFEMProblem::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), FEProblemBase::addBoundaryCondition(), MFEMProblem::addBoundaryCondition(), PhysicsComponentInterface::addComponent(), FEProblemBase::addConstraint(), FEProblemBase::addConvergence(), FEProblemBase::addDamper(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), MooseApp::addExecutor(), MooseApp::addExecutorParams(), MFEMProblem::addFESpace(), MFEMProblem::addFESpaceHierarchy(), FEProblemBase::addFunction(), MFEMProblem::addFunction(), SubProblem::addFunctor(), FEProblemBase::addFunctorMaterial(), MFEMProblem::addFunctorMaterial(), FunctorMaterial::addFunctorProperty(), FunctorMaterial::addFunctorPropertyByBlocks(), FEProblemBase::addFVBC(), FEProblemBase::addFVGradientMethod(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVInterfaceKernel(), FEProblemBase::addFVInterpolationMethod(), FEProblemBase::addFVKernel(), ADDGKernel::ADDGKernel(), FEProblemBase::addHDGKernel(), MFEMProblem::addImagComponentToBC(), MFEMProblem::addImagComponentToKernel(), FEProblemBase::addIndicator(), MFEMProblem::addIndicator(), FEProblemBase::addInitialCondition(), MFEMProblem::addInitialCondition(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), ElementAndTraceScalarHDGAssemblyHelper::additionalROVariables(), BoundaryIntegralValueConstraint::additionalROVariables(), DiffusionLHDGKernel::additionalROVariables(), ADKernelScalarBase::additionalROVariables(), FEProblemBase::addKernel(), MFEMProblem::addKernel(), FEProblemBase::addLinearFVBC(), FEProblemBase::addLinearFVKernel(), FEProblemBase::addMarker(), MFEMProblem::addMarker(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), ComponentMaterialPropertyInterface::addMaterials(), FEProblemBase::addMeshDivision(), MooseApp::addMeshGenerator(), ComponentJunction::addMeshGenerators(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), MFEMProblem::addMFEMProblemComposer(), MFEMProblem::addMFEMSolver(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObject(), InitialConditionWarehouse::addObject(), ComponentPhysicsInterface::addPhysics(), SubProblem::addPiecewiseByBlockLambdaFunctor(), FEProblemBase::addPostprocessor(), MFEMProblem::addPostprocessor(), UserObjectBase::addPostprocessorDependencyHelper(), AuxKernelBase::addPostprocessorDependencyHelper(), InitialConditionBase::addPostprocessorDependencyHelper(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), MFEMProblem::addRealComponentToBC(), MFEMProblem::addRealComponentToKernel(), AddActionComponentAction::addRelationshipManagers(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addScalarKernel(), WebServerControl::addServerActionsInternal(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), MFEMProblem::addTransfer(), PhysicsBase::addUserObject(), FEProblemBase::addUserObject(), UserObjectBase::addUserObjectDependencyHelper(), AuxKernelBase::addUserObjectDependencyHelper(), InitialConditionBase::addUserObjectDependencyHelper(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), MFEMProblem::addVectorPostprocessor(), UserObjectBase::addVectorPostprocessorDependencyHelper(), AuxKernelBase::addVectorPostprocessorDependencyHelper(), MooseLinearVariableFV< OutputType >::adError(), Output::advancedExecuteOn(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), NEML2ModelExecutor::advanceState(), MooseVariableBase::allDofIndices(), MooseApp::appBinaryName(), MooseApp::appendMeshGenerator(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayDGKernel::ArrayDGKernel(), ArrayParsedAux::ArrayParsedAux(), PhysicsBase::assignBlocks(), AStableDirk4::AStableDirk4(), Function::average(), MultiApp::backup(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), PiecewiseTabularInterface::buildFromFile(), PiecewiseTabularInterface::buildFromXY(), MFEMGeometricMultigridSolver::BuildMultigrid(), MooseMesh::buildNodeListFromSideList(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), MooseBase::callMooseError(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::checkComponentType(), DefaultNonlinearConvergence::checkConvergence(), ParsedConvergence::checkConvergence(), checkCoupledScalarVariableBlocks(), FEProblemBase::checkDependMaterialsHelper(), FVFluxBC::checkFaceIntegrity(), FVInterfaceKernel::checkFaceIntegrity(), TaggingInterface::checkForNans(), SamplerBase::checkForStandardFieldVariableType(), MeshGenerator::checkGetMesh(), ReporterTransferInterface::checkHasReporterValue(), FEProblemBase::checkICRestartError(), NonlinearSystemBase::checkKernelCoverage(), Moose::Kokkos::Material::checkMaterialProperty(), Material::checkMaterialProperty(), MooseApp::checkMetaDataIntegrity(), Damper::checkMinDamping(), SideUserObject::checkNoInterfaceMaterialPropertyDependencies(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), Checkpoint::checkpointInfo(), LinearFVGradientManager::checkRestartedGradientHistory(), FEProblemBase::checkUserObjectNameCollision(), BlockRestrictable::checkVariable(), DomainUserObject::checkVariable(), Coupleable::checkWritableVar(), CoarsenSurfaceMeshAlongSidesetGenerator::coarsenAlongSidesets(), MooseVariableFieldBase::componentName(), CompositeFunction::CompositeFunction(), MaterialBase::computeProperties(), FEProblemBase::computeUserObjectByName(), VectorPostprocessorVisualizationAux::computeValue(), MooseBase::connectControllableParams(), ConstantPostprocessor::ConstantPostprocessor(), Coupleable::coupledName(), CommonOutputAction::create(), MultiApp::createApp(), MooseApp::createExecutors(), MeshGeneratorSystem::createMeshGeneratorOrder(), MooseApp::createRecoverablePerfGraph(), MoveBoundaryNodesToCurveGenerator::curveGenerator(), CutMeshByPlaneGenerator::CutMeshByPlaneGenerator(), DebugResidualAux::DebugResidualAux(), MaterialBase::declareADProperty(), MFEMComplexVariable::declareCoefficients(), MFEMVariable::declareCoefficients(), MeshInfo::declareHelper(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MeshGenerator::declareMeshesForSubByName(), MeshGenerator::declareNullMeshName(), MaterialBase::declareProperty(), MFEMCoordinateTransformations::declareRZCoefficients(), DOFMapOutput::demangle(), DerivativeSumMaterialTempl< is_ad >::DerivativeSumMaterialTempl(), MooseMesh::detectPairedSidesets(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DomainUserObject::DomainUserObject(), DumpObjectsProblem::dumpObjectHelper(), ElementDamper::ElementDamper(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementMaterialSampler::ElementMaterialSampler(), ElementValueSampler::ElementValueSampler(), EigenKernel::enabled(), MooseMesh::errorIfDistributedMesh(), SolutionUserObjectBase::evalMeshFunction(), SolutionUserObjectBase::evalMeshFunctionGradient(), SolutionUserObjectBase::evalMultiValuedMeshFunction(), SolutionUserObjectBase::evalMultiValuedMeshFunctionGradient(), GreaterThanLessThanPostprocessor::execute(), PointValue::execute(), RestartableDataReporter::execute(), MultiAppGeneralFieldTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppUserObjectTransfer::execute(), SideValueSampler::execute(), WebServerControl::execute(), ActionWarehouse::executeActionsWithAction(), Exodus::Exodus(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FVInterfaceKernel::faceArg1(), FVInterfaceKernel::faceArg2(), FEProblemBase::FEProblemBase(), NEML2ModelExecutor::fillInputs(), MultiApp::fillPositions(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), PointSamplerBase::finalize(), ChainControl::fullControlDataName(), FunctionArrayAux::FunctionArrayAux(), FunctionDT::FunctionDT(), FVFunctionIC::functionName(), FunctionIC::functionName(), FunctorPositions::FunctorPositions(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), FVOneVarDiffusionInterface::FVOneVarDiffusionInterface(), GapValueAux::GapValueAux(), BoundaryDeletionGenerator::generate(), BreakMeshByBlockGenerator::generate(), CoarsenSurfaceMeshAlongSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), ManifoldSubdomainGenerator::generate(), ParsedExtraElementIDGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), RenumberBySubdomainGenerator::generate(), SideSetsFromNodeSetsGenerator::generate(), StitchBoundaryMeshGenerator::generate(), StitchMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), InterfaceMaterial::getADMaterialProperty(), Material::getADMaterialProperty(), MultiAppTransfer::getAppInfo(), MooseMesh::getBoundaryString(), MultiApp::getBoundingBox(), MooseBase::getCheckedPointerParam(), MooseApp::getCheckpointDirectories(), MFEMProblem::getComplexGridFunction(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), FEProblemBase::getConvergence(), MeshGenerator::getCSGBase(), MeshGenerator::getCSGBasesByName(), UserObjectBase::getDependObjects(), FEProblemBase::getDistribution(), DistributionInterface::getDistribution(), DistributionInterface::getDistributionByName(), ElementUOProvider::getElementalValueLong(), ElementUOProvider::getElementalValueReal(), MultiApp::getExecutioner(), FEProblemBase::getExecutor(), MooseApp::getExecutor(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SubProblem::getFunctor(), FEProblemBase::getFVAdvectedInterpolationMethod(), FEProblemBase::getFVFaceInterpolationMethod(), FEProblemBase::getFVGradientMethod(), FEProblemBase::getFVInterpolationMethod(), AuxKernelTempl< ComputeValueType >::getGenericMaterialProperty(), NodalPatchRecovery::getGenericMaterialProperty(), InterfaceMaterial::getGenericMaterialProperty(), Material::getGenericMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialProperty(), InterfaceMaterial::getGenericNeighborMaterialPropertyByName(), Material::getGenericOptionalMaterialProperty(), MaterialBase::getGenericZeroMaterialProperty(), MFEMProblem::getGridFunction(), FEProblemBase::getKokkosFunction(), FEProblemBase::getKokkosUserObject(), SolutionUserObjectBase::getLocalVarIndex(), Marker::getMarkerValue(), Material::getMaterial(), FEProblemBase::getMaterial(), Material::getMaterialByName(), AuxKernelTempl< ComputeValueType >::getMaterialProperty(), NodalPatchRecovery::getMaterialProperty(), InterfaceMaterial::getMaterialProperty(), Material::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOld(), InterfaceMaterial::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOlder(), NodalPatchRecovery::getMaterialPropertyOlder(), InterfaceMaterial::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), MFEMObject::getMatrixCoefficient(), MFEMObject::getMatrixCoefficientByName(), MeshGenerator::getMesh(), FEProblemBase::getMeshDivision(), MeshGenerator::getMeshesByName(), MooseApp::getMeshGenerator(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MFEMProblem::getMFEMObject(), ActionWarehouse::getMooseAppName(), NEML2FEInterpolation::getMOOSEVariable(), MultiAppTransfer::getMultiApp(), InterfaceMaterial::getNeighborADMaterialProperty(), InterfaceMaterial::getNeighborMaterialProperty(), InterfaceMaterial::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), Material::getOptionalADMaterialProperty(), Material::getOptionalMaterialProperty(), Material::getOptionalMaterialPropertyOld(), Material::getOptionalMaterialPropertyOlder(), MooseBase::getParam(), FEProblemBase::getPositionsObject(), FEProblemBase::getPostprocessorValueByName(), ComponentMaterialPropertyInterface::getPropertyValue(), ReporterData::getReporterInfo(), MFEMExecutedObject::getRequestedItems(), MooseApp::getRestartableDataMap(), MooseApp::getRestartableDataMapName(), MooseApp::getRestartableMetaData(), FEProblemBase::getSampler(), MFEMObject::getScalarCoefficient(), MFEMObject::getScalarCoefficientByName(), TimedSubdomainModifier::getSubdomainIDAndCheck(), MFEMExecutedObject::getSuppliedItems(), TransientBase::getTimeStepperName(), ProjectedStatefulMaterialStorageAction::getTypeEnum(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), MFEMObject::getVectorCoefficient(), MFEMObject::getVectorCoefficientByName(), LinearFVGradientManager::gradientStateVectorName(), Terminator::handleMessage(), Control::hasControllableParameterByName(), FEProblemBase::hasConvergence(), FEProblemBase::hasDistribution(), FEProblemBase::hasFunction(), SubProblem::hasFunctor(), SubProblem::hasFunctorWithType(), FEProblemBase::hasFVGradientMethod(), FEProblemBase::hasFVInterpolationMethod(), MeshInfo::hasItem(), MooseApp::hasMeshGenerator(), MFEMProblem::hasMFEMObject(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasPostprocessorValueByName(), MooseApp::hasRelationshipManager(), MooseApp::hasRestartableDataMap(), MooseApp::hasRestartableMetaData(), FEProblemBase::hasUserObject(), NEML2Action::inferMOOSEIOType(), AddVariableAction::init(), AdvancedOutput::init(), IterationAdaptiveDT::init(), AdvancedOutput::initAvailableLists(), MeshInfo::initCombinedInfos(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), NestedDivision::initialize(), TransformedPositions::initialize(), BoundaryRestrictable::initializeBoundaryRestrictable(), AuxKernelBase::initialSetup(), SolutionScalarAux::initialSetup(), MFEMScalarQuadratureFunction::initialSetup(), MFEMVectorQuadratureFunction::initialSetup(), Console::initialSetup(), JSONOutput::initialSetup(), BoundaryLinearFVFluxIntegral::initialSetup(), NodalVariableValue::initialSetup(), SideFVFluxBCIntegral::initialSetup(), MultiAppGeneralFieldFunctorTransfer::initialSetup(), MultiAppProjectionTransfer::initialSetup(), BoundaryMeshBuilder::initialSetup(), SolutionUserObjectBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), MeshGenerator::isChildMeshGenerator(), DerivativeMaterialInterface< T >::isNotObjectVariable(), MeshGenerator::isNullMeshName(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MeshGenerator::isParentMeshGenerator(), LinearCombinationFunction::LinearCombinationFunction(), FEProblemBase::logAdd(), MooseLinearVariableFV< OutputType >::lowerDError(), Marker::Marker(), MaterialBase::markMatPropRequested(), Material::Material(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), NEML2ModelExecutor::meshChanged(), MeshGenerator::meshPropertyPrefix(), MooseBase::messagePrefix(), MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver(), MFEMScalarQuadratureFunction::MFEMScalarQuadratureFunction(), MFEMTransient::MFEMTransient(), MFEMVectorQuadratureFunction::MFEMVectorQuadratureFunction(), OutputWarehouse::mooseConsole(), SolutionInvalidInterface::mooseDeprecated(), MooseVariableBase::MooseVariableBase(), MooseVariableInterface< T >::MooseVariableInterface(), SolutionInvalidInterface::mooseWarning(), SolutionInvalidInterface::mooseWarningNonPrefixed(), MoveNodesByParsedExpressionModifier::MoveNodesByParsedExpressionModifier(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NEML2PreKernel::NEML2PreKernel(), NodalDamper::NodalDamper(), MooseLinearVariableFV< OutputType >::nodalError(), NodalPatchRecoveryAuxBase::NodalPatchRecoveryAuxBase(), NodalValueSampler::NodalValueSampler(), MeshGenerator::Comparator::operator()(), DOFMapOutput::output(), ProgressOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), ConsoleUtils::outputExecutionInformation(), MaterialOutputAction::outputHelper(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), Exodus::outputPostprocessors(), Nemesis::outputPostprocessors(), TableOutput::outputReporter(), AdvancedOutput::outputReporters(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), SolutionInvalidInterface::paramWarning(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedODEKernel::ParsedODEKernel(), ComponentPhysicsInterface::physicsExists(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), PiecewiseFunction::PiecewiseFunction(), PointInUnionCheckUO::PointInUnionCheckUO(), MooseApp::possiblyLoadRestartableMetaData(), MFEMExecutedObject::postprocessorDependencyKey(), PhysicsBase::prefix(), MooseMesh::prepare(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), PerfGraphLivePrint::printStats(), FEProblemBase::projectInitialConditionOnCustomRange(), MooseBase::queryParam(), MultiApp::readCommandLineArguments(), Receiver::Receiver(), Executor::Result::record(), FEProblemBase::registerRandomInterface(), MooseApp::registerRestartableDataMapName(), MooseApp::registerRestartableNameWithFilter(), MaterialBase::resetQpProperties(), MultiApp::restore(), ScalarComponentIC::ScalarComponentIC(), MultiApp::setAppOutputFileBase(), FEProblemBase::setAuxKernelParamsAndLog(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), FEProblemBase::setPostprocessorValueByName(), FEProblemBase::setResidualObjectParamsAndLog(), MooseMesh::setSubdomainName(), MooseMesh::setSubdomainName(), NodeSetsGeneratorBase::setup(), SideSetsGeneratorBase::setup(), SurfaceMeshGeneratorBase::setup(), Split::setup(), TransientMultiApp::setupApp(), MoveNodesByParsedExpressionModifier::setupNodalOutputVariables(), NEML2Action::setupOutputMappings(), SideSetExtruderGenerator::SideSetExtruderGenerator(), TransientMultiApp::solveStep(), UserObject::spatialValue(), LinearFVGradientReader::stateComponents(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), MaterialBase::storeBoundaryZeroMatProp(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), MaterialBase::storeSubdomainZeroMatProp(), SubProblem::storeSubdomainZeroMatProp(), ConstraintWarehouse::subdomainsCovered(), MaterialBase::subdomainSetup(), SumPostprocessor::SumPostprocessor(), MFEMPostprocessor::suppliedPostprocessorName(), MFEMVectorPostprocessor::suppliedVectorPostprocessorName(), BoundaryMeshBuilder::surfaceElementSet(), NEML2FEInterpolation::syncWithMainThread(), TaggingInterface::TaggingInterface(), MooseLinearVariableFV< OutputType >::timeIntegratorError(), VectorPostprocessorVisualizationAux::timestepSetup(), ElementSubdomainModifierBase::timestepSetup(), to_json(), MultiAppDofCopyTransfer::transfer(), MultiAppShapeEvaluationTransfer::transferVariable(), MultiAppMFEMCopyTransfer::transferVariables(), MultiAppMFEMShapeEvaluationTransfer::transferVariables(), TransientMultiApp::TransientMultiApp(), MooseBase::typeAndName(), MooseBase::uniqueParameterName(), FVQpFluxBC::uOnGhost(), FVQpFluxBC::uOnUSub(), UserObjectBase::UserObjectBase(), UserObjectInterface::userObjectName(), ParsedAux::validateGenericVectorNames(), MeshInfo::validParams(), MFEMExecutedObject::variableDependencyKey(), PhysicsBase::variableExists(), MultiAppTransfer::variableIntegrityCheck(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), MFEMExecutedObject::vectorPostprocessorDependencyKey(), Convergence::verboseOutput(), AdvancedOutput::wantOutput(), Coupleable::writableCoupledValue(), Coupleable::writableVariable(), Console::write(), MooseApp::writeRestartableMetaData(), and XYQuadrilateralMeshFromBoundaryCurve::XYQuadrilateralMeshFromBoundaryCurve().

◆ needsGradientVectorStorage()

virtual bool MooseVariableFieldBase::needsGradientVectorStorage ( ) const
inlinevirtualinherited

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

This is mainly used for finite volume variables.

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

Definition at line 101 of file MooseVariableFieldBase.h.

101{ return false; }

◆ nodalDofIndex()

template<typename OutputType >
virtual const dof_id_type & MooseVariableFV< OutputType >::nodalDofIndex ( ) const
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 114 of file MooseVariableFV.h.

115 {
116 mooseError("nodalDofIndex not supported by MooseVariableFVBase");
117 }

◆ nodalDofIndexNeighbor()

template<typename OutputType >
virtual const dof_id_type & MooseVariableFV< OutputType >::nodalDofIndexNeighbor ( ) const
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 118 of file MooseVariableFV.h.

119 {
120 mooseError("nodalDofIndexNeighbor not supported by MooseVariableFVBase");
121 }

◆ nodalMatrixTagValue()

template<typename OutputType >
const DofValues & MooseVariableFV< OutputType >::nodalMatrixTagValue ( TagID  ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 202 of file MooseVariableFV.h.

203 {
204 mooseError("nodalMatrixTagValue not implemented for finite volume variables.");
205 }

◆ nodalValueArray()

template<typename OutputType >
const MooseArray< OutputType > & MooseVariableFV< OutputType >::nodalValueArray ( ) const
inlineoverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 580 of file MooseVariableFV.h.

581 {
582 mooseError("Finite volume variables do not have defined values at nodes.");
583 }

◆ nodalValueOldArray()

template<typename OutputType >
const MooseArray< OutputType > & MooseVariableFV< OutputType >::nodalValueOldArray ( ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 584 of file MooseVariableFV.h.

585 {
586 mooseError("Finite volume variables do not have defined values at nodes.");
587 }

◆ nodalValueOlderArray()

template<typename OutputType >
const MooseArray< OutputType > & MooseVariableFV< OutputType >::nodalValueOlderArray ( ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 588 of file MooseVariableFV.h.

589 {
590 mooseError("Finite volume variables do not have defined values at nodes.");
591 }

◆ nodalVectorTagValue()

template<typename OutputType >
const DofValues & MooseVariableFV< OutputType >::nodalVectorTagValue ( TagID  ) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 198 of file MooseVariableFV.h.

199 {
200 mooseError("nodalVectorTagValue not implemented for finite volume variables.");
201 }

◆ number()

unsigned int MooseVariableBase::number ( ) const
inlineinherited

Get variable number coming from libMesh.

Returns
the libmesh variable number

Definition at line 60 of file MooseVariableBase.h.

60{ return _var_num; }

Referenced by AdaptivityAction::act(), Assembly::addJacobianBlock(), Assembly::addJacobianCoupledVarPair(), FVInterfaceKernel::addResidualToVariable1(), FVInterfaceKernel::addResidualToVariable2(), EigenProblem::adjustEigenVector(), ArrayCoupledForce::ArrayCoupledForce(), Assembly::cacheJacobianBlock(), Assembly::cacheJacobianBlockNonzero(), Assembly::cacheJacobianCoupledVarPair(), FVFluxBC::checkFaceIntegrity(), ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), ComputeJacobianThread::compute(), ElemElemConstraint::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), ADDGKernel::computeElemNeighResidual(), InternalSideIndicatorBase::computeIndicator(), ArrayIntegratedBC::computeJacobian(), IntegratedBC::computeJacobian(), NonlocalIntegratedBC::computeJacobian(), VectorIntegratedBC::computeJacobian(), MortarScalarBase::computeJacobian(), NodeElemConstraint::computeJacobian(), NodeFaceConstraint::computeJacobian(), ArrayKernel::computeJacobian(), EigenKernel::computeJacobian(), Kernel::computeJacobian(), KernelGrad::computeJacobian(), KernelValue::computeJacobian(), MassLumpedTimeDerivative::computeJacobian(), NonlocalKernel::computeJacobian(), ODEKernel::computeJacobian(), TimeDerivative::computeJacobian(), VectorKernel::computeJacobian(), VectorTimeDerivative::computeJacobian(), NodalEqualValueConstraint::computeJacobian(), ScalarKernel::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), MortarConstraint::computeJacobian(), ArrayDGLowerDKernel::computeLowerDJacobian(), DGLowerDKernel::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDJacobian(), LowerDIntegratedBC::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), HFEMDirichletBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDResidual(), DGLowerDKernel::computeLowerDResidual(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayIntegratedBC::computeOffDiagJacobian(), BoundaryIntegralValueConstraint::computeOffDiagJacobian(), IntegratedBC::computeOffDiagJacobian(), LowerDIntegratedBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), NonlocalIntegratedBC::computeOffDiagJacobian(), VectorIntegratedBC::computeOffDiagJacobian(), VectorNodalBC::computeOffDiagJacobian(), NodeElemConstraint::computeOffDiagJacobian(), NodeFaceConstraint::computeOffDiagJacobian(), DGLowerDKernel::computeOffDiagJacobian(), ADKernelScalarBase::computeOffDiagJacobian(), ArrayKernel::computeOffDiagJacobian(), EigenKernel::computeOffDiagJacobian(), Kernel::computeOffDiagJacobian(), KernelGrad::computeOffDiagJacobian(), KernelValue::computeOffDiagJacobian(), NonlocalKernel::computeOffDiagJacobian(), VectorKernel::computeOffDiagJacobian(), ArrayNodalKernel::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), ADDGKernel::computeOffDiagJacobian(), ADNodalKernel::computeOffDiagJacobian(), ArrayIntegratedBC::computeOffDiagJacobianScalar(), BoundaryIntegralValueConstraint::computeOffDiagJacobianScalar(), IntegratedBC::computeOffDiagJacobianScalar(), VectorIntegratedBC::computeOffDiagJacobianScalar(), ArrayKernel::computeOffDiagJacobianScalar(), Kernel::computeOffDiagJacobianScalar(), NodalScalarKernel::computeOffDiagJacobianScalar(), ODEKernel::computeOffDiagJacobianScalar(), ScalarLagrangeMultiplier::computeOffDiagJacobianScalar(), VectorKernel::computeOffDiagJacobianScalar(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), DGLowerDKernel::computeOffDiagLowerDJacobian(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), OldEqualValueConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobian(), ArrayKernel::computeQpOffDiagJacobian(), ArrayCoupledForce::computeQpOffDiagJacobian(), ArrayCoupledTimeDerivative::computeQpOffDiagJacobian(), ArrayDiffusion::computeQpOffDiagJacobian(), ArrayReaction::computeQpOffDiagJacobian(), ArrayTimeDerivative::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), ArrayNodalBC::computeQpOffDiagJacobian(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), ArrayIntegratedBC::computeResidual(), ArrayLowerDIntegratedBC::computeResidual(), IntegratedBC::computeResidual(), LowerDIntegratedBC::computeResidual(), VectorIntegratedBC::computeResidual(), NodeElemConstraint::computeResidual(), NodeFaceConstraint::computeResidual(), ADDiracKernel::computeResidual(), FVElementalKernel::computeResidual(), ADArrayKernel::computeResidual(), ArrayKernel::computeResidual(), EigenKernel::computeResidual(), Kernel::computeResidual(), KernelGrad::computeResidual(), KernelValue::computeResidual(), ODEKernel::computeResidual(), ODETimeKernel::computeResidual(), TimeKernel::computeResidual(), VectorKernel::computeResidual(), VectorTimeKernel::computeResidual(), ADScalarKernel::computeResidual(), NodalEqualValueConstraint::computeResidual(), ScalarKernel::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxBC::computeResidual(), FVFluxKernel::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), ADMortarConstraint::computeResidual(), MortarConstraint::computeResidual(), BoundaryIntegralValueConstraint::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), Kernel::computeResidualAndJacobian(), KernelScalarBase::computeResidualAndJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), PenaltyPeriodicSegmentalConstraint::computeScalarQpOffDiagJacobian(), PeriodicSegmentalConstraint::computeScalarQpOffDiagJacobian(), DebugResidualAux::computeValue(), ProjectionAux::computeValue(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), CoupledForceNodalKernel::CoupledForceNodalKernel(), CoupledForceTempl< is_ad >::CoupledForceTempl(), ScalarCoupleable::coupledScalar(), VariableResidual::execute(), NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), NodalNormalsPreprocessor::execute(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::extractlibMeshNodePositions(), InternalSideIndicatorBase::finalize(), BoundsBase::getDoFIndex(), FVBoundaryCondition::hasFaceSide(), HDGKernel::HDGKernel(), LazyCoupleable::init(), NodalNormalsPreprocessor::initialize(), AuxKernelBase::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), ArrayKernel::initQpOffDiagJacobian(), MooseMesh::isTranslatedPeriodic(), LowerBoundNodalKernel::LowerBoundNodalKernel(), PNGOutput::makeMeshFunc(), MatCoupledForce::MatCoupledForce(), MatReactionTempl< is_ad >::MatReactionTempl(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MoveNodesByParsedExpressionModifier::MoveNodesByParsedExpressionModifier(), ComputeDiracThread::onElement(), ComputeNodalKernelBCJacobiansThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), ComputeLinearFVGreenGaussGradientVolumeThread::operator()(), ComputeLinearFVLimitedGradientThread::operator()(), ComputeLinearFVGreenGaussGradientFaceThread::operator()(), Assembly::prepareBlock(), Assembly::prepareBlockNonlocal(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), MultiAppMFEMTolibMeshShapeEvaluationTransfer::projectlibMeshNodalValues(), MultiAppProjectionTransfer::projectSolution(), MooseMesh::queryPeriodicDimensions(), MooseVariableScalar::reinit(), FVInterfaceKernel::setupData(), MoveNodesByParsedExpressionModifier::setupNodalOutputVariables(), NonlinearSystemBase::setupScalingData(), ElementSubdomainModifierBase::storeOverriddenDofValues(), MultiAppDofCopyTransfer::transferDofObject(), FVQpFluxBC::uOnGhost(), FVQpFluxBC::uOnUSub(), UpperBoundNodalKernel::UpperBoundNodalKernel(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), NodalDamper::variableDefinedOnNode(), and MortarConstraintBase::zeroInactiveLMDofs().

◆ numberOfDofs()

template<typename OutputType >
unsigned int MooseVariableFV< OutputType >::numberOfDofs ( ) const
inlinefinaloverridevirtual

Get the number of local DoFs.

Reimplemented from MooseVariableBase.

Definition at line 151 of file MooseVariableFV.h.

151{ return _element_data->numberOfDofs(); }

◆ numberOfDofsNeighbor()

template<typename OutputType >
virtual unsigned int MooseVariableFV< OutputType >::numberOfDofsNeighbor ( )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 153 of file MooseVariableFV.h.

154 {
155 mooseError("numberOfDofsNeighbor not supported by MooseVariableFVBase");
156 }

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const
inherited

Return the number of blocks for this object.

Returns
The number of subdomains

Definition at line 218 of file BlockRestrictable.C.

219{
220 return (unsigned int)_blk_ids.size();
221}

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

◆ numKokkosBlockElements()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockElements ( ) const
inlineprotectedinherited

Get the number of elements this Kokkos object is operating on.

Returns
The number of elements local to this process

Definition at line 261 of file BlockRestrictable.h.

261{ return _kokkos_element_ids.size(); }
KOKKOS_FUNCTION index_type size() const
Get the total array size.

Referenced by Moose::Kokkos::ElementReducer::numReducerThreads(), and Moose::Kokkos::ElementUserObject::numUserObjectThreads().

◆ numKokkosBlockNodes()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockNodes ( ) const
inlineprotectedinherited

Get the number of nodes this Kokkos object is operating on.

Returns
The number of nodes local to this process

Definition at line 266 of file BlockRestrictable.h.

266{ return _kokkos_node_ids.size(); }

Referenced by Moose::Kokkos::NodalReducer::numReducerThreads(), and Moose::Kokkos::NodalUserObject::numUserObjectThreads().

◆ numKokkosBlockSides()

KOKKOS_FUNCTION dof_id_type BlockRestrictable::numKokkosBlockSides ( ) const
inlineprotectedinherited

Get the number of sides this Kokkos object is operating on.

Returns
The number of sides local to this process

Definition at line 271 of file BlockRestrictable.h.

272 {
274 }

◆ oldestSolutionStateRequested()

template<typename OutputType >
unsigned int MooseVariableFV< 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 719 of file MooseVariableFV.C.

720{
721 unsigned int state = 0;
722 state = std::max(state, _element_data->oldestSolutionStateRequested());
723 state = std::max(state, _neighbor_data->oldestSolutionStateRequested());
724 return state;
725}

◆ operator()() [1/6]

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

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

These are the methods a user will call in their code

Definition at line 183 of file MooseFunctor.h.

604{
605 if (_always_evaluate)
606 return evaluate(elem, state);
607
608 mooseAssert(state.state == 0,
609 "Cached evaluations are only currently supported for the current state.");
610
611 return queryFVArgCache(_elem_arg_to_value, elem);
612}
T evaluate(Real, const Point &)
The general evaluation method is not defined.
ValueType queryFVArgCache(std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
check a finite volume spatial argument cache and if invalid then evaluate

◆ operator()() [2/6]

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

Definition at line 187 of file MooseFunctor.h.

714{
715 return evaluate(elem_point, state);
716}

◆ operator()() [3/6]

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

Definition at line 185 of file MooseFunctor.h.

663{
664 if (_always_evaluate)
665 return evaluate(elem_qp, state);
666
667 const auto elem_id = elem_qp.elem->id();
668 if (elem_id != _current_qp_map_key)
669 {
670 _current_qp_map_key = elem_id;
672 }
673 auto & qp_data = *_current_qp_map_value;
674 const auto qp = elem_qp.qp;
675 const auto * const qrule = elem_qp.qrule;
676 mooseAssert(qrule, "qrule must be non-null");
677
678 return queryQpCache(qp, *qrule, qp_data, elem_qp, state);
679}
ValueType queryQpCache(unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Moose::ADType< OutputType >::type > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
check a qp cache and if invalid then evaluate

◆ operator()() [4/6]

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

Definition at line 186 of file MooseFunctor.h.

684{
685 if (_always_evaluate)
686 return evaluate(elem_side_qp, state);
687
688 const Elem * const elem = elem_side_qp.elem;
689 mooseAssert(elem, "elem must be non-null");
690 const auto elem_id = elem->id();
691 if (elem_id != _current_side_qp_map_key)
692 {
693 _current_side_qp_map_key = elem_id;
695 }
696 auto & side_qp_data = *_current_side_qp_map_value;
697 const auto side = elem_side_qp.side;
698 const auto qp = elem_side_qp.qp;
699 const auto * const qrule = elem_side_qp.qrule;
700 mooseAssert(qrule, "qrule must be non-null");
701
702 // Check and see whether we even have sized for this side
703 if (side >= side_qp_data.size())
704 side_qp_data.resize(elem->n_sides());
705
706 // Ok we were sized enough for our side
707 auto & qp_data = side_qp_data[side];
708 return queryQpCache(qp, *qrule, qp_data, elem_side_qp, state);
709}

◆ operator()() [5/6]

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

Definition at line 184 of file MooseFunctor.h.

617{
618 checkFace(face_in);
619
620 if (_always_evaluate)
621 return evaluate(face_in, state);
622
623 mooseAssert(state.state == 0,
624 "Cached evaluations are only currently supported for the current state.");
625
626 return queryFVArgCache(_face_arg_to_value, face_in);
627}

◆ operator()() [6/6]

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

Definition at line 188 of file MooseFunctor.h.

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

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

163{
164 return _fe_type.order;
165}
OrderWrapper order

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

◆ paramError()

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

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

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

Definition at line 457 of file MooseBase.h.

458{
459 _pars.paramError(param, std::forward<Args>(args)...);
460}
void paramError(const std::string &param, Args... args) const
Emits a parameter error prefixed with the parameter location and object information if available.

Referenced by HierarchicalGridPartitioner::_do_partition(), AutoCheckpointAction::act(), CommonOutputAction::act(), SetupDebugAction::act(), DiffusionCG::addFEKernels(), DiffusionFV::addFVKernels(), NEML2ModelExecutor::addGatheredParameter(), NEML2ModelExecutor::addGatheredVariable(), ADDGKernel::ADDGKernel(), ComponentJunction::addMeshGenerators(), CylinderComponent::addMeshGenerators(), ReporterPointSource::addPoints(), DiffusionPhysicsBase::addPostprocessors(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ADPenaltyPeriodicSegmentalConstraint::ADPenaltyPeriodicSegmentalConstraint(), ADPeriodicSegmentalConstraint::ADPeriodicSegmentalConstraint(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), AdvectiveFluxAux::AdvectiveFluxAux(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), ArrayBodyForce::ArrayBodyForce(), ArrayCoupledForce::ArrayCoupledForce(), ArrayDGKernel::ArrayDGKernel(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayDirichletBC::ArrayDirichletBC(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), ArrayParsedAux::ArrayParsedAux(), ArrayPenaltyDirichletBC::ArrayPenaltyDirichletBC(), ArrayReactionNodalKernelTempl< is_ad >::ArrayReactionNodalKernelTempl(), ArrayVacuumBC::ArrayVacuumBC(), ArrayVarReductionAux::ArrayVarReductionAux(), ParsedSubdomainIDsGenerator::assignElemSubdomainID(), AuxKernelBase::AuxKernelBase(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), BlockDeletionGenerator::BlockDeletionGenerator(), BlockWeightedPartitioner::BlockWeightedPartitioner(), BoundaryIntegralValueConstraint::BoundaryIntegralValueConstraint(), BoundaryLinearFVFluxIntegral::BoundaryLinearFVFluxIntegral(), BoundsBase::BoundsBase(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BSplineCurveGenerator::BSplineCurveGenerator(), BuildArrayVariableAux::BuildArrayVariableAux(), MFEMFESpaceHierarchy::buildHierarchy(), MFEMMesh::buildMesh(), MFEMGeometricMultigridSolver::BuildMultigrid(), TimeSequenceStepperBase::buildSequence(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), SurfaceDelaunayGeneratorBase::checkBoundaryAndHolesParams(), checkComponent(), Moose::Kokkos::ParsedObjectBase::checkDuplicateSymbols(), SamplerBase::checkForStandardFieldVariableType(), MeshGenerator::checkGetMesh(), ComponentInitialConditionInterface::checkInitialConditionsAllRequested(), BatchMeshGeneratorAction::checkInputParameterType(), PhysicsBase::checkIntegrityEarly(), SurfaceDelaunayGeneratorBase::checkInteriorPoints(), SideUserObject::checkNoInterfaceMaterialPropertyDependencies(), PostprocessorInterface::checkParam(), FEProblemBase::checkProblemIntegrity(), MultiAppReporterTransfer::checkSiblingsTransferSupported(), MFEMMultiAppTransfer::checkValidTransferProblemTypes(), Coupleable::checkVar(), MultiAppTransfer::checkVariable(), CircularBoundaryCorrectionGenerator::CircularBoundaryCorrectionGenerator(), CircularBoundaryCorrectionGenerator::circularCenterCalculator(), MultiAppGeneralFieldTransfer::closestToPosition(), CoarsenBlockGenerator::CoarsenBlockGenerator(), CombinedVectorPostprocessor::CombinedVectorPostprocessor(), CombinerGenerator::CombinerGenerator(), ComponentInitialConditionInterface::ComponentInitialConditionInterface(), ComponentJunction::ComponentJunction(), ComponentMaterialPropertyInterface::ComponentMaterialPropertyInterface(), CompositionDT::CompositionDT(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< is_ad >::ConservativeAdvectionBCTempl(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), MFEMNewtonNonlinearSolver::ConstructSolver(), ContainsPointAux::ContainsPointAux(), CopyValueAux::CopyValueAux(), MultiAppGeneralFieldTransfer::correctSolutionVectorValues(), Coupleable::Coupleable(), CoupledForceTempl< is_ad >::CoupledForceTempl(), CoupledValueFunctionMaterialTempl< is_ad >::CoupledValueFunctionMaterialTempl(), MultiApp::createApp(), MeshGeneratorSystem::createMeshGenerator(), MoveBoundaryNodesToCurveGenerator::curveGenerator(), CylindricalGridDivision::CylindricalGridDivision(), DebugResidualAux::DebugResidualAux(), ConstantReporter::declareConstantReporterValue(), ConstantReporter::declareConstantReporterValues(), AccumulateReporter::declareLateValues(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DGLowerDKernel::DGLowerDKernel(), DiffusionFluxAux::DiffusionFluxAux(), DomainUserObject::DomainUserObject(), EigenProblem::EigenProblem(), EigenProblemSolve::EigenProblemSolve(), ElementAdaptivityLevelAux::ElementAdaptivityLevelAux(), ElementGenerator::ElementGenerator(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ElementLengthAux::ElementLengthAux(), ElementLpNormAux::ElementLpNormAux(), ElementNormalAux::ElementNormalAux(), ExtraIDIntegralVectorPostprocessor::elementValue(), ElementValueSampler::ElementValueSampler(), ElementVectorL2Error::ElementVectorL2Error(), EqualValueEmbeddedConstraintTempl< is_ad >::EqualValueEmbeddedConstraintTempl(), ReporterPointSource::errorCheck(), StitchMeshGeneratorBase::errorMissingBoundary(), ExamplePatchMeshGenerator::ExamplePatchMeshGenerator(), FunctorNodalCorrector::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), ExtraElementIDAux::ExtraElementIDAux(), ExtraElementIntegerDivision::ExtraElementIntegerDivision(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::FileMeshGenerator(), FillBetweenCurvesGenerator::FillBetweenCurvesGenerator(), FillBetweenSidesetsGenerator::FillBetweenSidesetsGenerator(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), InternalSideIndicatorBase::finalize(), MeshTriangulationUtils::finalizeTriangulation(), FixedPointSolve::findTransformedSystem(), FixedPointSolve::FixedPointSolve(), ForcingFunctionAux::ForcingFunctionAux(), FullSolveMultiApp::FullSolveMultiApp(), FunctionArrayAux::FunctionArrayAux(), FunctionValuePostprocessor::FunctionValuePostprocessor(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorAux::FunctorAux(), FunctorBinnedValuesDivision::FunctorBinnedValuesDivision(), FunctorCoordinatesFunctionAux::FunctorCoordinatesFunctionAux(), FunctorElementalGradientAuxTempl< is_ad >::FunctorElementalGradientAuxTempl(), FunctorExtremaPositions::FunctorExtremaPositions(), FunctorIC::FunctorIC(), FunctorNodalCorrector::FunctorNodalCorrector(), FunctorPositions::FunctorPositions(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FunctorVectorElementalAuxTempl< is_ad >::FunctorVectorElementalAuxTempl(), FVAdvection::FVAdvection(), FVFluxBC::FVFluxBC(), FVInterfaceKernel::FVInterfaceKernel(), FVOneVarDiffusionInterface::FVOneVarDiffusionInterface(), FVTwoVarContinuityConstraint::FVTwoVarContinuityConstraint(), Boundary2DDelaunayGenerator::General2DDelaunay(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), AddMetaDataGenerator::generate(), AdvancedExtruderGenerator::generate(), BlockDeletionGenerator::generate(), BlockToMeshConverterGenerator::generate(), Boundary2DDelaunayGenerator::generate(), BoundaryDeletionGenerator::generate(), BoundaryElementConversionGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), BreakMeshByBlockGenerator::generate(), BreakMeshByElementGenerator::generate(), CircularBoundaryCorrectionGenerator::generate(), CoarsenBlockGenerator::generate(), CoarsenSurfaceMeshAlongSidesetGenerator::generate(), CombinerGenerator::generate(), CutMeshByLevelSetGeneratorBase::generate(), ElementsToTetrahedronsConverter::generate(), ExtraNodesetGenerator::generate(), FillBetweenCurvesGenerator::generate(), FillBetweenSidesetsGenerator::generate(), FlipSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), ManifoldSubdomainGenerator::generate(), MeshCollectionGenerator::generate(), MeshExtruderGenerator::generate(), MoveBoundaryNodesToCurveGenerator::generate(), ParsedCurveGenerator::generate(), ParsedExtraElementIDGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), PlaneIDMeshGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), ProjectSideSetOntoLevelSetGenerator::generate(), RefineBlockGenerator::generate(), RefineSidesetGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), RenumberBySubdomainGenerator::generate(), SideSetsFromNodeSetsGenerator::generate(), StackGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), SurfaceSubdomainsDelaunayRemesher::generate(), TriToQuadConverter::generate(), UniqueExtraIDMeshGenerator::generate(), XYFrontalDelaunayGenerator::generate(), XYMeshLineCutter::generate(), XYZDelaunayGenerator::generate(), PatternedMeshGenerator::generate(), GeneratedMeshGenerator::GeneratedMeshGenerator(), BoundaryLayerUtils::generateOffsetPolyline(), GenericConstantStdVectorMaterialTempl< is_ad >::GenericConstantStdVectorMaterialTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericFunctorTimeDerivativeMaterialTempl< is_ad >::GenericFunctorTimeDerivativeMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), PropertyReadFile::getBlockData(), ComponentBoundaryConditionInterface::getBoundaryCondition(), MultiApp::getCommandLineArgs(), PropertyReadFile::getData(), PropertyReadFile::getFileNames(), Sampler::getGlobalSamples(), ComponentInitialConditionInterface::getInitialCondition(), NEML2Action::getInputParameterMapping(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), Sampler::getLocalSamples(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), FEProblemSolve::getParamFromNonlinearSystemVectorParam(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), Sampler::getSampleRow(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectName(), AddPeriodicBCAction::getVariables(), HFEMDirichletBC::HFEMDirichletBC(), AddVariableAction::init(), MFEMTransient::init(), MultiApp::init(), DistributedPositions::initialize(), BlockWeightedPartitioner::initialize(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), PhysicsBase::initializePhysics(), ReferenceResidualConvergence::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), PiecewiseConstantFromCSV::initialSetup(), SolutionIC::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), ElementSubdomainModifierBase::initialSetup(), MFEMScalarCoefficientPointValueSampler::initialSetup(), FullSolveMultiApp::initialSetup(), JSONOutput::initialSetup(), BoundaryLinearFVFluxIntegral::initialSetup(), SideFVFluxBCIntegral::initialSetup(), MultiAppCloneReporterTransfer::initialSetup(), MultiAppDofCopyTransfer::initialSetup(), MultiAppGeneralFieldKDTreeTransferBase::initialSetup(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), PointInPolyhedronCheckUO::initialSetup(), HistogramVectorPostprocessor::initialSetup(), SampledOutput::initSample(), AddMetaDataGenerator::inputChecker(), IntegratedBC::IntegratedBC(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceValueUserObjectAux::InterfaceValueUserObjectAux(), InternalSideIndicatorBase::InternalSideIndicatorBase(), InterpolatedStatefulMaterialTempl< T >::InterpolatedStatefulMaterialTempl(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), MultiApp::keepSolutionDuringRestore(), Kernel::Kernel(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), LinearCombinationFunction::LinearCombinationFunction(), LinearFVAdvectionDiffusionFunctorRobinBC::LinearFVAdvectionDiffusionFunctorRobinBC(), LowerDIntegratedBC::LowerDIntegratedBC(), PNGOutput::makeMeshFunc(), MatCoupledForce::MatCoupledForce(), MaterialADConverterTempl< T >::MaterialADConverterTempl(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), MatReactionTempl< is_ad >::MatReactionTempl(), MatrixSymmetryCheck::MatrixSymmetryCheck(), PatternedMeshGenerator::mergeSubdomainNameMaps(), MeshCollectionGenerator::MeshCollectionGenerator(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MeshDivisionAux::MeshDivisionAux(), MeshGenerator::MeshGenerator(), MeshGeneratorComponent::MeshGeneratorComponent(), MeshInfo::MeshInfo(), MFEMComplexSumAux::MFEMComplexSumAux(), MFEMEigenproblem::MFEMEigenproblem(), MFEMFunctorMaterial::MFEMFunctorMaterial(), MFEMGeneratedMeshGenerator::MFEMGeneratedMeshGenerator(), MFEMGenericFunctorMaterial::MFEMGenericFunctorMaterial(), MFEMGenericFunctorMatrixMaterial::MFEMGenericFunctorMatrixMaterial(), MFEMGenericFunctorVectorMaterial::MFEMGenericFunctorVectorMaterial(), MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver(), MFEMHypreBoomerAMG::MFEMHypreBoomerAMG(), MFEMMultiAppTransfer::MFEMMultiAppTransfer(), MFEMNDtoRTAux::MFEMNDtoRTAux(), MFEMSumAux::MFEMSumAux(), MFEMVariable::MFEMVariable(), MooseLinearVariableFV< OutputType >::MooseLinearVariableFV(), UserObjectInterface::mooseObjectError(), MoosePreconditioner::MoosePreconditioner(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MortarConstraintBase::MortarConstraintBase(), MortarNodalAuxKernelTempl< ComputeValueType >::MortarNodalAuxKernelTempl(), MultiApp::moveApp(), MoveBoundaryNodesToCurveGenerator::MoveBoundaryNodesToCurveGenerator(), MoveNodeGenerator::MoveNodeGenerator(), MoveNodesByParsedExpressionModifier::MoveNodesByParsedExpressionModifier(), TriToQuadConverter::moveSurvivingTriangles(), MultiApp::MultiApp(), MultiAppCloneReporterTransfer::MultiAppCloneReporterTransfer(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldKDTreeTransferBase::MultiAppGeneralFieldKDTreeTransferBase(), MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppGeometricInterpolationTransfer::MultiAppGeometricInterpolationTransfer(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorToAuxScalarTransfer::MultiAppPostprocessorToAuxScalarTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppProjectionTransfer::MultiAppProjectionTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppScalarToAuxScalarTransfer::MultiAppScalarToAuxScalarTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiAppVectorPostprocessorTransfer::MultiAppVectorPostprocessorTransfer(), MultiSystemSolveObject::MultiSystemSolveObject(), NearestNodeValueAux::NearestNodeValueAux(), NEML2Action::NEML2Action(), NEML2PreKernel::NEML2PreKernel(), NestedDivision::NestedDivision(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), NodalValueSampler::NodalValueSampler(), NumDOFs::NumDOFs(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), MeshTriangulationUtils::outerBoundaryIds(), Output::Output(), ParsedCurveGenerator::ParsedCurveGenerator(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), ParsedPostprocessor::ParsedPostprocessor(), ParsedReporterBase::ParsedReporterBase(), ParsedScalarReporter::ParsedScalarReporter(), ParsedSubdomainGeneratorBase::ParsedSubdomainGeneratorBase(), ParsedVectorRealReductionReporter::ParsedVectorRealReductionReporter(), ParsedVectorReporter::ParsedVectorReporter(), ParsedVectorVectorRealReductionReporter::ParsedVectorVectorRealReductionReporter(), PatternedMeshGenerator::PatternedMeshGenerator(), PenaltyPeriodicSegmentalConstraint::PenaltyPeriodicSegmentalConstraint(), PeriodicSegmentalConstraint::PeriodicSegmentalConstraint(), PIDTransientControl::PIDTransientControl(), PlaneDeletionGenerator::PlaneDeletionGenerator(), PlaneIDMeshGenerator::PlaneIDMeshGenerator(), PointInPolyhedronBaseUO::PointInPolyhedronBaseUO(), PointInSignedFunctionCheckUO::PointInSignedFunctionCheckUO(), PointInUnionCheckUO::PointInUnionCheckUO(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), EqualValueBoundaryConstraint::populateSecondaryNodes(), ReporterInterface::possiblyCheckHasReporter(), VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor(), LibmeshPartitioner::prepareBlocksForSubdomainPartitioner(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), ProjectSideSetOntoLevelSetGenerator::ProjectSideSetOntoLevelSetGenerator(), PropertyReadFile::PropertyReadFile(), RandomIC::RandomIC(), RankTwoTensorFromComponentProperties::RankTwoTensorFromComponentProperties(), MultiApp::readCommandLineArguments(), PropertyReadFile::readData(), SolutionUserObjectBase::readExodusIIOrNemesis(), SolutionUserObjectBase::readXda(), ReferenceResidualConvergence::ReferenceResidualConvergence(), RefineBlockGenerator::RefineBlockGenerator(), RefineSidesetGenerator::RefineSidesetGenerator(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), ReporterPointSource::ReporterPointSource(), FEProblemBase::restoreSolutions(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), FEProblemBase::setLinearConvergenceNames(), FEProblemBase::setNonlinearConvergenceNames(), MooseMesh::setPartitioner(), NodeSetsGeneratorBase::setup(), SideSetsGeneratorBase::setup(), SurfaceMeshGeneratorBase::setup(), CylinderComponent::setupComponent(), NEML2Action::setupDerivativeMappings(), NEML2Action::setupInputMappings(), MultiSystemSolveObject::setupMultiSystemFixedPointRelaxationFactors(), MoveNodesByParsedExpressionModifier::setupNodalOutputVariables(), NEML2Action::setupParameterDerivativeMappings(), NEML2Action::setupParameterMappings(), SetupQuadratureAction::SetupQuadratureAction(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SideValueSampler::SideValueSampler(), SingleRankPartitioner::SingleRankPartitioner(), SphericalGridDivision::SphericalGridDivision(), StitchBoundaryMeshGenerator::StitchBoundaryMeshGenerator(), StitchMeshGenerator::StitchMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TagVectorAux::TagVectorAux(), XYFrontalDelaunayGenerator::targetArea(), Terminator::Terminator(), TimeDerivativeAux::TimeDerivativeAux(), Transfer::Transfer(), TransformGenerator::TransformGenerator(), TransientMultiApp::TransientMultiApp(), CylinderComponent::translation(), MeshTriangulationUtils::triangulateWithDelaunay(), TriToQuadConverter::TriToQuadConverter(), ParsedCurveGenerator::tSectionSpaceDefiner(), UniqueExtraIDMeshGenerator::UniqueExtraIDMeshGenerator(), UserObjectBase::UserObjectBase(), Checkpoint::validateExecuteOn(), ParsedAux::validateGenericVectorNames(), SolutionAux::validateVariable(), MFEMProblem::validateVariableNumericType(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), VectorFunctionIC::VectorFunctionIC(), VolumeAux::VolumeAux(), WebServerControl::WebServerControl(), XYDelaunayGenerator::XYDelaunayGenerator(), XYFrontalDelaunayGenerator::XYFrontalDelaunayGenerator(), XYMeshLineCutter::XYMeshLineCutter(), XYQuadrilateralMeshFromBoundaryCurve::XYQuadrilateralMeshFromBoundaryCurve(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

◆ parameters()

const InputParameters & MooseBase::parameters ( ) const
inlineinherited

Get the parameters of the object.

Returns
The parameters of the object

Definition at line 131 of file MooseBase.h.

131{ return _pars; }

Referenced by AddActionComponentAction::act(), CommonOutputAction::act(), CSGOnlyAction::act(), MeshOnlyAction::act(), SetupDebugAction::act(), SplitMeshAction::act(), Action::Action(), FEProblemBase::addAnyRedistributers(), FEProblemBase::addAuxKernel(), MFEMProblem::addAuxKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), MFEMProblem::addAuxVariable(), FEProblemBase::addBoundaryCondition(), MFEMProblem::addBoundaryCondition(), FEProblemBase::addConstraint(), FEProblemBase::addConvergence(), FEProblemBase::addDamper(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), FEProblemBase::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::addDefaultNonlinearConvergence(), ReferenceResidualProblem::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::addDefaultSteadyStateConvergence(), FEProblemBase::addDGKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), MFEMProblem::addFESpace(), MFEMProblem::addFESpaceHierarchy(), FEProblemBase::addFunction(), MFEMProblem::addFunction(), FEProblemBase::addFunctorMaterial(), MFEMProblem::addFunctorMaterial(), FEProblemBase::addFVBC(), FEProblemBase::addFVGradientMethod(), FEProblemBase::addFVInitialCondition(), FEProblemBase::addFVInterfaceKernel(), FEProblemBase::addFVInterpolationMethod(), FEProblemBase::addFVKernel(), MFEMProblem::addGridFunction(), FEProblemBase::addHDGKernel(), MFEMProblem::addImagComponentToBC(), MFEMProblem::addImagComponentToKernel(), FEProblemBase::addIndicator(), MFEMProblem::addIndicator(), FEProblemBase::addInitialCondition(), MFEMProblem::addInitialCondition(), DiffusionPhysicsBase::addInitialConditions(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), FEProblemBase::addKernel(), MFEMProblem::addKernel(), FEProblemBase::addLinearFVBC(), FEProblemBase::addLinearFVKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), MFEMProblem::addMarker(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMeshDivision(), MFEMProblem::addMFEMFESpaceFromMOOSEVariable(), MFEMProblem::addMFEMProblemComposer(), MFEMProblem::addMFEMSolver(), FEProblemBase::addMultiApp(), FEProblemBase::addNodalKernel(), FEProblemBase::addObject(), FEProblemBase::addObjectParamsHelper(), FEProblemBase::addOutput(), FEProblemBase::addPostprocessor(), MFEMProblem::addPostprocessor(), FEProblemBase::addPredictor(), MFEMProblem::addRealComponentToBC(), MFEMProblem::addRealComponentToKernel(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), FEProblemBase::addScalarKernel(), MFEMProblem::addSubMesh(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), MFEMProblem::addTransfer(), FEProblemBase::addUserObject(), DisplacedProblem::addVariable(), MFEMEigenproblem::addVariable(), MFEMProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), MFEMProblem::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), AdvancedOutput::AdvancedOutput(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), assemble_l2(), Moose::assemble_matrix(), Action::associateWithParameter(), AuxKernelBase::AuxKernelBase(), AuxScalarKernel::AuxScalarKernel(), BoundsBase::BoundsBase(), MooseMesh::buildTypedMesh(), MeshGenerator::checkGetMesh(), PostprocessorInterface::checkParam(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), SampledOutput::cloneMesh(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), LibtorchNeuralNetControl::conditionalParameterError(), Console::Console(), MooseMeshUtils::copyIntoMesh(), CommonOutputAction::create(), MultiApp::createApp(), Postprocessor::declareValue(), DumpObjectsProblem::deduceNecessaryParameters(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), EigenProblem::EigenProblem(), EigenProblemSolve::EigenProblemSolve(), ElementMaterialSampler::ElementMaterialSampler(), ExamplePatchMeshGenerator::ExamplePatchMeshGenerator(), Executor::Executor(), Exodus::Exodus(), ElementSubdomainModifierBase::extrapolatePolynomial(), FEProblem::FEProblem(), FixedPointSolve::FixedPointSolve(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GapValueAux::GapValueAux(), ParsedSubdomainGeneratorBase::generate(), ActionWarehouse::getCurrentActionName(), ExecutorInterface::getExecutor(), Material::getMaterial(), Moose::PeriodicBCHelper::getParams(), ReporterInterface::getReporterName(), Reporter::getReporterValueName(), UserObjectInterface::getUserObjectName(), AuxKernelBase::getVariableHelper(), VectorPostprocessorInterface::getVectorPostprocessorName(), GhostingUserObject::GhostingUserObject(), MeshGeneratorSystem::hasDataDrivenAllowed(), AttribSystem::initFrom(), AttribDisplaced::initFrom(), BlockRestrictable::initializeBlockRestrictable(), FullSolveMultiApp::initialSetup(), FEProblemBase::initNullSpaceVectors(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MooseObject::isKokkosObject(), isValid(), IterationAdaptiveDT::IterationAdaptiveDT(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MooseObject::MooseObject(), UserObjectInterface::mooseObjectError(), MooseVariableInterface< T >::MooseVariableInterface(), MultiApp::MultiApp(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NodeFaceConstraint::NodeFaceConstraint(), ConsoleUtils::outputLegacyInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), ParsedReporterBase::ParsedReporterBase(), ParsedScalarReporter::ParsedScalarReporter(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), NEML2Action::printSummary(), ProjectedStatefulMaterialStorageAction::processProperty(), PropertyReadFile::PropertyReadFile(), PseudoTimestep::PseudoTimestep(), RandomIC::RandomIC(), ReferenceResidualConvergence::ReferenceResidualConvergence(), InputParameterWarehouse::removeInputParameters(), FEProblemBase::setAuxKernelParamsAndLog(), FEProblemBase::setInputParametersFEProblem(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setResidualObjectParamsAndLog(), SideSetsGeneratorBase::setup(), NonlinearSystemBase::shouldEvaluatePreSMOResidual(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), Moose::PetscSupport::storePetscOptions(), DumpObjectsProblem::stringifyParameters(), TaggingInterface::TaggingInterface(), Transfer::Transfer(), TransientBase::TransientBase(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), VectorFunctionIC::VectorFunctionIC(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().

◆ paramInfo()

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

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

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

Definition at line 471 of file MooseBase.h.

472{
473 mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
474}
std::string paramMessage(const std::string &param, Args... args) const

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

◆ paramWarning() [1/2]

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

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

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

Definition at line 464 of file MooseBase.h.

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

◆ paramWarning() [2/2]

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

◆ phi()

template<typename OutputType >
const FieldVariablePhiValue & MooseVariableFV< OutputType >::phi ( ) const
inlinefinaloverridevirtual

Return the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 598 of file MooseVariableFV.h.

598{ return _phi; }

◆ phiFace()

template<typename OutputType >
const FieldVariablePhiValue & MooseVariableFV< OutputType >::phiFace ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 613 of file MooseVariableFV.h.

613{ return _phi_face; }

◆ phiFaceNeighbor()

template<typename OutputType >
const FieldVariablePhiValue & MooseVariableFV< OutputType >::phiFaceNeighbor ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 620 of file MooseVariableFV.h.

621 {
622 return _phi_face_neighbor;
623 }

◆ phiFaceNeighborSize()

template<typename OutputType >
virtual std::size_t MooseVariableFV< OutputType >::phiFaceNeighborSize ( ) const
inlinefinaloverridevirtual

Return phiFaceNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 125 of file MooseVariableFV.h.

126 {
127 return _phi_face_neighbor.size();
128 }

◆ phiFaceSize()

template<typename OutputType >
virtual std::size_t MooseVariableFV< OutputType >::phiFaceSize ( ) const
inlinefinaloverridevirtual

Return phiFace size.

Implements MooseVariableFieldBase.

Definition at line 123 of file MooseVariableFV.h.

123{ return _phi_face.size(); }

◆ phiLower()

template<typename OutputType >
const MooseVariableFV< OutputType >::FieldVariablePhiValue & MooseVariableFV< OutputType >::phiLower ( ) const
overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 875 of file MooseVariableFV.h.

876{
877 lowerDError();
878}

◆ phiLowerSize()

template<typename OutputType >
virtual std::size_t MooseVariableFV< OutputType >::phiLowerSize ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableFieldBase.

Definition at line 129 of file MooseVariableFV.h.

130 {
131 mooseError("phiLowerSize not supported by MooseVariableFVBase");
132 }

◆ phiNeighbor()

template<typename OutputType >
const FieldVariablePhiValue & MooseVariableFV< OutputType >::phiNeighbor ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 633 of file MooseVariableFV.h.

633{ return _phi_neighbor; }

◆ phiNeighborSize()

template<typename OutputType >
virtual std::size_t MooseVariableFV< OutputType >::phiNeighborSize ( ) const
inlinefinaloverridevirtual

Return phiNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 124 of file MooseVariableFV.h.

124{ return _phi_neighbor.size(); }

◆ phiSize()

template<typename OutputType >
virtual std::size_t MooseVariableFV< OutputType >::phiSize ( ) const
inlinefinaloverridevirtual

Return phi size.

Implements MooseVariableFieldBase.

Definition at line 122 of file MooseVariableFV.h.

122{ return _phi.size(); }

◆ prepare()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::prepare ( )
inlinefinaloverridevirtual

Prepare the elemental degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 104 of file MooseVariableFV.h.

104{}

◆ prepareAux()

template<typename OutputType >
void MooseVariableFV< OutputType >::prepareAux ( )
finaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 860 of file MooseVariableFV.C.

861{
862 _element_data->prepareAux();
863 _neighbor_data->prepareAux();
864}

◆ prepareIC()

template<typename OutputType >
void MooseVariableFV< OutputType >::prepareIC ( )
overridevirtual

Prepare the initial condition.

Implements MooseVariableFieldBase.

Definition at line 305 of file MooseVariableFV.C.

306{
307 _element_data->prepareIC();
308}

◆ prepareLowerD()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::prepareLowerD ( )
inlinefinaloverridevirtual

Prepare a lower dimensional element's degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 112 of file MooseVariableFV.h.

112{}

◆ prepareNeighbor()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::prepareNeighbor ( )
inlinefinaloverridevirtual

Prepare the neighbor element degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 105 of file MooseVariableFV.h.

105{}

◆ queryFVArgCache()

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::queryFVArgCache ( std::map< SpaceArg, ValueType > &  cache_data,
const SpaceArg &  space 
) const
privateinherited

check a finite volume spatial argument cache and if invalid then evaluate

Definition at line 516 of file MooseFunctor.h.

588{
589 // We don't want to evaluate if the key already exists, so instead we value initialize
590 auto [it, inserted] = cache_data.try_emplace(space, ValueType());
591 auto & value = it->second;
592
593 if (inserted)
594 // value not ready to go
595 // this function is only called from functions that assert we are in the current time state
596 value = evaluate(space, currentState());
597
598 return value;
599}
StateArg currentState()

◆ queryParam()

template<typename T >
const T * MooseBase::queryParam ( const std::string &  name) const
inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or if the parameter is not valid, nullptr will be returned

Parameters
nameThe name of the parameter
Returns
A pointer to the parameter value, if it exists

Definition at line 413 of file MooseBase.h.

414{
415 return _pars.queryParam<T>(name);
416}
const T * queryParam(const std::string &name) const
Query a parameter.

Referenced by MFEMExecutedObject::getRequestedItems(), and MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver().

◆ queryQpCache()

FunctorBase< Moose::ADType< OutputType >::type >::ValueType Moose::FunctorBase< Moose::ADType< OutputType >::type >::queryQpCache ( unsigned int  qp,
const libMesh::QBase &  qrule,
std::vector< std::pair< bool, Moose::ADType< OutputType >::type > > &  qp_cache_data,
const SpaceArg &  space,
const StateArg &  state 
) const
privateinherited

check a qp cache and if invalid then evaluate

Definition at line 506 of file MooseFunctor.h.

637{
638 // Check and see whether we even have sized for this quadrature point. If we haven't then we
639 // must evaluate
640 if (qp >= qp_cache_data.size())
641 {
642 qp_cache_data.resize(qrule.n_points(), std::make_pair(false, ValueType()));
643 auto & pr = qp_cache_data[qp];
644 pr.second = evaluate(space, state);
645 pr.first = true;
646 return pr.second;
647 }
648
649 // We've already sized for this qp, so let's see whether we have a valid cache value
650 auto & pr = qp_cache_data[qp];
651 if (pr.first)
652 return pr.second;
653
654 // No valid cache value so evaluate
655 pr.second = evaluate(space, state);
656 pr.first = true;
657 return pr.second;
658}
unsigned int n_points() const

◆ registerInvalidSolutionInternal()

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

Definition at line 55 of file SolutionInvalidInterface.C.

57{
59 _si_moose_base.type(), message, warning);
60}
const std::string & type() const
Get the type of this class.
Definition MooseBase.h:93
InvalidSolutionID registerInvalidity(const std::string &object_type, const std::string &message, const bool warning)
Call to register an invalid calculation.

◆ reinitAux()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::reinitAux ( )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 110 of file MooseVariableFV.h.

110{}

◆ reinitAuxNeighbor()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::reinitAuxNeighbor ( )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 111 of file MooseVariableFV.h.

111{}

◆ reinitNode()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::reinitNode ( )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 107 of file MooseVariableFV.h.

107{}

◆ reinitNodes()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::reinitNodes ( const std::vector< dof_id_type > &  )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 108 of file MooseVariableFV.h.

108{}

◆ reinitNodesNeighbor()

template<typename OutputType >
virtual void MooseVariableFV< OutputType >::reinitNodesNeighbor ( const std::vector< dof_id_type > &  )
inlinefinaloverridevirtual

Implements MooseVariableFieldBase.

Definition at line 109 of file MooseVariableFV.h.

109{}

◆ requireQpComputations()

virtual void MooseVariableFieldBase::requireQpComputations ( ) const
inlinevirtualinherited

Request that quadrature point data be (pre)computed.

FE variables (pre)compute quadrature point data by default, so this is a no-op for them. Some FV variables (e.g. linear FV variables) do not compute it by default and use this call to opt in.

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

Definition at line 206 of file MooseVariableFieldBase.h.

206{}

Referenced by AuxKernelBase::AuxKernelBase().

◆ residualSetup()

template<typename OutputType >
void MooseVariableFV< OutputType >::residualSetup ( )
overridevirtual

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

Reimplemented from MooseVariableField< OutputType >.

Definition at line 693 of file MooseVariableFV.C.

◆ scalingFactor() [1/2]

Real MooseVariableBase::scalingFactor ( ) const
inlineinherited

Get the scaling factor for this variable.

Definition at line 120 of file MooseVariableBase.h.

120{ return _scaling_factor[0]; }

Referenced by MooseVariableBase::MooseVariableBase().

◆ scalingFactor() [2/2]

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

Set the scaling factor for this variable.

Definition at line 180 of file MooseVariableBase.C.

181{
182 mooseAssert(factor.size() == _count, "Inconsistent scaling factor size");
183 for (const auto i : make_range(_count))
184 _scaling_factor[i] = factor[i];
185}
IntRange< T > make_range(T beg, T end)

Referenced by FVInterfaceKernel::addResidualAndJacobian(), ADScalarKernel::computeADJacobian(), ADDGKernel::computeElemNeighJacobian(), BoundaryIntegralValueConstraint::computeFieldScalarJacobian(), ADDiracKernel::computeFullJacobian(), DiffusionLHDGDirichletBC::computeJacobian(), DiffusionLHDGPrescribedGradientBC::computeJacobian(), ADMortarScalarBase::computeJacobian(), ADNodeElemConstraint::computeJacobian(), FVElementalKernel::computeJacobian(), DiffusionLHDGKernel::computeJacobian(), ADKernelScalarBase::computeJacobian(), ADNodalKernel::computeJacobian(), NodalKernel::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVScalarLagrangeMultiplierInterface::computeJacobian(), NodalConstraint::computeJacobian(), ADMortarConstraint::computeJacobian(), DiffusionLHDGKernel::computeJacobianOnSide(), ADDGKernel::computeOffDiagElemNeighJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), DiffusionLHDGDirichletBC::computeResidual(), DiffusionLHDGPrescribedGradientBC::computeResidual(), ADMortarScalarBase::computeResidual(), ADNodeElemConstraint::computeResidual(), MortarScalarBase::computeResidual(), DiffusionLHDGKernel::computeResidual(), ADKernelScalarBase::computeResidual(), ADNodalKernel::computeResidual(), NodalKernel::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVScalarLagrangeMultiplierInterface::computeResidual(), NodalConstraint::computeResidual(), ADDiracKernel::computeResidualAndJacobian(), FVElementalKernel::computeResidualAndJacobian(), ADKernelScalarBase::computeResidualAndJacobian(), FVScalarLagrangeMultiplierConstraint::computeResidualAndJacobian(), DiffusionLHDGKernel::computeResidualOnSide(), BoundaryIntegralValueConstraint::computeScalarFieldJacobian(), BoundaryIntegralValueConstraint::computeScalarJacobian(), MortarScalarBase::computeScalarJacobian(), KernelScalarBase::computeScalarJacobian(), MortarScalarBase::computeScalarOffDiagJacobian(), KernelScalarBase::computeScalarOffDiagJacobian(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), BoundaryIntegralValueConstraint::computeScalarResidual(), KernelScalarBase::computeScalarResidual(), TagMatrixAux::computeValue(), TagVectorAux::computeValue(), ScalarTagMatrixAux::computeValue(), ScalarTagVectorAux::computeValue(), DiscreteVariableResidualNorm::finalize(), and ElementAndTraceScalarHDGAssemblyHelper::taggingData().

◆ secondPhi()

template<typename OutputType >
const FieldVariablePhiSecond & MooseVariableFV< OutputType >::secondPhi ( ) const
inlinefinaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.

Implements MooseVariableField< OutputType >.

Definition at line 600 of file MooseVariableFV.h.

601 {
602 mooseError("We don't currently implement second derivatives for FV");
603 }

◆ secondPhiFace()

template<typename OutputType >
const FieldVariablePhiSecond & MooseVariableFV< OutputType >::secondPhiFace ( ) const
inlinefinaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face.

Implements MooseVariableField< OutputType >.

Definition at line 615 of file MooseVariableFV.h.

616 {
617 mooseError("We don't currently implement second derivatives for FV");
618 }

◆ secondPhiFaceNeighbor()

template<typename OutputType >
const FieldVariablePhiSecond & MooseVariableFV< OutputType >::secondPhiFaceNeighbor ( ) const
inlinefinaloverridevirtual

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 628 of file MooseVariableFV.h.

629 {
630 mooseError("We don't currently implement second derivatives for FV");
631 }

◆ secondPhiNeighbor()

template<typename OutputType >
const FieldVariablePhiSecond & MooseVariableFV< OutputType >::secondPhiNeighbor ( ) const
inlinefinaloverridevirtual

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element.

Implements MooseVariableField< OutputType >.

Definition at line 638 of file MooseVariableFV.h.

639 {
640 mooseError("We don't currently implement second derivatives for FV");
641 }

◆ setActiveTags()

template<typename OutputType >
void MooseVariableFV< OutputType >::setActiveTags ( const std::set< TagID > &  vtags)
overridevirtual

Set the active vector tags.

Parameters
vtagsAdditional 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 831 of file MooseVariableFV.h.

832{
833 _element_data->setActiveTags(vtags);
834 _neighbor_data->setActiveTags(vtags);
835}

◆ setCacheClearanceSchedule()

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

Set how often to clear the functor evaluation cache.

Definition at line 238 of file MooseFunctor.h.

721{
722 if (clearance_schedule.count(EXEC_ALWAYS))
723 _always_evaluate = true;
724
725 _clearance_schedule = clearance_schedule;
726}
const ExecFlagType EXEC_ALWAYS
Definition Moose.C:54
bool _always_evaluate
Boolean to check if we always need evaluation.

◆ setDofValue()

template<typename OutputType >
void MooseVariableFV< OutputType >::setDofValue ( const DofValue &  value,
unsigned int  index 
)
overridevirtual

Degree of freedom value setters.

Implements MooseVariableField< OutputType >.

Definition at line 391 of file MooseVariableFV.C.

392{
393 _element_data->setDofValue(value, index);
394}

◆ setDofValues()

template<typename OutputType >
void MooseVariableFV< OutputType >::setDofValues ( const DenseVector< DofValue > &  values)
overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 398 of file MooseVariableFV.C.

399{
400 _element_data->setDofValues(values);
401}
std::array< Real, 2 > values
Definition MortarUtils.C:52

◆ setLowerDofValues()

template<typename OutputType >
void MooseVariableFV< OutputType >::setLowerDofValues ( const DenseVector< DofValue > &  values)
overridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 405 of file MooseVariableFV.C.

406{
407 lowerDError();
408}

◆ setNodalValue()

template<typename OutputType >
void MooseVariableFV< OutputType >::setNodalValue ( const OutputType &  value)
overridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 384 of file MooseVariableFV.C.

385{
386 mooseError("FV variables do not support setNodalValue");
387}

◆ sizeMatrixTagData()

template<typename OutputType >
void MooseVariableFV< OutputType >::sizeMatrixTagData ( )
overridevirtual

Size data structures related to matrix tagging.

Reimplemented from MooseVariableBase.

Definition at line 939 of file MooseVariableFV.C.

940{
941 _element_data->sizeMatrixTagData();
942 _neighbor_data->sizeMatrixTagData();
943}

◆ sln()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::sln ( ) const
inlineoverridevirtual
Returns
the current elemental solution

Implements MooseVariableField< OutputType >.

Definition at line 229 of file MooseVariableFV.h.

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

◆ slnNeighbor()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::slnNeighbor ( ) const
inlineoverridevirtual
Returns
the current neighbor solution

Implements MooseVariableField< OutputType >.

Definition at line 241 of file MooseVariableFV.h.

242 {
243 return _neighbor_data->sln(Moose::Current);
244 }

◆ slnOld()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::slnOld ( ) const
inlineoverridevirtual
Returns
the old elemental solution, e.g. that of the previous timestep

Implements MooseVariableField< OutputType >.

Definition at line 230 of file MooseVariableFV.h.

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

◆ slnOlder()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::slnOlder ( ) const
inlineoverridevirtual
Returns
the older elemental solution, e.g. that of two timesteps ago

Implements MooseVariableField< OutputType >.

Definition at line 231 of file MooseVariableFV.h.

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

◆ slnOldNeighbor()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::slnOldNeighbor ( ) const
inlineoverridevirtual
Returns
the old neighbor solution, e.g. that of the previous timestep

Implements MooseVariableField< OutputType >.

Definition at line 245 of file MooseVariableFV.h.

246 {
247 return _neighbor_data->sln(Moose::Old);
248 }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )
virtualinherited

Gets called when the subdomain changes (i.e.

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

Reimplemented in Material, MaterialBase, GeneralUserObject, NodalUserObject, ThreadedGeneralUserObject, Constraint, Moose::Kokkos::AuxKernel, Moose::Kokkos::MaterialBase, and Moose::Kokkos::UserObject.

Definition at line 68 of file SetupInterface.C.

69{
70}

◆ supportsElemSideQpArg()

template<typename OutputType >
bool MooseVariableFV< OutputType >::supportsElemSideQpArg ( ) const
inlinefinaloverridevirtual

Whether this functor supports evaluation with ElemSideQpArg.

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

Definition at line 503 of file MooseVariableFV.h.

503{ return true; }

◆ supportsFaceArg()

template<typename OutputType >
bool MooseVariableFV< OutputType >::supportsFaceArg ( ) const
inlinefinaloverridevirtual

Whether this functor supports evaluation with FaceArg.

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

Definition at line 502 of file MooseVariableFV.h.

502{ return true; }

◆ supportsGeometricInfoBasedLoops()

template<typename OutputType >
bool MooseVariableFV< OutputType >::supportsGeometricInfoBasedLoops ( ) const
inlineoverridevirtual

Whether this variable supports geometric-info-based loops, such as ElemInfo/FaceInfo loops.

Static, per-class property - never toggled by requireQpComputations().

Reimplemented from MooseVariableBase.

Definition at line 484 of file MooseVariableFV.h.

484{ return true; }

◆ supportsQpBasedLoops()

template<typename OutputType >
bool MooseVariableFV< OutputType >::supportsQpBasedLoops ( ) const
inlineoverridevirtual

Whether this variable supports QP-indexed loops.

Returns true for FE variables and nonlinear FV variables. Returns false for linear FV variables by default and for scalar variables.

Reimplemented from MooseVariableBase.

Definition at line 483 of file MooseVariableFV.h.

483{ return true; }

◆ sys() [1/2]

SystemBase & MooseVariableBase::sys ( )
inlineinherited

Get the system this variable is part of.

Definition at line 70 of file MooseVariableBase.h.

70{ return _sys; }

Referenced by SetupResidualDebugAction::act(), ADDGKernel::ADDGKernel(), FEProblemBase::addInitialCondition(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), MultiAppConservativeTransfer::adjustTransferredSolution(), MultiAppConservativeTransfer::adjustTransferredSolutionNearestPoint(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), MultiAppGeneralFieldNearestLocationTransfer::buildKDTrees(), MultiAppGeneralFieldShapeEvaluationTransfer::buildMeshFunctions(), FVFluxBC::checkFaceIntegrity(), InternalSideIndicatorBase::computeIndicator(), FVInterfaceKernel::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVInterfaceKernel::computeResidual(), FVFluxKernel::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), DGKernel::DGKernel(), MultiAppGeometricInterpolationTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), InternalSideIndicatorBase::finalize(), FVBoundaryCondition::hasFaceSide(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), IntegratedBC::IntegratedBC(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), MultiApplibMeshToMFEMShapeEvaluationTransfer::interpolatelibMeshVariable(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), MooseMesh::isTranslatedPeriodic(), Kernel::Kernel(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), NodalBC::NodalBC(), NodalKernel::NodalKernel(), Exodus::outputScalarVariables(), Nemesis::outputScalarVariables(), TableOutput::outputScalarVariables(), FEProblemBase::projectInitialConditionOnCustomRange(), FEProblemBase::projectSolution(), MultiAppProjectionTransfer::projectSolution(), MooseMesh::queryPeriodicDimensions(), MooseVariableScalar::reinit(), FVInterfaceKernel::setupData(), MultiAppDofCopyTransfer::transfer(), MultiAppDofCopyTransfer::transferDofObject(), MultiAppShapeEvaluationTransfer::transferVariable(), FVQpFluxBC::uOnGhost(), FVQpFluxBC::uOnUSub(), NodalDamper::variableDefinedOnNode(), Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl(), and Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl().

◆ sys() [2/2]

const SystemBase & MooseVariableBase::sys ( ) const
inlineinherited

Get the system this variable is part of.

Definition at line 75 of file MooseVariableBase.h.

75{ return _sys; }

◆ timestepSetup()

template<typename OutputType >
void MooseVariableFV< OutputType >::timestepSetup ( )
overridevirtual

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

Reimplemented from MooseVariableField< OutputType >.

Definition at line 866 of file MooseVariableFV.h.

867{
868 _dirichlet_map_setup = false;
869 _flux_map_setup = false;
871}
virtual void timestepSetup() override
Gets called at the beginning of the timestep before this object is asked to do its job.

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )
inlineinherited

Definition at line 105 of file MooseVariableBase.h.

105{ return allDofIndices().size(); }
const std::vector< dof_id_type > & allDofIndices() const
Get all global dofindices for the variable.

◆ type()

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

Get the type of this class.

Returns
the name of the type of this class

Definition at line 93 of file MooseBase.h.

94 {
95 mooseAssert(_type.size(), "Empty type");
96 return _type;
97 }
const std::string & _type
The type of this class.
Definition MooseBase.h:378

Referenced by CreateProblemDefaultAction::act(), MaterialDerivativeTestAction::act(), MaterialOutputAction::act(), SetupDebugAction::act(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addConvergence(), FEProblemBase::addDistribution(), DistributedRectilinearMeshGenerator::addElement(), DistributedRectilinearMeshGenerator::addElement(), MooseApp::addExecutor(), MooseApp::addExecutorParams(), MFEMProblem::addFESpace(), MFEMProblem::addFESpaceHierarchy(), FEProblemBase::addFunction(), MFEMProblem::addFunction(), FEProblemBase::addMeshDivision(), MooseApp::addMeshGenerator(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), MFEMProblem::addMFEMProblemComposer(), FEProblemBase::addObject(), DistributedRectilinearMeshGenerator::addPoint(), MFEMProblem::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), FEProblemBase::addReporter(), FEProblemBase::addSampler(), WebServerControl::addServerActionsInternal(), FEProblemBase::addTimeIntegrator(), MFEMProblem::addVectorPostprocessor(), SubProblem::addVectorTag(), DisplacedProblem::addVectorTag(), FEProblemBase::advanceMultiApps(), MooseApp::appendMeshGenerator(), AuxKernelBase::AuxKernelBase(), FEProblemBase::backupMultiApps(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), BoundaryPreservedMarker::BoundaryPreservedMarker(), DistributedRectilinearMeshGenerator::buildCube(), MooseMesh::buildHRefinementAndCoarseningMaps(), MooseMesh::buildLowerDMesh(), MooseMesh::buildPRefinementAndCoarseningMaps(), PhysicsBase::checkComponentType(), MeshGenerator::checkGetMesh(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), FEProblemBase::checkUserObjectNameCollision(), MFEMMultiAppTransfer::checkValidTransferProblemTypes(), MeshInfo::CombinedInfos< ElemInfoMap, ElemInfoItems >::CombinedInfos(), ElemElemConstraint::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ADDGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), ADDGKernel::computeElemNeighResidual(), ArrayDGLowerDKernel::computeLowerDJacobian(), DGLowerDKernel::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDJacobian(), LowerDIntegratedBC::computeLowerDJacobian(), ArrayLowerDIntegratedBC::computeLowerDOffDiagJacobian(), LowerDIntegratedBC::computeLowerDOffDiagJacobian(), ArrayHFEMDirichletBC::computeLowerDQpJacobian(), HFEMDirichletBC::computeLowerDQpJacobian(), ArrayHFEMDiffusion::computeLowerDQpJacobian(), HFEMDiffusion::computeLowerDQpJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), HFEMDirichletBC::computeLowerDQpOffDiagJacobian(), FEProblemBase::computeMultiAppsDT(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ADDGKernel::computeOffDiagElemNeighJacobian(), ArrayDGLowerDKernel::computeOffDiagLowerDJacobian(), DGLowerDKernel::computeOffDiagLowerDJacobian(), ScalarKernel::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGConvection::computeQpJacobian(), ArrayDGDiffusion::computeQpJacobian(), DGDiffusion::computeQpJacobian(), InterfaceDiffusion::computeQpJacobian(), InterfaceReaction::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), HFEMTestJump::computeQpOffDiagJacobian(), HFEMTrialJump::computeQpOffDiagJacobian(), ScalarKernel::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), DGConvection::computeQpResidual(), ADDGAdvection::computeQpResidual(), ADDGDiffusion::computeQpResidual(), DGDiffusion::computeQpResidual(), HFEMDiffusion::computeQpResidual(), HFEMTestJump::computeQpResidual(), HFEMTrialJump::computeQpResidual(), ADMatInterfaceReaction::computeQpResidual(), InterfaceDiffusion::computeQpResidual(), InterfaceReaction::computeQpResidual(), ArrayDGDiffusion::computeQpResidual(), ArrayHFEMDiffusion::computeQpResidual(), FEProblemBase::computeSystems(), FEProblemBase::computeUserObjectByName(), FEProblemBase::computeUserObjects(), FEProblemBase::computeUserObjectsInternal(), FEProblemBase::createQRules(), DisplacedProblem::createQRules(), MooseApp::createRecoverablePerfGraph(), MoveBoundaryNodesToCurveGenerator::curveGenerator(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiAppTransfers(), SteadyBase::execute(), WebServerControl::execute(), ActionWarehouse::executeActionsWithAction(), FEProblemBase::finishMultiAppStep(), FVScalarLagrangeMultiplierInterface::FVScalarLagrangeMultiplierInterface(), Boundary2DDelaunayGenerator::General2DDelaunay(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), Boundary2DDelaunayGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), SubdomainPerElementGenerator::generate(), PatternedMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), MultiAppTransfer::getAppInfo(), TransfiniteMeshGenerator::getEdge(), ElementGenerator::getElemType(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getMaterialPropertyStorageConsumers(), MaterialOutputAction::getParams(), ReporterData::getReporterInfo(), MooseServer::getSyntaxMetadata(), FEProblemBase::getTransfers(), FEProblemBase::getUOQuery(), SubProblem::getVectorTags(), DisplacedProblem::getVectorTags(), EqualValueBoundaryConstraint::ghostPrimary(), CommonOutputAction::hasConsole(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), NEML2Action::inferMOOSEIOType(), AdvancedOutput::initAvailableLists(), FunctorPositions::initialize(), FunctorTimes::initialize(), LinearFVAdvection::initialSetup(), LinearFVAnisotropicDiffusion::initialSetup(), LinearFVDiffusion::initialSetup(), MultiAppConservativeTransfer::initialSetup(), ArrayDGDiffusion::initQpResidual(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), FEProblemBase::logAdd(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), MooseObject::MooseObject(), SubProblem::numVectorTags(), DisplacedProblem::numVectorTags(), AdvancedOutput::output(), Console::output(), ConsoleUtils::outputExecutionInformation(), Output::outputStep(), SampledOutput::outputStep(), FEProblemBase::outputStep(), MooseServer::parseDocumentForDiagnostics(), PointInUnionCheckUO::PointInUnionCheckUO(), MooseMesh::prepare(), MFEMFunctorMaterial::processLiterals(), ProjectedStatefulMaterialStorageAction::processProperty(), MooseApp::recursivelyCreateExecutors(), SolutionInvalidInterface::registerInvalidSolutionInternal(), FEProblemBase::restoreMultiApps(), MeshRepairGenerator::separateSubdomainsByElementType(), FEProblemBase::setCoupling(), MooseApp::setupOptions(), ExplicitRK2::solve(), ExplicitTVDRK2::solve(), Reporter::store(), MooseBase::typeAndName(), AuxScalarKernel::uOld(), ScalarKernelBase::uOld(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), UserObjectInterface::userObjectType(), and AdvancedOutput::wantOutput().

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const
inherited

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

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

Definition at line 57 of file MooseBase.C.

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

Referenced by MaterialPropertyStorage::addProperty(), FEProblemBase::checkUserObjectNameCollision(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< T >::finalize(), ReporterData::getReporterInfo(), MFEMSamplerBase::initialSetup(), MFEMVariableSamplerBase::initialSetup(), WebServerControl::outputMessage(), and Action::timedAct().

◆ uDot()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::uDot ( ) const
inline

Definition at line 228 of file MooseVariableFV.h.

228{ return _element_data->uDot(); }

◆ uDotNeighbor()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::uDotNeighbor ( ) const
inline

Definition at line 240 of file MooseVariableFV.h.

240{ return _neighbor_data->uDot(); }

◆ uncorrectedAdGradSln()

template<typename OutputType >
VectorValue< ADReal > MooseVariableFV< OutputType >::uncorrectedAdGradSln ( const FaceInfo &  fi,
const StateArg &  state,
const bool  correct_skewness = false 
) const
virtual

Retrieve (or potentially compute) the uncorrected gradient on the provided face.

This uncorrected gradient is a simple linear interpolation between cell gradients computed at the centers of the two neighboring cells. "Correcting" the face gradient involves weighting the gradient stencil more heavily on the solution values on the face-neighbor cells than the linear interpolation process does. This is commonly known as a cross-diffusion correction. Correction is done in adGradSln(const FaceInfo & fi)

Parameters
faceThe face for which to retrieve the gradient
stateState argument which describes at what time / solution iteration state we want to evaluate the variable
correct_skewnessWhether to perform skew corrections

Definition at line 619 of file MooseVariableFV.C.

622{
623 const auto face_type = fi.faceType(std::make_pair(this->number(), this->sys().number()));
624 mooseAssert(face_type != FaceInfo::VarFaceNeighbors::NEITHER,
625 "Gradient requested on a face where the variable is defined on neither side.");
626
627 const bool var_defined_on_elem = (face_type == FaceInfo::VarFaceNeighbors::BOTH) ||
629 const Elem * const elem_one = var_defined_on_elem ? &fi.elem() : fi.neighborPtr();
630 const Elem * const elem_two = var_defined_on_elem ? fi.neighborPtr() : &fi.elem();
631
632 const VectorValue<ADReal> elem_one_grad = adGradSln(elem_one, state, correct_skewness);
633
634 // If we have a neighbor then we interpolate between the two to the face. If we do not, then we
635 // apply a zero Hessian assumption and use the element centroid gradient as the uncorrected face
636 // gradient
637 if (face_type == FaceInfo::VarFaceNeighbors::BOTH)
638 {
639 mooseAssert(elem_two, "Face type indicates BOTH but neighbor information is missing.");
640 const VectorValue<ADReal> & elem_two_grad = adGradSln(elem_two, state, correct_skewness);
641
642 // Uncorrected gradient value
643 return Moose::FV::linearInterpolation(elem_one_grad, elem_two_grad, fi, var_defined_on_elem);
644 }
645 else
646 return elem_one_grad;
647}
libMesh::CompareTypes< T, T2 >::supertype linearInterpolation(const T &value1, const T2 &value2, const FaceInfo &fi, const bool one_is_elem, const InterpMethod interp_method=InterpMethod::Average)
A simple linear interpolation of values between cell centers to a cell face.

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const
inherited
Returns
The unique name for accessing input parameters of this object in the InputParameterWarehouse

Definition at line 69 of file MooseBase.C.

70{
71 if (!_pars.have_parameter<std::string>(unique_name_param))
72 mooseError("uniqueName(): Object does not have a unique name");
73 return MooseObjectName(_pars.get<std::string>(unique_name_param));
74}
bool have_parameter(std::string_view name) const
A wrapper around the Parameters base class method.
static const std::string unique_name_param
The name of the parameter that contains the unique object name.
Definition MooseBase.h:57
A class for storing the names of MooseObject by tag and object name.

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

◆ uniqueParameterName()

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

Definition at line 63 of file MooseBase.C.

64{
65 return MooseObjectParameterName(getBase(), name(), parameter_name);
66}
const std::string & getBase() const
Definition MooseBase.h:147

◆ useDual()

bool MooseVariableBase::useDual ( ) const
inlineinherited

Get dual mortar option.

Definition at line 99 of file MooseVariableBase.h.

99{ return _use_dual; }
bool _use_dual
If dual mortar approach is used.

Referenced by MortarConstraintBase::MortarConstraintBase().

◆ usesGradPhiNeighbor()

template<typename OutputType >
bool MooseVariableField< OutputType >::usesGradPhiNeighbor ( ) const
inlineinherited

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

Currently hardcoded to true because we always compute the value.

Definition at line 346 of file MooseVariableField.h.

346{ return true; }

Referenced by Assembly::copyNeighborShapes().

◆ usesPhiNeighbor()

template<typename OutputType >
bool MooseVariableField< OutputType >::usesPhiNeighbor ( ) const
inlineinherited

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

Currently hardcoded to true because we always compute the value.

Definition at line 339 of file MooseVariableField.h.

339{ return true; }

Referenced by Assembly::copyNeighborShapes().

◆ usesSecondPhiNeighbor()

template<typename OutputType >
bool MooseVariableFV< OutputType >::usesSecondPhiNeighbor ( ) const
inlinefinaloverridevirtual

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

Implements MooseVariableField< OutputType >.

Definition at line 596 of file MooseVariableFV.h.

596{ return false; }

◆ validParams()

template<typename OutputType >
InputParameters MooseVariableFV< OutputType >::validParams ( )
static

Definition at line 34 of file MooseVariableFV.C.

35{
37 params.set<bool>("fv") = true;
38 params.set<MooseEnum>("family") = "MONOMIAL";
39 params.set<MooseEnum>("order") = "CONSTANT";
40 // A finite volume variable is always a CONSTANT MONOMIAL, whose basis has no p-refined
41 // counterpart, so the p-refinement parameters are fixed here and hidden from the user
42 params.set<bool>("p_refinement") = false;
43 params.suppressParameter<bool>("p_refinement");
44 params.suppressParameter<bool>("disable_p_refinement");
45 params.template addParam<bool>(
46 "two_term_boundary_expansion",
47 true,
48 "Whether to use a two-term Taylor expansion to calculate boundary face values. "
49 "If the two-term expansion is used, then the boundary face value depends on the "
50 "adjoining cell center gradient, which itself depends on the boundary face value. "
51 "Consequently an implicit solve is used to simultaneously solve for the adjoining cell "
52 "center gradient and boundary face value(s).");
53 MooseEnum face_interp_method("average skewness-corrected", "average");
54 params.template addParam<MooseEnum>("face_interp_method",
55 face_interp_method,
56 "Switch that can select between face interpolation methods.");
57 params.template addParam<bool>(
58 "cache_cell_gradients", true, "Whether to cache cell gradients or re-compute them.");
59
60 // Depending on the face interpolation we might have to do more than one layer ghosting.
62 "ElementSideNeighborLayers",
65 [](const InputParameters & obj_params, InputParameters & rm_params)
66 {
67 unsigned short layers = 1;
68 if (obj_params.get<MooseEnum>("face_interp_method") == "skewness-corrected")
69 layers = 2;
70
71 rm_params.set<unsigned short>("layers") = layers;
72 });
73 return params;
74}
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn't required or valid in the derived class...
void addRelationshipManager(const std::string &name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback input_parameter_callback=nullptr)
Tells MOOSE about a RelationshipManager that this object needs.
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition MooseEnum.h:55
static InputParameters validParams()

◆ vectorTagDofValue()

template<typename OutputType >
const DofValues & MooseVariableFV< OutputType >::vectorTagDofValue ( TagID  tag) const
inlineoverridevirtual

Implements MooseVariableField< OutputType >.

Definition at line 211 of file MooseVariableFV.h.

212 {
213 return _element_data->vectorTagDofValue(tag);
214 }

◆ vectorTagValue()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::vectorTagValue ( TagID  tag) const
inlineoverridevirtual

tag values getters

Implements MooseVariableField< OutputType >.

Definition at line 207 of file MooseVariableFV.h.

208 {
209 return _element_data->vectorTagValue(tag);
210 }

◆ vectorTagValueNeighbor()

template<typename OutputType >
const FieldVariableValue & MooseVariableFV< OutputType >::vectorTagValueNeighbor ( TagID  tag)
inline

Definition at line 219 of file MooseVariableFV.h.

220 {
221 return _neighbor_data->vectorTagValue(tag);
222 }

Friends And Related Symbol Documentation

◆ Moose::initDofIndices

template<typename OutputType >
void Moose::initDofIndices ( MooseVariableFV< OutputType > &  ,
const Elem &   
)
friend

Member Data Documentation

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory
protectedinherited

◆ _ad_real_dummy

template<typename OutputType >
ADReal MooseVariableField< OutputType >::_ad_real_dummy = 0
mutableprotectedinherited

A dummy ADReal variable.

Definition at line 409 of file MooseVariableField.h.

◆ _always_evaluate

bool Moose::FunctorBase< Moose::ADType< OutputType >::type >::_always_evaluate
privateinherited

Boolean to check if we always need evaluation.

Definition at line 523 of file MooseFunctor.h.

◆ _app

MooseApp& MooseBase::_app
protectedinherited

The MOOSE application this is associated with.

Definition at line 375 of file MooseBase.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), FEProblemBase::acceptInvalidSolution(), FEProblemBase::addAnyRedistributers(), MeshGenerator::addChildMeshGenerator(), FEProblemBase::addMaterialHelper(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addOutput(), MeshGenerator::addParentMeshGenerator(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), DefaultNonlinearConvergence::checkConvergence(), MeshGenerator::checkGetMesh(), FEProblemBase::checkICRestartError(), FEProblemBase::checkProblemIntegrity(), LibmeshPartitioner::clone(), BlockWeightedPartitioner::clone(), CopyMeshPartitioner::clone(), GridPartitioner::clone(), HierarchicalGridPartitioner::clone(), PetscExternalPartitioner::clone(), RandomPartitioner::clone(), SingleRankPartitioner::clone(), ElementPointNeighborLayers::clone(), ElementSideNeighborLayers::clone(), GhostAllPointNeighbors::clone(), GhostBoundary::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), GhostPrimaryFace::clone(), ProxyRelationshipManager::clone(), RedistributeProperties::clone(), SampledOutput::cloneMesh(), FEProblemBase::computeJacobianSys(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualSys(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), Control::Control(), CopyMeshPartitioner::CopyMeshPartitioner(), MultiApp::createApp(), MultiApp::createApps(), MoveBoundaryNodesToCurveGenerator::curveGenerator(), FEProblemBase::customSetup(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), MooseMesh::determineUseDistributedMesh(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), PIDTransientControl::execute(), Eigenvalue::execute(), InversePowerMethod::execute(), NonlinearEigen::execute(), SteadyBase::execute(), TransientBase::execute(), MFEMSteady::execute(), PseudoTimestep::execute(), IterationInfo::execute(), EigenProblem::execute(), Executioner::Executioner(), Executioner::Executioner(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), NEML2Assembly::finalize(), ChangeOverFixedPointPostprocessor::finalize(), RadialAverage::finalize(), FixedPointSolve::FixedPointSolve(), FEProblemBase::forceOutput(), FullSolveMultiApp::FullSolveMultiApp(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVAdvection::FVAdvection(), FileMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), MeshGenerator::getCSGBaseByName(), FEProblemBase::getExecutor(), MeshGenerator::getMeshByName(), NumFixedPointIterations::getValue(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), Eigenvalue::init(), InversePowerMethod::init(), NonlinearEigen::init(), TransientBase::init(), MFEMMesh::init(), FEProblemBase::init(), CompositionDT::init(), SubProblem::initialSetup(), PIDTransientControl::initialSetup(), RealFunctionControl::initialSetup(), TimePeriod::initialSetup(), EigenProblemSolve::initialSetup(), FEProblemSolve::initialSetup(), Console::initialSetup(), FEProblemBase::initialSetup(), BoundaryMeshBuilder::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), EigenProblem::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), FEProblemBase::meshChanged(), MeshGenerator::MeshGenerator(), MFEMProblemSolve::MFEMProblemSolve(), MooseMesh::MooseMesh(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), EigenExecutionerBase::normalizeSolution(), NumFailedTimeSteps::NumFailedTimeSteps(), Checkpoint::output(), Exodus::output(), Nemesis::output(), PerfGraphOutput::output(), Tecplot::output(), MortarNodalGeometryOutput::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), JSONOutput::outputReporters(), Output::outputStep(), SampledOutput::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), JSONOutput::outputSystemInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), MultiApp::parentOutputPositionChanged(), TransientBase::preExecute(), FEProblemBase::projectSolution(), AnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), FileMesh::safeClone(), GeneratedMesh::safeClone(), ImageMesh::safeClone(), MeshGeneratorMesh::safeClone(), PatternedMesh::safeClone(), RinglebMesh::safeClone(), SpiralAnnularMesh::safeClone(), StitchedMesh::safeClone(), TiledMesh::safeClone(), MFEMFileMesh::safeClone(), MFEMMeshGeneratorMesh::safeClone(), MultiApp::setAppOutputFileBase(), FileOutput::setFileBaseInternal(), MeshGenerator::setMeshProperty(), MeshGenerator::setMeshPropertyHelper(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), Output::setWallTimeIntervalFromCommandLineParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), SolutionInvalidityReporter::SolutionInvalidityReporter(), FixedPointSolve::solve(), ActuallyExplicitEuler::solve(), FEProblemBase::solve(), EigenProblem::solve(), FEProblemBase::solveLinearSystem(), PetscOutput::solveSetup(), FixedPointSolve::solveStep(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), SubProblem::timestepSetup(), PIDTransientControl::timestepSetup(), FEProblemBase::timestepSetup(), TransientBase::TransientBase(), MooseMesh::update(), NEML2FEInterpolation::updateDofMap(), NEML2FEInterpolation::updateGradPhi(), NEML2FEInterpolation::updateInterpolations(), FEProblemBase::updateMortarMesh(), NEML2FEInterpolation::updatePhi(), Console::write(), XYQuadrilateralMeshFromBoundaryCurve::XYQuadrilateralMeshFromBoundaryCurve(), and FEProblemBase::~FEProblemBase().

◆ _array_var_component_names

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

Array variable names when the variable is an array variable.

Definition at line 288 of file MooseVariableBase.h.

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

◆ _assembly

Assembly& MooseVariableBase::_assembly
protectedinherited

◆ _blk_dim

unsigned int BlockRestrictable::_blk_dim
privateinherited

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

Definition at line 336 of file BlockRestrictable.h.

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

◆ _blk_dual_restrictable

const bool BlockRestrictable::_blk_dual_restrictable
privateinherited

Flag for allowing dual restriction.

Definition at line 315 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blk_feproblem

FEProblemBase* BlockRestrictable::_blk_feproblem
privateinherited

◆ _blk_ids

std::set<SubdomainID> BlockRestrictable::_blk_ids
privateinherited

◆ _blk_material_data

const MaterialData* BlockRestrictable::_blk_material_data
protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 232 of file BlockRestrictable.h.

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

◆ _blk_mesh

const MooseMesh* BlockRestrictable::_blk_mesh
privateinherited

◆ _blk_name

const std::string& BlockRestrictable::_blk_name
privateinherited

Name of the object.

Definition at line 333 of file BlockRestrictable.h.

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

◆ _blk_tid

THREAD_ID BlockRestrictable::_blk_tid
privateinherited

Thread id for this object.

Definition at line 330 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blocks

std::vector<SubdomainName> BlockRestrictable::_blocks
privateinherited

Vector the block names supplied by the user via the input file.

Definition at line 312 of file BlockRestrictable.h.

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

◆ _boundary_id_to_dirichlet_bc

template<typename OutputType >
std::unordered_map<BoundaryID, const FVDirichletBCBase *> MooseVariableFV< OutputType >::_boundary_id_to_dirichlet_bc
private

Map from boundary ID to Dirichlet boundary conditions.

Added to speed up Dirichlet BC lookups in getDirichletBC

Definition at line 713 of file MooseVariableFV.h.

◆ _boundary_id_to_flux_bc

template<typename OutputType >
std::unordered_map<BoundaryID, std::vector<const FVFluxBC *> > MooseVariableFV< OutputType >::_boundary_id_to_flux_bc
private

Map from boundary ID to flux boundary conditions.

Added to enable internal separator boundaries.

Definition at line 717 of file MooseVariableFV.h.

◆ _boundary_ids

const std::set<BoundaryID>& BlockRestrictable::_boundary_ids
privateinherited

Reference to the boundary_ids, defaults to an empty set if not provided.

Definition at line 327 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _cache_cell_gradients

template<typename OutputType >
const bool MooseVariableFV< OutputType >::_cache_cell_gradients
protected

Whether to cache cell gradients.

Definition at line 736 of file MooseVariableFV.h.

◆ _clearance_schedule

std::set<ExecFlagType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_clearance_schedule
privateinherited

How often to clear the material property cache.

Definition at line 520 of file MooseFunctor.h.

◆ _console

const ConsoleStream ConsoleStreamInterface::_console
inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), MaterialOutputAction::act(), MeshOnlyAction::act(), SetupDebugAction::act(), FEProblemBase::adaptMesh(), Adaptivity::adaptMesh(), PerfGraph::addToExecutionList(), SimplePredictor::apply(), SystemBase::applyScalingFactors(), MultiApp::backup(), FEProblemBase::backupMultiApps(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), DefaultSteadyStateConvergence::checkConvergence(), MeshDiagnosticsGenerator::checkElementOverlap(), MeshDiagnosticsGenerator::checkElementTypes(), MeshDiagnosticsGenerator::checkElementVolumes(), FEProblemBase::checkExceptionAndStopSolve(), SolverSystem::checkInvalidSolution(), MeshDiagnosticsGenerator::checkLocalJacobians(), MeshDiagnosticsGenerator::checkNonConformalMesh(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonConformingFaces(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkNonPlanarSides(), MeshDiagnosticsGenerator::checkPolygons(), FEProblemBase::checkProblemIntegrity(), ReferenceResidualConvergence::checkResidualConvergence(), MeshDiagnosticsGenerator::checkSidesetsOrientation(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), CoarsenSurfaceMeshAlongSidesetGenerator::coarsenAlongSidesets(), IterationAdaptiveDT::computeAdaptiveDT(), TransientBase::computeConstrainedDT(), DefaultMultiAppFixedPointConvergence::computeCustomConvergencePostprocessor(), NonlinearSystemBase::computeDamping(), FixedPointIterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInitialDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeLinearSystemTags(), LinearSystem::computeLinearSystemTags(), NonlinearSystemBase::computeScaling(), Problem::console(), TimeStepper::constrainStep(), IterationAdaptiveDT::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), Eigenvalue::execute(), SteadyBase::execute(), MFEMSteady::execute(), MessageFromInput::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), MeshGeneratorSystem::executeMeshGenerators(), SidesetAroundSubdomainUpdater::finalize(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MeshRepairGenerator::fixOverlappingNodes(), SurfaceSubdomainsDelaunayRemesher::General2DDelaunay(), CoarsenBlockGenerator::generate(), CoarsenSurfaceMeshAlongSidesetGenerator::generate(), OrientSurfaceMeshGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), MeshGenerator::generateInternal(), VariableCondensationPreconditioner::getDofToCondense(), InversePowerMethod::init(), NonlinearEigen::init(), FEProblemBase::initialAdaptMesh(), DefaultMultiAppFixedPointConvergence::initialize(), SubProblem::initialSetup(), EigenExecutionerBase::inversePowerIteration(), FEProblemBase::joinAndFinalize(), TransientBase::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::logAdd(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), SurfaceDelaunayGeneratorBase::meshNormalDeviation2D(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), MooseBase::mooseWarning(), MooseBase::mooseWarningNonPrefixed(), ReferenceResidualConvergence::nonlinearConvergenceSetup(), Console::output(), DOFMapOutput::output(), MaterialPropertyDebugOutput::output(), PerfGraphOutput::output(), ReporterDebugOutput::output(), SolutionInvalidityOutput::output(), VariableResidualNormsDebugOutput::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), WebServerControl::outputMessage(), Console::outputPostprocessors(), PseudoTimestep::outputPseudoTimestep(), Console::outputReporters(), DefaultMultiAppFixedPointConvergence::outputResidualNorm(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), BlockRestrictionDebugOutput::printBlockRestrictionGroups(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), BlockRestrictionDebugOutput::printBoundaryRestrictionGroups(), SolutionInvalidity::printDebug(), EigenExecutionerBase::printEigenvalue(), PicardSolve::printFixedPointConvergenceHistory(), SecantSolve::printFixedPointConvergenceHistory(), SteffensenSolve::printFixedPointConvergenceHistory(), FixedPointSolve::printFixedPointConvergenceReason(), PerfGraphLivePrint::printLiveMessage(), MaterialPropertyDebugOutput::printMaterialMap(), PerfGraphLivePrint::printStats(), NEML2Action::printSummary(), AutomaticMortarGeneration::projectPrimaryNodesSinglePair(), AutomaticMortarGeneration::projectSecondaryNodesSinglePair(), CoarsenBlockGenerator::recursiveCoarsen(), SolutionTimeAdaptiveDT::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), FEProblemBase::restoreSolutions(), NonlinearSystemBase::setInitialSolution(), MooseApp::setupOptions(), Checkpoint::shouldOutput(), SubProblem::showFunctorRequestors(), SubProblem::showFunctors(), FullSolveMultiApp::showStatusMessage(), FEProblemSolve::solve(), FixedPointSolve::solve(), LinearSystem::solve(), NonlinearSystem::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), ExplicitTVDRK2::solve(), ImplicitMidpoint::solve(), LStableDirk2::solve(), LStableDirk3::solve(), LStableDirk4::solve(), EigenProblem::solve(), FixedPointSolve::solveStep(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), PerfGraphLivePrint::start(), WebServerControl::startServer(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), TransientBase::takeStep(), MFEMTransient::takeStep(), TerminateChainControl::terminate(), SubProblem::timestepSetup(), FEProblemBase::updateMeshXFEM(), Convergence::verboseOutput(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _count

const unsigned int MooseVariableBase::_count
protectedinherited

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag
protectedinherited

Reference to FEProblemBase.

Definition at line 86 of file SetupInterface.h.

Referenced by TimedSubdomainModifier::computeSubdomainID(), and PseudoTimestep::execute().

◆ _current_qp_map_key

dof_id_type Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_qp_map_key
mutableprivateinherited

Current key for qp map cache.

Definition at line 529 of file MooseFunctor.h.

◆ _current_qp_map_value

std::vector<std::pair<bool, ValueType> >* Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_qp_map_value
mutableprivateinherited

Current value for qp map cache.

Definition at line 532 of file MooseFunctor.h.

◆ _current_side_qp_map_key

dof_id_type Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_side_qp_map_key
mutableprivateinherited

Current key for side-qp map cache.

Definition at line 545 of file MooseFunctor.h.

◆ _current_side_qp_map_value

std::vector<std::vector<std::pair<bool, ValueType> > >* Moose::FunctorBase< Moose::ADType< OutputType >::type >::_current_side_qp_map_value
mutableprivateinherited

Current value for side-qp map cache.

Definition at line 548 of file MooseFunctor.h.

◆ _dirichlet_map_setup

template<typename OutputType >
bool MooseVariableFV< OutputType >::_dirichlet_map_setup = false
private

Whether the boundary to Dirichlet cache map has been setup yet.

Definition at line 569 of file MooseVariableFV.h.

◆ _dof_indices

std::vector<dof_id_type> MooseVariableBase::_dof_indices
protectedinherited

◆ _dof_map

const libMesh::DofMap& MooseVariableBase::_dof_map
protectedinherited

◆ _elem_arg_to_value

std::map<ElemArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_elem_arg_to_value
mutableprivateinherited

Map from element arguments to their cached evaluations.

Definition at line 561 of file MooseFunctor.h.

◆ _elem_to_grad

template<typename OutputType >
std::unordered_map<const Elem *, VectorValue<ADReal> > MooseVariableFV< OutputType >::_elem_to_grad
mutableprotected

A cache for storing gradients on elements.

Definition at line 726 of file MooseVariableFV.h.

◆ _element_data

template<typename OutputType >
std::unique_ptr<MooseVariableDataFV<OutputType> > MooseVariableFV< OutputType >::_element_data
protected

◆ _empty_boundary_ids

const std::set<BoundaryID> BlockRestrictable::_empty_boundary_ids
privateinherited

An empty set for referencing when boundary_ids is not included.

Definition at line 324 of file BlockRestrictable.h.

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum
privateinherited

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

This is private because others should not be messing with it.

Definition at line 79 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled
protectedinherited

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

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum
protectedinherited

◆ _face_arg_to_value

std::map<FaceArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_face_arg_to_value
mutableprivateinherited

Map from face arguments to their cached evaluations.

Definition at line 564 of file MooseFunctor.h.

◆ _face_interp_method

template<typename OutputType >
Moose::FV::InterpMethod MooseVariableFV< OutputType >::_face_interp_method
protected

Decides if an average or skewed corrected average is used for the face interpolation.

Other options are not taken into account here, but at higher, kernel-based levels.

Definition at line 741 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::faceInterpolationMethod().

◆ _factory

Factory& ParallelParamObject::_factory
protectedinherited

◆ _fe_type

libMesh::FEType MooseVariableBase::_fe_type
protectedinherited

◆ _flux_map_setup

template<typename OutputType >
bool MooseVariableFV< OutputType >::_flux_map_setup = false
private

Whether the boundary to fluxBC cache map has been setup yet.

Definition at line 577 of file MooseVariableFV.h.

◆ _functor_name

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

name of the functor

Definition at line 570 of file MooseFunctor.h.

◆ _grad_phi

template<typename OutputType >
const FieldVariablePhiGradient& MooseVariableFV< OutputType >::_grad_phi
private

Definition at line 699 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::gradPhi().

◆ _grad_phi_face

template<typename OutputType >
const FieldVariablePhiGradient& MooseVariableFV< OutputType >::_grad_phi_face
private

Definition at line 701 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::gradPhiFace().

◆ _grad_phi_face_neighbor

template<typename OutputType >
const FieldVariablePhiGradient& MooseVariableFV< OutputType >::_grad_phi_face_neighbor
private

◆ _grad_phi_neighbor

template<typename OutputType >
const FieldVariablePhiGradient& MooseVariableFV< OutputType >::_grad_phi_neighbor
private

Definition at line 705 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::gradPhiNeighbor().

◆ _index

unsigned int MooseVariableBase::_index
protectedinherited

variable number within MOOSE

Definition at line 246 of file MooseVariableBase.h.

◆ _is_eigen

bool MooseVariableBase::_is_eigen
protectedinherited

Whether or not this variable operates on eigen kernels.

Definition at line 249 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen(), and MooseVariableBase::eigen().

◆ _is_lower_d

bool MooseVariableBase::_is_lower_d
protectedinherited

Whether this variable lives on lower dimensional blocks.

Definition at line 285 of file MooseVariableBase.h.

◆ _kokkos_element_ids

Moose::Kokkos::Array<ContiguousElementID> BlockRestrictable::_kokkos_element_ids
privateinherited

List of contiguous element IDs this Kokkos object is operating on.

Definition at line 345 of file BlockRestrictable.h.

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

◆ _kokkos_element_side_ids

Moose::Kokkos::Array<Moose::Kokkos::Pair<ContiguousElementID, unsigned int> > BlockRestrictable::_kokkos_element_side_ids
privateinherited

List of contiguous local element ID - side index pairs this Kokkos object is operating on.

Definition at line 354 of file BlockRestrictable.h.

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

◆ _kokkos_node_ids

Moose::Kokkos::Array<ContiguousNodeID> BlockRestrictable::_kokkos_node_ids
privateinherited

List of contiguous node IDs this Kokkos object is operating on.

Definition at line 349 of file BlockRestrictable.h.

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

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem
protectedinherited

Reference to FEProblemBase instance.

Definition at line 44 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh

MooseMesh& MooseVariableBase::_mesh
protectedinherited

◆ _moose_object

const MooseObject* BlockRestrictable::_moose_object
privateinherited

◆ _name

const std::string& MooseBase::_name
protectedinherited

The name of this class.

Definition at line 381 of file MooseBase.h.

Referenced by AddFieldSplitAction::act(), AddBCAction::act(), AddConstraintAction::act(), AddControlAction::act(), AddConvergenceAction::act(), AddCorrectorAction::act(), AddDamperAction::act(), AddDGKernelAction::act(), AddDiracKernelAction::act(), AddDistributionAction::act(), AddFunctionAction::act(), AddFunctorMaterialAction::act(), AddFVBCAction::act(), AddFVGradientMethodAction::act(), AddFVInitialConditionAction::act(), AddFVInterfaceKernelAction::act(), AddFVInterpolationMethodAction::act(), AddFVKernelAction::act(), AddHDGKernelAction::act(), AddIndicatorAction::act(), AddInitialConditionAction::act(), AddInterfaceKernelAction::act(), AddKernelAction::act(), AddLinearFVBCAction::act(), AddLinearFVKernelAction::act(), AddMarkerAction::act(), AddMaterialAction::act(), AddMeshDivisionAction::act(), AddMeshGeneratorAction::act(), AddMeshModifiersAction::act(), AddMultiAppAction::act(), AddNodalKernelAction::act(), AddOutputAction::act(), AddPositionsAction::act(), AddPostprocessorAction::act(), AddReporterAction::act(), AddSamplerAction::act(), AddScalarKernelAction::act(), AddTimesAction::act(), AddTimeStepperAction::act(), AddTransferAction::act(), AddUserObjectAction::act(), AddVectorPostprocessorAction::act(), PartitionerAction::act(), ReadExecutorParamsAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::act(), AddMFEMFESpaceAction::act(), AddMFEMFESpaceHierarchyAction::act(), AddMFEMProblemComposerAction::act(), AddMFEMSolverAction::act(), AddMFEMSubMeshAction::act(), ADPiecewiseLinearInterpolationMaterial::ADPiecewiseLinearInterpolationMaterial(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), PiecewiseLinearBase::buildInterpolation(), CombinerGenerator::CombinerGenerator(), Executor::Executor(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), MultiApp::fillPositions(), CentroidMultiApp::fillPositions(), QuadraturePointMultiApp::fillPositions(), FunctionDT::FunctionDT(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), MooseBase::MooseBase(), MooseBase::name(), ReferenceResidualConvergence::nonlinearConvergenceSetup(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), and AddVariableAction::varName().

◆ _neighbor_data

template<typename OutputType >
std::unique_ptr<MooseVariableDataFV<OutputType> > MooseVariableFV< OutputType >::_neighbor_data
protected

◆ _node_arg_to_value

std::map<NodeArg, ValueType> Moose::FunctorBase< Moose::ADType< OutputType >::type >::_node_arg_to_value
mutableprivateinherited

Map from nodal arguments to their cached evaluations.

Definition at line 567 of file MooseFunctor.h.

◆ _oi_moose_app

MooseApp& OutputInterface::_oi_moose_app
privateinherited

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

Definition at line 72 of file OutputInterface.h.

◆ _oi_output_warehouse

OutputWarehouse& OutputInterface::_oi_output_warehouse
privateinherited

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

Definition at line 75 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList().

◆ _oi_outputs

std::set<OutputName> OutputInterface::_oi_outputs
privateinherited

The set of Output object names listed in the 'outputs' parameter.

Definition at line 78 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList(), and OutputInterface::getOutputs().

◆ _parent

const ParallelParamObject& DataFileInterface::_parent
privateinherited

◆ _pars

const InputParameters& MooseBase::_pars
protectedinherited

The object's parameters.

Definition at line 384 of file MooseBase.h.

Referenced by AddAuxKernelAction::act(), AddFVICAction::act(), AddICAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MultiSystemSolveObject::MultiSystemSolveObject(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseBase::queryParam(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _phi

template<typename OutputType >
const FieldVariablePhiValue& MooseVariableFV< OutputType >::_phi
private

Shape functions.

Definition at line 698 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::phi(), and MooseVariableFV< OutputType >::phiSize().

◆ _phi_face

template<typename OutputType >
const FieldVariablePhiValue& MooseVariableFV< OutputType >::_phi_face
private

◆ _phi_face_neighbor

template<typename OutputType >
const FieldVariablePhiValue& MooseVariableFV< OutputType >::_phi_face_neighbor
private

◆ _phi_neighbor

template<typename OutputType >
const FieldVariablePhiValue& MooseVariableFV< OutputType >::_phi_neighbor
private

◆ _prev_elem

template<typename OutputType >
const Elem* MooseVariableFV< OutputType >::_prev_elem
mutableprivate

A member used to help determine when we can return cached data as opposed to computing new data.

Definition at line 709 of file MooseVariableFV.h.

◆ _qp_to_value

std::unordered_map<dof_id_type, std::vector<std::pair<bool, ValueType> > > Moose::FunctorBase< Moose::ADType< OutputType >::type >::_qp_to_value
mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values should have size corresponding to the number of quadrature points on the element. The vector elements are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 539 of file MooseFunctor.h.

◆ _scaling_factor

std::vector<Real> MooseVariableBase::_scaling_factor
protectedinherited

◆ _si_moose_base

const MooseBase& SolutionInvalidInterface::_si_moose_base
privateinherited

◆ _si_problem

const FEProblemBase* SolutionInvalidInterface::_si_problem
privateinherited

A pointer to FEProblem base.

Definition at line 114 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal().

◆ _side_qp_to_value

std::unordered_map<dof_id_type, std::vector<std::vector<std::pair<bool, ValueType> > > > Moose::FunctorBase< Moose::ADType< OutputType >::type >::_side_qp_to_value
mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values are a multi-dimensional vector (or vector of vectors) with the first index corresponding to the side and the second index corresponding to the quadrature point index. The elements returned after double indexing are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 558 of file MooseFunctor.h.

◆ _solution

template<typename OutputType >
const libMesh::NumericVector<libMesh::Number>* const& MooseVariableFV< 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 695 of file MooseVariableFV.h.

◆ _subproblem

SubProblem& MooseVariableBase::_subproblem
protectedinherited

◆ _sys

SystemBase& MooseVariableBase::_sys
protectedinherited

◆ _temp_cell_gradient

template<typename OutputType >
VectorValue<ADReal> MooseVariableFV< OutputType >::_temp_cell_gradient
mutableprotected

A member to hold the cell gradient when not caching, used to return a reference (due to expensive ADReal copy)

Definition at line 733 of file MooseVariableFV.h.

◆ _tid

THREAD_ID MooseVariableBase::_tid
protectedinherited

◆ _time_integrator

template<typename OutputType >
const TimeIntegrator* const MooseVariableField< OutputType >::_time_integrator
protectedinherited

the time integrator used for computing time derivatives

Definition at line 406 of file MooseVariableField.h.

◆ _two_term_boundary_expansion

template<typename OutputType >
bool MooseVariableFV< OutputType >::_two_term_boundary_expansion
protected

Whether to use a two term expansion for computing boundary face values.

Definition at line 729 of file MooseVariableFV.h.

Referenced by MooseVariableFV< OutputType >::getTwoTermBoundaryExpansion().

◆ _type

const std::string& MooseBase::_type
protectedinherited

◆ _use_dual

bool MooseVariableBase::_use_dual
protectedinherited

If dual mortar approach is used.

Definition at line 282 of file MooseVariableBase.h.

Referenced by MooseVariableBase::useDual().

◆ _var_kind

Moose::VarKindType MooseVariableBase::_var_kind
protectedinherited

Variable type (see MooseTypes.h)

Definition at line 252 of file MooseVariableBase.h.

Referenced by MooseVariableBase::initialSetup(), and MooseVariableBase::kind().

◆ _var_num

unsigned int MooseVariableBase::_var_num
protectedinherited

◆ _variable

const libMesh::Variable& MooseVariableBase::_variable
protectedinherited

libMesh variable object for this variable

Definition at line 258 of file MooseVariableBase.h.

◆ _vec_ids

std::vector<SubdomainID> BlockRestrictable::_vec_ids
privateinherited

Vector of block ids supplied by the user via the input file (for error reporting)

Definition at line 309 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"
staticinherited

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"
staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"
staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ name_param

const std::string MooseBase::name_param = "_object_name"
staticinherited

◆ type_param

const std::string MooseBase::type_param = "_type"
staticinherited

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"
staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

MooseObject::usingCombinedWarningSolutionWarnings
inherited

Definition at line 67 of file MooseObject.h.

◆ usingMooseVariableFieldMembers

template<typename OutputType >
MooseVariableFV< OutputType >::usingMooseVariableFieldMembers
protected

Definition at line 683 of file MooseVariableFV.h.


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