Reaction class for describing secondary emissions due to a single outgoing particle in ItoKMCPhysics.
More...
#include <CD_ItoKMCSurfaceReaction.H>
|
|
| ItoKMCSurfaceReaction ()=default |
| | Allowed, but you need to call the define function afterwards.
|
| |
| | ItoKMCSurfaceReaction (const size_t a_reactant, const std::list< size_t > a_products, const Real a_efficiency) noexcept |
| | Full constructor. Calls the define function. More...
|
| |
|
virtual | ~ItoKMCSurfaceReaction () noexcept |
| | Destructor.
|
| |
| void | define (const size_t a_reactant, const std::list< size_t > a_products, const Real a_efficiency) noexcept |
| | Full define function. More...
|
| |
|
const size_t & | getReactant () const noexcept |
| | Get the reactant.
|
| |
|
size_t & | getReactant () noexcept |
| | Get the reactant.
|
| |
|
const std::list< size_t > & | getProducts () const noexcept |
| | Get the plasma products.
|
| |
|
std::list< size_t > & | getProducts () noexcept |
| | Get the plasma products.
|
| |
|
const Real & | getEfficiency () const noexcept |
| | Get the reaction efficiency.
|
| |
|
Real & | getEfficiency () noexcept |
| | Get the reaction efficiencies.
|
| |
Reaction class for describing secondary emissions due to a single outgoing particle in ItoKMCPhysics.
This class supports multiple emissions due to single impinging particles, and encapsulates all reactions A -> B, A -> B + C, etc.
◆ ItoKMCSurfaceReaction()
| ItoKMCSurfaceReaction::ItoKMCSurfaceReaction |
( |
const size_t |
a_reactant, |
|
|
const std::list< size_t > |
a_products, |
|
|
const Real |
a_efficiency |
|
) |
| |
|
inlinenoexcept |
Full constructor. Calls the define function.
- Parameters
-
| [in] | a_reactant | Index in the list of plasma or photon species that triggers the reaction. |
| [in] | a_products | List of plasma species potentially generated by the reaction. |
| [in] | a_efficiency | Reaction efficiency |
◆ define()
| void ItoKMCSurfaceReaction::define |
( |
const size_t |
a_reactant, |
|
|
const std::list< size_t > |
a_products, |
|
|
const Real |
a_efficiency |
|
) |
| |
|
inlinenoexcept |
Full define function.
- Parameters
-
| [in] | a_reactant | Index in the list of plasma or photon species that triggers the reaction. |
| [in] | a_products | List of plasma species potentially generated by the reaction. |
| [in] | a_efficiency | Reaction efficiency |
The documentation for this class was generated from the following files:
