CD_MeshODESolver.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_MESHODESOLVER_H
#define CD_MESHODESOLVER_H
 
// Std includes
#include <array>
 
// Our includes
#include <CD_AmrMesh.H>
#include <CD_NamespaceHeader.H>
 
template <size_t N = 1>
class MeshODESolver
{
public:
  using RHSFunction = std::function<std::array<Real, N>(const std::array<Real, N>&, const Real)>;
 
  MeshODESolver();
 
  MeshODESolver(const RefCountedPtr<AmrMesh>& a_amr) noexcept;
 
  MeshODESolver(const MeshODESolver&) = delete;
 
  MeshODESolver(const MeshODESolver&&) = delete;
 
  virtual ~MeshODESolver();
 
  MeshODESolver&
  operator=(const MeshODESolver&) = delete;
 
  MeshODESolver&
  operator=(const MeshODESolver&&) = delete;
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amrMesh) noexcept;
 
  virtual void
  parseOptions() noexcept;
 
  virtual void
  parseRuntimeOptions() noexcept;
 
  virtual void
  allocate() noexcept;
 
  virtual void
  setPhi(const std::function<Real(const RealVect& a_pos)>& a_phiFunc, size_t a_comp) noexcept;
 
  virtual void
  setPhi(const std::function<std::array<Real, N>(const RealVect& a_pos)>& a_phiFunc) noexcept;
 
  virtual void
  setRHS(const std::function<Real(const RealVect& a_pos)>& a_srcFunc, size_t a_comp) noexcept;
 
  virtual void
  computeRHS(const RHSFunction& a_rhsFunction) noexcept;
 
  virtual void
  computeRHS(EBAMRCellData& a_rhs, const RHSFunction& a_rhsFunction) const noexcept;
 
  EBAMRCellData&
  getPhi() noexcept;
 
  const EBAMRCellData&
  getPhi() const noexcept;
 
  EBAMRCellData&
  getRHS() noexcept;
 
  const EBAMRCellData&
  getRHS() const noexcept;
 
  virtual void
  preRegrid(int a_lbase, int a_oldFinestLevel) noexcept;
 
  virtual void
  regrid(int a_lmin, int a_oldFinestLevel, int a_newFinestLevel) noexcept;
 
  virtual std::string
  getRealm() const noexcept;
 
  virtual std::string
  getName() const noexcept;
 
  virtual void
  setName(const std::string& a_name) noexcept;
 
  virtual void
  registerOperators() const noexcept;
 
  virtual void
  setRealm(const std::string& a_realm) noexcept;
 
  virtual void
  setPhase(phase::which_phase a_phase) noexcept;
 
  virtual void
  setVerbosity(int a_verbosity) noexcept;
 
  virtual void
  setTime(int a_step, Real a_time, Real a_dt) noexcept;
 
  virtual void
  writePlotFile() const noexcept;
 
  virtual int
  getNumberOfPlotVariables() const noexcept;
 
  virtual Vector<std::string>
  getPlotVariableNames() const noexcept;
 
  virtual void
  writePlotData(LevelData<EBCellFAB>& a_output,
                int&                  a_icomp,
                const std::string&    a_outputRealm,
                int                   a_level) const noexcept;
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointLevel(HDF5Handle& a_handle, int a_level) const noexcept;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointLevel(HDF5Handle& a_handle, int a_level) noexcept;
#endif
 
protected:
  RefCountedPtr<AmrMesh> m_amr;
 
  int m_verbosity;
 
  int m_timeStep;
 
  Real m_time;
 
  Real m_dt;
 
  bool m_plotPhi;
 
  bool m_plotRHS;
 
  bool m_regridSlopes;
 
  std::string m_name;
 
  std::string m_className;
 
  std::string m_realm;
 
  phase::which_phase m_phase;
 
  EBAMRCellData m_phi;
 
  EBAMRCellData m_rhs;
 
  EBAMRCellData m_cache;
 
  virtual void
  writeData(LevelData<EBCellFAB>& a_output,
            int&                  a_comp,
            const EBAMRCellData&  a_data,
            std::string           a_outputRealm,
            int                   a_level,
            bool                  a_interpToCentroids,
            bool                  a_interpGhost) const noexcept;
 
  virtual void
  parsePlotVariables() noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_MeshODESolverImplem.H>
 
#endif