CD_TimeStepper.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_TIMESTEPPER_H
#define CD_TIMESTEPPER_H
 
// Chombo includes
#include <CH_HDF5.H>
 
// Our includes
#include <CD_ComputationalGeometry.H>
#include <CD_MultiFluidIndexSpace.H>
#include <CD_AmrMesh.H>
#include <CD_NamespaceHeader.H>
 
class TimeStepper
{
public:
  TimeStepper();
 
  virtual ~TimeStepper();
 
  TimeStepper(const TimeStepper&) = delete;
 
  TimeStepper&
  operator=(const TimeStepper&) = delete;
 
  TimeStepper(TimeStepper&&) = default;
 
  TimeStepper&
  operator=(TimeStepper&&) = default;
 
  void
  setAmr(const RefCountedPtr<AmrMesh>& a_amr);
 
  void
  setComputationalGeometry(const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
  virtual void
  setupSolvers() = 0;
 
  virtual void
  allocate() = 0;
 
  virtual void
  initialData() = 0;
 
  virtual void
  postInitialize() = 0;
 
  virtual void
  postCheckpointSetup() = 0;
 
  virtual void
  registerRealms() = 0;
 
  virtual void
  registerOperators() = 0;
 
  virtual void
  parseRuntimeOptions();
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointHeader(HDF5HeaderData& a_header);
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointHeader(HDF5HeaderData& a_header) const;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointData(HDF5Handle& a_handle, int a_lvl) const = 0;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointData(HDF5Handle& a_handle, int a_lvl) = 0;
#endif
 
  virtual int
  getNumberOfPlotVariables() const = 0;
 
  virtual Vector<std::string>
  getPlotVariableNames() const = 0;
 
  virtual void
  writePlotData(LevelData<EBCellFAB>& a_output, int& a_icomp, const std::string& a_outputRealm, int a_level) const = 0;
 
  virtual void
  prePlot();
 
  virtual void
  postPlot();
 
  virtual Vector<long int>
  getCheckpointLoads(const std::string& a_realm, int a_level) const;
 
  virtual Real
  computeDt() = 0;
 
  virtual Real
  advance(Real a_dt) = 0;
 
  virtual void
  synchronizeSolverTimes(int a_step, Real a_time, Real a_dt) = 0;
 
  virtual void
  printStepReport() = 0;
 
  virtual void
  preRegrid(int a_lmin, int a_oldFinestLevel) = 0;
 
  virtual void
  regrid(int a_lmin, int a_oldFinestLevel, int a_newFinestLevel) = 0;
 
  virtual void
  postRegrid() = 0;
 
  virtual bool
  needToRegrid();
 
  bool
  keepGoing() const;
 
  virtual bool
  loadBalanceThisRealm(const std::string& a_realm) const;
 
  virtual void
  loadBalanceBoxes(Vector<Vector<int>>&             a_procs,
                   Vector<Vector<Box>>&             a_boxes,
                   const std::string&               a_realm,
                   const Vector<DisjointBoxLayout>& a_grids,
                   int                              a_lmin,
                   int                              a_finestLevel);
 
protected:
  int m_verbosity;
 
  int m_timeStep;
 
  Real m_time;
 
  Real m_dt;
 
  bool m_keepGoing;
 
  RefCountedPtr<AmrMesh> m_amr;
 
  RefCountedPtr<ComputationalGeometry> m_computationalGeometry;
};
 
#include <CD_NamespaceFooter.H>
 
#endif