Cantera 2.6.0
|
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 &)=delete | |
Species objects are not copyable or assignable. More... | |
Species & | operator= (const Species &other)=delete |
AnyMap | parameters (const ThermoPhase *phase=0, bool withInput=true) const |
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 of the species. More... | |
shared_ptr< TransportData > | transport |
shared_ptr< SpeciesThermoInterpType > | thermo |
Thermodynamic data for the species. More... | |
AnyMap | input |
Input parameters used to define a species, for example from a YAML input file. More... | |
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.
Species | ( | ) |
Definition at line 19 of file Species.cpp.
Species | ( | const std::string & | name, |
const compositionMap & | comp, | ||
double | charge = 0.0 , |
||
double | size = 1.0 |
||
) |
Constructor.
Definition at line 25 of file Species.cpp.
~Species | ( | ) |
Definition at line 34 of file Species.cpp.
AnyMap parameters | ( | const ThermoPhase * | phase = 0 , |
bool | withInput = true |
||
) | const |
Definition at line 38 of file Species.cpp.
std::string name |
The name of the species.
Definition at line 42 of file Species.h.
Referenced by VPStandardStateTP::installPDSS(), and GasTransportData::validate().
compositionMap composition |
The elemental composition of the species.
Keys are element names; values are the corresponding atomicities.
Definition at line 46 of file Species.h.
Referenced by GasTransportData::validate().
double charge |
double size |
shared_ptr<TransportData> transport |
shared_ptr<SpeciesThermoInterpType> thermo |
Thermodynamic data for the species.
Definition at line 58 of file Species.h.
Referenced by VPStandardStateTP::installPDSS().
AnyMap input |