ElectronCollisionPlasmaData Struct Reference

Data container holding shared data specific to ElectronCollisionPlasmaRate. More...

#include <ElectronCollisionPlasmaRate.h>

Inheritance diagram for ElectronCollisionPlasmaData:

Detailed Description

Data container holding shared data specific to ElectronCollisionPlasmaRate.

The data container ElectronCollisionPlasmaData holds precalculated data common to all ElectronCollisionPlasmaRate objects.

Definition at line 23 of file ElectronCollisionPlasmaRate.h.

Public Member Functions
virtual bool	update (const ThermoPhase &phase, const Kinetics &kin) override
	Update data container based on thermodynamic phase state.
virtual void	invalidateCache () override
	Force shared data and reaction rates to be updated next time.
virtual void	update (double T)
	Update data container based on temperature T
virtual void	update (double T, double extra)
	Update data container based on temperature T and an extra parameter.
virtual void	update (double T, const vector< double > &extra)
	Update data container based on temperature T and a vector parameter extra
virtual bool	update (const ThermoPhase &phase, const Kinetics &kin)=0
	Update data container based on thermodynamic phase state.
Public Member Functions inherited from ReactionData
virtual void	update (double T)
	Update data container based on temperature T
virtual void	update (double T, double extra)
	Update data container based on temperature T and an extra parameter.
virtual void	update (double T, const vector< double > &extra)
	Update data container based on temperature T and a vector parameter extra
virtual bool	update (const ThermoPhase &phase, const Kinetics &kin)=0
	Update data container based on thermodynamic phase state.
void	perturbTemperature (double deltaT)
	Perturb temperature of data container.
virtual void	restore ()
	Restore data container after a perturbation.
virtual void	resize (size_t nSpecies, size_t nReactions, size_t nPhases)
	Update number of species, reactions and phases.
virtual void	invalidateCache ()
	Force shared data and reaction rates to be updated next time.

Public Attributes
vector< double >	energyLevels
	electron energy levels
vector< double >	distribution
	electron energy distribution
bool	levelChanged
Public Attributes inherited from ReactionData
double	temperature = 1.0
	temperature
double	logT = 0.0
	logarithm of temperature
double	recipT = 1.0
	inverse of temperature

Protected Attributes
int	m_dist_number = -1
	integer that is incremented when electron energy distribution changes
int	m_level_number = -1
	integer that is incremented when electron energy level changes
Protected Attributes inherited from ReactionData
double	m_temperature_buf = -1.0
	buffered temperature

Constructor & Destructor Documentation

ElectronCollisionPlasmaData()

ElectronCollisionPlasmaData

(

)

Definition at line 14 of file ElectronCollisionPlasmaRate.cpp.

Member Function Documentation

update() [1/5]

bool update ( const ThermoPhase &  phase, const Kinetics &  kin  )

overridevirtual

Update data container based on thermodynamic phase state.

This update mechanism is used by Kinetics reaction rate evaluators.

Returns

A boolean element indicating whether the evalFromStruct method needs to be called (assuming previously-calculated values were cached)

Implements ReactionData.

Definition at line 20 of file ElectronCollisionPlasmaRate.cpp.

invalidateCache()

virtual void invalidateCache ( )

inlineoverridevirtual

Force shared data and reaction rates to be updated next time.

This is called by functions that change quantities affecting rate calculations that are normally assumed to be constant, like the reaction rate parameters or the number of reactions.

Reimplemented from ReactionData.

Definition at line 30 of file ElectronCollisionPlasmaRate.h.

update() [2/5]

virtual void update ( double  T )

inlinevirtual

Update data container based on temperature T

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Reimplemented from ReactionData.

Definition at line 36 of file ReactionData.h.

update() [3/5]

virtual void update ( double  T, double  extra  )

inlinevirtual

Update data container based on temperature T and an extra parameter.

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Reimplemented from ReactionData.

Definition at line 48 of file ReactionData.h.

update() [4/5]

virtual void update ( double  T, const vector< double > &  extra  )

inlinevirtual

Update data container based on temperature T and a vector parameter extra

Only used in conjunction with MultiRateBase::evalSingle / ReactionRate::eval. This method allows for testing of a reaction rate expression outside of Kinetics reaction rate evaluators.

Warning

This method is an experimental part of the Cantera API and may be changed or removed without notice.

Reimplemented from ReactionData.

Definition at line 62 of file ReactionData.h.

update() [5/5]

virtual bool update ( const ThermoPhase &  phase, const Kinetics &  kin  )

virtual

Update data container based on thermodynamic phase state.

This update mechanism is used by Kinetics reaction rate evaluators.

Returns

A boolean element indicating whether the evalFromStruct method needs to be called (assuming previously-calculated values were cached)

Implements ReactionData.

Member Data Documentation

energyLevels

vector<double> energyLevels

electron energy levels

Definition at line 36 of file ElectronCollisionPlasmaRate.h.

distribution

vector<double> distribution

electron energy distribution

Definition at line 37 of file ElectronCollisionPlasmaRate.h.

levelChanged

bool levelChanged

Definition at line 38 of file ElectronCollisionPlasmaRate.h.

m_dist_number

int m_dist_number = -1

protected

integer that is incremented when electron energy distribution changes

Definition at line 42 of file ElectronCollisionPlasmaRate.h.

m_level_number

int m_level_number = -1

protected

integer that is incremented when electron energy level changes

Definition at line 45 of file ElectronCollisionPlasmaRate.h.

---

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

• ElectronCollisionPlasmaRate.h
• ElectronCollisionPlasmaRate.cpp