TimePeriod

The TimePeriod class derives from ConditionalEnableControl.

TimePeriod objects are designed to control the active state of a MOOSE object, based on whether the time value is in some range.

For example, consider a simulation that contains two Kernels "diff0" and "diff1". Initially, "diff0" is active and after time 0.49 "diff1" becomes active and "diff0" is disabled. The following code snippet demonstrates how this switching of kernels is achieved with the TimePeriod object.

[Controls]
  [./diff]
    type = TimePeriod
    enable_objects = 'Kernel::diff0'
    disable_objects = '*::diff1'
    start_time = '0'
    end_time = '0.49'
  [../]
[]
(moose/test/tests/controls/time_periods/kernels/kernels.i)

Input Parameters

  • depends_onThe Controls that this control relies upon (i.e. must execute before this one)

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:The Controls that this control relies upon (i.e. must execute before this one)

  • disable_objectsA list of object tags to disable.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of object tags to disable.

  • enable_objectsA list of object tags to enable.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of object tags to enable.

  • end_timeThe time at which the objects are to be enable/disabled.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The time at which the objects are to be enable/disabled.

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, PRE_MULTIAPP_SETUP

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • reverse_on_falseTrueWhen true, the disable/enable lists are set to opposite values when the specified condition is false.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When true, the disable/enable lists are set to opposite values when the specified condition is false.

  • set_sync_timesFalseSet the start and end time as execute sync times.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the start and end time as execute sync times.

  • start_timeThe time at which the objects are to be enabled/disabled.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The time at which the objects are to be enabled/disabled.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters