CD_FieldStepper.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_FIELDSTEPPER_H
#define CD_FIELDSTEPPER_H
 
// Our includes
#include <CD_TimeStepper.H>
#include <CD_SurfaceODESolver.H>
#include <CD_FieldSolver.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace Electrostatics {
 
template <class T>
class FieldStepper : public TimeStepper
{
public:
  FieldStepper();
 
  virtual ~FieldStepper();
 
  void
  setupSolvers() override;
 
  void
  initialData() override;
 
  void
  postInitialize() override;
 
  void
  allocate() override;
 
  MFAMRCellData&
  getPotential();
 
#ifdef CH_USE_HDF5
  void
  writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const override;
#endif
 
#ifdef CH_USE_HDF5
  void
  readCheckpointData(HDF5Handle& a_handle, const int a_lvl) override;
#endif
 
  void
  postCheckpointSetup() override
  {}
 
  int
  getNumberOfPlotVariables() const override;
 
  Vector<std::string>
  getPlotVariableNames() const override;
 
  void
  writePlotData(LevelData<EBCellFAB>& a_output,
                int&                  a_icomp,
                const std::string&    a_outputRealm,
                const int             a_level) const override;
 
  Real
  computeDt() override
  {
    return 0.0;
  }
 
  Real
  advance(const Real a_dt) override;
 
  void
  synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override;
 
  void
  printStepReport() override {};
 
  void
  registerRealms() override;
 
  void
  registerOperators() override;
 
  void
  preRegrid(const int a_lbase, const int a_finestLevel) override;
 
  bool
  loadBalanceThisRealm(const std::string& a_realm) const override;
 
  void
  loadBalanceBoxes(Vector<Vector<int>>&             a_procs,
                   Vector<Vector<Box>>&             a_boxes,
                   const std::string&               a_realm,
                   const Vector<DisjointBoxLayout>& a_grids,
                   const int                        a_lmin,
                   const int                        a_finestLevel) override;
 
  void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
 
  void
  postRegrid() override;
 
  void
  setRho(const std::function<Real(const RealVect& a_pos)>& a_rho, const phase::which_phase a_phase) noexcept;
 
  void
  setSigma(const std::function<Real(const RealVect& a_pos)>& a_sigma) noexcept;
 
protected:
  bool m_loadBalance;
 
  BoxSorting m_boxSort;
 
  RefCountedPtr<FieldSolver> m_fieldSolver;
 
  RefCountedPtr<SurfaceODESolver<1>> m_sigma;
 
  std::string m_realm;
 
  std::function<Real(const RealVect& a_pos)> m_rhoGas;
 
  std::function<Real(const RealVect& a_pos)> m_rhoDielectric;
 
  std::function<Real(const RealVect& a_pos)> m_surfaceChargeDensity;
 
  void
  solvePoisson();
};
} // namespace Electrostatics
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_FieldStepperImplem.H>
 
#endif