Doxygen update.

This commit is contained in:
Harry Moffat 2009-10-21 00:10:48 +00:00
parent 60c4b40d32
commit e64a381754
7 changed files with 13 additions and 12 deletions

View file

@ -104,7 +104,7 @@ namespace Cantera {
* water (IAPWS 1995 formulation) is used as its standard state. * water (IAPWS 1995 formulation) is used as its standard state.
* All standard state properties for the solvent are based on * All standard state properties for the solvent are based on
* this real model for water, and involve function calls * this real model for water, and involve function calls
* to the object that handles the real water model, #WaterPropsIAPWS. * to the object that handles the real water model, #Cantera::WaterPropsIAPWS.
* *
* The standard states for solutes are on the unit molality basis. * The standard states for solutes are on the unit molality basis.
* Therefore, in the documentation below, the normal \f$ o \f$ * Therefore, in the documentation below, the normal \f$ o \f$

View file

@ -1,12 +1,12 @@
/** /**
* @file PDSS_SSVol.h * @file PDSS_SSVol.h
* Declarations for the class PDSS_SSVol (pressure dependent standard state) * Declarations for the class PDSS_SSVol (pressure dependent standard state)
* which handles calculations for a single species with an expression for the molar volume in a phase * which handles calculations for a single species with an expression for the standard state molar volume in a phase
* given by an enumerated data type * given by an enumerated data type
* (see class \ref pdssthermo and \link Cantera::PDSS_SSVol PDSS_SSVol\endlink). * (see class \ref pdssthermo and \link Cantera::PDSS_SSVol PDSS_SSVol\endlink).
*/ */
/* /*
* Copywrite (2006) Sandia Corporation. Under the terms of * Copywrite (2009) Sandia Corporation. Under the terms of
* Contract DE-AC04-94AL85000 with Sandia Corporation, the * Contract DE-AC04-94AL85000 with Sandia Corporation, the
* U.S. Government retains certain rights in this software. * U.S. Government retains certain rights in this software.
*/ */
@ -23,9 +23,10 @@ namespace Cantera {
class XML_Node; class XML_Node;
class VPStandardStateTP; class VPStandardStateTP;
//! Class for pressure dependent standard states that use a constant volume model //! Class for pressure dependent standard states that uses a standard state volume
//! model of some sort.
/*! /*!
* Class for pressure dependent standard states that use a constant volume model. *
* *
* *
* @ingroup pdssthermo * @ingroup pdssthermo

View file

@ -495,7 +495,7 @@ namespace Cantera {
// Parameters for the viscosityWater() function // Parameters for the viscosityWater() function
//@{
const double H[4] = {1., const double H[4] = {1.,
0.978197, 0.978197,
0.579829, 0.579829,
@ -514,7 +514,7 @@ namespace Cantera {
const double rhoStar = 317.763; // kg / m3 const double rhoStar = 317.763; // kg / m3
const double presStar = 22.115E6; // Pa const double presStar = 22.115E6; // Pa
const double muStar = 55.071E-6; //Pa s const double muStar = 55.071E-6; //Pa s
//@}
// Returns the viscosity of water at the current conditions // Returns the viscosity of water at the current conditions
// (kg/m/s) // (kg/m/s)

View file

@ -2,7 +2,7 @@
* @file WaterPropsIAPWS.cpp * @file WaterPropsIAPWS.cpp
* Definitions for a class for calculating the equation of state of water * Definitions for a class for calculating the equation of state of water
* from the IAPWS 1995 Formulation based on the steam tables thermodynamic * from the IAPWS 1995 Formulation based on the steam tables thermodynamic
* basis (See class \link WaterPropsIAPWS WaterPropsIAPWS\endlink). * basis (See class \link Cantera::WaterPropsIAPWS WaterPropsIAPWS\endlink).
*/ */
/* /*
* Copywrite (2006) Sandia Corporation. Under the terms of * Copywrite (2006) Sandia Corporation. Under the terms of

View file

@ -2,7 +2,7 @@
* @file WaterPropsIAPWS.h * @file WaterPropsIAPWS.h
* Headers for a class for calculating the equation of state of water * Headers for a class for calculating the equation of state of water
* from the IAPWS 1995 Formulation based on the steam tables thermodynamic * from the IAPWS 1995 Formulation based on the steam tables thermodynamic
* basis (See class \link WaterPropsIAPWS WaterPropsIAPWS\endlink). * basis (See class \link Cantera::WaterPropsIAPWS WaterPropsIAPWS\endlink).
*/ */
/* /*
* Copywrite (2005) Sandia Corporation. Under the terms of * Copywrite (2005) Sandia Corporation. Under the terms of

View file

@ -1,7 +1,7 @@
/** /**
* @file WaterPropsIAPWSphi.cpp * @file WaterPropsIAPWSphi.cpp
* Definitions for Lowest level of the classes which support a real water model * Definitions for Lowest level of the classes which support a real water model
* (see class #WaterPropsIAPWS and class #WaterPropsIAPWSphi). * (see class \link Cantera::WaterPropsIAPWS WaterPropsIAPWS\endlink and class #WaterPropsIAPWSphi).
*/ */
/* /*
* Copywrite (2006) Sandia Corporation. Under the terms of * Copywrite (2006) Sandia Corporation. Under the terms of

View file

@ -1,7 +1,7 @@
/** /**
* @file WaterPropsIAPWSphi.h * @file WaterPropsIAPWSphi.h
* Header for Lowest level of the classes which support a real water model * Header for Lowest level of the classes which support a real water model
* (see class #WaterPropsIAPWS and class #WaterPropsIAPWSphi). * (see class \link Cantera::WaterPropsIAPWS WaterPropsIAPWS\endlink and class \link WaterPropsIAPWSphi WaterPropsIAPWSphi\endlink).
* *
* This class calculates dimensionless quantitites. * This class calculates dimensionless quantitites.
*/ */