chombo-discharge
Public Member Functions | Protected Attributes | List of all members
Physics::ItoPlasma::ItoPlasmaPhotoReaction Class Reference

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

#include <CD_ItoPlasmaPhotoReaction.H>

Public Member Functions

 ItoPlasmaPhotoReaction ()=default
 Allowed, but you need to call the define function afterwards.
 
 ItoPlasmaPhotoReaction (const size_t a_source, const std::list< size_t > a_targets) noexcept
 Full constructor. Calls the define function. More...
 
virtual ~ItoPlasmaPhotoReaction () noexcept
 Destructor.
 
void define (const size_t a_source, const std::list< size_t > a_targets) 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.
 

Protected Attributes

size_t m_source
 Source photon index.
 
std::list< size_t > m_targets
 Plasma product indices.
 

Detailed Description

Reaction class for describing photoionization in ItoPlasmaPhysics.

Constructor & Destructor Documentation

◆ ItoPlasmaPhotoReaction()

ItoPlasmaPhotoReaction::ItoPlasmaPhotoReaction ( const size_t  a_source,
const std::list< size_t >  a_targets 
)
inlinenoexcept

Full constructor. Calls the define function.

Parameters
[in]a_sourceIndex in the list of photon species that leads to a photo-reaction
[in]a_targetsList of plasma species generated by the photo-reaction.

Member Function Documentation

◆ define()

void ItoPlasmaPhotoReaction::define ( const size_t  a_source,
const std::list< size_t >  a_targets 
)
inlinenoexcept

Define function.

Parameters
[in]a_sourceIndex in the list of photon species that leads to a photo-reaction
[in]a_targetsList of plasma species generated by the photo-reaction.

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