www.mooseframework.org
TimePeriod.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef TIMEPERIOD_H
16 #define TIMEPERIOD_H
17 
18 // MOOSE includes
19 #include "Control.h"
20 
21 // Forward declarations
22 class TimePeriod;
23 class Function;
24 
25 template <>
27 
31 class TimePeriod : public Control
32 {
33 public:
39 
40  virtual void execute() override;
41 
42 protected:
46  void initialSetup() override;
47 
48 private:
50  const std::vector<std::string> & _enable;
51 
53  const std::vector<std::string> & _disable;
54 
56  std::vector<Real> _start_time;
57 
59  std::vector<Real> _end_time;
60 
63 };
64 
65 #endif // TIMEPERIOD_H
Base class for function objects.
Definition: Function.h:46
virtual void execute() override
Execute the control.
Definition: TimePeriod.C:94
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const std::vector< std::string > & _disable
List of objects to disable.
Definition: TimePeriod.h:53
std::vector< Real > _start_time
The time to begin enabling the supplied object tags (defaults to the simulation start time) ...
Definition: TimePeriod.h:56
A basic control for disabling objects for a portion of the simulation.
Definition: TimePeriod.h:31
TimePeriod(const InputParameters &parameters)
Class constructor.
Definition: TimePeriod.C:45
const std::vector< std::string > & _enable
List of objects to enable.
Definition: TimePeriod.h:50
Base class for Control objects.
Definition: Control.h:43
std::vector< Real > _end_time
The time to stop enabling the supplied object tags (defaults to the end of the simulation) ...
Definition: TimePeriod.h:59
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
void initialSetup() override
If enabled, this injects the start/end times into the TimeStepper sync times.
Definition: TimePeriod.C:124
InputParameters validParams< TimePeriod >()
Definition: TimePeriod.C:23
bool _set_outside_of_range
Flag for setting value outside of time range.
Definition: TimePeriod.h:62