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. More...
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 function. More...
const size_t &	getSourcePhoton () const noexcept
	Get the photon source.
const std::list< size_t > &	getTargetSpecies () const noexcept
	Get the photon target products.
const Real &	getEfficiency () const noexcept
	Get 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 function.

The reaction efficiency matters if multiple reactions using the same photon species as the left hand side are specified. If this is the case, the user should also ensure

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.

---

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

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