CD_ItoPlasmaReaction.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_ItoPlasmaReaction_H
#define CD_ItoPlasmaReaction_H
 
// Chombo includes
#include <Vector.H>
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoPlasma {
 
    class ItoPlasmaReaction
    {
    public:
      ItoPlasmaReaction() = default;
 
      ItoPlasmaReaction(const std::initializer_list<int>                  a_reactants,
                        const std::initializer_list<int>                  a_particle_products,
                        const std::initializer_list<int>                  a_photon_products,
                        const std::initializer_list<std::pair<int, Real>> a_energy_jumps)
        : m_reactants(a_reactants),
          m_particle_products(a_particle_products),
          m_photon_products(a_photon_products),
          m_energy_jumps(a_energy_jumps)
      {
        this->computeStateChange();
        this->computeEnergyChange();
      }
 
      ItoPlasmaReaction(const std::initializer_list<int>                  a_reactants,
                        const std::initializer_list<int>                  a_particle_products,
                        const std::initializer_list<std::pair<int, Real>> a_energy_jumps)
        : m_reactants(a_reactants),
          m_particle_products(a_particle_products),
          m_photon_products(0),
          m_energy_jumps(a_energy_jumps)
      {
        this->computeStateChange();
        this->computeEnergyChange();
      }
 
      ItoPlasmaReaction(const std::initializer_list<int> a_reactants,
                        const std::initializer_list<int> a_particle_products,
                        const std::initializer_list<int> a_photon_products)
        : m_reactants(a_reactants),
          m_particle_products(a_particle_products),
          m_photon_products(a_photon_products),
          m_energy_jumps(0)
      {
        this->computeStateChange();
        this->computeEnergyChange();
      }
 
      ItoPlasmaReaction(const std::initializer_list<int> a_reactants,
                        const std::initializer_list<int> a_particle_products)
        : m_reactants(a_reactants), m_particle_products(a_particle_products), m_photon_products(0), m_energy_jumps(0)
      {
        this->computeStateChange();
        this->computeEnergyChange();
      }
 
      ~ItoPlasmaReaction() {}
 
      inline void
      jumpState(Vector<long long>& a_particles, const long long a_num_reactions) const;
 
      inline void
      jumpState(Vector<long long>& a_particles, Vector<long long>& a_Photons, const long long a_num_reactions) const;
 
      inline void
      jumpEnergy(Vector<Real>& a_energies, const Vector<Real>& a_mean_energies, const long long a_num_reactions) const;
 
      inline void
      jumpEnergy(Vector<Real>&       a_energies,
                 const Vector<Real>& a_mean_energies,
                 const Vector<Real>& a_sources,
                 const long long     a_num_reactions,
                 const Real          a_dt) const;
 
      inline Real&
      rate() const;
 
      inline Real
      propensity(const Vector<long long>& a_particles) const;
 
      inline int
      getGi(const Vector<long long>& a_particles) const;
 
      inline const std::list<int>&
      getReactants() const;
 
      inline const std::list<int>&
      getParticleProdcuts() const;
 
      inline const std::list<int>&
      getPhotonProducts() const;
 
      inline const std::map<int, int>&
      getStateChange() const;
 
      inline const int
      getStateChange(const int a_idx) const;
 
      inline const std::map<int, Real>&
      getEnergychange() const;
 
      inline const Real
      getEnergychange(const int a_idx) const;
 
    protected:
      // Reaction rate, mutable because I want ItoPlasmaReaction to be a const object, but reaction rate may need to change
      mutable Real m_rate;
 
      std::list<int>                  m_reactants;         // Particle reactants
      std::list<int>                  m_particle_products; // Particle products
      std::list<int>                  m_photon_products;   // Photon products
      std::list<std::pair<int, Real>> m_energy_jumps;      // Energy changes
 
      std::map<int, int>
        m_phiChange; // Change in species due to firing of one reaction. First index is species, second is change.
      std::map<int, Real>
        m_energyChange; // Change in energyk due to firing of one reaction. First index is species, second is change.
 
      inline void
      computeStateChange();
 
      inline void
      computeEnergyChange();
    };
  } // namespace ItoPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoPlasmaReactionImplem.H>
 
#endif