Class for encapsulating reactive process of type A + B + Y -> X3 + for CdrPlasmaPhysics. This class just stores a list of product target species. More...

#include <CD_CdrPlasmaPhotoReactionJSON.H>

Public Member Functions
	CdrPlasmaPhotoReactionJSON ()
	Disallowed weak construction.

	CdrPlasmaPhotoReactionJSON (const std::list< int > a_plasmaReactants, const std::list< int > a_neutralReactants, const std::list< int > a_photonReactants, const std::list< int > a_plasmaProducts, const std::list< int > a_neutralProducts)
	Full constructor.

virtual	~CdrPlasmaPhotoReactionJSON ()
	Destructor.

const std::list< int > &	getPlasmaReactants () const
	Get the plasma reactants.

const std::list< int > &	getNeutralReactants () const
	Get the neutral reactants.

const std::list< int > &	getPhotonReactants () const
	Get the photo-reactants.

const std::list< int > &	getPlasmaProducts () const
	Get the plasma products.

const std::list< int > &	getNeutralProducts () const
	Get the neutral products.

Protected Attributes
std::list< int >	m_plasmaReactants
	Plasma species on the left-hand side of the reaction.

std::list< int >	m_neutralReactants
	Neutral species on the left-hand side of the reaction.

std::list< int >	m_photonReactants
	Photon species on the left-hand side of the reaction.

std::list< int >	m_plasmaProducts
	Plasma species on the right-hand side of the reaction.

std::list< int >	m_neutralProducts
	Neutral species on the right-hand side of the reaction.

Detailed Description

Class for encapsulating reactive process of type A + B + Y -> X3 + for CdrPlasmaPhysics. This class just stores a list of product target species.

Constructor & Destructor Documentation

◆ CdrPlasmaPhotoReactionJSON()

CdrPlasmaPhotoReactionJSON::CdrPlasmaPhotoReactionJSON	(	const std::list< int >	a_plasmaReactants,
		const std::list< int >	a_neutralReactants,
		const std::list< int >	a_photonReactants,
		const std::list< int >	a_plasmaProducts,
		const std::list< int >	a_neutralProducts
	)

Full constructor.

Parameters

[in]	a_plasmaReactants	Plasma species on the left-hand side of the reaction
[in]	a_neutralReactants	Neutral species on the left-hand side of the reaction
[in]	a_photonReactants	Photon species on the left hand side of the reaction.
[in]	a_plasmaProducts	Plasma species on the right-hand side of the reaction.
[in]	a_photonProducts	Photons on the right-hand side of the reaction.

Member Function Documentation

◆ getNeutralProducts()

const std::list< int > & CdrPlasmaPhotoReactionJSON::getNeutralProducts ( ) const

Get the neutral products.

Returns: Returns m_neutralProducts

◆ getNeutralReactants()

const std::list< int > & CdrPlasmaPhotoReactionJSON::getNeutralReactants ( ) const

Get the neutral reactants.

Returns: Returns m_neutralReactants

◆ getPhotonReactants()

const std::list< int > & CdrPlasmaPhotoReactionJSON::getPhotonReactants ( ) const

Get the photo-reactants.

Returns: Returns m_photonReactants

◆ getPlasmaProducts()

const std::list< int > & CdrPlasmaPhotoReactionJSON::getPlasmaProducts ( ) const

Get the plasma products.

Returns: Returns m_plasmaProducts

◆ getPlasmaReactants()

const std::list< int > & CdrPlasmaPhotoReactionJSON::getPlasmaReactants ( ) const

Get the plasma reactants.

Returns: Returns m_plasmaReactants

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

Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaPhotoReactionJSON.H
Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaPhotoReactionJSON.cpp

Public Member Functions

Protected Attributes