CD_MeshODEStepper.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_MESHODESTEPPER_H
#define CD_MESHODESTEPPER_H
 
// Std includes
#include <array>
 
// Our includes
#include <CD_TimeStepper.H>
#include <CD_MeshODESolver.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace MeshODE {
 
    enum class IntegrationAlgorithm
    {
      Euler, 
      RK2,   
      RK4    
    };
 
    template <size_t N>
    class MeshODEStepper : public TimeStepper
    {
    public:
      MeshODEStepper();
 
      MeshODEStepper(const MeshODEStepper<N>&) = delete;
 
      MeshODEStepper(const MeshODEStepper<N>&&) = delete;
 
      virtual ~MeshODEStepper();
 
      MeshODEStepper&
      operator=(const MeshODEStepper<N>&) = delete;
 
      MeshODEStepper&
      operator=(const MeshODEStepper<N>&&) = delete;
 
      void
      setupSolvers() override;
 
      void
      allocate() override;
 
      void
      initialData() override;
 
      void
      postInitialize() override;
 
      void
      postCheckpointSetup() override;
 
      void
      registerRealms() override;
 
      void
      registerOperators() override;
 
      void
      parseOptions();
 
      void
      parseRuntimeOptions() override;
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointData(HDF5Handle& a_handle, const int a_lvl) override;
#endif
      virtual int
      getNumberOfPlotVariables() const override;
 
      virtual Vector<std::string>
      getPlotVariableNames() const override;
 
      virtual void
      writePlotData(LevelData<EBCellFAB>& a_output,
                    int&                  a_icomp,
                    const std::string&    a_outputRealm,
                    const int             a_level) const override;
 
      virtual Real
      computeDt() override;
 
      virtual Real
      advance(const Real a_dt) override;
 
      virtual void
      synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override;
 
      virtual void
      printStepReport() override
      {}
 
      virtual void
      preRegrid(const int a_lmin, const int a_oldFinestLevel) override;
 
      virtual void
      regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
 
      virtual void
      postRegrid() override;
 
    protected:
      IntegrationAlgorithm m_algorithm;
 
      Real m_dt;
 
      std::string m_realm;
 
      phase::which_phase m_phase;
 
      RefCountedPtr<MeshODESolver<N>> m_solver;
 
      std::function<std::array<Real, N>(const std::array<Real, N> y, Real t)> m_rhsFunction;
 
      std::function<std::array<Real, N>(const RealVect& a_position)> m_initialData;
 
      virtual void
      parseIntegrator();
 
      virtual void
      parseVerbosity();
 
      virtual void
      parseProblem();
 
      virtual void
      advanceEuler(const Real a_dt);
 
      virtual void
      advanceRK2(const Real a_dt);
 
      virtual void
      advanceRK4(const Real a_dt);
    };
  } // namespace MeshODE
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_MeshODEStepperImplem.H>
 
#endif