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

[Doc] Fix errors in NASA9 formula documentation

Browse source 
Also, remove duplicate (erroneous) documentation from Nasa9PolyMultiTempRegion
and replace this with a reference to the docs for Nasa9Poly1.
This commit is contained in:
Ray Speth 2014-10-08 16:54:14 +00:00
parent f58fb95404
commit b1e89a09a8
2 changed files with 10 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
include/cantera/thermo/Nasa9Poly1.h
View file

@ -35,7 +35,7 @@ namespace Cantera
* B. J. McBride, M. J. Zehe, S. Gordon
* NASA/TP-2002-211556, Sept. 2002
*
* Nine coefficients \f$(a_0,\dots,a_6)\f$ are used to represent
* Nine coefficients \f$(a_0,\dots,a_8)\f$ are used to represent
* \f$ C_p^0(T)\f$, \f$ H^0(T)\f$, and \f$ S^0(T) \f$ as
* polynomials in \f$ T \f$ :
* \f[
@ -44,13 +44,14 @@ namespace Cantera
* \f]
*
* \f[
* \frac{H^0(T)}{RT} = - a_0 T^{-2} + a_1 \frac{\ln(T)}{T} + a_2
* + a_3 T + a_4 T^2 + a_5 T^3 + a_6 T^4 + \frac{a_7}{T}
* \frac{H^0(T)}{RT} = - a_0 T^{-2} + a_1 \frac{\ln T}{T} + a_2
* + \frac{a_3}{2} T + \frac{a_4}{3} T^2 + \frac{a_5}{4} T^3 +
* \frac{a_6}{5} T^4 + \frac{a_7}{T}
* \f]
*
* \f[
* \frac{s^0(T)}{R} = - \frac{a_0}{2} T^{-2} - a_1 T^{-1} + a_2 \ln(T)
+ + a_3 T \frac{a_4}{2} T^2 + \frac{a_5}{3} T^3 + \frac{a_6}{4} T^4 + a_8
* \frac{s^0(T)}{R} = - \frac{a_0}{2} T^{-2} - a_1 T^{-1} + a_2 \ln T
* + a_3 T + \frac{a_4}{2} T^2 + \frac{a_5}{3} T^3 + \frac{a_6}{4} T^4 + a_8
* \f]
*
* The standard state is assumed to be an ideal gas at the
@ -65,6 +66,7 @@ namespace Cantera
* regions.
*
* @ingroup spthermo
* @see Nasa9PolyMultiTempRegion
*/
class Nasa9Poly1 : public SpeciesThermoInterpType
{

37
include/cantera/thermo/Nasa9PolyMultiTempRegion.h
View file

@ -21,40 +21,8 @@ namespace Cantera
//! The NASA 9 polynomial parameterization for a single species
//! encompassing multiple temperature regions.
/*!
* This parameterization expresses the heat capacity via a
* 7 coefficient polynomial.
* Note that this is the form used in the
* 2002 NASA equilibrium program. A reference to the form is
* provided below:
*
* "NASA Glenn Coefficients for Calculating Thermodynamic
* Properties of Individual Species,"
* B. J. McBride, M. J. Zehe, S. Gordon
* NASA/TP-2002-211556, Sept. 2002
*
* Nine coefficients \f$(a_0,\dots,a_6)\f$ are used to represent
* \f$ C_p^0(T)\f$, \f$ H^0(T)\f$, and \f$ S^0(T) \f$ as
* polynomials in \f$ T \f$ :
* \f[
* \frac{C_p^0(T)}{R} = a_0 T^{-2} + a_1 T^{-1} + a_2 + a_3 T
* + a_4 T^2 + a_5 T^3 + a_6 T^4
* \f]
*
* \f[
* \frac{H^0(T)}{RT} = - a_0 T^{-2} + a_1 \frac{\ln(T)}{T} + a_2
* + a_3 T + a_4 T^2 + a_5 T^3 + a_6 T^4 + \frac{a_7}{T}
* \f]
*
* \f[
* \frac{s^0(T)}{R} = - \frac{a_0}{2} T^{-2} - a_1 T^{-1} + a_2 \ln(T)
+ + a_3 T \frac{a_4}{2} T^2 + \frac{a_5}{3} T^3 + \frac{a_6}{4} T^4 + a_8
* \f]
*
* The standard state is assumed to be an ideal gas at the
* standard pressure of 1 bar, for gases.
* For condensed species, the standard state is the
* pure crystalline or liquid substance at the standard
* pressure of 1 atm.
* The parameterization used in each temperature range is described in the
* documentation for class Nasa9Poly1.
*
* These NASA representations may have multiple temperature regions
* through the use of this %Nasa9PolyMultiTempRegion object, which uses
@ -62,6 +30,7 @@ namespace Cantera
* regions.
*
* @ingroup spthermo
* @see Nasa9Poly1
*/
class Nasa9PolyMultiTempRegion : public SpeciesThermoInterpType
{