Cantera  2.4.0
Species Class Reference

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

#include <Species.h>

Collaboration diagram for Species:
[legend]

## 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...

Speciesoperator= (const Species &other)=delete

## 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< TransportDatatransport

shared_ptr< SpeciesThermoInterpTypethermo
Thermodynamic data for the species. More...

AnyMap extra
Extra data used for specific models. 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 24 of file Species.h.

## ◆ Species() [1/2]

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

Constructor.

Definition at line 22 of file Species.cpp.

## ◆ Species() [2/2]

 Species ( const Species & )
delete

Species objects are not copyable or assignable.

## ◆ name

 std::string name

The name of the species.

Definition at line 39 of file Species.h.

Referenced by GasTransportData::validate().

## ◆ composition

 compositionMap composition

The elemental composition of the species.

Keys are element names; values are the corresponding atomicities.

Definition at line 43 of file Species.h.

Referenced by GasTransportData::validate().

## ◆ charge

 double charge

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

Definition at line 46 of file Species.h.

## ◆ size

 double size

The effective size of the species.

Currently used only for surface species, where it represents the number of sites occupied.

Definition at line 50 of file Species.h.

## ◆ thermo

 shared_ptr thermo

Thermodynamic data for the species.

Definition at line 55 of file Species.h.

## ◆ extra

 AnyMap extra

Extra data used for specific models.

Definition at line 58 of file Species.h.

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