Cantera: Species Class Reference

Cantera 2.3.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 &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 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 23 of file Species.h.

Constructor & Destructor Documentation

◆ 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 & other )

Deprecated:: To be removed after Cantera 2.3.

Definition at line 35 of file Species.cpp.

References Species::thermo, and Cantera::warn_deprecated().

Member Function Documentation

◆ operator=()

Species & operator= ( const Species & other )

Deprecated:: To be removed after Cantera 2.3.

Definition at line 49 of file Species.cpp.

References Species::charge, Species::composition, Species::name, Species::size, Species::thermo, and Cantera::warn_deprecated().

Member Data Documentation

◆ name

std::string name

The name of the species.

Definition at line 39 of file Species.h.

Referenced by Species::operator=(), and 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 Species::operator=(), and 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.

Referenced by Species::operator=().

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

Referenced by Species::operator=().

◆ thermo

shared_ptr<SpeciesThermoInterpType> thermo

Thermodynamic data for the species.

Definition at line 55 of file Species.h.

Referenced by Species::operator=(), and Species::Species().

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