TimeStepper.h

Go to the documentation of this file.

//* 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
 
#include "MooseObject.h"
#include "Restartable.h"
#include "ScalarCoupleable.h"
 
class FEProblemBase;
class TransientBase;
 
class TimeStepper : public MooseObject, public Restartable, public ScalarCoupleable
{
public:
  static InputParameters validParams();
 
  TimeStepper(const InputParameters & parameters);
  virtual ~TimeStepper();
 
  virtual void init();
 
  virtual void preExecute();
  virtual void preSolve() {}
  virtual void postSolve() {}
  virtual void postExecute() {}
  virtual void preStep() {}
  virtual void postStep() {}
 
  void computeStep();
 
  virtual bool constrainStep(Real & dt);
 
  virtual void step();
 
  virtual void acceptStep();
 
  virtual void rejectStep();
 
  unsigned int numFailures() const;
 
  virtual bool converged() const;
 
  Real getCurrentDT() { return _current_dt; }
 
  virtual void forceTimeStep(Real dt);
 
  virtual void forceNumSteps(const unsigned int num_steps);
 
 
  void addSyncTime(Real sync_time);
  void addSyncTime(const std::set<Real> & times);
 
  bool justFailedTimeStep() const { return _currently_restepping; }
 
protected:
  virtual Real computeInitialDT() = 0;
 
  virtual Real computeDT() = 0;
 
  virtual Real computeFailedDT();
 
  FEProblemBase & _fe_problem;
  TransientBase & _executioner;
 
  Real & _time;
  Real & _time_old;
  int & _t_step;
  Real & _dt;
  Real & _dt_min;
  Real & _dt_max;
  Real & _end_time;
  std::set<Real> & _sync_times;
 
  Real & _timestep_tolerance;
 
  const bool & _verbose;
 
  bool _converged;
 
  const Real _cutback_factor_at_failure;
 
  bool _reset_dt;
 
  bool _has_reset_dt;
 
  bool _currently_restepping;
 
  unsigned int _failure_count;
 
private:
  Real & _current_dt;
};