doxygen commits.

This commit is contained in:
Harry Moffat 2009-01-02 20:04:17 +00:00
parent 1cfa6431a5
commit 704cc1d969
5 changed files with 25 additions and 21 deletions

View file

@ -2225,7 +2225,7 @@ namespace Cantera {
/*!
* See the Eq3/6 Manual for a thorough discussion of the need
*/
void HMWSoln::s_updateScaling_pHScaling_dT2() const;
void s_updateScaling_pHScaling_dT2() const;
//! Apply the current phScale to a set of derivatives of the activity Coefficients
//! wrt pressure

View file

@ -1,8 +1,8 @@
/**
* @file StoichSubstanceSSTP.h
* Header file for the StoichSubstanceSSTP class, which represents a fixed-composition
* incompressible substance (see \ref thermoprops and
* class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
* @file MineralEQ3.h
* Header file for the MineralEQ3 class, which represents a fixed-composition
* incompressible substance based on EQ3's parameterization (see \ref thermoprops and
* class \link Cantera::MineralEQ3 MineralEQ3\endlink)
*/
/*
@ -11,10 +11,9 @@
* U.S. Government retains certain rights in this software.
*/
/* $Author$
/*
* $Date$
* $Revision$
*
*/
#ifndef CT_MINERALEQ3_H
@ -27,13 +26,11 @@
namespace Cantera {
//! Class %StoichSubstanceSSTP represents a stoichiometric (fixed
//! composition) incompressible substance.
//! Class %MineralEQ3 represents a stoichiometric (fixed
//! composition) incompressible substance based on EQ3's parameterization
/*!
* This class internally changes the independent degree of freedom from
* density to pressure. This is necessary because the phase is
* incompressible. It uses a constant volume approximation.
*
* This class inherits from SingleSpeciesSSTP class.
* EQ's parameterization is mapped onto the Shomate polynomial class.
*
* <b> Specification of Species Standard %State Properties </b>
*

View file

@ -242,7 +242,7 @@ namespace Cantera {
*
* @param temp Temperature (Kelvin)
*/
doublereal PDSS_Water::pref_safe(doublereal temp) const;
doublereal pref_safe(doublereal temp) const;
//! Return the molar gibbs free energy divided by RT at reference pressure

View file

@ -1,6 +1,6 @@
/**
* @file StoichSubstanceSSTP.cpp
* Definition file for the StoichSubstanceSSTP class, which represents a fixed-composition
* Definition file for the StoichSubstanceSSTP class, which represents a fixed-composition
* incompressible substance (see \ref thermoprops and
* class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
*/
@ -21,10 +21,10 @@
#include "mix_defs.h"
#include "StoichSubstanceSSTP.h"
#include "SpeciesThermo.h"
#include <string>
//#include "importCTML.h"
#include "ThermoFactory.h"
#include <string>
namespace Cantera {
/*

View file

@ -1,5 +1,5 @@
/**
* @file StoichSubstanceSSTP.h
* @file StoichSubstanceSSTP.h
* Header file for the StoichSubstanceSSTP class, which represents a fixed-composition
* incompressible substance (see \ref thermoprops and
* class \link Cantera::StoichSubstanceSSTP StoichSubstanceSSTP\endlink)
@ -11,10 +11,9 @@
* U.S. Government retains certain rights in this software.
*/
/* $Author$
/*
* $Date$
* $Revision$
*
*/
#ifndef CT_STOICHSUBSTANCESSTP_H
@ -527,9 +526,17 @@ namespace Cantera {
};
//! Class %electrodeElectron represents an electron in a
//! metal using the Standard hydrogen reference electrode
/*!
*
* The class is based on the electron have a chemical potential
* equal to one-half of the entropy of the H2 gas at 1 bar.
*
*/
class electrodeElectron : public StoichSubstanceSSTP {
public:
//! Default constructor for the electrodeElectron class
electrodeElectron();