From 6c8835bb84b1757a470d4b35081ac6b8538cfd34 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Thu, 15 Jul 2010 15:45:37 +0000 Subject: [PATCH] doxygen input --- Cantera/src/transport/MultiTransport.cpp | 43 +++++++++++--- Cantera/src/transport/MultiTransport.h | 72 ++++++++++++++---------- 2 files changed, 76 insertions(+), 39 deletions(-) diff --git a/Cantera/src/transport/MultiTransport.cpp b/Cantera/src/transport/MultiTransport.cpp index 88659cf64..32076b462 100644 --- a/Cantera/src/transport/MultiTransport.cpp +++ b/Cantera/src/transport/MultiTransport.cpp @@ -1,9 +1,8 @@ /** - * * @file MultiTransport.cpp * Implementation file for class MultiTransport - * - * @ingroup transportProps + */ +/* * * $Author$ * $Date$ @@ -526,10 +525,22 @@ namespace Cantera { } } } - //==================================================================================================================== - - void MultiTransport::getMassFluxes(const doublereal* state1, - const doublereal* state2, doublereal delta, + //==================================================================================================================== + // Get the mass diffusional fluxes [kg/m^2/s] of the species, given the thermodynamic + // state at two nearby points. + /* + * The specific diffusional fluxes are calculated with reference to the mass averaged + * velocity. This is a one-dimensional vector + * + * @param state1 Array of temperature, density, and mass + * fractions for state 1. + * @param state2 Array of temperature, density, and mass + * fractions for state 2. + * @param delta Distance from state 1 to state 2 (m). + * @param fluxes Output mass fluxes of the species. + * (length = m_nsp) + */ + void MultiTransport::getMassFluxes(const doublereal* state1, const doublereal* state2, doublereal delta, doublereal* fluxes) { double* x1 = DATA_PTR(m_spwork1); @@ -652,6 +663,20 @@ namespace Cantera { } } //==================================================================================================================== + // Set the solution method for inverting the L matrix + /* + * @param method enum TRANSOLVE_TYPE Either use direct or TRANSOLVE_GMRES + */ + void MultiTransport::setSolutionMethod(TRANSOLVE_TYPE method) { + if (method == TRANSOLVE_GMRES) m_gmres = true; + else m_gmres = false; + } + //==================================================================================================================== + void MultiTransport::setOptions_GMRES(int m, doublereal eps) { + if (m > 0) m_mgmres = m; + if (eps > 0.0) m_eps_gmres = eps; + } + //==================================================================================================================== void MultiTransport::getMultiDiffCoeffs(const int ld, doublereal* const d) { int i,j; @@ -994,7 +1019,7 @@ namespace Cantera { } } //==================================================================================================================== - /** + /* * This function returns a Transport data object for a given species. * */ @@ -1018,5 +1043,5 @@ namespace Cantera { return td; } - + //==================================================================================================================== } diff --git a/Cantera/src/transport/MultiTransport.h b/Cantera/src/transport/MultiTransport.h index a9f878d2d..754c96fcf 100644 --- a/Cantera/src/transport/MultiTransport.h +++ b/Cantera/src/transport/MultiTransport.h @@ -51,16 +51,24 @@ namespace Cantera { */ class L_Matrix : public DenseMatrix { public: + + //! default constructor L_Matrix() {} + + //! destructor virtual ~L_Matrix(){} - /** + //! Conduct a multiply with the Dense matrix + /*! * This method is used by GMRES to multiply the L matrix by a * vector b. The L matrix has a 3x3 block structure, where each * block is a K x K matrix. The elements of the upper-right and * lower-left blocks are all zero. This method is defined so * that the multiplication only involves the seven non-zero * blocks. + * + * @param b + * @param prod */ virtual void mult(const doublereal* b, doublereal* prod) const; }; @@ -83,6 +91,9 @@ namespace Cantera { protected: //! default constructor + /*! + * @param thermo Optional parameter for the pointer to the ThermoPhase object + */ MultiTransport(thermo_t* thermo=0); public: @@ -189,17 +200,18 @@ namespace Cantera { const doublereal* state2, doublereal delta, doublereal* fluxes); - virtual void setSolutionMethod(TRANSOLVE_TYPE method) { - if (method == TRANSOLVE_GMRES) m_gmres = true; - else m_gmres = false; - } + //! Set the solution method for inverting the L matrix + /*! + * @param method enum TRANSOLVE_TYPE Either use direct or TRANSOLVE_GMRES + */ + virtual void setSolutionMethod(TRANSOLVE_TYPE method); - virtual void setOptions_GMRES(int m, doublereal eps) { - if (m > 0) m_mgmres = m; - if (eps > 0.0) m_eps_gmres = eps; - } - - void save(std::string outfile); + //! Set the options for the GMRES solution + /*! + * @param m set the mgmres param + * @param eps Set the eps parameter + */ + virtual void setOptions_GMRES(int m, doublereal eps); /** * @internal @@ -241,31 +253,25 @@ namespace Cantera { friend class TransportFactory; - /** - * Return a structure containing all of the pertinent parameters - * about a species that was used to construct the Transport - * properties in this object. - * - * @param k Species number to obtain the properties from. + + //! Return a structure containing all of the pertinent parameters + //! about a species that was used to construct the Transport properties in this object + /*! + * @param k Species index */ - struct GasTransportData getGasTransportData(int); - + struct GasTransportData getGasTransportData(int k); private: - // int m_update_transport_T; - // int m_update_transport_C; - // int m_update_spvisc_T; - // int m_update_visc_T; - // int m_update_diff_T; - // int m_update_thermal_T; + doublereal m_diff_tlast; + doublereal m_spvisc_tlast; + doublereal m_visc_tlast; + doublereal m_thermal_tlast; - doublereal m_diff_tlast, m_spvisc_tlast, m_visc_tlast, - m_thermal_tlast; - - // mixture attributes + //! Number of species in the phase int m_nsp; - doublereal m_tmin, m_tmax; + doublereal m_tmin; + doublereal m_tmax; vector_fp m_mw; // polynomial fits @@ -289,8 +295,14 @@ namespace Cantera { //! Dense matrix for astar DenseMatrix m_astar; + + //! Dense matrix for bstar DenseMatrix m_bstar; + + //! Dense matrix for cstar DenseMatrix m_cstar; + + //! Dense matrix for omega22 DenseMatrix m_om22; DenseMatrix m_phi; // viscosity weighting functions