Class for holding a set of surface reactions. More...

Public Types
enum class	Surface { Dielectric , Electrode }
	Local enum for specifying surface type.

enum class	Species { Plasma , Photon }
	Local enum for specifying species type.

Public Member Functions
	ItoKMCSurfaceReactionSet ()=default
	Allowed, but you need to call the define function afterwards.

virtual	~ItoKMCSurfaceReactionSet () noexcept
	Destructor.

void	add (const size_t a_speciesIndex, const ItoKMCSurfaceReaction &a_reaction, const ItoKMCSurfaceReactionSet::Surface a_surface, const ItoKMCSurfaceReactionSet::Species a_speciesType) noexcept
	Add a surface reaction to the set.

const std::map< size_t, ItoKMCSurfaceReactions > &	getDielectricPlasmaReactions () const noexcept
	Get the dielectric surface reactions where the outgoing species is a plasma species.

const std::map< size_t, ItoKMCSurfaceReactions > &	getDielectricPhotonReactions () const noexcept
	Get the dielectric surface reactions where the outgoing species is a photon species.

const std::map< size_t, ItoKMCSurfaceReactions > &	getElectrodePlasmaReactions () const noexcept
	Get the electrode surface reactions where the outgoing species is a plasma species.

const std::map< size_t, ItoKMCSurfaceReactions > &	getElectrodePhotonReactions () const noexcept
	Get the electrode surface reactions where the outgoing species is a photon species.

Protected Attributes
std::map< size_t, ItoKMCSurfaceReactions >	m_dielectricPlasmaReactions
	Dielectric reaction set where outgoing species is a plasma species.

std::map< size_t, ItoKMCSurfaceReactions >	m_dielectricPhotonReactions
	Dielectric reaction set where outgoing species is a photon species.

std::map< size_t, ItoKMCSurfaceReactions >	m_electrodePlasmaReactions
	Electrode reaction set where outgoing species is a plasma species.

std::map< size_t, ItoKMCSurfaceReactions >	m_electrodePhotonReactions
	Electrode reaction set where outgoing species is a photon species.

Detailed Description

Class for holding a set of surface reactions.

Member Function Documentation

void ItoKMCSurfaceReactionSet::add	(	const size_t	a_speciesIndex,
		const ItoKMCSurfaceReaction &	a_reaction,
		const ItoKMCSurfaceReactionSet::Surface	a_surface,
		const ItoKMCSurfaceReactionSet::Species	a_speciesType
	)

inlinenoexcept

Add a surface reaction to the set.

Parameters

[in]	a_speciesIndex	Index of the outgoing/impinging species that triggers the reaction.
[in]	a_reaction	Reaction to add.
[in]	a_surface	Whether this is a dielectric or electrode surface.
[in]	a_speciesType	Whether the outgoing species is a plasma or photon species.

const std::map< size_t, ItoKMCSurfaceReactions > & ItoKMCSurfaceReactionSet::getDielectricPhotonReactions ( ) const

inlinenoexcept

Get the dielectric surface reactions where the outgoing species is a photon species.

Returns: Map from species index to reaction list for dielectric photon reactions.

const std::map< size_t, ItoKMCSurfaceReactions > & ItoKMCSurfaceReactionSet::getDielectricPlasmaReactions ( ) const

inlinenoexcept

Get the dielectric surface reactions where the outgoing species is a plasma species.

Returns: Map from species index to reaction list for dielectric plasma reactions.

const std::map< size_t, ItoKMCSurfaceReactions > & ItoKMCSurfaceReactionSet::getElectrodePhotonReactions ( ) const

inlinenoexcept

Get the electrode surface reactions where the outgoing species is a photon species.

Returns: Map from species index to reaction list for electrode photon reactions.

const std::map< size_t, ItoKMCSurfaceReactions > & ItoKMCSurfaceReactionSet::getElectrodePlasmaReactions ( ) const

inlinenoexcept

Get the electrode surface reactions where the outgoing species is a plasma species.

Returns: Map from species index to reaction list for electrode plasma reactions.

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