CD_SurfaceODESolver.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_SURFACEODESOLVER_H
#define CD_SURFACEODESOLVER_H
 
// Std includes
#include <array>
 
// Our includes
#include <CD_AmrMesh.H>
#include <CD_NamespaceHeader.H>
 
template <int N = 1>
class SurfaceODESolver
{
public:
  static_assert(N > 0, "SurfaceODESolver<N> must have N > 0");
 
  SurfaceODESolver();
 
  SurfaceODESolver(const RefCountedPtr<AmrMesh>& a_amr);
 
  SurfaceODESolver(const SurfaceODESolver&) = delete;
 
  SurfaceODESolver(const SurfaceODESolver&&) = delete;
 
  virtual ~SurfaceODESolver();
 
  SurfaceODESolver&
  operator=(const SurfaceODESolver&) = delete;
 
  SurfaceODESolver&
  operator=(const SurfaceODESolver&&) = delete;
 
  virtual void
  parseOptions() noexcept;
 
  virtual void
  parseRuntimeOptions() noexcept;
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amrMesh) noexcept;
 
  virtual void
  setRealm(const std::string& a_realm) noexcept;
 
  virtual void
  setName(const std::string& a_name) noexcept;
 
  std::string
  getRealm() const noexcept;
 
  virtual void
  setPhase(const phase::which_phase a_phase) noexcept;
 
  virtual phase::which_phase
  getPhase() const noexcept;
 
  virtual void
  setVerbosity(const int a_verbosity) noexcept;
 
  virtual int
  getVerbosity() const noexcept;
 
  virtual void
  setTime(const int a_step, const Real a_time, const Real a_dt) noexcept;
 
  virtual Real
  computeMass(const int a_comp = 0) const noexcept;
 
  virtual Real
  computeMass(const EBAMRIVData& a_data, const int a_comp = 0) const noexcept;
 
  virtual int
  getStep() const noexcept;
 
  virtual Real
  getTime() const noexcept;
 
  virtual Real
  getDt() const noexcept;
 
  virtual void
  setPhi(const Real a_phi);
 
  virtual void
  setPhi(const std::array<Real, N>& a_phi);
 
  virtual void
  setPhi(const EBAMRIVData& a_phi);
 
  virtual EBAMRIVData&
  getPhi() noexcept;
 
  virtual const EBAMRIVData&
  getPhi() const noexcept;
 
  virtual void
  setRHS(const Real a_rhs);
 
  virtual void
  setRHS(const std::array<Real, N>& a_rhs);
 
  virtual void
  setRHS(const EBAMRIVData& a_rhs);
 
  virtual EBAMRIVData&
  getRHS();
 
  virtual const EBAMRIVData&
  getRHS() const noexcept;
 
  virtual void
  allocate() noexcept;
 
  virtual void
  deallocate() noexcept;
 
  virtual void
  registerOperators() noexcept;
 
  virtual void
  preRegrid(const int a_lbase, const int a_oldFinestLevel) noexcept;
 
  virtual void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) noexcept;
 
  virtual void
  resetElectrodes(const Real a_value) noexcept;
 
  virtual void
  resetElectrodes(EBAMRIVData& a_phi, const Real a_value) const noexcept;
 
  virtual void
  resetDielectrics(const Real a_value) noexcept;
 
  virtual void
  resetDielectrics(EBAMRIVData& a_phi, const Real a_value) const noexcept;
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointLevel(HDF5Handle& a_handle, const int a_level) const noexcept;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointLevel(HDF5Handle& a_handle, const int a_level) noexcept;
#endif
 
  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_comp,
                const std::string&    a_outputRealm,
                const int             a_level) const noexcept;
 
protected:
  std::string m_realm;
 
  std::string m_className;
 
  std::string m_name;
 
  phase::which_phase m_phase;
 
  bool m_conservativeRegrid;
 
  bool m_plotPhi;
 
  bool m_plotRHS;
 
  RefCountedPtr<MultiFluidIndexSpace> m_mfis;
 
  RefCountedPtr<AmrMesh> m_amr;
 
  Vector<RefCountedPtr<LayoutData<VoFIterator>>> m_electrodeVoFs;
 
  Vector<RefCountedPtr<LayoutData<VoFIterator>>> m_dielectricVoFs;
 
  EBAMRIVData m_phi;
 
  EBAMRIVData m_cache;
 
  EBAMRIVData m_rhs;
 
  int m_verbosity;
 
  int m_step;
 
  Real m_time;
 
  Real m_dt;
 
  void
  parseVerbosity() noexcept;
 
  void
  parseRegrid() noexcept;
 
  void
  parsePlotVariables() noexcept;
 
  void
  defineVoFIterators() noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_SurfaceODESolverImplem.H>
 
#endif