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

Added more documentation to doxygen.

Browse source
This commit is contained in:
Harry Moffat 2005-10-21 22:15:35 +00:00
parent c98c60138a
commit b4dcb8a231
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
Cantera/src/StoichSubstance.h
View file

@ -29,6 +29,7 @@ namespace Cantera {
*
* Class StoichSubstance represents a stoichiometric (fixed composition)
* incompressible substance.
* \nosubgrouping
*
*/
class StoichSubstance : public ThermoPhase {
@ -329,6 +330,10 @@ namespace Cantera {
* Returns the vector of nondimensional
* 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
* the underlying species thermo function for the
* dimensionless enthalpy.
*/
virtual void getEnthalpy_RT_ref(doublereal *hrt) const {
_updateThermo();
@ -339,6 +344,11 @@ namespace Cantera {
* Returns the vector of nondimensional
* 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
* the underlying species thermo function for the
* dimensionless gibbs free energy, calculated from the
* dimensionless enthalpy and entropy.
*/
virtual void getGibbs_RT_ref(doublereal *grt) const {
_updateThermo();
@ -350,6 +360,11 @@ namespace Cantera {
* gibbs function of the reference state at the current temperature
* of the solution and the reference pressure for the species.
* units = J/kmol
*
* This function fills in its one entry in g[] by calling
* the underlying species thermo functions for the
* gibbs free energy, calculated from enthalpy and the
* entropy, and the multiplying by RT.
*/
virtual void getGibbs_ref(doublereal *g) const {
getGibbs_RT_ref(g);
@ -360,6 +375,10 @@ namespace Cantera {
* Returns the vector of nondimensional
* entropies 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
* the underlying species thermo function for the
* dimensionless entropy.
*/
virtual void getEntropy_R_ref(doublereal *er) const {
_updateThermo();