Physics::ItoKMC::ItoKMCSurfaceReaction Class Reference

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

#include <CD_ItoKMCSurfaceReaction.H>

Public Member Functions
	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.
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.
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.

Protected Attributes
size_t	m_reactant
	Source reactant index.
std::list< size_t >	m_products
	Plasma product indices.
Real	m_efficiency
	Reaction efficiency.

Detailed Description

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.

Constructor & Destructor Documentation

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

Member Function Documentation

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:

• Physics/ItoKMC/CD_ItoKMCSurfaceReaction.H
• Physics/ItoKMC/CD_ItoKMCSurfaceReactionImplem.H