Line data    Source code

       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             : #include "TimeStepper.h"
      13             : 
      14             : /**
      15             :  * Solves the PDEs at a sequence of given time points.
      16             :  * Adjusts the time sequence vector according to Transient start_time and end_time.
      17             :  */
      18             : class TimeSequenceStepperBase : public TimeStepper
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   TimeSequenceStepperBase(const InputParameters & parameters);
      24             : 
      25             :   void setupSequence(const std::vector<Real> & times);
      26             :   void updateSequence(const std::vector<Real> & times);
      27             : 
      28             :   // Clear the time sequence array, usually use when time sequence need to be updated during the
      29             :   // simulation
      30             :   void resetSequence();
      31             : 
      32             :   // Increase the current step count by one
      33        1382 :   void increaseCurrentStep() { _current_step++; };
      34             : 
      35             :   // Get the time of the current step from input time sequence
      36        3209 :   virtual Real getNextTimeInSequence() { return _time_sequence[_current_step]; };
      37             : 
      38           0 :   virtual void init() override {}
      39             :   virtual void acceptStep() override;
      40             : 
      41             : protected:
      42             :   virtual Real computeInitialDT() override;
      43             :   virtual Real computeDT() override;
      44             :   virtual Real computeFailedDT() override;
      45             : 
      46             :   /// Whether to use the final dt past the last t in sequence
      47             :   const bool _use_last_dt_after_last_t;
      48             : 
      49             :   /// the step that the time stepper is currently at
      50             :   unsigned int & _current_step;
      51             : 
      52             :   /// stores the sequence of time points
      53             :   std::vector<Real> & _time_sequence;
      54             : 
      55             :   /// Whether to use the last t in sequence as Executioner end_time
      56             :   const bool _set_end_time;
      57             : };