CD_BrownianWalkerStepper.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_BROWNIANWALKERSTEPPER_H
#define CD_BROWNIANWALKERSTEPPER_H
 
// Our includes
#include <CD_TimeStepper.H>
#include <CD_ItoSolver.H>
#include <CD_ItoLayout.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace BrownianWalker {
 
class BrownianWalkerStepper : public TimeStepper
{
public:
  BrownianWalkerStepper();
 
  BrownianWalkerStepper(const std::string& a_className);
 
  BrownianWalkerStepper(RefCountedPtr<ItoSolver>& a_solver, const std::string& a_className);
 
  BrownianWalkerStepper(RefCountedPtr<ItoSolver>& a_solver);
 
  virtual ~BrownianWalkerStepper();
 
  void
  initialData() override;
 
  void
  allocate() override;
 
  void
  postInitialize() override;
 
  bool
  loadBalanceThisRealm(const std::string& a_realm) const override;
 
  Vector<long int>
  getCheckpointLoads(const std::string& a_realm, const int a_level) 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;
 
#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;
 
  void
  synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override;
 
  void
  printStepReport() override;
 
  void
  postPlot() override;
 
  void
  plotParticles() const noexcept;
 
  void
  registerOperators() override;
 
  void
  registerRealms() override;
 
  void
  parseRuntimeOptions() override;
 
  bool
  needToRegrid() override;
 
  void
  preRegrid(const int a_lbase, const int a_oldFinestLevel) override;
 
  void
  setupSolvers() override;
 
  Real
  advance(const Real a_dt) override;
 
  void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
 
  void
  postRegrid() override;
 
protected:
  enum LoadBalancingMethod
  {
    Mesh,    
    Particle 
  };
 
  LoadBalancingMethod m_whichLoadBalance;
 
  std::string m_realm;
 
  phase::which_phase m_phase;
 
  bool m_loadBalance;
 
  RefCountedPtr<ItoSolver> m_solver;
 
  RefCountedPtr<ItoSpecies> m_species;
 
  EBAMRCellData m_regridPPC;
 
  Real m_diffCo;
 
  Real m_mobility;
 
  Real m_omega;
 
  std::string m_className;
 
  bool m_constantVelocity;
 
  RealVect m_velocity;
 
  bool m_verifyConservation;
 
  Real m_cfl;
 
  void
  setAdvectionDiffusion();
 
  void
  setVelocity();
 
  void
  setDiffusion();
 
  void
  makeSuperParticles();
 
  Real
  computeTotalWeight();
 
  void
  loadBalanceBoxesMesh(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);
 
  void
  loadBalanceBoxesParticles(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);
};
} // namespace BrownianWalker
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif