CD_TracerParticleStepper.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_TRACERPARTICLESTEPPER_H
#define CD_TRACERPARTICLESTEPPER_H
 
// Our includes
#include <CD_TracerParticleSolver.H>
#include <CD_TracerParticlePhysics.H>
#include <CD_TimeStepper.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace TracerParticle {
 
    enum class IntegrationAlgorithm
    {
      Euler, 
      RK2,   
      RK4    
    };
 
    enum class VelocityField
    {
      Diagonal,  
      Rotational 
    };
 
    template <typename P>
    class TracerParticleStepper : public TimeStepper
    {
    public:
      TracerParticleStepper();
 
      TracerParticleStepper(const TracerParticleStepper<P>& a_other) = delete;
 
      TracerParticleStepper(const TracerParticleStepper<P>&& a_other) = delete;
 
      virtual ~TracerParticleStepper();
 
      TracerParticleStepper&
      operator=(const TracerParticleStepper<P>& a_other) = delete;
 
      TracerParticleStepper&
      operator=(const TracerParticleStepper<P>&& a_other) = delete;
 
      void
      setupSolvers() override;
 
      void
      allocate() override;
 
      void
      initialData() override;
 
      void
      postInitialize() override
      {}
 
      void
      postCheckpointSetup() override
      {}
 
      void
      registerRealms() override;
 
      void
      registerOperators() override;
 
      void
      parseOptions();
 
      void
      parseRuntimeOptions() override;
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointData(HDF5Handle& a_handle, const int a_lvl) override;
#endif
 
      int
      getNumberOfPlotVariables() const override;
 
      Vector<std::string>
      getPlotVariableNames() const override;
 
      void
      writePlotData(LevelData<EBCellFAB>& a_output,
                    int&                  a_icomp,
                    const std::string&    a_realm,
                    const int             a_level) const override;
 
      virtual Real
      computeDt() override;
 
      virtual Real
      advance(const Real a_dt) override;
 
      virtual void
      synchronizeSolverTimes(const int a_step, const Real a_time, const Real a_dt) override;
 
      virtual void
      printStepReport() override
      {}
 
      virtual void
      preRegrid(const int a_lmin, const int a_oldFinestLevel) override;
 
      virtual void
      regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
 
      virtual void
      postRegrid() override;
 
    protected:
      IntegrationAlgorithm m_algorithm;
 
      VelocityField m_velocityField;
 
      std::string m_realm;
 
      phase::which_phase m_phase;
 
      RefCountedPtr<TracerParticleSolver<P>> m_solver;
 
      EBAMRCellData m_velocity;
 
      Real m_cfl;
 
      size_t m_numInitialParticles;
 
      virtual void
      initialParticles();
 
      virtual void
      setVelocity();
 
      virtual void
      parseIntegrator();
 
      virtual void
      parseVelocityField();
 
      virtual void
      parseInitialConditions();
 
      virtual void
      advanceParticlesEuler(const Real a_dt);
 
      virtual void
      advanceParticlesRK2(const Real a_dt);
 
      virtual void
      advanceParticlesRK4(const Real a_dt);
    };
  } // namespace TracerParticle
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_TracerParticleStepperImplem.H>
 
#endif