CD_RtLayout.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_RTLAYOUT_H
#define CD_RTLAYOUT_H
 
// Our includes
#include <CD_RtSolver.H>
#include <CD_NamespaceHeader.H>
 
template <class T>
class RtIterator;
 
template <class T>
class RtLayout
{
public:
  RtLayout(const Vector<RefCountedPtr<RtSpecies>>& a_RtSpecies);
 
  virtual ~RtLayout();
 
  virtual RtIterator<T>
  iterator();
 
  virtual const std::string
  getRealm() const;
 
  virtual void
  setRealm(const std::string& a_realm);
 
  virtual void
  addSolver(RefCountedPtr<T> a_solver);
 
  virtual void
  parseOptions();
 
  virtual void
  parseRuntimeOptions();
 
  virtual void
  allocate();
 
  virtual void
  preRegrid(const int a_base, const int a_oldFinestLevel);
 
  virtual void
  deallocate();
 
  virtual void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel);
 
  virtual void
  registerOperators();
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amr);
 
  virtual void
  setComputationalGeometry(const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
  virtual void
  sanityCheck();
 
  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
  setSource(const EBAMRCellData& a_source);
 
  virtual void
  setSource(const Real a_source);
 
  virtual void
  setStationary(const bool a_stationary);
 
  virtual void
  writePlotFile();
 
  virtual void
  advance(const Real a_dt);
 
  virtual void
  initialData();
 
  virtual bool
  isStationary();
 
  virtual phase::which_phase
  getPhase();
 
  virtual Vector<RefCountedPtr<T>>&
  getSolvers();
 
  virtual Vector<RefCountedPtr<RtSpecies>>&
  getSpecies();
 
  virtual Vector<EBAMRCellData*>
  getSources();
 
  virtual Vector<EBAMRCellData*>
  getPhis();
 
protected:
  std::string m_realm;
 
  phase::which_phase m_phase;
 
  Vector<RefCountedPtr<T>> m_solvers;
 
  Vector<RefCountedPtr<RtSpecies>> m_species;
 
  int m_verbosity;
};
 
template <class T, class S>
class RtFactory
{
public:
  RtFactory();
 
  ~RtFactory();
 
  RefCountedPtr<RtLayout<T>>
  newLayout(const Vector<RefCountedPtr<RtSpecies>>& a_species) const;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_RtLayoutImplem.H>
 
#endif