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

Doxygen changes.

Browse source
This commit is contained in:
Harry Moffat 2011-09-21 16:36:49 +00:00
parent fd1e408f25
commit 7bb60ff596
1 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
Cantera/src/thermo/LatticeSolidPhase.h
View file

@ -106,7 +106,7 @@ namespace Cantera {
* *
* *
* \f[ * \f[
* V_i = \sum_k{ \X_k V_k} * V_i = \sum_k{ X_k V_k}
* \f] * \f]
* *
* where k is a species in the ith sublattice. * where k is a species in the ith sublattice.
@ -325,7 +325,7 @@ namespace Cantera {
//! Set the mole fractions to the specified values, and then //! Set the mole fractions to the specified values, and then
//! normalize them so that they sum to 1.0 for each of the subphases //! normalize them so that they sum to 1.0 for each of the subphases
/* /*!
* On input, the mole fraction vector is assumed to sum to one for each of the sublattices. The sublattices * On input, the mole fraction vector is assumed to sum to one for each of the sublattices. The sublattices
* are updated with this mole fraction vector. The mole fractions are also storred within this object, after * are updated with this mole fraction vector. The mole fractions are also storred within this object, after
* they are normalized to one by dividing by the number of sublattices. * they are normalized to one by dividing by the number of sublattices.
@ -567,29 +567,31 @@ namespace Cantera {
/// @name Thermodynamic Values for the Species Reference States -------------------- /// @name Thermodynamic Values for the Species Reference States --------------------
//@{ //@{
/** //! Returns the vector of nondimensional enthalpies of the reference state at the current
* Returns the vector of nondimensional //! temperature of the solution and the reference pressure for the species.
* enthalpies of the reference state at the current temperature /*!
* of the solution and the reference pressure for the species.
*
* This function fills in its one entry in hrt[] by calling * This function fills in its one entry in hrt[] by calling
* the underlying species thermo function for the * the underlying species thermo function for the
* dimensionless gibbs free energy, calculated from the * dimensionless gibbs free energy, calculated from the
* dimensionless enthalpy and entropy. * dimensionless enthalpy and entropy.
*
* @param grt Vector of dimensionless Gibbs free energies of the reference state
* length = m_kk
*/ */
virtual void getGibbs_RT_ref(doublereal *grt) const; virtual void getGibbs_RT_ref(doublereal *grt) const;
/** //! Returns the vector of the gibbs function of the reference state at the current
* Returns the vector of the //! temperatureof the solution and the reference pressure for the species.
* gibbs function of the reference state at the current temperature /*!
* of the solution and the reference pressure for the species.
* units = J/kmol * units = J/kmol
* *
* This function fills in its one entry in g[] by calling * This function fills in its one entry in g[] by calling the underlying species thermo
* the underlying species thermo functions for the * functions for the gibbs free energy, calculated from enthalpy and the
* gibbs free energy, calculated from enthalpy and the
* entropy, and the multiplying by RT. * entropy, and the multiplying by RT.
*
* @param g Vector of Gibbs free energies of the reference state.
* length = m_kk
*/ */
virtual void getGibbs_ref(doublereal *g) const; virtual void getGibbs_ref(doublereal *g) const;