www.mooseframework.org
Classes | Functions
TimePeriod.h File Reference

Go to the source code of this file.

Classes

class  TimePeriod
 A basic control for disabling objects for a portion of the simulation. More...
 

Functions

template<>
InputParameters validParams< TimePeriod > ()
 

Function Documentation

Definition at line 23 of file TimePeriod.C.

24 {
26  params.addClassDescription("Control the enabled/disabled state of objects with time.");
27  params.addParam<std::vector<std::string>>(
28  "disable_objects", std::vector<std::string>(), "A list of object tags to disable.");
29  params.addParam<std::vector<std::string>>(
30  "enable_objects", std::vector<std::string>(), "A list of object tags to enable.");
31  params.addParam<std::vector<Real>>("start_time",
32  "The time at which the objects are to be enabled/disabled.");
33  params.addParam<std::vector<Real>>("end_time",
34  "The time at which the objects are to be enable/disabled.");
35  params.addParam<bool>(
36  "set_sync_times", false, "Set the start and end time as execute sync times.");
37  params.addParam<bool>("set_outside_of_range",
38  true,
39  "When true the disable/enable lists are set "
40  "to opposite values when outside of the "
41  "given time range.");
42  return params;
43 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< Control >()
Definition: Control.C:20
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...