Reaktoro 
A unified framework for modeling chemically reactive systems
Reaktoro::MineralSpecies Class Reference

Detailed Description

A type to describe the attributes of a mineral species.

#include <MineralSpecies.hpp>

Inheritance diagram for Reaktoro::MineralSpecies:
Collaboration diagram for Reaktoro::MineralSpecies:

Public Member Functions

 MineralSpecies ()
 Construct a default MineralSpecies instance.
 
 MineralSpecies (const Species &species)
 Construct an MineralSpecies instance from a Species instance.
 
auto setThermoData (const MineralSpeciesThermoData &thermo) -> void
 Set the thermodynamic data of the mineral species.
 
auto thermoData () const -> const MineralSpeciesThermoData &
 Return the thermodynamic data of the mineral species.
 
- Public Member Functions inherited from Reaktoro::Species
 Species ()
 Construct a default Species instance.
 
auto setName (std::string name) -> void
 Set the name of the species.
 
auto setFormula (std::string formula) -> void
 Set the formula of the species.
 
auto setElements (const std::map< Element, double > &elements) -> void
 Set the elements of the species.
 
auto numElements () const -> unsigned
 Return the number of elements of the species.
 
auto name () const -> std::string
 Return the name of the species.
 
auto formula () const -> std::string
 Return the formula of the species.
 
auto elements () const -> const std::map< Element, double > &
 Return the elements that compose the species and their coefficients.
 
auto molarMass () const -> double
 Return the molar mass of the species (in units of kg/mol).
 
auto charge () const -> double
 Return the electrical charge of the species.
 
auto elementCoefficient (std::string element) const -> double
 Return the stoichiometry of an element in the species.
 

The documentation for this class was generated from the following files:
  • Reaktoro/Thermodynamics/Species/MineralSpecies.hpp
  • Reaktoro/Thermodynamics/Species/MineralSpecies.cpp