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

Doxygen update

Browse source 
Documented the getSpeciesFluxes interface
  Changed a doublereal * grad_T parameter to const doublereal * grad_T
parameter.
This commit is contained in:
Harry Moffat 2007-07-27 00:09:11 +00:00
parent 449e133e02
commit be6c44da59
5 changed files with 30 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cantera/src/transport/MixTransport.cpp
View file

@ -244,7 +244,7 @@ namespace Cantera {
* \f]
*/
void MixTransport::getSpeciesFluxes(int ndim,
doublereal* grad_T, int ldx, const doublereal* grad_X,
const doublereal* grad_T, int ldx, const doublereal* grad_X,
int ldf, doublereal* fluxes) {
int n, k;

2
Cantera/src/transport/MixTransport.h
View file

@ -71,7 +71,7 @@ namespace Cantera {
virtual void update_C();
virtual void getSpeciesFluxes(int ndim,
doublereal* grad_T, int ldx, const doublereal* grad_X,
const doublereal* grad_T, int ldx, const doublereal* grad_X,
int ldf, doublereal* fluxes);
virtual bool init(TransportParams& tr);

2
Cantera/src/transport/MultiTransport.cpp
View file

@ -440,7 +440,7 @@ namespace Cantera {
*
*/
void MultiTransport::getSpeciesFluxes(int ndim,
doublereal* grad_T, int ldx, const doublereal* grad_X,
const doublereal* grad_T, int ldx, const doublereal* grad_X,
int ldf, doublereal* fluxes) {
// update the binary diffusion coefficients if necessary

2
Cantera/src/transport/MultiTransport.h
View file

@ -104,7 +104,7 @@ namespace Cantera {
virtual void getSpeciesFluxes(int ndim,
doublereal* grad_T, int ldx, const doublereal* grad_X,
const doublereal* grad_T, int ldx, const doublereal* grad_X,
int ldf, doublereal* fluxes);
virtual void getMolarFluxes(const doublereal* state1,

31
Cantera/src/transport/TransportBase.h
View file

@ -135,13 +135,34 @@ namespace Cantera {
//@}
/**
* Get the species mass fluxes, given the gradients.
//! Get the species diffusive mass fluxes wrt to
//! the mass averaged velocity,
//! given the gradients in mole fraction and temperature
/*!
* Units for the returned fluxes are kg m-2 s-1.
*
* @param ndim Number of dimensions in the flux expressions
* @param grad_T Gradient of the temperature
* (length = ndim)
* @param ldx Leading dimension of the grad_X array
* (usually equal to m_nsp but not always)
* @param grad_X Gradients of the mole fraction
* Flat vector with the m_nsp in the inner loop.
* length = ldx * ndim
* @param ldf Leading dimension of the fluxes array
* (usually equal to m_nsp but not always)
* @param fluxes Output of the diffusive mass fluxes
* Flat vector with the m_nsp in the inner loop.
* length = ldx * ndim
*/
virtual void getSpeciesFluxes(int ndim,
doublereal* grad_T, int ldx, const doublereal* grad_X,
int ldf, doublereal* fluxes) { err("getSpeciesFluxes"); }
const doublereal* grad_T,
int ldx,
const doublereal* grad_X,
int ldf,
doublereal* fluxes) {
err("getSpeciesFluxes");
}
/**
* Get the molar fluxes [kmol/m^2/s], given the thermodynamic