https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
AnalysisStepPeriod Class Reference

A basic control for disabling objects for a portion of the simulation based on the analysis step concept. More...

#include <AnalysisStepPeriod.h>

Inheritance diagram for AnalysisStepPeriod:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 AnalysisStepPeriod (const InputParameters &parameters)
 
virtual void execute () override
 
std::vector< std::string > & getDependencies ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
PerfGraph & perfGraph ()
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 Class constructor. More...
 
static MultiMooseEnum getExecuteOptions ()
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

void initialSetup () override
 If enabled, this injects the start/end times into the TimeStepper sync times. More...
 
virtual bool conditionMet (const unsigned int &i) override
 
void setupTimes ()
 
bool hasControllableParameterByName (const std::string &name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
ControllableParameter getControllableParameter (const std::string &param_name)
 
ControllableParameter getControllableParameter (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectParameterName &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectParameterName &param_name)
 
T getControllableValue (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValue (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)
 
void setControllableValue (const std::string &name, const T &value)
 
void setControllableValue (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectParameterName &name, const T &value)
 
void setControllableValueByName (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectParameterName &name, const T &value)
 
virtual void getAnalysisStepUserObject (const FEProblemBase &fe_problem, const AnalysisStepUserObject *&step_user_object, const std::string &name)
 

Protected Attributes

const AnalysisStepUserObject * _step_user_object
 
std::vector< Real > _start_time
 
std::vector< Real > _end_time
 
const std::vector< std::string > & _enable
 
const std::vector< std::string > & _disable
 
const bool & _reverse_on_false
 
FEProblemBase & _fe_problem
 
std::vector< std::string > _depends_on
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
const Parallel::Communicator & _communicator
 

Detailed Description

A basic control for disabling objects for a portion of the simulation based on the analysis step concept.

Definition at line 22 of file AnalysisStepPeriod.h.

Constructor & Destructor Documentation

◆ AnalysisStepPeriod()

AnalysisStepPeriod::AnalysisStepPeriod ( const InputParameters &  parameters)

Definition at line 35 of file AnalysisStepPeriod.C.

36  : TimePeriodBase(parameters)
37 {
38 }
TimePeriodBase::TimePeriodBase
TimePeriodBase(const InputParameters &parameters)
TimePeriodBase::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ conditionMet()

bool AnalysisStepPeriod::conditionMet ( const unsigned int &  i)
overrideprotectedvirtual

Implements TimePeriodBase.

Definition at line 71 of file AnalysisStepPeriod.C.

72 {
73  return MooseUtils::absoluteFuzzyGreaterEqual(_t, _start_time[0]) &&
74  MooseUtils::absoluteFuzzyLessThan(_t, _end_time[0]);
75 }
MooseUtils::absoluteFuzzyLessThan
bool absoluteFuzzyLessThan(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
TimePeriodBase::_start_time
std::vector< Real > _start_time
MooseUtils::absoluteFuzzyGreaterEqual
bool absoluteFuzzyGreaterEqual(const T &var1, const T2 &var2, const T3 &tol=libMesh::TOLERANCE *libMesh::TOLERANCE)
TimePeriodBase::_end_time
std::vector< Real > _end_time

◆ getAnalysisStepUserObject()

void AnalysisStepUOInterface::getAnalysisStepUserObject ( const FEProblemBase &  fe_problem,
const AnalysisStepUserObject *&  step_user_object,
const std::string &  name 
)
protectedvirtualinherited

Definition at line 15 of file AnalysisStepUOInterface.C.

Referenced by AbaqusUExternalDB::initialSetup(), AbaqusUMATStress::initialSetup(), and initialSetup().

18 {
19  std::vector<const UserObject *> uos;
20  fe_problem.theWarehouse().query().condition<AttribSystem>("UserObject").queryIntoUnsorted(uos);
21 
22  std::vector<const AnalysisStepUserObject *> step_uos;
23  for (const auto & uo : uos)
24  {
25  const AnalysisStepUserObject * possible_step_uo =
26  dynamic_cast<const AnalysisStepUserObject *>(uo);
27  if (possible_step_uo)
28  step_uos.push_back(possible_step_uo);
29  }
30 
31  if (step_uos.size() > 1)
32  mooseError("Your input file has multiple AnalysisStepUserObjects. MOOSE currently only support "
33  "one in ",
34  name,
35  ". \n");
36  else if (step_uos.size() == 1)
37  mooseInfo("A AnalysisStepUserObject, has been identified and will be used to drive stepping "
38  "behavior in ",
39  name,
40  ".");
41 
42  step_user_object = step_uos.size() == 1 ? step_uos[0] : nullptr;
43 }
mooseError
void mooseError(Args &&... args)
mooseInfo
void mooseInfo(Args &&... args)
FEProblemBase::theWarehouse
TheWarehouse & theWarehouse() const
name
const std::string name
Definition: Setup.h:20
TheWarehouse::query
Query query()
AnalysisStepUserObject
User object that provides analysis steps given user input.
Definition: AnalysisStepUserObject.h:17

◆ initialSetup()

void AnalysisStepPeriod::initialSetup ( )
overrideprotectedvirtual

If enabled, this injects the start/end times into the TimeStepper sync times.

Reimplemented from TimePeriodBase.

Definition at line 41 of file AnalysisStepPeriod.C.

42 {
43  // Let's automatically detect uos and identify the one we are interested in.
44  // If there is more than one, we assume something is off and error out.
45  if (!isParamSetByUser("step_user_object"))
46  getAnalysisStepUserObject(_fe_problem, _step_user_object, name());
47  else
48  _step_user_object = &getUserObject<AnalysisStepUserObject>("analysis_step_user_object");
49 
50  _start_time.resize(1);
51  _end_time.resize(1);
52 
53  // Set start time
54  _start_time[0] = _step_user_object->getStartTime(getParam<unsigned int>("step_number"));
55 
56  // Set end time
57  _end_time[0] = _step_user_object->getEndTime(getParam<unsigned int>("step_number"));
58 
59  // Call base method to populate control times.
60  TimePeriodBase::setupTimes();
61 
62  if (getParam<bool>("set_sync_times"))
63  {
64  std::set<Real> & sync_times = _app.getOutputWarehouse().getSyncTimes();
65  sync_times.insert(_start_time.begin(), _start_time.end());
66  sync_times.insert(_end_time.begin(), _end_time.end());
67  }
68 }
AnalysisStepUserObject::getEndTime
Real getEndTime(const unsigned int &step) const
Definition: AnalysisStepUserObject.C:158
TimePeriodBase::name
virtual const std::string & name() const
AnalysisStepUserObject::getStartTime
Real getStartTime(const unsigned int &step) const
Definition: AnalysisStepUserObject.C:149
TimePeriodBase::_fe_problem
FEProblemBase & _fe_problem
AnalysisStepUOInterface::getAnalysisStepUserObject
virtual void getAnalysisStepUserObject(const FEProblemBase &fe_problem, const AnalysisStepUserObject *&step_user_object, const std::string &name)
Definition: AnalysisStepUOInterface.C:15
TimePeriodBase::_start_time
std::vector< Real > _start_time
TimePeriodBase::isParamSetByUser
bool isParamSetByUser(const std::string &nm) const
TimePeriodBase::_app
MooseApp & _app
AnalysisStepPeriod::_step_user_object
const AnalysisStepUserObject * _step_user_object
Definition: AnalysisStepPeriod.h:41
OutputWarehouse::getSyncTimes
std::set< Real > & getSyncTimes()
MooseApp::getOutputWarehouse
OutputWarehouse & getOutputWarehouse()
TimePeriodBase::_end_time
std::vector< Real > _end_time

◆ validParams()

InputParameters AnalysisStepPeriod::validParams ( )
static

Class constructor.

Parameters
parametersInput parameters for this Control object

Definition at line 20 of file AnalysisStepPeriod.C.

21 {
22  InputParameters params = TimePeriodBase::validParams();
23  params.addClassDescription(
24  "Control the enabled/disabled state of objects with user-provided analysis steps.");
25  params.addParam<bool>(
26  "set_sync_times", true, "Set the start and end time as execute sync times.");
27  params.addParam<UserObjectName>(
28  "analysis_step_user_object",
29  "The AnalysisStepUserObject that provides times from analysis steps.");
30  params.addRequiredParam<unsigned int>("step_number",
31  "Step number on which this control object applies.");
32  return params;
33 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
TimePeriodBase::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _step_user_object

const AnalysisStepUserObject* AnalysisStepPeriod::_step_user_object
protected

Definition at line 41 of file AnalysisStepPeriod.h.

Referenced by initialSetup().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:45:03 for https://mooseframework.inl.gov by   doxygen 1.8.14