chombo-discharge
Public Types | Public Member Functions | Protected Attributes | List of all members
Physics::ItoKMC::ItoKMCSurfaceReactions Class Reference

Reaction class for describing multiple pathways of secondary emissions due to a single outgoing particle in ItoKMCPhysics. More...

#include <CD_ItoKMCSurfaceReactions.H>

Public Types

using Products = std::list< size_t >
 Alias for list of products.
 

Public Member Functions

 ItoKMCSurfaceReactions () noexcept
 Allowed, but you need to call the define function afterwards.
 
virtual ~ItoKMCSurfaceReactions () noexcept
 Destructor.
 
void add (const ItoKMCSurfaceReaction &a_surfaceReaction) noexcept
 Add a reaction.
 
void reset () noexcept
 Reset method for clearing class.
 
const size_t & getReactant () const noexcept
 Get the reactant.
 
const std::vector< Products > & getProducts () const noexcept
 Get the plasma products for each reaction.
 
const std::vector< Real > & getEfficiencies () const noexcept
 Get the reaction efficiency.
 
std::discrete_distribution< size_t > & getDistribution () const noexcept
 Get the discrete distribution for the reaction efficiencies.
 

Protected Attributes

bool m_isDefined
 Is defined or not.
 
size_t m_reactant
 Reactant index.
 
std::vector< Productsm_products
 Plasma product indices.
 
std::vector< Real > m_efficiencies
 Reaction efficiencies.
 
std::discrete_distribution< size_t > m_distribution
 Discrete distribution – useful when drawing a reaction.
 

Detailed Description

Reaction class for describing multiple pathways of 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.


The documentation for this class was generated from the following files: