Base class for all Postprocessors. More...
#include <Postprocessor.h>
Public Types | |
using | FunctorType = FunctorBase< Real > |
using | ValueType = Real |
using | GradientType = typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type |
This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array). More... | |
using | DotType = ValueType |
Public Member Functions | |
Postprocessor (const MooseObject *moose_object) | |
virtual PostprocessorValue | getValue () const =0 |
This will get called to actually grab the final value the postprocessor has calculated. More... | |
const PostprocessorValue & | getCurrentValue () const |
const std::string & | PPName () const |
Returns the name of the Postprocessor. More... | |
virtual bool | hasBlocks (SubdomainID) const override |
Returns whether the functor is defined on this block. More... | |
void | buildOutputHideVariableList (std::set< std::string > variable_names) |
Builds hide lists for output objects NOT listed in the 'outputs' parameter. More... | |
const std::set< OutputName > & | getOutputs () |
Get the list of output objects that this class is restricted. More... | |
FunctorReturnType< Real, FET >::type | genericEvaluate (const Space &r, const State &state) const |
Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments. More... | |
const MooseFunctorName & | functorName () const |
Return the functor name. More... | |
virtual void | 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. More... | |
virtual bool | isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const |
Returns whether this (sided) face is an extrapolated boundary face for this functor. More... | |
bool | isInternalFace (const FaceInfo &) const |
Returns true if the face is an internal face. More... | |
virtual bool | isConstant () const |
Returns true if this functor is a constant. More... | |
virtual bool | hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override |
Moose::FaceArg | checkFace (const Moose::FaceArg &face) const |
Examines the incoming face argument. More... | |
ValueType | operator() (const ElemArg &elem, const StateArg &state) const |
Same as their evaluate overloads with the same arguments but allows for caching implementation. More... | |
ValueType | operator() (const FaceArg &face, const StateArg &state) const |
ValueType | operator() (const ElemQpArg &qp, const StateArg &state) const |
ValueType | operator() (const ElemSideQpArg &qp, const StateArg &state) const |
ValueType | operator() (const ElemPointArg &elem_point, const StateArg &state) const |
ValueType | operator() (const NodeArg &node, const StateArg &state) const |
GradientType | gradient (const ElemArg &elem, const StateArg &state) const |
Same as their evaluateGradient overloads with the same arguments but allows for caching implementation. More... | |
GradientType | gradient (const FaceArg &face, const StateArg &state) const |
GradientType | gradient (const ElemQpArg &qp, const StateArg &state) const |
GradientType | gradient (const ElemSideQpArg &qp, const StateArg &state) const |
GradientType | gradient (const ElemPointArg &elem_point, const StateArg &state) const |
GradientType | gradient (const NodeArg &node, const StateArg &state) const |
DotType | dot (const ElemArg &elem, const StateArg &state) const |
Same as their evaluateDot overloads with the same arguments but allows for caching implementation. More... | |
DotType | dot (const FaceArg &face, const StateArg &state) const |
DotType | dot (const ElemQpArg &qp, const StateArg &state) const |
DotType | dot (const ElemSideQpArg &qp, const StateArg &state) const |
DotType | dot (const ElemPointArg &elem_point, const StateArg &state) const |
DotType | dot (const NodeArg &node, const StateArg &state) const |
GradientType | gradDot (const ElemArg &elem, const StateArg &state) const |
Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation. More... | |
GradientType | gradDot (const FaceArg &face, const StateArg &state) const |
GradientType | gradDot (const ElemQpArg &qp, const StateArg &state) const |
GradientType | gradDot (const ElemSideQpArg &qp, const StateArg &state) const |
GradientType | gradDot (const ElemPointArg &elem_point, const StateArg &state) const |
GradientType | gradDot (const NodeArg &node, const StateArg &state) const |
Static Public Member Functions | |
static InputParameters | validParams () |
static std::string | deduceFunctorName (const std::string &name, const InputParameters ¶ms) |
Helper to look up a functor name through the input parameter keys. More... | |
Protected Member Functions | |
std::string | deduceFunctorName (const std::string &name) const |
Small helper to look up a functor name through the input parameter keys. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name) |
Retrieves a functor from the subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, THREAD_ID tid) |
Retrieves a functor from the subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, SubProblem &subproblem) |
Retrieves a functor from the passed-in subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid) |
Retrieves a functor from the passed-in subproblem. More... | |
bool | isFunctor (const std::string &name) const |
Checks the subproblem for the given functor. More... | |
bool | isFunctor (const std::string &name, const SubProblem &subproblem) const |
Checks the passed-in subproblem for the given functor. More... | |
Moose::ElemArg | makeElemArg (const Elem *elem, bool correct_skewnewss=false) const |
Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections. More... | |
Functor evaluation routines | |
These methods are all for evaluating functors with different kinds of spatial arguments. Each of these methods also takes a state argument. For a description of the state argument, please see the | |
virtual GradientType | evaluateGradDot (const ElemArg &, const StateArg &) const |
Evaluate the functor gradient-dot with a given element. More... | |
virtual GradientType | evaluateGradDot (const FaceArg &, const StateArg &) const |
virtual GradientType | evaluateGradDot (const ElemQpArg &, const StateArg &) const |
virtual GradientType | evaluateGradDot (const ElemSideQpArg &, const StateArg &) const |
virtual GradientType | evaluateGradDot (const ElemPointArg &, const StateArg &) const |
Evaluate the functor gradient-dot with a given element and point. More... | |
virtual GradientType | evaluateGradDot (const NodeArg &, const StateArg &) const |
Protected Attributes | |
const std::string & | _pp_name |
Post-processor name. More... | |
const PostprocessorValue & | _current_value |
The current value, which is the Reporter value that changes when we execute UOs in the problem. More... | |
Private Types | |
using | ElemArg = Moose::ElemArg |
using | ElemQpArg = Moose::ElemQpArg |
using | ElemSideQpArg = Moose::ElemSideQpArg |
using | FaceArg = Moose::FaceArg |
using | ElemPointArg = Moose::ElemPointArg |
using | NodeArg = Moose::NodeArg |
Private Member Functions | |
const PostprocessorValue & | declareValue (const MooseObject &moose_object) |
Internal method to be used to declare the value and store it within _current_value in the constructor. More... | |
ValueType | evaluate (const ElemArg &elem, const Moose::StateArg &state) const override final |
Evaluate the functor with a given element. More... | |
ValueType | evaluate (const FaceArg &face, const Moose::StateArg &state) const override final |
ValueType | evaluate (const ElemQpArg &qp, const Moose::StateArg &state) const override final |
ValueType | evaluate (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final |
ValueType | evaluate (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final |
Evaluate the functor with a given element and point. More... | |
ValueType | evaluate (const NodeArg &node, const Moose::StateArg &state) const override final |
GradientType | evaluateGradient (const ElemArg &elem, const Moose::StateArg &state) const override final |
Evaluate the functor gradient with a given element. More... | |
GradientType | evaluateGradient (const FaceArg &face, const Moose::StateArg &state) const override final |
GradientType | evaluateGradient (const ElemQpArg &qp, const Moose::StateArg &state) const override final |
GradientType | evaluateGradient (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final |
GradientType | evaluateGradient (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final |
Evaluate the functor gradient with a given element and point. More... | |
GradientType | evaluateGradient (const NodeArg &node, const Moose::StateArg &state) const override final |
DotType | evaluateDot (const ElemArg &elem, const Moose::StateArg &state) const override final |
Evaluate the functor time derivative with a given element. More... | |
DotType | evaluateDot (const FaceArg &face, const Moose::StateArg &state) const override final |
DotType | evaluateDot (const ElemQpArg &qp, const Moose::StateArg &state) const override final |
DotType | evaluateDot (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final |
DotType | evaluateDot (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final |
Evaluate the functor time derivative with a given element and point. More... | |
DotType | evaluateDot (const NodeArg &node, const Moose::StateArg &state) const override final |
void | evaluateDotWarning () const |
Internal method for giving a one-time warning for calling an evaluateDot() method. More... | |
Private Attributes | |
const MooseObject & | _pp_moose_object |
MOOSE object. More... | |
Base class for all Postprocessors.
Defines a name and sets up the virtual getValue() interface which must be overridden by derived classes.
Definition at line 23 of file Postprocessor.h.
|
inherited |
Definition at line 150 of file MooseFunctor.h.
|
private |
Definition at line 79 of file Postprocessor.h.
|
private |
Definition at line 83 of file Postprocessor.h.
|
private |
Definition at line 80 of file Postprocessor.h.
|
private |
Definition at line 81 of file Postprocessor.h.
|
private |
Definition at line 82 of file Postprocessor.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.
|
private |
Definition at line 84 of file Postprocessor.h.
|
inherited |
Definition at line 141 of file MooseFunctor.h.
Postprocessor::Postprocessor | ( | const MooseObject * | moose_object | ) |
Definition at line 30 of file Postprocessor.C.
|
inherited |
Builds hide lists for output objects NOT listed in the 'outputs' parameter.
variable_names | A set of variables for which the 'outputs' parameter controls |
By default this is called by the constructor and passes the block name as the list of variables. This needs to be called explicitly if the build_list flag is set to False in the constructor. The latter cases is needed by the Material object to work correctly with the automatic material output capability.
Definition at line 61 of file OutputInterface.C.
Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface::OutputInterface().
|
inherited |
Examines the incoming face argument.
If the face argument producer (residual object, postprocessor, etc.) did not indicate a sidedness to the face, e.g. if the face_side
member of the FaceArg
is nullptr
, then we may "modify" the sidedness of the argument if we are only defined on one side of the face. If the face argument producer has indicated a sidedness and we are not defined on that side, then we will error
face | The face argument created by the face argument producer, likely a residual object |
Definition at line 713 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function.
Definition at line 822 of file MooseFunctor.h.
|
private |
Internal method to be used to declare the value and store it within _current_value in the constructor.
Definition at line 41 of file Postprocessor.C.
|
staticinherited |
Helper to look up a functor name through the input parameter keys.
name | The input parameter name that we are trying to deduce the functor name for |
params | The input parameters object that we will be checking for parameters named name |
Definition at line 28 of file FunctorInterface.C.
Referenced by FunctorInterface::deduceFunctorName(), FunctorInterface::getFunctor(), and FunctorInterface::isFunctor().
|
protectedinherited |
Small helper to look up a functor name through the input parameter keys.
Definition at line 60 of file FunctorInterface.C.
|
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 872 of file MooseFunctor.h.
|
inherited |
Definition at line 879 of file MooseFunctor.h.
|
inherited |
Definition at line 886 of file MooseFunctor.h.
|
inherited |
Definition at line 893 of file MooseFunctor.h.
|
inherited |
Definition at line 900 of file MooseFunctor.h.
|
inherited |
Definition at line 907 of file MooseFunctor.h.
|
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< Real >.
Definition at line 65 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
face | See the FaceArg doxygen |
state | See the StateArg doxygen |
Implements Moose::FunctorBase< Real >.
Definition at line 71 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
qp | See the ElemQpArg doxygen |
state | See the StateArg doxygen |
Implements Moose::FunctorBase< Real >.
Definition at line 77 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
side_qp | See the ElemSideQpArg doxygen |
state | See the StateArg doxygen |
Implements Moose::FunctorBase< Real >.
Definition at line 83 of file Postprocessor.C.
|
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< Real >.
Definition at line 90 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
Implements Moose::FunctorBase< Real >.
Definition at line 97 of file Postprocessor.C.
|
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< Real >.
Definition at line 144 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
face | See the FaceArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 151 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
qp | See the ElemQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 158 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
side_qp | See the ElemSideQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 165 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
Evaluate the functor time derivative with a given element and point.
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 173 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 181 of file Postprocessor.C.
|
private |
Internal method for giving a one-time warning for calling an evaluateDot()
method.
Definition at line 188 of file Postprocessor.C.
Referenced by evaluateDot().
|
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 Moose::FunctorEnvelope< Real >.
Definition at line 427 of file MooseFunctor.h.
|
inlineprotectedvirtualinherited |
face | See the FaceArg doxygen |
state | See the StateArg doxygen |
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 437 of file MooseFunctor.h.
|
inlineprotectedvirtualinherited |
qp | See the ElemQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 447 of file MooseFunctor.h.
|
inlineprotectedvirtualinherited |
side_qp | See the ElemSideQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 458 of file MooseFunctor.h.
|
inlineprotectedvirtualinherited |
Evaluate the functor gradient-dot with a given element and point.
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 467 of file MooseFunctor.h.
|
inlineprotectedvirtualinherited |
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 472 of file MooseFunctor.h.
|
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< Real >.
Definition at line 103 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
face | See the FaceArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 110 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
qp | See the ElemQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 116 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
side_qp | See the ElemSideQpArg doxygen |
state | See the StateArg doxygen |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 123 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
Evaluate the functor gradient with a given element and point.
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 130 of file Postprocessor.C.
|
finaloverrideprivatevirtual |
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 137 of file Postprocessor.C.
|
inlineinherited |
Return the functor name.
Definition at line 168 of file MooseFunctor.h.
|
inherited |
Perform a generic evaluation based on the supplied template argument FET
and supplied spatial and temporal arguments.
Definition at line 967 of file MooseFunctor.h.
|
inline |
Your sanity would tell you... why not just call getValue()? Well - the intention of getValue() is to be called by the problem when the UserObjects are executed, and not by other things. This enables the control of when this Postprocessor is updated, which could be very important. If the implementation of getValue() is such that it actually computes a new value (instead of one that is called in finalize()), you could potentially call getValue() and not get the value as it was at the last time this PP was executed.
What this does instead is gives you the value that was last set as this PP was executed by the problem. That is, the value that every object that uses the PostprocessorInterface will get you.
Definition at line 56 of file Postprocessor.h.
Referenced by evaluate().
|
protectedinherited |
Retrieves a functor from the subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
Definition at line 191 of file FunctorInterface.h.
Referenced by MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl().
|
protectedinherited |
Retrieves a functor from the subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
tid | The thread ID used to retrieve the functor from this interface's subproblem |
Definition at line 183 of file FunctorInterface.h.
|
protectedinherited |
Retrieves a functor from the passed-in subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
Definition at line 176 of file FunctorInterface.h.
|
protectedinherited |
Retrieves a functor from the passed-in subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
tid | The thread ID used to retrieve the functor from the subproblem |
Definition at line 167 of file FunctorInterface.h.
|
inherited |
Get the list of output objects that this class is restricted.
Definition at line 94 of file OutputInterface.C.
|
pure virtual |
This will get called to actually grab the final value the postprocessor has calculated.
Note that this should only be called by internal methods, namely the problem that actually sets the value globally for other things to use. If you want the value outside of one of these external methods, you should use getCurrentValue().
Implemented in LibtorchControlValuePostprocessor, TimeExtremeValue, RelativeSolutionDifferenceNorm, Receiver, RelativeDifferencePostprocessor, VectorPostprocessorComparison, PostprocessorComparison, ElementW1pError, NumNonlinearIterations, ScalarL2Error, NodalVariableValue, TagVectorSum, LinearCombinationPostprocessor, ElementExtremeMaterialPropertyTempl< is_ad >, FindValueOnLine, ElementalVariableValue, GreaterThanLessThanPostprocessor, MemoryUsage, ElementIntegralPostprocessor, FunctionValuePostprocessor, InternalSideIntegralPostprocessor, NumDOFs, NumMeshDivisions, PointValue, SideDiffusiveFluxAverageTempl< is_ad >, SideIntegralPostprocessor, CumulativeValuePostprocessor, ElementAverageValue, InterfaceDiffusiveFluxAverageTempl< is_ad >, InterfaceIntegralPostprocessor, NodalL2Norm, NumPositions, SideAverageValue, AverageElementSize, ChangeOverFixedPointPostprocessor, ChangeOverTimePostprocessor, DifferencePostprocessor, ElementAverageMaterialPropertyTempl< is_ad >, ElementH1SemiError, ElementVectorL2Error, NumFixedPointIterations, ParsedPostprocessor, SideAverageMaterialPropertyTempl< is_ad >, NearestNodeNumber, NodalL2Error, NodalMaxValue, NodalSum, NumFailedTimeSteps, NumNodes, NumResidualEvaluations, PercentChangePostprocessor, PseudoTimestep, Residual, TimePostprocessor, TimestepSize, ConstantPostprocessor, FunctionElementAverage, FunctionSideAverage, InterfaceAverageVariableValuePostprocessor, NodalMaxValueId, ScalarVariable, ScalePostprocessor, TimeIntegratedPostprocessor, ElementL2FunctorErrorTempl< is_ad >, ElementSidesL2Norm, NumVars, AverageNodalVariableValue, ElementL2Difference, NumElems, NumLinearIterations, NumRelationshipManagers, PerfGraphData, VariableResidual, VectorPostprocessorComponent, VectorPostprocessorReductionValue, ElementL2Error, EmptyPostprocessor, ExtremeValueBase< ElementPostprocessor >, ExtremeValueBase< ElementVariablePostprocessor >, ExtremeValueBase< NodalVariablePostprocessor >, ExtremeValueBase< SideVariablePostprocessor >, ElementArrayL2Norm, and ElementL2Norm.
|
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 914 of file MooseFunctor.h.
|
inherited |
Definition at line 921 of file MooseFunctor.h.
|
inherited |
Definition at line 928 of file MooseFunctor.h.
|
inherited |
Definition at line 935 of file MooseFunctor.h.
|
inherited |
Definition at line 942 of file MooseFunctor.h.
|
inherited |
Definition at line 949 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 830 of file MooseFunctor.h.
|
inherited |
Definition at line 837 of file MooseFunctor.h.
|
inherited |
Definition at line 844 of file MooseFunctor.h.
|
inherited |
Definition at line 851 of file MooseFunctor.h.
|
inherited |
Definition at line 858 of file MooseFunctor.h.
|
inherited |
Definition at line 865 of file MooseFunctor.h.
|
inlineoverridevirtual |
Returns whether the functor is defined on this block.
Reimplemented from Moose::FunctorBase< Real >.
Definition at line 63 of file Postprocessor.h.
|
overridevirtualinherited |
Implements FaceArgInterface.
Reimplemented in Moose::FunctorEnvelope< Real >, InternalSideIntegralVariablePostprocessor, InterfaceIntegralVariableValuePostprocessor, SideIntegralVariablePostprocessor, and SideIntegralFunctorPostprocessorTempl< is_ad >.
Definition at line 956 of file MooseFunctor.h.
|
inlinevirtualinherited |
Returns true if this functor is a constant.
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 258 of file MooseFunctor.h.
|
inlinevirtualinherited |
Returns whether this (sided) face is an extrapolated boundary face for this functor.
Reimplemented in Moose::FunctorEnvelope< Real >.
Definition at line 245 of file MooseFunctor.h.
|
protectedinherited |
Checks the subproblem for the given functor.
This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file
name | The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file |
Definition at line 113 of file FunctorInterface.C.
|
protectedinherited |
Checks the passed-in subproblem for the given functor.
This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file
name | The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
Definition at line 104 of file FunctorInterface.C.
|
inherited |
Returns true if the face is an internal face.
Definition at line 554 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function.
Definition at line 814 of file MooseFunctor.h.
|
protectedinherited |
Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.
Definition at line 120 of file FunctorInterface.C.
Referenced by FVFunctorTimeKernel::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), FunctorAux::computeValue(), and FunctorTimes::initialize().
|
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 582 of file MooseFunctor.h.
|
inherited |
Definition at line 595 of file MooseFunctor.h.
|
inherited |
Definition at line 641 of file MooseFunctor.h.
|
inherited |
Definition at line 662 of file MooseFunctor.h.
|
inherited |
Definition at line 692 of file MooseFunctor.h.
|
inherited |
Definition at line 706 of file MooseFunctor.h.
|
inline |
Returns the name of the Postprocessor.
Definition at line 61 of file Postprocessor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function.
Definition at line 806 of file MooseFunctor.h.
|
inherited |
Set how often to clear the functor evaluation cache.
Definition at line 699 of file MooseFunctor.h.
|
overridevirtualinherited |
Implements Moose::FunctorAbstract.
Reimplemented in Function, NumNonlinearIterations, and MemoryUsage.
Definition at line 798 of file MooseFunctor.h.
|
static |
Definition at line 17 of file Postprocessor.C.
Referenced by ElementPostprocessor::validParams(), InternalSidePostprocessor::validParams(), NodalPostprocessor::validParams(), SidePostprocessor::validParams(), GeneralPostprocessor::validParams(), and InterfacePostprocessor::validParams().
|
protected |
The current value, which is the Reporter value that changes when we execute UOs in the problem.
Definition at line 70 of file Postprocessor.h.
Referenced by getCurrentValue().
|
private |
|
protected |
Post-processor name.
Definition at line 67 of file Postprocessor.h.
Referenced by declareValue(), and PPName().