Physics::ItoKMC::ItoKMCPhotoReaction Class Reference

Reaction class for describing photoionization in ItoKMCPhysics. More...

#include <CD_ItoKMCPhotoReaction.H>

Public Member Functions
	ItoKMCPhotoReaction ()=default
	Allowed, but you need to call the define function afterwards.
	ItoKMCPhotoReaction (const size_t a_source, const std::list< size_t > a_targets, const Real a_efficiency=1.0) noexcept
	Full constructor. Calls the define function.
virtual	~ItoKMCPhotoReaction () noexcept
	Destructor.
void	define (const size_t a_source, const std::list< size_t > a_targets, const Real a_efficiency=1.0) noexcept
	Define the photo-reaction.
const size_t &	getSourcePhoton () const noexcept
	Get the source photon species index.
const std::list< size_t > &	getTargetSpecies () const noexcept
	Get the plasma product species indices.
const Real &	getEfficiency () const noexcept
	Get the reaction efficiency.

Protected Attributes
size_t	m_source
	Source photon index.
std::list< size_t >	m_targets
	Plasma product indices.
Real	m_efficiency
	Reaction efficiency.

Detailed Description

Reaction class for describing photoionization in ItoKMCPhysics.

Constructor & Destructor Documentation

ItoKMCPhotoReaction()

ItoKMCPhotoReaction::ItoKMCPhotoReaction ( const size_t  a_source, const std::list< size_t >  a_targets, const Real  a_efficiency = 1.0  )

inlinenoexcept

Full constructor. Calls the define function.

Parameters

[in]	a_source	Index in the list of photon species that leads to a photo-reaction
[in]	a_targets	List of plasma species generated by the photo-reaction.
[in]	a_efficiency	Reaction efficiency.

Member Function Documentation

define()

void ItoKMCPhotoReaction::define ( const size_t  a_source, const std::list< size_t >  a_targets, const Real  a_efficiency = 1.0  )

inlinenoexcept

Define the photo-reaction.

The reaction efficiency matters when multiple reactions share the same source photon species; in that case the probabilities should sum to 1 across all competing reactions.

Parameters

[in]	a_source	Index of the source photon species in the species list.
[in]	a_targets	Indices of plasma species produced by the reaction.
[in]	a_efficiency	Probability that an absorbed photon triggers this reaction.

getEfficiency()

const Real & ItoKMCPhotoReaction::getEfficiency ( ) const

inlinenoexcept

Get the reaction efficiency.

Returns

Probability that an absorbed photon triggers this reaction.

getSourcePhoton()

const size_t & ItoKMCPhotoReaction::getSourcePhoton ( ) const

inlinenoexcept

Get the source photon species index.

Returns

Index into the photon species list that triggers this reaction.

getTargetSpecies()

const std::list< size_t > & ItoKMCPhotoReaction::getTargetSpecies ( ) const

inlinenoexcept

Get the plasma product species indices.

Returns

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

---

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

• Physics/ItoKMC/CD_ItoKMCPhotoReaction.H
• Physics/ItoKMC/CD_ItoKMCPhotoReactionImplem.H