#include <SetupRecoverFileBaseAction.h>
Public Member Functions | |
SetupRecoverFileBaseAction (InputParameters params) | |
Class constructor. More... | |
virtual void | act () override |
Method to add objects to the simulation or perform other setup tasks. More... | |
void | timedAct () |
The method called externally that causes the action to act() More... | |
virtual void | addRelationshipManagers (Moose::RelationshipManagerType when_type) |
Method to add a relationship manager for the objects being added to the system. More... | |
const std::string & | name () const |
The name of the action. More... | |
const std::string & | type () const |
InputParameters & | parameters () |
const InputParameters & | parameters () const |
const std::string & | specificTaskName () const |
const std::set< std::string > & | getAllTasks () const |
template<typename T > | |
T | getCheckedPointerParam (const std::string &name, const std::string &error_string="") const |
Verifies that the requested parameter exists and is not NULL and returns it to the caller. More... | |
bool | isParamValid (const std::string &name) const |
void | appendTask (const std::string &task) |
template<typename... Args> | |
void | paramError (const std::string ¶m, Args... args) |
Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More... | |
template<typename... Args> | |
void | paramWarning (const std::string ¶m, Args... args) |
Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More... | |
template<typename... Args> | |
void | paramInfo (const std::string ¶m, Args... args) |
Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More... | |
std::string | getBaseName () const |
Deprecated name methods, use name() More... | |
std::string | getShortName () const |
DEPRECATED METHODS. More... | |
template<typename T > | |
const T & | getParam (const std::string &name) const |
Retrieve a parameter for the object. More... | |
Public Attributes | |
const ConsoleStream | _console |
An instance of helper class to write streams to the Console objects. More... | |
Protected Member Functions | |
PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level) |
Call to register a named section for timing. More... | |
Protected Attributes | |
InputParameters | _pars |
Input parameters for the action. More... | |
std::string | _registered_identifier |
std::string | _name |
The name of the action. More... | |
std::string | _action_type |
MooseApp & | _app |
The MOOSE application this is associated with. More... | |
Factory & | _factory |
The Factory associated with the MooseApp. More... | |
ActionFactory & | _action_factory |
Builds Actions. More... | |
std::string | _specific_task_name |
This member will only be populated if this Action instance is only designed to handle one task. More... | |
std::set< std::string > | _all_tasks |
A list of all the tasks that this Action will satisfy. More... | |
ActionWarehouse & | _awh |
Reference to ActionWarehouse where we store object build by actions. More... | |
const std::string & | _current_task |
The current action (even though we have seperate instances for each action) More... | |
std::shared_ptr< MooseMesh > & | _mesh |
std::shared_ptr< MooseMesh > & | _displaced_mesh |
std::shared_ptr< FEProblemBase > & | _problem |
Convenience reference to a problem this action works on. More... | |
PerfID | _act_timer |
Timers. More... | |
const InputParameters * | _pg_params |
Params. More... | |
PerfGraph & | _perf_graph |
The performance graph to add to. More... | |
std::string | _prefix |
A prefix to use for all sections. More... | |
Definition at line 25 of file SetupRecoverFileBaseAction.h.
SetupRecoverFileBaseAction::SetupRecoverFileBaseAction | ( | InputParameters | params | ) |
Class constructor.
params | Input parameters for this action |
Definition at line 27 of file SetupRecoverFileBaseAction.C.
|
overridevirtual |
Method to add objects to the simulation or perform other setup tasks.
Implements Action.
Definition at line 30 of file SetupRecoverFileBaseAction.C.
|
virtualinherited |
Method to add a relationship manager for the objects being added to the system.
Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.
when_type | The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup. |
Reimplemented in MooseADObjectAction, and MooseObjectAction.
|
inlineinherited |
Definition at line 103 of file Action.h.
|
inlineinherited |
Definition at line 79 of file Action.h.
Referenced by AddKernelAction::act().
|
inherited |
Deprecated name methods, use name()
Definition at line 100 of file Action.C.
|
inlineinherited |
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 96 of file Action.h.
|
inherited |
Retrieve a parameter for the object.
name | The name of the parameter |
Definition at line 211 of file Action.h.
Referenced by CreateDisplacedProblemAction::act(), AddPeriodicBCAction::act(), AddPeriodicBCAction::autoTranslationBoundaries(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and MooseApp::getCheckpointDirectories().
|
inherited |
DEPRECATED METHODS.
Definition at line 93 of file Action.C.
|
inlineinherited |
Definition at line 101 of file Action.h.
Referenced by CopyNodalVarsAction::act(), SetAdaptivityOptionsAction::act(), SetupMeshAction::act(), CreateDisplacedProblemAction::act(), AddAuxVariableAction::act(), AddVariableAction::act(), AddVariableAction::addVariable(), AddPeriodicBCAction::autoTranslationBoundaries(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and SetupMeshAction::setupMesh().
|
inlineinherited |
The name of the action.
Definition at line 62 of file Action.h.
Referenced by AddElementalFieldAction::act(), CopyNodalVarsAction::act(), AdaptivityAction::act(), AddMortarInterfaceAction::act(), DeprecatedBlockAction::act(), AddAuxVariableAction::act(), MaterialOutputAction::act(), AddVariableAction::act(), MooseADObjectAction::addRelationshipManagers(), MooseObjectAction::addRelationshipManagers(), CheckOutputAction::checkVariableOutput(), AddVariableAction::createInitialConditionAction(), Action::getCheckedPointerParam(), Action::getParam(), Action::isParamValid(), GlobalParamsAction::remove(), GlobalParamsAction::setDoubleIndexParam(), GlobalParamsAction::setScalarParam(), and GlobalParamsAction::setVectorParam().
|
inlineinherited |
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 112 of file Action.h.
|
inlineinherited |
Definition at line 74 of file Action.h.
Referenced by Action::getCheckedPointerParam(), GlobalParamsAction::remove(), GlobalParamsAction::setDoubleIndexParam(), GlobalParamsAction::setScalarParam(), and GlobalParamsAction::setVectorParam().
|
inlineinherited |
|
inlineinherited |
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 143 of file Action.h.
|
inlineinherited |
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 127 of file Action.h.
|
protectedinherited |
Call to register a named section for timing.
section_name | The name of the code section to be timed |
level | The importance of the timer - lower is more important (0 will always come out) |
Definition at line 50 of file PerfGraphInterface.C.
|
inlineinherited |
Definition at line 77 of file Action.h.
|
inherited |
|
inlineinherited |
Definition at line 72 of file Action.h.
Referenced by CreateProblemDefaultAction::act(), SetupDebugAction::act(), MaterialOutputAction::getParams(), and CommonOutputAction::hasConsole().
|
protectedinherited |
|
protectedinherited |
Builds Actions.
Definition at line 176 of file Action.h.
Referenced by CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), and DynamicObjectRegistrationAction::DynamicObjectRegistrationAction().
|
protectedinherited |
Definition at line 167 of file Action.h.
Referenced by Action::type().
|
protectedinherited |
A list of all the tasks that this Action will satisfy.
Note: That this is not populated at construction time. However, all tasks will be added prior to act().
Definition at line 191 of file Action.h.
Referenced by Action::appendTask(), and Action::getAllTasks().
|
protectedinherited |
The MOOSE application this is associated with.
Definition at line 170 of file Action.h.
Referenced by CheckIntegrityAction::act(), CopyNodalVarsAction::act(), CreateExecutionerAction::act(), ExecuteMeshGenerators::act(), CreateProblemDefaultAction::act(), AddMeshModifierAction::act(), AddMeshGeneratorAction::act(), CreateProblemAction::act(), MeshOnlyAction::act(), AdaptivityAction::act(), SetupMeshAction::act(), SplitMeshAction::act(), SetupMeshCompleteAction::act(), SetupTimeStepperAction::act(), SetupPredictorAction::act(), AddRelationshipManager::act(), act(), MaterialOutputAction::act(), CommonOutputAction::act(), MooseObjectAction::addRelationshipManagers(), MooseADObjectAction::addRelationshipManagers(), CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), SetupMeshCompleteAction::completeSetup(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and SetupMeshAction::setupMesh().
|
protectedinherited |
Reference to ActionWarehouse where we store object build by actions.
Definition at line 194 of file Action.h.
Referenced by CheckIntegrityAction::act(), SetupDampersAction::act(), CreateProblemDefaultAction::act(), AddRelationshipManager::act(), CheckOutputAction::checkVariableOutput(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CommonOutputAction::hasConsole(), and SetupDebugAction::SetupDebugAction().
|
inherited |
An instance of helper class to write streams to the Console objects.
Definition at line 32 of file ConsoleStreamInterface.h.
Referenced by IterationAdaptiveDT::acceptStep(), act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), FEProblemBase::FEProblemBase(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), PicardSolve::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().
|
protectedinherited |
The current action (even though we have seperate instances for each action)
Definition at line 197 of file Action.h.
Referenced by AddKernelAction::act(), AddScalarKernelAction::act(), CheckIntegrityAction::act(), CopyNodalVarsAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), SetupMeshCompleteAction::act(), MaterialDerivativeTestAction::act(), AddRelationshipManager::act(), AddOutputAction::act(), MaterialOutputAction::act(), and AddNodalNormalsAction::act().
|
protectedinherited |
Definition at line 200 of file Action.h.
Referenced by PartitionerAction::act(), SetupMeshCompleteAction::act(), SetupMeshAction::act(), AddMortarInterfaceAction::act(), and CreateDisplacedProblemAction::act().
|
protectedinherited |
The Factory associated with the MooseApp.
Definition at line 173 of file Action.h.
Referenced by CreateExecutionerAction::act(), PartitionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), CreateDisplacedProblemAction::act(), SetupPreconditionerAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), AddControlAction::act(), AddNodalNormalsAction::act(), MooseObjectAction::addRelationshipManagers(), MooseADObjectAction::addRelationshipManagers(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), and MaterialOutputAction::getParams().
|
protectedinherited |
Definition at line 199 of file Action.h.
Referenced by PartitionerAction::act(), AddMeshGeneratorAction::act(), AddMeshModifierAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupMeshAction::act(), SetupMeshCompleteAction::act(), AddMortarInterfaceAction::act(), MooseObjectAction::addRelationshipManagers(), and MooseADObjectAction::addRelationshipManagers().
|
protectedinherited |
The name of the action.
Definition at line 164 of file Action.h.
Referenced by AddADBCAction::act(), AddADKernelAction::act(), AddInitialConditionAction::act(), PartitionerAction::act(), AddDamperAction::act(), AddVectorPostprocessorAction::act(), AddKernelAction::act(), AddMultiAppAction::act(), AddInterfaceKernelAction::act(), AddDiracKernelAction::act(), AddTransferAction::act(), AddPostprocessorAction::act(), AddDGKernelAction::act(), AddIndicatorAction::act(), AddMaterialAction::act(), AddBCAction::act(), AddADMaterialAction::act(), AddMarkerAction::act(), AddUserObjectAction::act(), AddNodalKernelAction::act(), AddConstraintAction::act(), AddScalarKernelAction::act(), AddFieldSplitAction::act(), AddMeshGeneratorAction::act(), AddMeshModifierAction::act(), AddDistributionAction::act(), SetupPreconditionerAction::act(), SetupTimeIntegratorAction::act(), AddFunctionAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddPeriodicBCAction::act(), AddControlAction::act(), SetupPostprocessorDataAction::act(), Action::getBaseName(), Action::getShortName(), and Action::name().
|
protectedinherited |
Input parameters for the action.
Definition at line 158 of file Action.h.
Referenced by AddICAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), Action::getParam(), Action::isParamValid(), Action::paramError(), Action::parameters(), Action::paramInfo(), Action::paramWarning(), and SetupMeshAction::setupMesh().
|
protectedinherited |
The performance graph to add to.
Definition at line 66 of file PerfGraphInterface.h.
Referenced by PerfGraphData::getValue(), and PerfGraphInterface::registerTimedSection().
|
protectedinherited |
Params.
Definition at line 63 of file PerfGraphInterface.h.
|
protectedinherited |
A prefix to use for all sections.
Definition at line 69 of file PerfGraphInterface.h.
Referenced by PerfGraphInterface::registerTimedSection().
|
protectedinherited |
Convenience reference to a problem this action works on.
Definition at line 203 of file Action.h.
Referenced by AddADBCAction::act(), AddADMaterialAction::act(), AddTransferAction::act(), CopyNodalVarsAction::act(), AddScalarKernelAction::act(), AddUserObjectAction::act(), AddICAction::act(), AddConstraintAction::act(), AddIndicatorAction::act(), AddVectorPostprocessorAction::act(), SetAdaptivityOptionsAction::act(), AddDamperAction::act(), AddInitialConditionAction::act(), CheckIntegrityAction::act(), InitProblemAction::act(), AddInterfaceKernelAction::act(), AddDGKernelAction::act(), AddPostprocessorAction::act(), AddKernelAction::act(), CreateExecutionerAction::act(), AddMarkerAction::act(), AddADKernelAction::act(), AddBCAction::act(), AddDiracKernelAction::act(), AddMaterialAction::act(), AddMultiAppAction::act(), AddNodalKernelAction::act(), SetupDampersAction::act(), AddBoundsVectorsAction::act(), AddElementalFieldAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AddFieldSplitAction::act(), SetupDebugAction::act(), AdaptivityAction::act(), AddFunctionAction::act(), AddDistributionAction::act(), CreateDisplacedProblemAction::act(), SetupTimeIntegratorAction::act(), SetupTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupPredictorAction::act(), SetupResidualDebugAction::act(), MaterialDerivativeTestAction::act(), SetupQuadratureAction::act(), AddSamplerAction::act(), AddOutputAction::act(), AddExternalAuxVariableAction::act(), AddAuxVariableAction::act(), AddPeriodicBCAction::act(), MaterialOutputAction::act(), AddControlAction::act(), AddNodalNormalsAction::act(), SetupPostprocessorDataAction::act(), AddVariableAction::addVariable(), AddPeriodicBCAction::autoTranslationBoundaries(), CheckOutputAction::checkMaterialOutput(), MooseADObjectAction::flagDoingAD(), AddVariableAction::getSubdomainIDs(), and AddPeriodicBCAction::setPeriodicVars().
|
protectedinherited |
|
protectedinherited |
This member will only be populated if this Action instance is only designed to handle one task.
This happens when an Action is registered with several pieces of syntax in which case separate instances are built to handle the different incoming parameter values.
Definition at line 184 of file Action.h.
Referenced by Action::specificTaskName().