Doxygen updates

Started to document new PDSS formulations
This commit is contained in:
Harry Moffat 2009-10-21 01:02:44 +00:00
parent 70ea5d84d2
commit d5b74320ac
4 changed files with 23 additions and 12 deletions

View file

@ -257,15 +257,7 @@ namespace Cantera {
return 0;
}
//@}
/// @name Properties of the Standard State of the Species in the Solution
//@{
//@}
/// @name Thermodynamic Values for the Species Reference States
//@{
double GibbsExcessVPSSTP::checkMFSum(const doublereal * const x) const {
doublereal norm = accumulate(x, x + m_kk, 0.0);

View file

@ -1,9 +1,9 @@
/**
* @file gibbsExcessVPSSTP.h
* @file GibbsExcessVPSSTP.h
* Header for intermediate ThermoPhase object for phases which
* employ gibbs excess free energy based formulations
* (see \ref thermoprops
* and class \link Cantera::gibbsExcessVPSSTP gibbsExcessVPSSTP\endlink).
* and class \link Cantera::GibbsExcessVPSSTP GibbsExcessVPSSTP\endlink).
*
* Header file for a derived class of ThermoPhase that handles
* variable pressure standard state methods for calculating
@ -517,6 +517,10 @@ namespace Cantera {
protected:
//! utility routine to check mole fraction sum
/*!
* @param x vector of mole fractions.
*/
double checkMFSum(const doublereal * const x) const;
protected:

View file

@ -1,5 +1,5 @@
/**
* @file Margules.h
* @file MargulesVPSSTP.h
* Header for intermediate ThermoPhase object for phases which
* employ gibbs excess free energy based formulations
* (see \ref thermoprops

View file

@ -100,6 +100,21 @@ namespace Cantera {
* pressure dependencies to these thermo functions.
* .
*
* - PDSS_SSVol
* - standardState model = "constant_incompressible" || model == "constant"
* - standardState model = "temperature_polynomial"
* - standardState model = "density_temperature_polynomial"
* - This model assumes that the species in the phase obey a
* fairly general equation of state, but one that separates out
* the calculation of the standard state density and/or volume.
* Models include a cubic polynomial in temperature for either
* the standard state volume or the standard state density.
* The manager uses a SimpleThermo object to handle the
* calculation of the reference state. This object then adds the
* pressure dependencies and the volume terms to these thermo functions
* to complete the representation.
* .
*
* - PDSS_Water_
* - standardState model = "Water"
* - This model assumes that