#include <SetupInterface.h>
Public Member Functions | |
SetupInterface (const MooseObject *moose_object) | |
virtual | ~SetupInterface () |
virtual void | initialSetup () |
Gets called at the beginning of the simulation before this object is asked to do its job. More... | |
virtual void | timestepSetup () |
Gets called at the beginning of the timestep before this object is asked to do its job. More... | |
virtual void | jacobianSetup () |
Gets called just before the Jacobian is computed and before this object is asked to do its job. More... | |
virtual void | residualSetup () |
Gets called just before the residual is computed and before this object is asked to do its job. More... | |
virtual void | subdomainSetup () |
Gets called when the subdomain changes (i.e. More... | |
virtual void | customSetup (const ExecFlagType &) |
Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain. More... | |
const ExecFlagEnum & | getExecuteOnEnum () const |
Return the execute on MultiMooseEnum for this object. More... | |
Static Public Member Functions | |
static InputParameters | validParams () |
Protected Attributes | |
const ExecFlagEnum & | _execute_enum |
Execute settings for this object. More... | |
const ExecFlagType & | _current_execute_flag |
Reference to FEProblemBase. More... | |
Private Attributes | |
ExecFlagEnum | _empty_execute_enum |
Empty ExecFlagEnum for the case when the "execute_on" parameter is not included. More... | |
Friends | |
class | FEProblemBase |
Definition at line 23 of file SetupInterface.h.
SetupInterface::SetupInterface | ( | const MooseObject * | moose_object | ) |
Definition at line 26 of file SetupInterface.C.
|
virtual |
Definition at line 37 of file SetupInterface.C.
|
inlinevirtual |
Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.
Reimplemented in Function.
Definition at line 61 of file SetupInterface.h.
const ExecFlagEnum & SetupInterface::getExecuteOnEnum | ( | ) | const |
Return the execute on MultiMooseEnum for this object.
Definition at line 65 of file SetupInterface.C.
Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), and GeneralReporter::shouldStore().
|
virtual |
Gets called at the beginning of the simulation before this object is asked to do its job.
Reimplemented in SolutionUserObject, AdvancedOutput, MooseVariableBase, MultiApp, MooseParsedFunction, MooseParsedGradFunction, DerivativeFunctionMaterialBaseTempl< is_ad >, Transfer, ProjectedStatefulMaterialNodalPatchRecoveryTempl< T, is_ad >, CSV, Exodus, OversampleOutput, Terminator, MultiAppGeneralFieldTransfer, Axisymmetric2D3DSolutionFunction, LibtorchControlValuePostprocessor, MultiAppTransfer, Nemesis, RadialAverage, MooseParsedVectorFunction, ImageFunction, Console, PiecewiseConstantFromCSV, NodalVariableValue, MortarNodalAuxKernelTempl< ComputeValueType >, LibtorchArtificialNeuralNetParameters, TimePeriod, MatDiffusionBase< T >, TransientMultiApp, ElementalVariableValue, GhostingUserObject, InterfaceQpUserObjectBase, MatDiffusionBase< Real >, SolutionAux, MultiAppProjectionTransfer, HistogramVectorPostprocessor, SolutionScalarAux, MultiAppDofCopyTransfer, MultiAppGeneralFieldNearestLocationTransfer, CoarsenedPiecewiseLinear, PiecewiseTabularBase, MatReaction, SideIntegralMaterialPropertyTempl< is_ad >, MultiAppVariableValueSamplePostprocessorTransfer, NodalPatchRecoveryMaterialProperty, ProjectedStatefulMaterialAuxTempl< T, is_ad >, PiecewiseLinear, FullSolveMultiApp, MultiAppFieldTransfer, MultiAppVariableValueSampleTransfer, PiecewiseLinearBase, MultiAppConservativeTransfer, MultiAppCloneReporterTransfer, MultiAppReporterTransfer, ElementSubdomainModifier, and DerivativeSumMaterialTempl< is_ad >.
Definition at line 40 of file SetupInterface.C.
Referenced by ElementalVariableValue::initialSetup(), LibtorchControlValuePostprocessor::initialSetup(), and Positions::meshChanged().
|
virtual |
Gets called just before the Jacobian is computed and before this object is asked to do its job.
Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, ADKernelTempl< T >, and EqualValueEmbeddedConstraint.
Definition at line 50 of file SetupInterface.C.
Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().
|
virtual |
Gets called just before the residual is computed and before this object is asked to do its job.
Reimplemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, NodeFaceConstraint, Positions, and Times.
Definition at line 55 of file SetupInterface.C.
Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().
|
virtual |
Gets called when the subdomain changes (i.e.
in a Jacobian or residual loop) and before this object is asked to do its job
Reimplemented in MaterialBase, Material, NodalUserObject, GeneralUserObject, Constraint, and ThreadedGeneralUserObject.
Definition at line 60 of file SetupInterface.C.
|
virtual |
Gets called at the beginning of the timestep before this object is asked to do its job.
Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< RT >, MooseVariableField< T >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, VectorMemoryUsage, EqualValueEmbeddedConstraint, MemoryUsage, and JSONOutput.
Definition at line 45 of file SetupInterface.C.
Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().
|
static |
Definition at line 15 of file SetupInterface.C.
Referenced by FunctorMaterial::validParams(), AuxScalarKernel::validParams(), Transfer::validParams(), Control::validParams(), Function::validParams(), Output::validParams(), UserObject::validParams(), Sampler::validParams(), FVInterfaceKernel::validParams(), AuxKernelTempl< Real >::validParams(), and MultiApp::validParams().
|
friend |
Definition at line 81 of file SetupInterface.h.
|
protected |
Reference to FEProblemBase.
Definition at line 78 of file SetupInterface.h.
Referenced by PseudoTimestep::execute().
|
private |
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 71 of file SetupInterface.h.
Referenced by SetupInterface().
|
protected |
Execute settings for this object.
Definition at line 75 of file SetupInterface.h.
Referenced by ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FunctorADConverterTempl< T >::FunctorADConverterTempl(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), getExecuteOnEnum(), JSONOutput::outputReporters(), XMLOutput::outputVectorPostprocessors(), ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl(), PiecewiseByBlockFunctorMaterialTempl< T >::PiecewiseByBlockFunctorMaterialTempl(), and VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl().