From 6766225d8040d436d41c7db50326611818cd8163 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Wed, 11 Aug 2010 00:07:03 +0000
Subject: [PATCH] doxygen update

---
 Cantera/src/transport/MixTransport.cpp   | 22 +--------
 Cantera/src/transport/MixTransport.h     | 57 +++++++++++++++++-------
 Cantera/src/transport/MultiTransport.cpp |  2 +-
 3 files changed, 42 insertions(+), 39 deletions(-)

diff --git a/Cantera/src/transport/MixTransport.cpp b/Cantera/src/transport/MixTransport.cpp
index 5eebd68f1..b3a54ceb0 100644
--- a/Cantera/src/transport/MixTransport.cpp
+++ b/Cantera/src/transport/MixTransport.cpp
@@ -54,16 +54,9 @@ namespace Cantera {
     m_cond(0),
     m_molefracs(0),
     m_poly(0),
-    m_bstar_poly(0),
-    m_cstar_poly(0),
-    m_om22_poly(0),
-    m_bstar(0, 0),
-    m_cstar(0, 0),
-    m_om22(0, 0),
     m_phi(0,0),
     m_wratjk(0,0),
     m_wratkj1(0,0),
-    m_zrot(0),
     m_crot(0),
     m_cinternal(0),
     m_eps(0),
@@ -114,16 +107,9 @@ namespace Cantera {
     m_cond(0),
     m_molefracs(0),
     m_poly(0),
-    m_bstar_poly(0),
-    m_cstar_poly(0),
-    m_om22_poly(0),
-    m_bstar(0, 0),
-    m_cstar(0, 0),
-    m_om22(0, 0),
     m_phi(0,0),
     m_wratjk(0,0),
     m_wratkj1(0,0),
-    m_zrot(0),
     m_crot(0),
     m_cinternal(0),
     m_eps(0),
@@ -187,12 +173,6 @@ namespace Cantera {
     m_cond = right.m_cond;
     m_molefracs = right.m_molefracs;
     m_poly = right.m_poly;
-    m_bstar_poly = right.m_bstar_poly;
-    m_cstar_poly = right.m_cstar_poly; 
-    m_om22_poly = right.m_om22_poly; 
-    m_bstar = right.m_bstar;
-    m_cstar = right.m_cstar;
-    m_om22 = right.m_om22;
     m_phi = right.m_phi; 
     m_wratjk = right.m_wratjk; 
     m_wratkj1 = right.m_wratkj1; 
@@ -251,7 +231,7 @@ namespace Cantera {
   {
   }
   //====================================================================================================================
-  bool MixTransport::initGas( GasTransportParams& tr ) {
+  bool MixTransport::initGas(GasTransportParams& tr) {
 
     // constant substance attributes
     m_thermo = tr.thermo;
diff --git a/Cantera/src/transport/MixTransport.h b/Cantera/src/transport/MixTransport.h
index e901a61eb..13d098606 100644
--- a/Cantera/src/transport/MixTransport.h
+++ b/Cantera/src/transport/MixTransport.h
@@ -79,6 +79,7 @@ namespace Cantera {
   class MixTransport : public Transport {
 
   protected:
+
     //! Default constructor.  
     /*!
      *
@@ -303,21 +304,21 @@ namespace Cantera {
     vector_fp                    m_polytempvec;
 
     // property values
-    DenseMatrix                  m_bdiff;
+    DenseMatrix m_bdiff;
 
     //! vector of species viscosities (kg /m /s)
     /*!
      *  These are used in wilke's rule to calculate the viscosity of the solution
      *  length = m_kk
      */
-    vector_fp                    m_visc;
+    vector_fp m_visc;
 
     //! vector of square root of species viscosities sqrt(kg /m /s)
     /*!
      *  These are used in wilke's rule to calculate the viscosity of the solution
      *  length = m_kk
      */
-    vector_fp                    m_sqvisc;
+    vector_fp m_sqvisc;
 
     //! vector of species thermal conductivities (W/m /K)
     /*!
@@ -336,31 +337,53 @@ namespace Cantera {
 
     std::vector<std::vector<int> > m_poly;
  
-    std::vector<vector_fp >   m_bstar_poly;
-    std::vector<vector_fp >   m_cstar_poly;
-    std::vector<vector_fp >   m_om22_poly;
-
-    DenseMatrix          m_bstar;
-    DenseMatrix          m_cstar;
-    DenseMatrix          m_om22;
-
     //! Viscosity Weighting Functions
     DenseMatrix m_phi;  
     DenseMatrix m_wratjk;
     DenseMatrix m_wratkj1;
 
-    vector_fp   m_zrot;
-    vector_fp   m_crot;
-    vector_fp   m_cinternal;
-    vector_fp   m_eps;
-    vector_fp   m_alpha;
-    vector_fp   m_dipoleDiag;
+    //! Rotational relaxation number for the species in the current phase
+    /*!
+     *  Not used in this routine -> just a passthrough
+     *
+     * length is the number of species in the phase
+     * units are dimensionless
+     */
+    vector_fp m_zrot;
 
+    //! Dimensionless rotational heat capacity of the species in the current phase
+    /*!
+     *  These values are 0, 1 and 1.5 for single-molecule, linear, and nonlinear species respectively
+     *  length is the number of species in the pahse
+     *  units are dimensionless  (Cr / R)
+     */
+    vector_fp m_crot;
+    vector_fp m_cinternal;
+
+    //! Lennard-Jones well-depth of the species in the current phase
+    /*!
+     * length is the number of species in the phase
+     * Units are Joules (Note this is not Joules/kmol) (note, no kmol -> this is a per molecule amount)
+     */
+    vector_fp m_eps;
+    vector_fp m_alpha;
+    vector_fp m_dipoleDiag;
+
+    //! Current value of the temperature at which the properties in this object are calculated (Kelvin)
     doublereal m_temp;
+
+    //! Current value of the log of the temperature
     doublereal m_logt;
+
+    //! Current value of Boltzman's constant times the temperature (Joules)
     doublereal m_kbt;
+
+    //! Current value of temperature to 1/4 power
     doublereal m_t14;
+
+    //! Current value of temperature to the 3/2 power
     doublereal m_t32;
+
     doublereal m_sqrt_kbt;
     doublereal m_sqrt_t;
 
diff --git a/Cantera/src/transport/MultiTransport.cpp b/Cantera/src/transport/MultiTransport.cpp
index 32076b462..19d21ee7f 100644
--- a/Cantera/src/transport/MultiTransport.cpp
+++ b/Cantera/src/transport/MultiTransport.cpp
@@ -112,7 +112,7 @@ namespace Cantera {
 
   }
 
-  bool MultiTransport::initGas( GasTransportParams& tr ) {
+  bool MultiTransport::initGas(GasTransportParams& tr) {
 
     // constant mixture attributes
     //m_phase = tr.mix;