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_CdrPlasmaSurfaceReactionJSON.H>

Public Member Functions
	CdrPlasmaSurfaceReactionJSON ()
	Disallowed weak construction.

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

virtual	~CdrPlasmaSurfaceReactionJSON ()
	Destructor.

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

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

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

Protected Attributes
std::list< int >	m_plasmaReactants
	Plasma 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.

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.

This class is specifically for surface reactions. When including more species on the left hand side, e.g. A + B -> C, it is the same as specifying A -> C, B -> C with equal reaction rates.

Constructor & Destructor Documentation

◆ CdrPlasmaSurfaceReactionJSON()

CdrPlasmaSurfaceReactionJSON::CdrPlasmaSurfaceReactionJSON	(	const std::list< int >	a_plasmaReactants,
		const std::list< int >	a_photonReactants,
		const std::list< int >	a_plasmaProducts
	)

Full constructor.

Parameters

[in]	a_plasmaReactants	Plasma 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.

Member Function Documentation

◆ getPhotonReactants()

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

Get the photo-reactants.

Returns: Returns m_photonReactants

◆ getPlasmaProducts()

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

Get the plasma products.

Returns: Returns m_plasmaProducts

◆ getPlasmaReactants()

const std::list< int > & CdrPlasmaSurfaceReactionJSON::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_CdrPlasmaSurfaceReactionJSON.H
Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaSurfaceReactionJSON.cpp

Public Member Functions