From b26b8c4bab6787c706027092410edebb09436486 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 29 Jun 2016 16:36:47 -0400 Subject: [PATCH] [Doc] Correct documentation relating to species "size" --- include/cantera/thermo/Phase.h | 11 +++++++++-- include/cantera/thermo/Species.h | 3 ++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/include/cantera/thermo/Phase.h b/include/cantera/thermo/Phase.h index 46bcb7030..2246240d1 100644 --- a/include/cantera/thermo/Phase.h +++ b/include/cantera/thermo/Phase.h @@ -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. diff --git a/include/cantera/thermo/Species.h b/include/cantera/thermo/Species.h index bd0fe1880..f12773e18 100644 --- a/include/cantera/thermo/Species.h +++ b/include/cantera/thermo/Species.h @@ -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 transport;