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

[Thermo/Doc] Fix description of Shomate temperature polynomial

Browse source 
The docstring for this function was incorrectly copied from NasaPoly1.
This commit is contained in:
Ray Speth 2015-07-17 18:21:25 -04:00
parent b7a5aff900
commit ca90c671ac
1 changed files with 1 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
include/cantera/thermo/ShomatePoly.h
View file

@ -270,26 +270,7 @@ public:
msp_low.updateTemperaturePoly(T, T_poly);
}
//! Update the properties for this species, given a temperature polynomial
/*!
* This method is called with a pointer to an array containing the
* functions of temperature needed by this parameterization, and three
* pointers to arrays where the computed property values should be
* written. This method updates only one value in each array.
*
* Temperature Polynomial:
* - `tt[0] = t`
* - `tt[1] = t*t`
* - `tt[2] = m_t[1]*t`
* - `tt[3] = m_t[2]*t`
* - `tt[4] = 1.0/t`
* - `tt[5] = std::log(t)`
*
* @param tt vector of temperature polynomials
* @param cp_R Vector of Dimensionless heat capacities. (length m_kk).
* @param h_RT Vector of Dimensionless enthalpies. (length m_kk).
* @param s_R Vector of Dimensionless entropies. (length m_kk).
*/
//! @copydoc ShomatePoly::updateProperties
virtual void updateProperties(const doublereal* tt,
doublereal* cp_R, doublereal* h_RT,
doublereal* s_R) const {