chombo-discharge
CD_ItoPlasmaPhotoReaction.H
Go to the documentation of this file.
1 /* chombo-discharge
2  * Copyright © 2021 SINTEF Energy Research.
3  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
4  */
5 
12 #ifndef CD_ItoPlasmaPhotoReaction_H
13 #define CD_ItoPlasmaPhotoReaction_H
14 
15 // Std includes
16 #include <list>
17 
18 // Our includes
19 #include <CD_NamespaceHeader.H>
20 
21 namespace Physics {
22  namespace ItoPlasma {
23 
28  {
29  public:
34 
40  inline ItoPlasmaPhotoReaction(const size_t a_source, const std::list<size_t> a_targets) noexcept;
41 
45  virtual inline ~ItoPlasmaPhotoReaction() noexcept;
46 
52  inline void
53  define(const size_t a_source, const std::list<size_t> a_targets) noexcept;
54 
58  inline const size_t&
59  getSourcePhoton() const noexcept;
60 
64  inline const std::list<size_t>&
65  getTargetSpecies() const noexcept;
66 
67  protected:
71  size_t m_source;
72 
76  std::list<size_t> m_targets;
77  };
78  } // namespace ItoPlasma
79 } // namespace Physics
80 
81 #include <CD_NamespaceFooter.H>
82 
84 
85 #endif
Implementation of CD_ItoPlasmaPhotoReaction.H.
Reaction class for describing photoionization in ItoPlasmaPhysics.
Definition: CD_ItoPlasmaPhotoReaction.H:28
size_t m_source
Source photon index.
Definition: CD_ItoPlasmaPhotoReaction.H:71
std::list< size_t > m_targets
Plasma product indices.
Definition: CD_ItoPlasmaPhotoReaction.H:76
const std::list< size_t > & getTargetSpecies() const noexcept
Get the photon target products.
Definition: CD_ItoPlasmaPhotoReactionImplem.H:43
const size_t & getSourcePhoton() const noexcept
Get the photon source.
Definition: CD_ItoPlasmaPhotoReactionImplem.H:37
ItoPlasmaPhotoReaction()=default
Allowed, but you need to call the define function afterwards.
virtual ~ItoPlasmaPhotoReaction() noexcept
Destructor.
Definition: CD_ItoPlasmaPhotoReactionImplem.H:26
void define(const size_t a_source, const std::list< size_t > a_targets) noexcept
Define function.
Definition: CD_ItoPlasmaPhotoReactionImplem.H:29
Name containing various physics models for running chombo-discharge code.
Definition: CD_AdvectionDiffusion.H:15