www.mooseframework.org
TimePeriod.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // MOOSE includes
13 #include "TimePeriodBase.h"
14 
18 class TimePeriod : public TimePeriodBase
19 {
20 public:
26 
28 
29 protected:
33  void initialSetup() override;
34 
35  virtual bool conditionMet(const unsigned int & i) override;
36 };
virtual bool conditionMet(const unsigned int &i) override
Condition that must be true for an entry of the "enable" list to be enabled and/or an entry of the "d...
Definition: TimePeriod.C:65
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
A basic control for disabling objects for a portion of the simulation.
Definition: TimePeriod.h:18
static InputParameters validParams()
Class constructor.
Definition: TimePeriod.C:19
TimePeriod(const InputParameters &parameters)
Definition: TimePeriod.C:35
const InputParameters & parameters() const
Get the parameters of the object.
void initialSetup() override
If enabled, this injects the start/end times into the TimeStepper sync times.
Definition: TimePeriod.C:54
Base class for basic control for disabling objects for a portion of the simulation.