CD_ItoPlasmaPhysics.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2021 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_ItoPlasmaPhysics_H
#define CD_ItoPlasmaPhysics_H
 
// Std includes
#include <memory>
#include <vector>
 
// Chombo includes
#include <RealVect.H>
#include <RefCountedPtr.H>
#include <List.H>
 
// Our includes
#include <CD_ItoSpecies.H>
#include <CD_RtSpecies.H>
#include <CD_Photon.H>
#include <CD_ItoParticle.H>
#include <CD_ItoPlasmaPhotoReaction.H>
#include <CD_KMCDualState.H>
#include <CD_KMCDualStateReaction.H>
#include <CD_KMCSolver.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoPlasma {
 
    using FPR = Real;
 
    using KMCState = KMCDualState<FPR>;
 
    using KMCReaction = KMCDualStateReaction<KMCState, FPR>;
 
    using KMCSolverType = KMCSolver<KMCReaction, KMCState, FPR>;
 
    class ItoPlasmaPhysics
    {
    public:
      inline ItoPlasmaPhysics();
 
      inline virtual ~ItoPlasmaPhysics();
 
      inline virtual Real
      computeDt(const RealVect a_E, const RealVect a_pos, const Vector<FPR> a_numParticles) const noexcept;
 
      virtual Real
      computeAlpha(const RealVect a_E) const = 0;
 
      const Vector<RefCountedPtr<ItoSpecies>>&
      getItoSpecies() const;
 
      const Vector<RefCountedPtr<RtSpecies>>&
      getRtSpecies() const;
 
      inline int
      getNumPlasmaSpecies() const;
 
      inline int
      getNumPhotonSpecies() const;
 
      inline virtual void
      parseRuntimeOptions() noexcept;
 
      inline virtual Real
      initialSigma(const Real a_time, const RealVect a_pos) const;
 
      virtual Vector<Real>
      computeItoMobilities(const Real a_time, const RealVect a_pos, const RealVect a_E) const noexcept = 0;
 
      virtual Vector<Real>
      computeItoDiffusion(const Real a_time, const RealVect a_pos, const RealVect a_E) const noexcept = 0;
 
      virtual void
      injectParticlesEB(Vector<List<ItoParticle>>&       a_outgoingParticles,
                        Vector<List<Photon>>&            a_outgoingPhotons,
                        const Vector<List<ItoParticle>>& a_incomingParticles,
                        const Vector<List<Photon>>&      a_incomingPhotons,
                        const Vector<FPR>&               a_newNumParticles,
                        const Vector<FPR>&               a_oldNumParticles,
                        const RealVect&                  a_E,
                        const RealVect&                  a_cellCenter,
                        const RealVect&                  a_cellCentroid,
                        const RealVect&                  a_bndryCentroid,
                        const RealVect&                  a_bndryNormal,
                        const Real                       a_bndryArea,
                        const Real                       a_dx,
                        const Real                       a_dt,
                        const bool                       a_isDielectric,
                        const int                        a_matIndex) const noexcept = 0;
 
      inline void
      advanceKMC(Vector<FPR>&   a_numParticles,
                 Vector<FPR>&   a_numNewPhotons,
                 const Real     a_dt,
                 const RealVect a_E,
                 const Real     a_dx,
                 const Real     a_kappa) const;
 
      inline void
      reconcileParticles(Vector<List<ItoParticle>*>& a_particles,
                         const Vector<FPR>&          a_newNumParticles,
                         const Vector<FPR>&          a_oldNumParticles,
                         const RealVect              a_cellPos,
                         const RealVect              a_centroidPos,
                         const RealVect              a_lo,
                         const RealVect              a_hi,
                         const RealVect              a_bndryCentroid,
                         const RealVect              a_bndryNormal,
                         const Real                  a_dx,
                         const Real                  a_kappa) const noexcept;
 
      inline void
      reconcilePhotons(Vector<List<Photon>*>& a_newPhotons,
                       const Vector<FPR>&     a_numNewPhotons,
                       const RealVect         a_cellPos,
                       const RealVect         a_centroidPos,
                       const RealVect         a_lo,
                       const RealVect         a_hi,
                       const RealVect         a_bndryCentroid,
                       const RealVect         a_bndryNormal,
                       const Real             a_dx,
                       const Real             a_kappa) const noexcept;
 
      inline void
      reconcilePhotoionization(Vector<List<ItoParticle>*>&  a_particles,
                               const Vector<List<Photon>*>& a_absorbedPhotons) const noexcept;
 
    protected:
      enum class Algorithm
      {
        SSA,
        Tau,
        Hybrid
      };
 
      enum class ParticlePlacement
      {
        Random,
        Centroid
      };
 
      Algorithm m_algorithm;
 
      ParticlePlacement m_particlePlacement;
 
      std::string m_className;
 
      bool m_debug;
 
      mutable KMCState m_kmcState;
 
      mutable KMCSolverType m_kmcSolver;
 
      std::vector<std::shared_ptr<const KMCReaction>> m_kmcReactions;
 
      std::vector<std::shared_ptr<const ItoPlasmaPhotoReaction>> m_photoReactions;
 
      Vector<RefCountedPtr<ItoSpecies>> m_plasmaSpecies;
 
      Vector<RefCountedPtr<RtSpecies>> m_rtSpecies;
 
      int m_maxNewParticles;
 
      int m_maxNewPhotons;
 
      int m_Ncrit;
 
      int m_NSSA;
 
      Real m_SSAlim;
 
      Real m_eps;
 
      inline void
      defineKMC() noexcept;
 
      inline void
      parsePPC() noexcept;
 
      inline void
      parseDebug() noexcept;
 
      inline void
      parseAlgorithm() noexcept;
 
      virtual void
      updateReactionRates(const RealVect a_E, const Real a_dx, const Real a_kappa) const noexcept = 0;
 
      inline void
      removeParticles(List<ItoParticle>& a_particles, const long long a_numToRemove) const;
    };
  } // namespace ItoPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoPlasmaPhysicsImplem.H>
 
#endif