chombo-discharge
Loading...
Searching...
No Matches
CD_ItoKMCPhotoReactionImplem.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// Our includes
14#ifndef CD_ITOKMCPHOTOREACTIONIMPLEM_H
15#define CD_ITOKMCPHOTOREACTIONIMPLEM_H
16
18#include <CD_NamespaceHeader.H>
19
20using namespace Physics::ItoKMC;
21
24 const Real a_efficiency) noexcept
25{
26 this->define(a_source, a_targets, a_efficiency);
27}
28
31
32inline void
34{
35 m_source = a_source;
36 m_targets = a_targets;
37 m_efficiency = a_efficiency;
38
39 const std::string baseError = "CD_ItoKMCPhotoReactionImplem.H in function ";
40 if (m_efficiency < 0.0) {
41 const std::string derivError = "'ItoKMCPhotoReaction::define' - efficiency must be >= 0.0";
42
43 MayDay::Error((baseError + derivError).c_str());
44 }
45}
46
47inline const size_t&
52
53inline const std::list<size_t>&
58
59inline const Real&
64
65#include <CD_NamespaceFooter.H>
66
67#endif
Declaration of the Physics::ItoKMC::ItoKMCPhotoReaction class.
const Real & getEfficiency() const noexcept
Get the reaction efficiency.
Definition CD_ItoKMCPhotoReactionImplem.H:60
void define(const size_t a_source, const std::list< size_t > a_targets, const Real a_efficiency=1.0) noexcept
Define the photo-reaction.
Definition CD_ItoKMCPhotoReactionImplem.H:33
const size_t & getSourcePhoton() const noexcept
Get the source photon species index.
Definition CD_ItoKMCPhotoReactionImplem.H:48
virtual ~ItoKMCPhotoReaction() noexcept
Destructor.
Definition CD_ItoKMCPhotoReactionImplem.H:29
size_t m_source
Source photon index.
Definition CD_ItoKMCPhotoReaction.H:90
std::list< size_t > m_targets
Plasma product indices.
Definition CD_ItoKMCPhotoReaction.H:95
Real m_efficiency
Reaction efficiency.
Definition CD_ItoKMCPhotoReaction.H:100
const std::list< size_t > & getTargetSpecies() const noexcept
Get the plasma product species indices.
Definition CD_ItoKMCPhotoReactionImplem.H:54
ItoKMCPhotoReaction()=default
Allowed, but you need to call the define function afterwards.
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38
TracerParticleSolver()
Default constructor.
Definition CD_TracerParticleSolverImplem.H:26