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

Added more expressive comments.

Browse source
This commit is contained in:
Harry Moffat 2009-12-06 17:56:45 +00:00
parent 1a3af47eb9
commit 4f66d852b5
1 changed files with 22 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -123,14 +123,18 @@ namespace Cantera {
*/
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.
//! 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.
* Must have a length greater than or equal to the number of
* species.
*
* @param x Input vector of mole fractions.
* @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.
*/
virtual void setMoleFractions(const doublereal* const x);
@ -176,7 +180,10 @@ namespace Cantera {
* Must have a length greater than or equal to the number of
* species.
*
* @param y Input vector of mass fractions.
* @param y Input vector of mass fractions. There is no restriction
* on the sum of the mass fraction vector. Internally,
* the State object will normalize this vector before
* storring its contents.
* Length is m_kk.
*/
virtual void setMassFractions(const doublereal* const y);
@ -209,9 +216,14 @@ namespace Cantera {
*/
doublereal concentration(const int k) const;
/**
* Set the concentrations to the specified values within the
* phase.
//! Set the concentrations to the specified values within the
//! phase.
/*
* We set the concentrations here and therefore we set the
* overall density of the phase. We hold the temperature constant
* during this operation. Therefore, we have possibly changed
* the pressure of the phase by calling this routine.
*
* @param c The input vector to this routine is in dimensional
* units. For volumetric phases c[k] is the