Contains data about a single chemical species.
More...
#include <Species.h>
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 string & |
name, |
|
|
const Composition & |
comp, |
|
|
double |
charge = 0.0 , |
|
|
double |
size = 1.0 |
|
) |
| |
◆ Species() [2/2]
Species objects are not copyable or assignable.
◆ molecularWeight()
double molecularWeight |
( |
| ) |
|
The molecular weight [amu] of the species.
Calculates and sets the molecular weight from the elemental composition of the species and element definitions in Elements.cpp, if the molecular weight is Undef.
- Since
- New in version 3.0
Definition at line 29 of file Species.cpp.
◆ setMolecularWeight()
void setMolecularWeight |
( |
double |
weight | ) |
|
Set the molecular weight of the species.
Since phases can have custom element weights, the phase will always call this method when a species is added to that phase. The species may also call this method the first time the molecularWeight() method is called if the species has not been added to a phase.
- Parameters
-
weight | The weight of this species to assign |
- Since
- New in version 3.0
Definition at line 48 of file Species.cpp.
◆ name
The name of the species.
Definition at line 41 of file Species.h.
◆ composition
The elemental composition of the species.
Keys are element names; values are the corresponding atomicities.
Definition at line 45 of file Species.h.
◆ charge
The electrical charge on the species, in units of the elementary charge.
Definition at line 48 of file Species.h.
◆ size
The effective size of the species.
Currently used only for surface species, where it represents the number of sites occupied.
Definition at line 52 of file Species.h.
◆ thermo
Thermodynamic data for the species.
Definition at line 80 of file Species.h.
◆ input
Input parameters used to define a species, for example from a YAML input file.
Definition at line 83 of file Species.h.
◆ m_molecularWeight
double m_molecularWeight = Undef |
|
protected |
The molecular weight of the species, in atomic mass units.
Includes electron mass for charged species.
Definition at line 89 of file Species.h.
The documentation for this class was generated from the following files: