chombo-discharge
Loading...
Searching...
No Matches
Physics
ItoKMC
CD_ItoKMCSurfaceReactionImplem.H
Go to the documentation of this file.
1
/*
2
* SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3
*
4
* SPDX-License-Identifier: GPL-3.0-or-later
5
*/
6
13
#ifndef CD_ITOKMCSURFACEREACTIONIMPLEM_H
14
#define CD_ITOKMCSURFACEREACTIONIMPLEM_H
15
16
// Our includes
17
#include <
CD_ItoKMCSurfaceReaction.H
>
18
#include <CD_NamespaceHeader.H>
19
20
using namespace
Physics::ItoKMC;
21
22
inline
ItoKMCSurfaceReaction::ItoKMCSurfaceReaction
(
const
size_t
a_reactant
,
23
const
std::list<size_t>
a_products
,
24
const
Real
a_efficiency
)
noexcept
25
{
26
this->define(
a_reactant
,
a_products
,
a_efficiency
);
27
}
28
29
inline
ItoKMCSurfaceReaction::~ItoKMCSurfaceReaction
()
noexcept
30
{}
31
32
inline
void
33
ItoKMCSurfaceReaction::define
(
const
size_t
a_reactant
,
34
const
std::list<size_t>
a_products
,
35
const
Real
a_efficiency
)
noexcept
36
{
37
m_reactant =
a_reactant
;
38
m_products =
a_products
;
39
m_efficiency =
a_efficiency
;
40
}
41
42
inline
const
size_t
&
43
ItoKMCSurfaceReaction::getReactant
()
const
noexcept
44
{
45
return
m_reactant
;
46
}
47
48
inline
size_t
&
49
ItoKMCSurfaceReaction::getReactant
()
noexcept
50
{
51
return
m_reactant
;
52
}
53
54
inline
const
std::list<size_t>
&
55
ItoKMCSurfaceReaction::getProducts
()
const
noexcept
56
{
57
return
m_products
;
58
}
59
60
inline
std::list<size_t>
&
61
ItoKMCSurfaceReaction::getProducts
()
noexcept
62
{
63
return
m_products
;
64
}
65
66
inline
const
Real
&
67
ItoKMCSurfaceReaction::getEfficiency
()
const
noexcept
68
{
69
return
m_efficiency
;
70
}
71
72
inline
Real
&
73
ItoKMCSurfaceReaction::getEfficiency
()
noexcept
74
{
75
return
m_efficiency
;
76
}
77
78
#include <CD_NamespaceFooter.H>
79
80
#endif
CD_ItoKMCSurfaceReaction.H
Declaration of the Physics::ItoKMC::ItoKMCSurfaceReaction class.
Physics::ItoKMC::ItoKMCSurfaceReaction::getEfficiency
const Real & getEfficiency() const noexcept
Get the reaction efficiency (const).
Definition
CD_ItoKMCSurfaceReactionImplem.H:67
Physics::ItoKMC::ItoKMCSurfaceReaction::m_reactant
size_t m_reactant
Source reactant index.
Definition
CD_ItoKMCSurfaceReaction.H:110
Physics::ItoKMC::ItoKMCSurfaceReaction::m_products
std::list< size_t > m_products
Plasma product indices.
Definition
CD_ItoKMCSurfaceReaction.H:115
Physics::ItoKMC::ItoKMCSurfaceReaction::getReactant
const size_t & getReactant() const noexcept
Get the reactant species index (const).
Definition
CD_ItoKMCSurfaceReactionImplem.H:43
Physics::ItoKMC::ItoKMCSurfaceReaction::ItoKMCSurfaceReaction
ItoKMCSurfaceReaction()=default
Allowed, but you need to call the define function afterwards.
Physics::ItoKMC::ItoKMCSurfaceReaction::~ItoKMCSurfaceReaction
virtual ~ItoKMCSurfaceReaction() noexcept
Destructor.
Definition
CD_ItoKMCSurfaceReactionImplem.H:29
Physics::ItoKMC::ItoKMCSurfaceReaction::define
void define(const size_t a_reactant, const std::list< size_t > a_products, const Real a_efficiency) noexcept
Full define function.
Definition
CD_ItoKMCSurfaceReactionImplem.H:33
Physics::ItoKMC::ItoKMCSurfaceReaction::getProducts
const std::list< size_t > & getProducts() const noexcept
Get the plasma product species indices (const).
Definition
CD_ItoKMCSurfaceReactionImplem.H:55
Physics::ItoKMC::ItoKMCSurfaceReaction::m_efficiency
Real m_efficiency
Reaction efficiency.
Definition
CD_ItoKMCSurfaceReaction.H:120
TracerParticleSolver
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition
CD_TracerParticleSolver.H:38
TracerParticleSolver::TracerParticleSolver
TracerParticleSolver()
Default constructor.
Definition
CD_TracerParticleSolverImplem.H:26
Generated by
1.9.8