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

Cleared up some documentation issues.

Browse source
This commit is contained in:
Harry Moffat 2010-07-08 22:05:17 +00:00
parent 1dd189fefb
commit 101d4543fb
2 changed files with 45 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -62,6 +62,8 @@ namespace Cantera {
* The mole fraction vector has been redefined within the LatticeSolidPhase object. The mole fractions sum
* to one within each of the individual lattice phases. The routine getMoleFraction() and setMoleFraction()
* have been redefined to use this convention.
*
* (This object is still under construction)
*
*/
class LatticeSolidPhase : public ThermoPhase {
@ -228,7 +230,24 @@ namespace Cantera {
m_press = p;
setMolarDensity(m_molar_density);
}
//! Set the mole fractions to the specified values, and then
//! normalize them so that they sum to 1.0 for each of the subphases
/*!
*
* @param x Input vector of mole fractions. There is no restriction
* on the sum of the mole fraction vector. Internally,
* this object will normalize this vector before
* storring its contents.
* Length is m_kk.
*/
virtual void setMoleFractions(const doublereal *x);
//! Get the species mole fraction vector.
/*!
* @param x On return, x contains the mole fractions. Must have a
* length greater than or equal to the number of species.
*/
virtual void getMoleFractions(doublereal *x) const;
doublereal moleFraction(const int k) const {

50
Cantera/src/thermo/State.h
View file

@ -122,20 +122,16 @@ namespace Cantera {
* @param k species index
*/
doublereal moleFraction(const int k) const;
//! Set the mole fractions to the specified values, and then
//! normalize them so that they sum to 1.0.
/*!
* @param x Array of unnormalized mole fraction values (input).
* Must have a length greater than or equal to the number of
* species.
*
* @param x Input vector of mole fractions. There is no restriction
* on the sum of the mole fraction vector. Internally,
* the State object will normalize this vector before
* storring its contents.
* Length is m_kk.
* species, m_kk. There is no restriction
* on the sum of the mole fraction vector. Internally,
* the State object will normalize this vector before
* storring its contents.
*/
virtual void setMoleFractions(const doublereal* const x);
@ -151,23 +147,17 @@ namespace Cantera {
*/
virtual void setMoleFractions_NoNorm(const doublereal* const x);
/**
* Get the species mass fractions.
* @param y On return, y
* contains the mass fractions. Array \a y must have a length
* greater than or equal to the number of species.
*
* @param y Output vector of mass fractions.
* Length is m_kk.
//! Get the species mass fractions.
/*!
* @param y On return, y contains the mass fractions. Array \a y must have a length
* greater than or equal to the number of species.
*/
void getMassFractions(doublereal* const y) const;
//! Mass fraction of species k.
/*!
* If k is outside the valid
* range, an exception will be thrown. Note that it is
* somewhat more efficent to call getMassFractions if the
* mass fractions of all species are desired.
* If k is outside the valid range, an exception will be thrown. Note that it is
* somewhat more efficent to call getMassFractions if the mass fractions of all species are desired.
*
* @param k species index
*/
@ -305,20 +295,32 @@ namespace Cantera {
/// mass density.
//@{
/// Temperature (K).
//! Temperature (K).
/*!
* @return Returns the temperature of the phase
*/
doublereal temperature() const {
return m_temp;
}
/// Density (kg/m^3).
//! Density (kg/m^3).
/*!
* @return Returns the density of the phase
*/
virtual doublereal density() const {
return m_dens;
}
/// Molar density (kmol/m^3).
//! Molar density (kmol/m^3).
/*!
* @return Returns the molar density of the phase
*/
doublereal molarDensity() const;
/// Molar density (kmol/m^3).
//! Molar volume (m^3/kmol).
/*!
* @return Returns the molar volume of the phase
*/
doublereal molarVolume() const;
//! Set the internally storred density (kg/m^3) of the phase