doxygen/moose/TimePeriodBase_8h_source.html

//* This file is part of the MOOSE framework

//* https://mooseframework.inl.gov

//*

//* All rights reserved, see COPYRIGHT for full restrictions

//* https://github.com/idaholab/moose/blob/master/COPYRIGHT

//*

//* Licensed under LGPL 2.1, please see LICENSE for details

//* https://www.gnu.org/licenses/lgpl-2.1.html


#pragma once


// MOOSE includes

#include "ConditionalEnableControl.h"


class TimePeriodBase : public ConditionalEnableControl

{

public:

  static InputParameters validParams();


  TimePeriodBase(const InputParameters & parameters);


protected:

  void setupTimes();


  virtual bool conditionMet(const unsigned int & i) = 0;


  std::vector<Real> _start_time;


  std::vector<Real> _end_time;

};


ConditionalEnableControl.h

ConditionalEnableControl
Base class for controls that enable/disable object(s) based on some condition.
Definition ConditionalEnableControl.h:18

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

MooseBase::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131

TimePeriodBase
Base class for basic control for disabling objects for a portion of the simulation.
Definition TimePeriodBase.h:19

TimePeriodBase::conditionMet
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...

TimePeriodBase::_end_time
std::vector< Real > _end_time
The time to stop enabling the supplied object tags (defaults to the end of the simulation)
Definition TimePeriodBase.h:41

TimePeriodBase::_start_time
std::vector< Real > _start_time
The time to begin enabling the supplied object tags (defaults to the simulation start time)
Definition TimePeriodBase.h:38

TimePeriodBase::validParams
static InputParameters validParams()
Class constructor.
Definition TimePeriodBase.C:17

TimePeriodBase::setupTimes
void setupTimes()
Helper base method to set start and end times for controls.
Definition TimePeriodBase.C:34