https://mooseframework.inl.gov
TimePeriodBase.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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
14 
19 {
20 public:
26 
28 
29 protected:
33  void setupTimes();
34 
35  virtual bool conditionMet(const unsigned int & i) = 0;
36 
38  std::vector<Real> _start_time;
39 
41  std::vector<Real> _end_time;
42 };
TimePeriodBase(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Class constructor.
std::vector< Real > _start_time
The time to begin enabling the supplied object tags (defaults to the simulation start time) ...
const InputParameters & parameters() const
Get the parameters of the object.
virtual bool conditionMet(const unsigned int &i)=0
Condition that must be true for an entry of the "enable" list to be enabled and/or an entry of the "d...
Base class for controls that enable/disable object(s) based on some condition.
Base class for basic control for disabling objects for a portion of the simulation.
void setupTimes()
Helper base method to set start and end times for controls.
std::vector< Real > _end_time
The time to stop enabling the supplied object tags (defaults to the end of the simulation) ...