From be6c44da59fb6a3fd8609487fbcbe9ca1b260daa Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Fri, 27 Jul 2007 00:09:11 +0000 Subject: [PATCH] Doxygen update Documented the getSpeciesFluxes interface Changed a doublereal * grad_T parameter to const doublereal * grad_T parameter. --- Cantera/src/transport/MixTransport.cpp | 2 +- Cantera/src/transport/MixTransport.h | 2 +- Cantera/src/transport/MultiTransport.cpp | 2 +- Cantera/src/transport/MultiTransport.h | 2 +- Cantera/src/transport/TransportBase.h | 31 ++++++++++++++++++++---- 5 files changed, 30 insertions(+), 9 deletions(-) diff --git a/Cantera/src/transport/MixTransport.cpp b/Cantera/src/transport/MixTransport.cpp index 96b419659..bc020abe1 100755 --- a/Cantera/src/transport/MixTransport.cpp +++ b/Cantera/src/transport/MixTransport.cpp @@ -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; diff --git a/Cantera/src/transport/MixTransport.h b/Cantera/src/transport/MixTransport.h index 09dfa8bd9..154e2eb2e 100755 --- a/Cantera/src/transport/MixTransport.h +++ b/Cantera/src/transport/MixTransport.h @@ -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); diff --git a/Cantera/src/transport/MultiTransport.cpp b/Cantera/src/transport/MultiTransport.cpp index e48b5faba..166204b0f 100755 --- a/Cantera/src/transport/MultiTransport.cpp +++ b/Cantera/src/transport/MultiTransport.cpp @@ -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 diff --git a/Cantera/src/transport/MultiTransport.h b/Cantera/src/transport/MultiTransport.h index 51d961c2b..8ab0400cc 100755 --- a/Cantera/src/transport/MultiTransport.h +++ b/Cantera/src/transport/MultiTransport.h @@ -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, diff --git a/Cantera/src/transport/TransportBase.h b/Cantera/src/transport/TransportBase.h index 1e5177292..9a6c37297 100755 --- a/Cantera/src/transport/TransportBase.h +++ b/Cantera/src/transport/TransportBase.h @@ -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