Species Class Reference

Contains data about a single chemical species. More...

#include <Species.h>

Public Member Functions
	Species (const std::string &name, const compositionMap &comp, double charge=0.0, double size=1.0)
	Constructor. More...
	Species (const Species &other)
Species &	operator= (const Species &other)

Public Attributes
std::string	name
	The name of the species. More...
compositionMap	composition
	The elemental composition of the species. More...
double	charge
	The electrical charge on the species, in units of the elementary charge. More...
double	size
	The effective size [m] of the species. More...
shared_ptr< TransportData >	transport
shared_ptr < SpeciesThermoInterpType >	thermo
	Thermodynamic data for the species. More...

Detailed Description

Contains data about a single chemical species.

This class stores the data about a species which may be needed to add it to a ThermoPhase or Transport object.

Definition at line 21 of file Species.h.

Constructor & Destructor Documentation

Species	(	const std::string &	name,
		const compositionMap &	comp,
		double	charge = 0.0,
		double	size = 1.0
	)

Constructor.

Definition at line 20 of file Species.cpp.

Member Data Documentation

std::string name

The name of the species.

Definition at line 35 of file Species.h.

Referenced by GasTransportData::validate().

compositionMap composition

The elemental composition of the species.

Keys are element names; values are the corresponding atomicities.

Definition at line 39 of file Species.h.

Referenced by GasTransportData::validate().

double charge

The electrical charge on the species, in units of the elementary charge.

Definition at line 42 of file Species.h.

double size

The effective size [m] of the species.

Definition at line 45 of file Species.h.

shared_ptr<SpeciesThermoInterpType> thermo

Thermodynamic data for the species.

Definition at line 50 of file Species.h.

---

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

• Species.h
• Species.cpp