time_iterator.hpp

Go to the documentation of this file.

#pragma once
 
#include <deal.II/base/function_parser.h>
 
#include <meltpooldg/time_integration/time_stepping_data.hpp>
#include <meltpooldg/utilities/conditional_ostream.hpp>
 
namespace MeltPoolDG::TimeIntegration
{
  /*
   *  This class provides a simple time stepping routine.
   */
  template <typename number>
  class TimeIterator
  {
  public:
    TimeIterator(const TimeSteppingData<number> &data_in);
 
    bool
    is_finished() const;
 
    number
    compute_next_time_increment();
 
    void
    resize_current_time_increment(const number factor);
 
    void
    set_current_time_increment(const number value, const number factor = 1.0);
 
    void
    reset_max_n_time_steps(const unsigned int time_steps_in);
 
    number
    get_current_time() const;
 
    number
    get_current_time_increment() const;
 
    unsigned int
    get_current_time_step_number() const;
 
    number
    get_old_time_increment() const;
 
    number
    get_old_time() const;
 
    void
    reset();
 
    void
    print_me(const ConditionalOStream &pcout) const;
 
    bool
    check_time_step_limit(const number &time_step_limit);
 
    template <class Archive>
    void
    serialize(Archive &ar, const unsigned int /*version*/)
    {
      ar &old_time;
      ar &current_time;
      ar &old_time_increment;
      ar &n_time_steps;
      ar &time_step_size_function;
 
      // @note: we don't archive current_time_increment, since we want to set it during the restart.
    }
 
  private:
    TimeSteppingData<number>  time_data;
    number                    old_time;
    number                    current_time;
    number                    current_time_increment;
    number                    old_time_increment;
    unsigned int              n_time_steps;
    dealii::FunctionParser<1> time_step_size_function;
  };
 
} // namespace MeltPoolDG::TimeIntegration