chombo-discharge
Loading...
Searching...
No Matches
Physics
ItoKMC
CD_ItoKMCPhotoReaction.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_ItoKMCPhotoReaction_H
13
#define CD_ItoKMCPhotoReaction_H
14
15
// Std includes
16
#include <list>
17
18
// Chombo includes
19
#include <REAL.H>
20
21
// Our includes
22
#include <CD_NamespaceHeader.H>
23
24
namespace
Physics
{
25
namespace
ItoKMC {
26
30
class
ItoKMCPhotoReaction
31
{
32
public
:
36
ItoKMCPhotoReaction
() =
default
;
37
44
inline
ItoKMCPhotoReaction
(
const
size_t
a_source
,
45
const
std::list<size_t>
a_targets
,
46
const
Real
a_efficiency
= 1.0)
noexcept
;
47
51
virtual
inline
~
ItoKMCPhotoReaction
()
noexcept
;
52
61
inline
void
62
define
(
const
size_t
a_source
,
const
std
::
list
<
size_t
>
a_targets
,
const
Real
a_efficiency
= 1.0)
noexcept
;
63
67
inline
const
size_t
&
68
getSourcePhoton
()
const
noexcept
;
69
73
inline
const
std
::
list
<
size_t
>&
74
getTargetSpecies
()
const
noexcept
;
75
79
inline
const
Real
&
80
getEfficiency
()
const
noexcept
;
81
82
protected
:
86
size_t
m_source
;
87
91
std
::
list
<
size_t
>
m_targets
;
92
96
Real
m_efficiency
;
97
};
98
}
// namespace ItoKMC
99
}
// namespace Physics
100
101
#include <CD_NamespaceFooter.H>
102
103
#include <
CD_ItoKMCPhotoReactionImplem.H
>
104
105
#endif
CD_ItoKMCPhotoReactionImplem.H
Implementation of CD_ItoKMCPhotoReaction.H.
Physics::ItoKMC::ItoKMCPhotoReaction
Reaction class for describing photoionization in ItoKMCPhysics.
Definition
CD_ItoKMCPhotoReaction.H:31
Physics::ItoKMC::ItoKMCPhotoReaction::getEfficiency
const Real & getEfficiency() const noexcept
Get reaction efficiency.
Definition
CD_ItoKMCPhotoReactionImplem.H:59
Physics::ItoKMC::ItoKMCPhotoReaction::define
void define(const size_t a_source, const std::list< size_t > a_targets, const Real a_efficiency=1.0) noexcept
Define function.
Definition
CD_ItoKMCPhotoReactionImplem.H:32
Physics::ItoKMC::ItoKMCPhotoReaction::getSourcePhoton
const size_t & getSourcePhoton() const noexcept
Get the photon source.
Definition
CD_ItoKMCPhotoReactionImplem.H:47
Physics::ItoKMC::ItoKMCPhotoReaction::m_source
size_t m_source
Source photon index.
Definition
CD_ItoKMCPhotoReaction.H:86
Physics::ItoKMC::ItoKMCPhotoReaction::m_targets
std::list< size_t > m_targets
Plasma product indices.
Definition
CD_ItoKMCPhotoReaction.H:91
Physics::ItoKMC::ItoKMCPhotoReaction::m_efficiency
Real m_efficiency
Reaction efficiency.
Definition
CD_ItoKMCPhotoReaction.H:96
Physics::ItoKMC::ItoKMCPhotoReaction::getTargetSpecies
const std::list< size_t > & getTargetSpecies() const noexcept
Get the photon target products.
Definition
CD_ItoKMCPhotoReactionImplem.H:53
Physics::ItoKMC::ItoKMCPhotoReaction::ItoKMCPhotoReaction
ItoKMCPhotoReaction()=default
Allowed, but you need to call the define function afterwards.
TracerParticleSolver
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition
CD_TracerParticleSolver.H:37
TracerParticleSolver::TracerParticleSolver
TracerParticleSolver()
Default constructor.
Definition
CD_TracerParticleSolverImplem.H:25
Physics
Name containing various physics models for running chombo-discharge code.
Definition
CD_AdvectionDiffusion.H:15
Generated by
1.9.8