Worked on documentation

This commit is contained in:
Harry Moffat 2010-07-21 16:31:45 +00:00
parent 942fa9c2ec
commit 4334ec5d8a
3 changed files with 21 additions and 14 deletions

View file

@ -227,21 +227,20 @@ namespace Cantera {
return m_lambda;
}
//===================================================================================================================
/****************** thermal diffusion coefficients ************/
/**
* Thermal diffusion is not considered in this mixture-averaged
* model. To include thermal diffusion, use transport manager
* MultiTransport instead. This methods fills out array dt with
* zeros.
// Return the thermal diffusion coefficients
/*
* For this approximation, these are all zero.
*
* Eqns. (12.168) shows how they are used in an expression for the species flux.
*
* @param dt Vector of thermal diffusion coefficients. Units = kg/m/s
*/
void MixTransport::getThermalDiffCoeffs(doublereal* const dt) {
int k;
for (k = 0; k < m_nsp; k++) {
for (int k = 0; k < m_nsp; k++) {
dt[k] = 0.0;
}
}
//===================================================================================================================
/**
* @param ndim The number of spatial dimensions (1, 2, or 3).
* @param grad_T The temperature gradient (ignored in this model).

View file

@ -63,6 +63,10 @@ namespace Cantera {
//! Return the thermal diffusion coefficients
/*!
* For this approximation, these are all zero.
*
* Eqns. (12.168) shows how they are used in an expression for the species flux.
*
* @param dt Vector of thermal diffusion coefficients. Units = kg/m/s
*/
virtual void getThermalDiffCoeffs(doublereal* const dt);

View file

@ -114,11 +114,15 @@ namespace Cantera {
virtual void getSpeciesViscosities(doublereal* const visc)
{ updateViscosity_T(); std::copy(m_visc.begin(), m_visc.end(), visc); }
//! Return the thermal diffusion coefficients for the species
//! Return the thermal diffusion coefficients (kg/m/s)
/*!
*
* @param dt thermal diffusion coefficients
* (length = m_nsp)
* Eqn. (12.126) displays how they are calculated. The reference work is from
* Dixon-Lewis.
*
* Eqns. (12.168) shows how they are used in an expression for the species flux.
*
* @param dt Vector of thermal diffusion coefficients. Units = kg/m/s
*/
virtual void getThermalDiffCoeffs(doublereal* const dt);