time_int_base.h

/*  ______________________________________________________________________
 *
 *  ExaDG - High-Order Discontinuous Galerkin for the Exa-Scale
 *
 *  Copyright (C) 2021 by the ExaDG authors
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *  ______________________________________________________________________
 */
 
#ifndef INCLUDE_EXADG_TIME_INTEGRATION_TIME_INT_BASE_H_
#define INCLUDE_EXADG_TIME_INTEGRATION_TIME_INT_BASE_H_
 
// C/C++
#include <boost/archive/binary_iarchive.hpp>
#include <boost/archive/binary_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/archive/text_oarchive.hpp>
 
#include <fstream>
#include <sstream>
 
// deal.II
#include <deal.II/base/conditional_ostream.h>
#include <deal.II/base/timer.h>
 
// ExaDG
#include <exadg/time_integration/restart.h>
#include <exadg/time_integration/restart_data.h>
#include <exadg/utilities/numbers.h>
#include <exadg/utilities/timer_tree.h>
 
 
namespace ExaDG
{
class TimeIntBase
{
public:
  // Archive type used for serialization, alternatively choose text archive type.
  typedef boost::archive::binary_iarchive BoostInputArchiveType;
  typedef boost::archive::binary_oarchive BoostOutputArchiveType;
  // typedef boost::archive::text_iarchive BoostInputArchiveType;
  // typedef boost::archive::text_oarchive BoostOutputArchiveType;
 
  TimeIntBase(double const &      start_time_,
              double const &      end_time_,
              unsigned int const  max_number_of_time_steps_,
              RestartData const & restart_data_,
              MPI_Comm const &    mpi_comm_,
              bool const          is_test_);
 
  virtual ~TimeIntBase()
  {
  }
 
  /*
   * Setup of time integration scheme.
   */
  virtual void
  setup(bool const do_restart) = 0;
 
  /*
   * Returns true if the start time has been reached.
   */
  bool
  started() const;
 
  /*
   * returns true if the end of time loop has been reached or the maximum number of time steps
   */
  bool
  finished() const;
 
  /*
   * Performs the time loop from start_time to end_time by repeatingly calling
   * advance_one_timestep().
   */
  void
  timeloop();
 
  /*
   * Perform only one time step (which is used when coupling different solvers, equations, etc.).
   */
  void
  advance_one_timestep();
 
  /*
   * The main sub-routines of advance_one_timestep()
   */
  void
  advance_one_timestep_pre_solve(bool const print_header);
 
  void
  advance_one_timestep_solve();
 
  void
  advance_one_timestep_post_solve();
 
  /*
   * Reset the current time.
   */
  void
  reset_time(double const & current_time);
 
  /*
   * In case of adaptive mesh refinement, the driver requests preparing the owned vectors
   * for refinement and interpolation afterwards.
   */
  virtual void
  prepare_coarsening_and_refinement();
 
  virtual void
  interpolate_after_coarsening_and_refinement();
 
  /*
   * Get the time step size.
   */
  virtual double
  get_time_step_size() const = 0;
 
  /*
   * Set the time step size.
   */
  virtual void
  set_current_time_step_size(double const & time_step_size) = 0;
 
  /*
   * Get the current time t_{n}.
   */
  double
  get_time() const;
 
  /*
   * Get time at the end of the current time step t_{n+1}.
   */
  double
  get_next_time() const;
 
  /*
   * Get number of computed time steps
   */
  unsigned int
  get_number_of_time_steps() const;
 
  std::shared_ptr<TimerTree>
  get_timings() const;
 
protected:
  /*
   * Do one time step including pre and post routines done before and after the actual solution of
   * the current time step. Compared to the function advance_one_timestep(), do_timestep() is a raw
   * version that does not call postprocessing routines, does not write output to pcout, and does
   * not perform timer measurements within its sub-routines. The typical use case of do_timestep()
   * is when using pseudo-timestepping to obtain the solution of a steady-state problem with a
   * transient solver.
   */
  void
  do_timestep();
 
  /*
   * e.g., update of time integrator constants
   */
  virtual void
  do_timestep_pre_solve(bool const print_header) = 0;
 
  /*
   * The actual solution of the current time step
   */
  virtual void
  do_timestep_solve() = 0;
 
  /*
   * e.g., update of DoF vectors, increment time, adjust time step size, etc.
   */
  virtual void
  do_timestep_post_solve() = 0;
 
  /*
   * Postprocessing of solution.
   */
  virtual void
  postprocessing() const = 0;
 
  /*
   * Get the current time step number.
   */
  types::time_step
  get_time_step_number() const;
 
  /*
   * Write solution vectors to files so that the simulation can be restart from an intermediate
   * state. Note that the sequence of writing and reading data in `write_restart` and `read_restart`
   * needs to be identical.
   */
  void
  write_restart() const;
 
  /*
   * Read all relevant data from restart files to start the time integrator. Note that the sequence
   * of writing and reading data in `write_restart` and `read_restart` needs to be identical.
   */
  void
  read_restart();
 
  /*
   * Output solver information before solving the time step.
   */
  void
  output_solver_info_header() const;
 
 
  /*
   * Output estimated computation time until completion of the simulation.
   */
  void
  output_remaining_time() const;
 
  /*
   * Start and end times.
   */
  double start_time, end_time;
 
  /*
   * Physical time.
   */
  double time;
 
  /*
   * A small number which is much smaller than the time step size.
   */
  double const eps;
 
  /*
   * Output to screen.
   */
  dealii::ConditionalOStream pcout;
 
  /*
   * The number of the current time step starting with time_step_number = 1.
   */
  types::time_step time_step_number;
 
  /*
   * Maximum number of time steps.
   */
  unsigned int const max_number_of_time_steps;
 
  /*
   * Restart.
   */
  RestartData const restart_data;
 
  /*
   * MPI communicator.
   */
  MPI_Comm const mpi_comm;
 
  /*
   * Computation time (wall clock time).
   */
  dealii::Timer              global_timer;
  std::shared_ptr<TimerTree> timer_tree;
  bool                       is_test;
 
private:
  /*
   * Write restart data.
   */
  virtual void
  do_write_restart(std::string const & filename) const = 0;
 
  /*
   * Read restart data.
   */
  virtual void
  do_read_restart(std::ifstream & in) = 0;
};
 
} // namespace ExaDG
 
 
#endif /* INCLUDE_EXADG_TIME_INTEGRATION_TIME_INT_BASE_H_ */