This is a wrapper that forwards calls to the implementation, which can be switched out at any time without disturbing references to FunctorBase. More...
#include <MooseFunctor.h>
Public Types | |
| using | FunctorType = FunctorBase< T > |
| using | ValueType = T |
| using | GradientType = typename FunctorReturnType< T, 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 | |
| FunctorEnvelope (const FunctorBase< T > &wrapped) | |
| FunctorEnvelope (std::unique_ptr< FunctorBase< T > > &&wrapped) | |
| FunctorEnvelope (FunctorBase< T > &&)=delete | |
| Prevent wrapping of a temporary object. | |
| void | assign (const FunctorBase< T > &wrapped) |
| void | assign (std::unique_ptr< FunctorBase< T > > &&wrapped) |
| void | assign (FunctorBase< T > &&)=delete |
| Prevent wrapping of a temporary object. | |
| FunctorEnvelope (const FunctorEnvelope &)=delete | |
| FunctorEnvelope (FunctorEnvelope &&)=delete | |
| FunctorEnvelope & | operator= (const FunctorEnvelope &)=delete |
| FunctorEnvelope & | operator= (FunctorEnvelope &&)=delete |
| virtual | ~FunctorEnvelope ()=default |
| virtual bool | wrapsNull () const override |
| virtual std::string | returnType () const override |
| virtual bool | ownsWrappedFunctor () const override |
| template<typename T2 > | |
| bool | wrapsType () const |
| virtual bool | isExtrapolatedBoundaryFace (const FaceInfo &fi, const Elem *const elem, const StateArg &state) const override |
| Returns whether this (sided) face is an extrapolated boundary face for this functor. | |
| virtual bool | isConstant () const override |
| Returns true if this functor is a constant. | |
| virtual bool | hasBlocks (const SubdomainID id) const override |
| Returns whether the functor is defined on this block. | |
| virtual bool | hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override |
| bool | supportsFaceArg () const override final |
| Whether this functor supports evaluation with FaceArg. | |
| bool | supportsElemSideQpArg () const override final |
| Whether this functor supports evaluation with ElemSideQpArg. | |
| template<FunctorEvaluationKind FET, typename Space , typename State > | |
| FunctorReturnType< T, 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. | |
| virtual void | residualSetup () override |
| virtual void | jacobianSetup () override |
| virtual void | timestepSetup () override |
| virtual void | customSetup (const ExecFlagType &exec_type) override |
| void | setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule) |
| Set how often to clear the functor evaluation cache. | |
| bool | isInternalFace (const FaceInfo &) const |
| Returns true if the face is an internal face. | |
| 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 |
| ValueType | operator() (const PointArg &point, 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 |
| GradientType | gradient (const PointArg &point, 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 |
| DotType | dot (const PointArg &point, 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 |
| GradientType | gradDot (const PointArg &point, const StateArg &state) const |
Protected Member Functions | |
| virtual ValueType | evaluate (const ElemArg &elem, const StateArg &state) const override |
| Forward calls to wrapped object. | |
| virtual ValueType | evaluate (const FaceArg &face, const StateArg &state) const override |
| virtual ValueType | evaluate (const ElemQpArg &qp, const StateArg &state) const override |
| virtual ValueType | evaluate (const ElemSideQpArg &qp, const StateArg &state) const override |
| virtual ValueType | evaluate (const ElemPointArg &elem_point, const StateArg &state) const override |
| Evaluate the functor with a given element and point. | |
| virtual ValueType | evaluate (const NodeArg &node, const StateArg &state) const override |
| virtual ValueType | evaluate (const PointArg &point, const StateArg &state) const override |
| Evaluate the functor at a physical point without any mesh information. | |
| virtual GradientType | evaluateGradient (const ElemArg &elem, const StateArg &state) const override |
| Evaluate the functor gradient with a given element. | |
| virtual GradientType | evaluateGradient (const FaceArg &face, const StateArg &state) const override |
| virtual GradientType | evaluateGradient (const ElemQpArg &qp, const StateArg &state) const override |
| virtual GradientType | evaluateGradient (const ElemSideQpArg &qp, const StateArg &state) const override |
| virtual GradientType | evaluateGradient (const ElemPointArg &elem_point, const StateArg &state) const override |
| Evaluate the functor gradient with a given element and point. | |
| virtual GradientType | evaluateGradient (const NodeArg &node, const StateArg &state) const override |
| virtual GradientType | evaluateGradient (const PointArg &point, const StateArg &state) const override |
| virtual DotType | evaluateDot (const ElemArg &elem, const StateArg &state) const override |
| Evaluate the functor time derivative with a given element. | |
| virtual DotType | evaluateDot (const FaceArg &face, const StateArg &state) const override |
| virtual DotType | evaluateDot (const ElemQpArg &qp, const StateArg &state) const override |
| virtual DotType | evaluateDot (const ElemSideQpArg &qp, const StateArg &state) const override |
| virtual DotType | evaluateDot (const ElemPointArg &elem_point, const StateArg &state) const override |
| Evaluate the functor time derivative with a given element and point. | |
| virtual DotType | evaluateDot (const NodeArg &node, const StateArg &state) const override |
| virtual DotType | evaluateDot (const PointArg &point, const StateArg &state) const override |
| virtual GradientType | evaluateGradDot (const ElemArg &elem, const StateArg &state) const override |
| Evaluate the functor gradient-dot with a given element. | |
| virtual GradientType | evaluateGradDot (const FaceArg &face, const StateArg &state) const override |
| virtual GradientType | evaluateGradDot (const ElemQpArg &qp, const StateArg &state) const override |
| virtual GradientType | evaluateGradDot (const ElemSideQpArg &qp, const StateArg &state) const override |
| virtual GradientType | evaluateGradDot (const ElemPointArg &elem_point, const StateArg &state) const override |
| Evaluate the functor gradient-dot with a given element and point. | |
| virtual GradientType | evaluateGradDot (const NodeArg &node, const StateArg &state) const override |
| virtual GradientType | evaluateGradDot (const PointArg &point, const StateArg &state) const override |
Private Member Functions | |
| void | clearCacheData () |
| clear cache data | |
| template<typename SpaceArg , typename StateArg > | |
| ValueType | queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, T > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const |
| check a qp cache and if invalid then evaluate | |
| template<typename SpaceArg > | |
| ValueType | queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const |
| check a finite volume spatial argument cache and if invalid then evaluate | |
Private Attributes | |
| std::unique_ptr< FunctorBase< T > > | _owned |
| Our wrapped object. | |
| const FunctorBase< T > * | _wrapped |
| 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 = libMesh::DofObject::invalid_id |
| Current key for qp map cache. | |
| std::vector< std::pair< bool, ValueType > > * | _current_qp_map_value = nullptr |
| 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 = libMesh::DofObject::invalid_id |
| 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 | |
| class | ::SubProblem |
This is a wrapper that forwards calls to the implementation, which can be switched out at any time without disturbing references to FunctorBase.
Implementation motivated by https://stackoverflow.com/a/65455485/4493669
Definition at line 1102 of file MooseFunctor.h.
|
inherited |
Definition at line 150 of file MooseFunctor.h.
|
inherited |
Definition at line 140 of file MooseFunctor.h.
|
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.
|
inherited |
Definition at line 141 of file MooseFunctor.h.
|
inline |
| wrapped | The functor to wrap. We will not not own the wrapped object |
Definition at line 1112 of file MooseFunctor.h.
|
inline |
| wrapped | A unique pointer around the functor to wrap. We will own the wrapped object, e.g. if we are ever destructed or we are reassigned to wrap another functor, then this functor will be destructed |
Definition at line 1122 of file MooseFunctor.h.
|
delete |
Prevent wrapping of a temporary object.
If we are to own a functor, the unique_ptr constructor overload should be used
|
delete |
|
delete |
|
virtualdefault |
|
inline |
| wrapped | The functor to wrap. We will not not own the wrapped object. If we previously owned a functor, it will be destructed |
Definition at line 1140 of file MooseFunctor.h.
|
delete |
Prevent wrapping of a temporary object.
If we are to own a functor, the unique_ptr assign overload should be used
|
inline |
| wrapped | A unique pointer around the functor to wrap. We will own the wrapped object. If we previously owned a functor, it will be destructed |
Definition at line 1150 of file MooseFunctor.h.
|
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
| face | The face argument created by the face argument producer, likely a residual object |
Definition at line 773 of file MooseFunctor.h.
|
privateinherited |
clear cache data
Definition at line 830 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function.
Definition at line 880 of file MooseFunctor.h.
Referenced by Function::customSetup().
|
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 938 of file MooseFunctor.h.
Referenced by FVFunctorTimeKernel::computeQpResidual(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), and Moose::ADWrapperFunctor< T >::evaluateDot().
|
inherited |
Definition at line 967 of file MooseFunctor.h.
|
inherited |
Definition at line 953 of file MooseFunctor.h.
|
inherited |
Definition at line 960 of file MooseFunctor.h.
|
inherited |
Definition at line 945 of file MooseFunctor.h.
|
inherited |
Definition at line 974 of file MooseFunctor.h.
|
inherited |
Definition at line 981 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Forward calls to wrapped object.
Implements Moose::FunctorBase< T >.
Definition at line 1211 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
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< T >.
Definition at line 1227 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Implements Moose::FunctorBase< T >.
Definition at line 1219 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
| side_qp | See the ElemSideQpArg doxygen |
| state | See the StateArg doxygen |
Implements Moose::FunctorBase< T >.
Definition at line 1223 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Implements Moose::FunctorBase< T >.
Definition at line 1215 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Implements Moose::FunctorBase< T >.
Definition at line 1231 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Evaluate the functor at a physical point without any mesh information.
Functors that need mesh information, e.g. field variables, do not support this
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1235 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
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< T >.
Definition at line 1272 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Evaluate the functor time derivative with a given element and point.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1288 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1280 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
| side_qp | See the ElemSideQpArg doxygen |
| state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1284 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1276 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1293 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1297 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Evaluate the functor gradient-dot with a given element.
Some example implementations of this method could compute an element-average or evaluate at the element centroid
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1302 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Evaluate the functor gradient-dot with a given element and point.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1319 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1310 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
| side_qp | See the ElemSideQpArg doxygen |
| state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1314 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1306 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1324 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1328 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
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< T >.
Definition at line 1240 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Evaluate the functor gradient with a given element and point.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1257 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1248 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
| side_qp | See the ElemSideQpArg doxygen |
| state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1252 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1244 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1262 of file MooseFunctor.h.
|
inlineoverrideprotectedvirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1266 of file MooseFunctor.h.
|
inlineinherited |
Return the functor name.
Definition at line 176 of file MooseFunctor.h.
Referenced by Moose::FunctorBase< T >::evaluate(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradDot(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), Moose::FunctorBase< T >::evaluateGradient(), and Moose::FunctorBase< T >::hasBlocks().
|
inherited |
Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.
Definition at line 1049 of file MooseFunctor.h.
|
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 988 of file MooseFunctor.h.
Referenced by Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::VectorComponentFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::VectorComponentFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), and Moose::ADWrapperFunctor< T >::evaluateGradDot().
|
inherited |
Definition at line 1017 of file MooseFunctor.h.
|
inherited |
Definition at line 1003 of file MooseFunctor.h.
|
inherited |
Definition at line 1010 of file MooseFunctor.h.
|
inherited |
Definition at line 995 of file MooseFunctor.h.
|
inherited |
Definition at line 1024 of file MooseFunctor.h.
|
inherited |
Definition at line 1031 of file MooseFunctor.h.
|
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 888 of file MooseFunctor.h.
Referenced by FVAdvectedInterpolationMethod::advectedInterpolate(), GradientJumpIndicator::computeQpIntegral(), Moose::FV::containerInterpolate(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::VectorComponentFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::VectorComponentFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), and Moose::FV::greenGaussGradient().
|
inherited |
Definition at line 917 of file MooseFunctor.h.
|
inherited |
Definition at line 903 of file MooseFunctor.h.
|
inherited |
Definition at line 910 of file MooseFunctor.h.
|
inherited |
Definition at line 895 of file MooseFunctor.h.
|
inherited |
Definition at line 924 of file MooseFunctor.h.
|
inherited |
Definition at line 931 of file MooseFunctor.h.
|
inlineoverridevirtual |
Returns whether the functor is defined on this block.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1197 of file MooseFunctor.h.
|
inlineoverridevirtual |
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1198 of file MooseFunctor.h.
|
inlineoverridevirtual |
Returns true if this functor is a constant.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1196 of file MooseFunctor.h.
|
inlineoverridevirtual |
Returns whether this (sided) face is an extrapolated boundary face for this functor.
Reimplemented from Moose::FunctorBase< T >.
Definition at line 1190 of file MooseFunctor.h.
|
inherited |
Returns true if the face is an internal face.
Definition at line 603 of file MooseFunctor.h.
Referenced by FVAnisotropicDiffusion::computeQpResidual(), and FVDiffusion::computeQpResidual().
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< Real >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< T >, and Function.
Definition at line 872 of file MooseFunctor.h.
Referenced by Function::jacobianSetup().
|
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 631 of file MooseFunctor.h.
|
inherited |
Definition at line 741 of file MooseFunctor.h.
|
inherited |
Definition at line 690 of file MooseFunctor.h.
|
inherited |
Definition at line 711 of file MooseFunctor.h.
|
inherited |
Definition at line 644 of file MooseFunctor.h.
|
inherited |
Definition at line 758 of file MooseFunctor.h.
|
inherited |
Definition at line 766 of file MooseFunctor.h.
|
delete |
|
delete |
|
inlineoverridevirtual |
SubProblem itself. With this expectation, we don't have to worry about performing setup calls Implements Moose::FunctorEnvelopeBase.
Definition at line 1179 of file MooseFunctor.h.
|
privateinherited |
check a finite volume spatial argument cache and if invalid then evaluate
Definition at line 614 of file MooseFunctor.h.
|
privateinherited |
check a qp cache and if invalid then evaluate
Definition at line 660 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< Real >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< T >, and Function.
Definition at line 864 of file MooseFunctor.h.
Referenced by Function::residualSetup().
|
inlineoverridevirtual |
Implements Moose::FunctorEnvelopeBase.
Definition at line 1177 of file MooseFunctor.h.
|
inherited |
Set how often to clear the functor evaluation cache.
Definition at line 748 of file MooseFunctor.h.
|
inlinefinaloverridevirtual |
Whether this functor supports evaluation with ElemSideQpArg.
Implements Moose::FunctorBase< T >.
Definition at line 1204 of file MooseFunctor.h.
|
inlinefinaloverridevirtual |
Whether this functor supports evaluation with FaceArg.
Implements Moose::FunctorBase< T >.
Definition at line 1203 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function, MemoryUsage, NumNonlinearIterations, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< T >.
Definition at line 856 of file MooseFunctor.h.
Referenced by Function::timestepSetup().
|
inlineoverridevirtual |
Implements Moose::FunctorEnvelopeBase.
Definition at line 1172 of file MooseFunctor.h.
|
inline |
Definition at line 1185 of file MooseFunctor.h.
|
friend |
Definition at line 1340 of file MooseFunctor.h.
|
privateinherited |
Boolean to check if we always need evaluation.
Definition at line 551 of file MooseFunctor.h.
|
privateinherited |
How often to clear the material property cache.
Definition at line 548 of file MooseFunctor.h.
|
mutableprivateinherited |
Current key for qp map cache.
Definition at line 557 of file MooseFunctor.h.
|
mutableprivateinherited |
Current value for qp map cache.
Definition at line 560 of file MooseFunctor.h.
|
mutableprivateinherited |
Current key for side-qp map cache.
Definition at line 573 of file MooseFunctor.h.
|
mutableprivateinherited |
Current value for side-qp map cache.
Definition at line 576 of file MooseFunctor.h.
|
mutableprivateinherited |
Map from element arguments to their cached evaluations.
Definition at line 589 of file MooseFunctor.h.
|
mutableprivateinherited |
Map from face arguments to their cached evaluations.
Definition at line 592 of file MooseFunctor.h.
|
privateinherited |
name of the functor
Definition at line 598 of file MooseFunctor.h.
Referenced by Moose::FunctorBase< T >::functorName().
|
mutableprivateinherited |
Map from nodal arguments to their cached evaluations.
Definition at line 595 of file MooseFunctor.h.
|
private |
Our wrapped object.
Definition at line 1337 of file MooseFunctor.h.
Referenced by Moose::FunctorEnvelope< T >::assign(), Moose::FunctorEnvelope< T >::assign(), and Moose::FunctorEnvelope< T >::ownsWrappedFunctor().
|
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 567 of file MooseFunctor.h.
|
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 586 of file MooseFunctor.h.
|
private |
Definition at line 1338 of file MooseFunctor.h.
Referenced by Moose::FunctorEnvelope< T >::assign(), Moose::FunctorEnvelope< T >::assign(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluate(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradDot(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::evaluateGradient(), Moose::FunctorEnvelope< T >::hasBlocks(), Moose::FunctorEnvelope< T >::hasFaceSide(), Moose::FunctorEnvelope< T >::isConstant(), Moose::FunctorEnvelope< T >::isExtrapolatedBoundaryFace(), and Moose::FunctorEnvelope< T >::wrapsType().