Physics::CdrPlasma::CdrPlasmaReactionJSON Class Reference

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

#include <CD_CdrPlasmaReactionJSON.H>

Public Member Functions
	CdrPlasmaReactionJSON ()=delete
	Disallowed weak construction.
	CdrPlasmaReactionJSON (const std::list< int > a_plasmaReactants, const std::list< int > a_neutralReactants, const std::list< int > a_plasmaProducts, const std::list< int > a_photonProducts)
	Full constructor. More...
virtual	~CdrPlasmaReactionJSON ()
	Destructor.
const std::list< int > &	getPlasmaReactants () const
	Get the plasma reactants. More...
const std::list< int > &	getNeutralReactants () const
	Get the neutral reactants. More...
const std::list< int > &	getPlasmaProducts () const
	Get the plasma products. More...
const std::list< int > &	getPhotonProducts () const
	Get the photon products. More...

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_plasmaProducts
	Particles on the right-hand side of the reaction.
std::list< int >	m_photonProducts
	Photons on the right-hand side of the reaction.

Detailed Description

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

Constructor & Destructor Documentation

CdrPlasmaReactionJSON()

CdrPlasmaReactionJSON::CdrPlasmaReactionJSON	(	const std::list< int >	a_plasmaReactants,
		const std::list< int >	a_neutralReactants,
		const std::list< int >	a_plasmaProducts,
		const std::list< int >	a_photonProducts
	)

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_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

getNeutralReactants()

const std::list< int > & CdrPlasmaReactionJSON::getNeutralReactants

(

)

const

Get the neutral reactants.

Returns

Returns m_neutralReactants

getPhotonProducts()

const std::list< int > & CdrPlasmaReactionJSON::getPhotonProducts

(

)

const

Get the photon products.

Returns

Returns m_photonProducts

getPlasmaProducts()

const std::list< int > & CdrPlasmaReactionJSON::getPlasmaProducts

(

)

const

Get the plasma products.

Returns

Returns m_plasmaProducts

getPlasmaReactants()

const std::list< int > & CdrPlasmaReactionJSON::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_CdrPlasmaReactionJSON.H
• Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaReactionJSON.cpp