research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Correct documentation relating to species "size"

Browse source
This commit is contained in:
Ray Speth 2016-06-29 16:36:47 -04:00
parent b31e9a1bf1
commit b26b8c4bab
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
include/cantera/thermo/Phase.h
View file

@ -401,8 +401,14 @@ public:
const vector_fp& molecularWeights() const;
//! This routine returns the size of species k
//!
//! The meaning and dimensions are model-dependent. For surface phases, the
//! size is the number of sites occupied by one molecule of the species
//! [nondimensional]. For models which utilize the species partial molar
//! volumes, this is the molar volume of the species in its reference state.
//! For other models, this value may have no meaning.
//! @param k index of the species
//! @return The size of the species. Units are meters.
//! @return The size of the species
doublereal size(size_t k) const {
return m_speciesSize[k];
}
@ -785,7 +791,8 @@ protected:
vector_fp m_speciesComp;
//!Vector of species sizes. length m_kk. Used in some equations of state
//! which employ the constant partial molar volume approximation.
//! which employ the constant partial molar volume approximation, and for
//! surface phases.
vector_fp m_speciesSize;
vector_fp m_speciesCharge; //!< Vector of species charges. length m_kk.

3
include/cantera/thermo/Species.h
View file

@ -40,7 +40,8 @@ public:
//! The electrical charge on the species, in units of the elementary charge.
double charge;
//! The effective size [m] of the species
//! The effective size of the species. Currently used only for surface
//! species, where it represents the number of sites occupied.
double size;
shared_ptr<TransportData> transport;