TimeSequenceStepperBase.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 "TimeStepper.h"
 
class TimeSequenceStepperBase : public TimeStepper
{
public:
  static InputParameters validParams();
 
  TimeSequenceStepperBase(const InputParameters & parameters);
 
  void setupSequence(const std::vector<Real> & times);
  void updateSequence(const std::vector<Real> & times);
 
  // Clear the time sequence array, usually used when the time sequence needs to be updated during
  // the simulation
  void resetSequence();
 
  // Increase the current step count by one
  void increaseCurrentStep() { _current_step++; };
 
  virtual Real getNextTimeInSequence();
 
  bool advanceToFutureTime(Real time, Real tolerance, Real & next_time);
 
  virtual void init() override {}
  virtual void acceptStep() override;
 
protected:
  virtual Real computeInitialDT() override;
  virtual Real computeDT() override;
 
  virtual void refreshSequence() {}
 
  std::vector<Real> buildSequence(const std::vector<Real> & times) const;
 
  std::vector<Real>::const_iterator findFirstFutureTime(Real time, Real tolerance) const;
 
  void synchronizeCurrentStep(Real time, Real tolerance);
 
  const bool _use_last_dt_after_last_t;
 
  unsigned int & _current_step;
 
  std::vector<Real> & _time_sequence;
 
  const bool _set_end_time;
};