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

Fixed incorrect documentation for getPureGibbs in some classes

Browse source
This commit is contained in:
Ray Speth 2012-03-01 00:44:22 +00:00
parent cf388bde90
commit 8161a9aa5a
2 changed files with 7 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
include/cantera/thermo/MixtureFugacityTP.h
View file

@ -281,21 +281,11 @@ public:
*/
virtual void getGibbs_RT(doublereal* grt) const;
//! Get the nondimensional Gibbs functions for the standard
//! state of the species at the current T and P.
/*!
* For all objects with the Mixture Fugacity approximation, we define the
* standard state as an ideal gas at the current temperature and pressure
* of the solution.
*
* @param gpure Output vector of standard state
* Gibbs free energies. length = m_kk.
* units are J/kmol.
*
* @todo This could be eliminated. It doesn't fit into the current
* naming convention.
*/
//! Get the pure Gibbs free energies of each species.
//! Species are assumed to be in their standard states. This is the same
//! as getStandardChemPotentials().
//! @param gpure[out] Array of standard state Gibbs free energies.
//! length = m_kk. units are J/kmol.
void getPureGibbs(doublereal* gpure) const;
//! Returns the vector of nondimensional internal Energies of the standard state at the current temperature

8
include/cantera/thermo/VPStandardStateTP.h
View file

@ -216,18 +216,14 @@ public:
*/
virtual void getGibbs_RT(doublereal* grt) const;
//! Get the nondimensional Gibbs functions for the standard
//! state of the species at the current T and P.
//! Get the standard state Gibbs functions for each species
//! at the current T and P.
/*!
* (Note resolved at this level)
*
* @param gpure Output vector of standard state
* Gibbs free energies. length = m_kk.
* units are J/kmol.
*
* @todo This could be eliminated. It doesn't fit into the current
* naming convention.
*/
void getPureGibbs(doublereal* gpure) const;