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 species index (const).
size_t &	getReactant () noexcept
	Get the reactant species index (mutable).
const std::list< size_t > &	getProducts () const noexcept
	Get the plasma product species indices (const).
std::list< size_t > &	getProducts () noexcept
	Get the plasma product species indices (mutable).
const Real &	getEfficiency () const noexcept
	Get the reaction efficiency (const).
Real &	getEfficiency () noexcept
	Get the reaction efficiency (mutable).

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

getEfficiency() [1/2]

const Real & ItoKMCSurfaceReaction::getEfficiency ( ) const

inlinenoexcept

Get the reaction efficiency (const).

Returns

Probability that an impinging particle triggers this reaction.

getEfficiency() [2/2]

Real & ItoKMCSurfaceReaction::getEfficiency ( )

inlinenoexcept

Get the reaction efficiency (mutable).

Returns

Probability that an impinging particle triggers this reaction.

getProducts() [1/2]

const std::list< size_t > & ItoKMCSurfaceReaction::getProducts ( ) const

inlinenoexcept

Get the plasma product species indices (const).

Returns

List of indices into the plasma species list produced by this reaction.

getProducts() [2/2]

std::list< size_t > & ItoKMCSurfaceReaction::getProducts ( )

inlinenoexcept

Get the plasma product species indices (mutable).

Returns

List of indices into the plasma species list produced by this reaction.

getReactant() [1/2]

const size_t & ItoKMCSurfaceReaction::getReactant ( ) const

inlinenoexcept

Get the reactant species index (const).

Returns

Index into the plasma/photon species list that triggers this reaction.

getReactant() [2/2]

size_t & ItoKMCSurfaceReaction::getReactant ( )

inlinenoexcept

Get the reactant species index (mutable).

Returns

Index into the plasma/photon species list that triggers this reaction.

---

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

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