From 4ec5327086d6803b9c78d910b988b6a72919f071 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Thu, 19 Aug 2010 00:30:18 +0000
Subject: [PATCH] Doxygen update

---
 Cantera/src/transport/DustyGasTransport.cpp | 14 ++++++-----
 Cantera/src/transport/DustyGasTransport.h   | 26 +++++++++++++++++++--
 2 files changed, 32 insertions(+), 8 deletions(-)

diff --git a/Cantera/src/transport/DustyGasTransport.cpp b/Cantera/src/transport/DustyGasTransport.cpp
index bca1e6de3..dc0cead8d 100644
--- a/Cantera/src/transport/DustyGasTransport.cpp
+++ b/Cantera/src/transport/DustyGasTransport.cpp
@@ -53,7 +53,6 @@ namespace Cantera {
       m_gradP(0.0),
       m_knudsen_ok(false),
       m_bulk_ok(false),
-      m_conc_set(false),
       m_gradConc_set(false),
       m_gradP_set(false),
       m_porosity(0.0),
@@ -79,7 +78,6 @@ namespace Cantera {
       m_gradP(0.0),
       m_knudsen_ok(false),
       m_bulk_ok(false),
-      m_conc_set(false),
       m_gradConc_set(false),
       m_gradP_set(false),
       m_porosity(0.0),
@@ -120,7 +118,6 @@ namespace Cantera {
     m_gradP = right.m_gradP;
     m_knudsen_ok = right.m_knudsen_ok;
     m_bulk_ok= right.m_bulk_ok;
-    m_conc_set = right.m_conc_set;
     m_gradConc_set = right.m_gradConc_set;
     m_gradP_set = right.m_gradP_set;
     m_porosity = right.m_porosity;  
@@ -204,7 +201,6 @@ namespace Cantera {
     // set flags all false
     m_knudsen_ok = false;
     m_bulk_ok = false;
-    m_conc_set = false;
     m_gradConc_set = false;
     m_gradP_set = false;
   
@@ -248,11 +244,17 @@ namespace Cantera {
     for (k = 0; k < m_nsp; k++) {
 
       // evaluate off-diagonal terms
-      for (l = 0; l < m_nsp; l++) m_multidiff(k,l) = -m_x[k]/m_d(k,l);
+      for (l = 0; l < m_nsp; l++) {
+	m_multidiff(k,l) = -m_x[k]/m_d(k,l);
+      }
 
       // evaluate diagonal term
       sum = 0.0;
-      for (j = 0; j < m_nsp; j++) if (j != k) sum += m_x[j]/m_d(k,j);
+      for (j = 0; j < m_nsp; j++) {
+	if (j != k) {
+	  sum += m_x[j]/m_d(k,j);
+	}
+      }
       m_multidiff(k,k) = 1.0/m_dk[k] + sum;
     }
   }
diff --git a/Cantera/src/transport/DustyGasTransport.h b/Cantera/src/transport/DustyGasTransport.h
index 4dea75558..dee73bdd3 100644
--- a/Cantera/src/transport/DustyGasTransport.h
+++ b/Cantera/src/transport/DustyGasTransport.h
@@ -189,12 +189,30 @@ namespace Cantera {
     vector_fp                    m_x;
 
     //! Knudsen diffusion coefficients
+    /*!
+     *  The Knudsen diffusion coefficients are given by the following form
+     *  
+     *     \f[
+     *        \mathcal{D}^{knud}_k =  \frac{2}{3} \frac{r_{pore} \phi}{\tau} \left( \frac{8 R T}{\pi W_k}  \right)^{1/2}
+     *     \f]
+     *
+     */
     vector_fp                    m_dk;
 
     //! temperature
     doublereal                   m_temp;
 
-    //! multicomponent diffusion coefficients
+    //! Multicomponent diffusion coefficients
+    /*!
+     *  The multicomponent diffusion matrix \f$  H_{k,l} \f$ is given by the following form
+     *
+     *     \f[
+     *        H_{k,l} = - \frac{X_k}{D_{k,l}}
+     *     \f]
+     *     \f[
+     *        H_{k,k} = \frac{1}{\mathcal(D)^{knud}_{k}} + \sum_{j \ne k}^N{ \frac{X_j}{D_{k,j}} }
+     *     \f]
+     */
     DenseMatrix                  m_multidiff;
 
     //!  work space of size m_nsp;
@@ -207,10 +225,14 @@ namespace Cantera {
     //! Pressure Gradient
     doublereal m_gradP;
 
+    //! Update-to-date variable for Knudsen diffusion coefficients
     bool m_knudsen_ok;
+
+   //! Update-to-date variable for Binary diffusion coefficients
     bool m_bulk_ok;
-    bool m_conc_set;
+
     bool m_gradConc_set;
+
     bool m_gradP_set;
 
     //! Porosity