chombo-discharge
Toggle main menu visibility
Main Page
Related Pages
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
e
f
g
i
k
l
m
n
p
q
r
s
t
v
w
Functions
a
b
c
d
f
g
l
m
n
p
r
s
v
w
Variables
Typedefs
Enumerations
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
~
Functions
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
~
Variables
k
m
p
s
t
Typedefs
b
c
d
f
i
k
m
n
p
r
s
t
v
Enumerations
a
b
c
d
e
f
g
i
j
l
m
n
p
r
s
t
w
Files
File List
File Members
All
Functions
Typedefs
Enumerations
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Pages
Loading...
Searching...
No Matches
Physics
ItoKMC
CD_ItoKMCPhotoReactionImplem.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
// Our includes
13
#ifndef CD_ItoKMCPhotoReactionImplem_H
14
#define CD_ItoKMCPhotoReactionImplem_H
15
16
#include <
CD_ItoKMCPhotoReaction.H
>
17
#include <CD_NamespaceHeader.H>
18
19
using namespace
Physics::ItoKMC;
20
21
inline
ItoKMCPhotoReaction::ItoKMCPhotoReaction
(
const
size_t
a_source
,
22
const
std::list<size_t>
a_targets
,
23
const
Real
a_efficiency
)
noexcept
24
{
25
this->define(
a_source
,
a_targets
,
a_efficiency
);
26
}
21
inline
ItoKMCPhotoReaction::ItoKMCPhotoReaction
(
const
size_t
a_source
, {
…
}
27
28
inline
ItoKMCPhotoReaction::~ItoKMCPhotoReaction
()
noexcept
29
{}
28
inline
ItoKMCPhotoReaction::~ItoKMCPhotoReaction
()
noexcept
{
…
}
30
31
inline
void
32
ItoKMCPhotoReaction::define
(
const
size_t
a_source
,
const
std::list<size_t>
a_targets
,
const
Real
a_efficiency
)
noexcept
33
{
34
m_source =
a_source
;
35
m_targets =
a_targets
;
36
m_efficiency =
a_efficiency
;
37
38
const
std::string
baseError
=
"CD_ItoKMCPhotoReactionImplem.H in function "
;
39
if
(m_efficiency < 0.0) {
40
const
std::string
derivError
=
"'ItoKMCPhotoReaction::define' - efficiency must be >= 0.0"
;
41
42
MayDay::Error((
baseError
+
derivError
).
c_str
());
43
}
44
}
32
ItoKMCPhotoReaction::define
(
const
size_t
a_source
,
const
std::list<size_t>
a_targets
,
const
Real
a_efficiency
)
noexcept
{
…
}
45
46
inline
const
size_t
&
47
ItoKMCPhotoReaction::getSourcePhoton
()
const
noexcept
48
{
49
return
m_source
;
50
}
47
ItoKMCPhotoReaction::getSourcePhoton
()
const
noexcept
{
…
}
51
52
inline
const
std::list<size_t>
&
53
ItoKMCPhotoReaction::getTargetSpecies
()
const
noexcept
54
{
55
return
m_targets
;
56
}
53
ItoKMCPhotoReaction::getTargetSpecies
()
const
noexcept
{
…
}
57
58
inline
const
Real
&
59
ItoKMCPhotoReaction::getEfficiency
()
const
noexcept
60
{
61
return
m_efficiency
;
62
}
59
ItoKMCPhotoReaction::getEfficiency
()
const
noexcept
{
…
}
63
64
#include <CD_NamespaceFooter.H>
65
66
#endif
CD_ItoKMCPhotoReaction.H
Declaration of a class for holding photoionization reaction types in ito_plasma physics.
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::~ItoKMCPhotoReaction
virtual ~ItoKMCPhotoReaction() noexcept
Destructor.
Definition
CD_ItoKMCPhotoReactionImplem.H:28
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
Generated by
1.9.8