CD_ItoKMCGodunovStepper.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_ITOKMCGODUNOVSTEPPER_H
#define CD_ITOKMCGODUNOVSTEPPER_H
 
// Our includes
#include <CD_ItoKMCStepper.H>
#include <CD_Timer.H>
#include <CD_PointParticle.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    template <typename I = ItoSolver, typename C = CdrCTU, typename R = McPhoto, typename F = FieldSolverGMG>
    class ItoKMCGodunovStepper : public ItoKMCStepper<I, C, R, F>
    {
    public:
      ItoKMCGodunovStepper() = delete;
 
      ItoKMCGodunovStepper(RefCountedPtr<ItoKMCPhysics>& a_physics, bool a_parseOptions = true);
 
      virtual ~ItoKMCGodunovStepper();
 
      virtual Real
      computeDt() override;
 
      virtual Real
      advance(const Real a_dt) override;
 
      virtual void
      allocate() noexcept override;
 
      virtual void
      parseOptions() noexcept override;
 
      virtual void
      parseRuntimeOptions() noexcept override;
 
      virtual void
      preRegrid(const int a_lmin, const int a_oldFinestLevel) noexcept override;
 
      virtual void
      registerOperators() noexcept override;
 
      virtual void
      regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) noexcept override;
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const noexcept override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointHeader(HDF5HeaderData& a_header) noexcept override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointHeader(HDF5HeaderData& a_header) const noexcept override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointData(HDF5Handle& a_handle, const int a_lvl) noexcept override;
#endif
 
      virtual void
      postPlot() noexcept override;
 
    protected:
      enum class WhichAlgorithm
      {
        EulerMaruyama,
      };
 
      bool m_writeCheckpointParticles;
 
      bool m_readCheckpointParticles;
 
      bool m_canRegridOnRestart;
 
      bool m_extendConductivityEB;
 
      bool m_emitSecondaryParticlesBeforeReactions;
 
      WhichAlgorithm m_algorithm;
 
      Timer m_timer;
 
      int m_rhoFilterNum;
 
      int m_rhoFilterMaxStride;
 
      Real m_rhoFilterAlpha;
 
      int m_condFilterNum;
 
      int m_condFilterMaxStride;
 
      Real m_condFilterAlpha;
 
      Real m_maxFieldAbort;
 
      Vector<RefCountedPtr<ParticleContainer<PointParticle>>> m_conductivityParticles;
 
      Vector<RefCountedPtr<ParticleContainer<PointParticle>>> m_irregularParticles;
 
      Vector<RefCountedPtr<ParticleContainer<PointParticle>>> m_rhoDaggerParticles;
 
      EBAMRCellData m_semiImplicitRhoCDR;
 
      EBAMRCellData m_semiImplicitConductivityCDR;
 
      EBAMRCellData m_scratchSemiImplicitRhoCDR;
 
      EBAMRCellData m_scratchSemiImplicitConductivityCDR;
 
      Vector<EBAMRCellData> m_cdrDivD;
 
      virtual void
      allocateInternals() noexcept override;
 
      virtual void
      parseAlgorithm() noexcept;
 
      virtual void
      parseFiltering() noexcept;
 
      virtual void
      parseCheckpointParticles() noexcept;
 
      virtual void
      parseSecondaryEmissionSpecification() noexcept;
 
      virtual void
      setOldPositions() noexcept;
 
      virtual void
      barrier() const noexcept;
 
      virtual void
      remapPointParticles(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                          const SpeciesSubset                                      a_subset) noexcept;
 
      virtual void
      depositPointParticles(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                            const SpeciesSubset                                            a_subset) noexcept;
 
      virtual void
      clearPointParticles(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                          const SpeciesSubset                                            a_subset) noexcept;
 
      virtual void
      computeConductivities(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles) noexcept;
 
      virtual void
      computeCellConductivity(EBAMRCellData&                                                 a_conductivityCell,
                              const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles) noexcept;
 
      virtual void
      computeFaceConductivity() noexcept;
 
      virtual void
      computeSemiImplicitRho() noexcept;
 
      virtual void
      setupSemiImplicitPoisson(const Real a_dt) noexcept;
 
      virtual bool
      solvePoisson() noexcept override;
 
      virtual void
      removeCoveredPointParticles(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                                  const EBRepresentation                                   a_representation,
                                  const Real                                               a_tolerance) const noexcept;
 
      virtual void
      copyConductivityParticles(
        Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_conductivityParticles) noexcept;
 
      virtual void
      advanceEulerMaruyama(const Real a_dt) noexcept;
 
      virtual void
      diffuseParticlesEulerMaruyama(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_rhoDaggerParticles,
                                    const Real                                               a_dt) noexcept;
 
      virtual void
      computeDiffusionTermCDR(EBAMRCellData& m_semiImplicitRhoCDR, const Real a_dt) noexcept;
 
      virtual void
      stepEulerMaruyamaParticles(const Real a_dt) noexcept;
 
      virtual void
      stepEulerMaruyamaCDR(const Real a_dt) noexcept;
 
      virtual void
      plotParticles() const noexcept;
    };
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCGodunovStepperImplem.H>
 
#endif