CD_AdvectionDiffusionStepper.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_ADVECTIONDIFFUSIONSTEPPER_H
#define CD_ADVECTIONDIFFUSIONSTEPPER_H
 
// Our includes
#include <CD_TimeStepper.H>
#include <CD_CdrSolver.H>
#include <CD_AdvectionDiffusionSpecies.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace AdvectionDiffusion {
 
    class AdvectionDiffusionStepper : public TimeStepper
    {
    public:
      AdvectionDiffusionStepper();
 
      AdvectionDiffusionStepper(RefCountedPtr<CdrSolver>& a_solver);
 
      virtual ~AdvectionDiffusionStepper();
 
      void
      initialData() override;
 
      void
      allocate() override;
 
      void
      postInitialize() 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
      parseRuntimeOptions() override;
 
      void
      registerRealms() override;
 
      void
      registerOperators() 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
      {}
 
      void
      setCFL(const Real a_cfl);
 
      void
      setInitialData(const std::function<Real(const RealVect& a_position)>& a_initData) noexcept;
 
      void
      setVelocity(const std::function<RealVect(const RealVect& a_position)>& a_velocity) noexcept;
 
      void
      setDiffusionCoefficient(const std::function<Real(const RealVect& a_position)>& a_diffusion) noexcept;
 
    protected:
      enum Integrator
      {
        Heun, 
        IMEX  
      };
 
      RefCountedPtr<CdrSolver> m_solver;
 
      RefCountedPtr<AdvectionDiffusionSpecies> m_species;
 
      std::string m_realm;
 
      phase::which_phase m_phase;
 
      std::function<RealVect(const RealVect& a_position)> m_velocity;
 
      std::function<Real(const RealVect& a_position)> m_diffCo;
 
      std::function<Real(const RealVect& a_initialData)> m_initialData;
 
      Real m_minDt;
 
      Real m_maxDt;
 
      Real m_cfl;
 
      Real m_forceCFL;
 
      bool m_debug;
 
      bool m_mobile;
 
      bool m_diffusive;
 
      Integrator m_integrator;
 
      void
      parseIntegrator();
    };
  } // namespace AdvectionDiffusion
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif