TimeStepper.h

Go to the documentation of this file.

#ifndef CHITECH_TIMESTEPPER_H
#define CHITECH_TIMESTEPPER_H
 
#include "ChiObject.h"
 
namespace chi_physics
{
 
enum class TimeStepStatus
{
  SUCCESS = 0,
  FAILURE = 1,
  NEUTRAL = 2
};
 
/**Base class for all timestep controllers.*/
class TimeStepper : public ChiObject
{
public:
  /**Overridable method to get the timestep size.*/
  double TimeStepSize() const;
 
  /**Returns the current controller time.*/
  double Time() const;
 
  /**Returns the current time index.*/
  size_t TimeStepIndex() const;
 
  /**Returns the current controller start_time.*/
  double StartTime() const;
 
  /**Returns the current controller end_time.*/
  double EndTime() const;
 
  /**Returns the current controller max time steps.*/
  double MaxTimeSteps() const;
 
  /**If start_time <= time <= end_time, this will return true.*/
  bool IsActive() const;
 
 
  /**Manually set the time step size.*/
  void SetTimeStepSize(double dt);
 
  /**Manually set the current time.*/
  void SetTime(double time);
 
  /**Manually set the start_time.*/
  void SetStartTime(double time);
 
  /**Manually set the end_time.*/
  void SetEndTime(double time);
 
  /**Manually set the maximum number of time steps. A negative number disables
* this check.*/
  void SetMaxTimeSteps(int n);
 
  /**Manually sets the minimum time step size.*/
  void SetMinimumTimeStepSize(double dt_min);
 
  /**Advances the controller's state. The most basic action here is to
  * advance time and the time index.*/
  virtual void Advance();
 
  /**Adapts according to the timestep status. If it could provide a change
  * it returns true, otherwise false.*/
  virtual bool Adapt(TimeStepStatus time_step_status) {return false;}
 
  /**Builds a formatted string of the time information.*/
  std::string StringTimeInfo(bool old_time=false) const;
 
protected:
  static chi::InputParameters GetInputParameters();
  explicit TimeStepper(const chi::InputParameters& params);
 
  double dt_;
  double time_;
  size_t t_index_;
 
  double start_time_;
  double end_time_;
  int max_time_steps_;
  double dt_min_;
 
  const double general_tolerance_;
  /**Last dt before finishing.*/
  double last_dt_;
};
 
}
 
#endif // CHITECH_TIMESTEPPER_H