CD_RtSolver.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_RTSOLVER_H
#define CD_RTSOLVER_H
 
// Std includes
#include <functional>
 
// Our includes
#include <CD_ComputationalGeometry.H>
#include <CD_AmrMesh.H>
#include <CD_RtSpecies.H>
#include <CD_Location.H>
#include <CD_NamespaceHeader.H>
 
class RtSolver
{
public:
  RtSolver();
 
  virtual ~RtSolver();
 
  virtual std::string
  getName();
 
  virtual std::string
  getRealm() const;
 
  virtual void
  parseOptions() = 0;
 
  virtual void
  parseRuntimeOptions() = 0;
 
  virtual bool
  advance(const Real a_dt, const bool a_zeroPhi = false);
 
  virtual bool
  advance(const Real a_dt, EBAMRCellData& a_phi, const bool a_zeroPhi = false);
 
  virtual bool
  advance(const Real a_dt, EBAMRCellData& a_phi, const EBAMRCellData& a_source, const bool a_zeroPhi = false) = 0;
 
  virtual void
  setRealm(const std::string& a_realm);
 
  virtual void
  setRtSpecies(const RefCountedPtr<RtSpecies>& a_RtSpecies);
 
  virtual void
  setComputationalGeometry(const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
  virtual void
  computeLoads(Vector<long long>& a_loads, const DisjointBoxLayout& a_dbl, const int a_level) const noexcept;
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amr);
 
  virtual void
  setPhase(phase::which_phase a_phase = phase::gas);
 
  virtual void
  setVerbosity(const int a_verbosity);
 
  virtual void
  setTime(const int a_step, const Real a_time, const Real a_dt);
 
  virtual void
  setStationary(const bool a_stationary);
 
  virtual void
  sanityCheck();
 
  virtual bool
  isStationary();
 
  virtual void
  computeBoundaryFlux(EBAMRIVData& a_ebFlux, const EBAMRCellData& a_phi) = 0;
 
  virtual void
  computeDomainFlux(EBAMRIFData& a_domainflux, const EBAMRCellData& a_phi) = 0;
 
  virtual void
  computeFlux(EBAMRCellData& a_flux, const EBAMRCellData& a_phi) = 0;
 
  virtual void
  computeDensity(EBAMRCellData& a_isotropic, const EBAMRCellData& a_phi) = 0;
 
  virtual void
  allocate() = 0;
 
  virtual void
  deallocate() = 0;
 
  virtual void
  preRegrid(const int a_lbase, const int a_oldFinestLevel) = 0;
 
  virtual void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) = 0;
 
  virtual void
  registerOperators() = 0;
 
  virtual void
  initialData();
 
  virtual void
  setSource(const EBAMRCellData& a_source);
 
  virtual void
  setSource(const Real a_source);
 
  virtual void
  setSource(const std::function<Real(const RealVect a_pos)>& a_source);
 
  virtual void
  writePlotFile() = 0;
 
  virtual int
  getNumberOfPlotVariables() const;
 
  virtual Vector<std::string>
  getPlotVariableNames() const;
 
  virtual void
  writePlotData(LevelData<EBCellFAB>& a_output,
                int&                  a_comp,
                const std::string&    a_outputRealm,
                const int             a_level) const noexcept;
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointLevel(HDF5Handle& a_handle, const int a_level) const = 0;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointLevel(HDF5Handle& a_handle, const int a_level) = 0;
#endif
 
  virtual Real
  getTime() const;
 
  virtual phase::which_phase
  getPhase();
 
  virtual EBAMRCellData&
  getPhi();
 
  virtual EBAMRCellData&
  getSource();
 
  virtual EBAMRFluxData&
  getKappa();
 
  virtual EBAMRIVData&
  getKappaEb();
 
  virtual RefCountedPtr<RtSpecies>&
  getSpecies();
 
protected:
  static constexpr int m_comp = 0;
 
  static constexpr int m_nComp = 1;
 
  Location::Cell m_dataLocation;
 
  std::string m_realm;
 
  RefCountedPtr<EBIndexSpace> m_ebis;
 
  RefCountedPtr<RtSpecies> m_rtSpecies;
 
  RefCountedPtr<ComputationalGeometry> m_computationalGeometry;
 
  RefCountedPtr<AmrMesh> m_amr;
 
  phase::which_phase m_phase;
 
  std::string m_name = "RtSolver";
 
  std::string m_className = "RtSolver";
 
  EBAMRCellData m_cachePhi;
 
  EBAMRCellData m_phi;
 
  EBAMRCellData m_source;
 
  EBAMRFluxData m_kappa;
 
  EBAMRIVData m_kappaEB;
 
  Real m_time;
 
  Real m_dt;
 
  bool m_stationary;
 
  bool m_plotPhi;
 
  bool m_plotSource;
 
  int m_verbosity = -1;
 
  int m_timeStep;
 
  void
  setEbIndexSpace(const RefCountedPtr<EBIndexSpace>& a_ebis);
 
  void
  parseVerbosity() noexcept;
 
  virtual void
  writeData(LevelData<EBCellFAB>& a_output,
            int&                  a_comp,
            const EBAMRCellData&  a_data,
            const std::string&    a_outputRealm,
            const int             a_level,
            const bool            a_interpToCentroids,
            const bool            a_interpGhost) const noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#endif