From 0d0e481e2fc5ea6a66298611bbca278488d12d64 Mon Sep 17 00:00:00 2001
From: Harry Moffat <hkmoffa@sandia.gov>
Date: Thu, 3 Nov 2011 20:03:23 +0000
Subject: [PATCH] Added comments.

---
 Cantera/src/zeroD/Reactor.h     | 45 ++++++++++++++++-----------------
 Cantera/src/zeroD/ReactorBase.h | 13 ++++++++--
 2 files changed, 33 insertions(+), 25 deletions(-)

diff --git a/Cantera/src/zeroD/Reactor.h b/Cantera/src/zeroD/Reactor.h
index d43760f08..510844405 100644
--- a/Cantera/src/zeroD/Reactor.h
+++ b/Cantera/src/zeroD/Reactor.h
@@ -59,10 +59,8 @@ namespace CanteraZeroD {
 
     public:
 
-        /**
-         * Default constructor.
-         */
-        Reactor();
+      //!  Default constructor.
+      Reactor();
 
         /**
          * Destructor. Deletes the integrator.
@@ -121,26 +119,27 @@ namespace CanteraZeroD {
         virtual int componentIndex(std::string nm) const;
 
     protected:
-        
-        Cantera::Kinetics*   m_kin;
-
-        doublereal m_temp_atol;      // tolerance on T
-        doublereal m_maxstep;        // max step size
-        doublereal m_vdot, m_Q;
-        Cantera::vector_fp m_atol;
-        doublereal m_rtol;
-        Cantera::vector_fp m_work;
-        Cantera::vector_fp m_sdot;            // surface production rates
-        bool m_chem;
-        bool m_energy;
-        int m_nv;
-
-        int m_nsens;
-        Cantera::vector_int m_pnum;
-        std::vector<std::string> m_pname;
-        Cantera::vector_int m_nsens_wall;
-        Cantera::vector_fp m_mult_save;
+      //! Pointer to the homogeneous Kinetics object that handles the reactions
+      Cantera::Kinetics*   m_kin;
 
+      //! Tolerance on the temperature
+      doublereal m_temp_atol;
+      doublereal m_maxstep;        // max step size
+      doublereal m_vdot, m_Q;
+      Cantera::vector_fp m_atol;
+      doublereal m_rtol;
+      Cantera::vector_fp m_work;
+      Cantera::vector_fp m_sdot;            // surface production rates
+      bool m_chem;
+      bool m_energy;
+      int m_nv;
+      
+      int m_nsens;
+      Cantera::vector_int m_pnum;
+      std::vector<std::string> m_pname;
+      Cantera::vector_int m_nsens_wall;
+      Cantera::vector_fp m_mult_save;
+      
     private:
     };
 }
diff --git a/Cantera/src/zeroD/ReactorBase.h b/Cantera/src/zeroD/ReactorBase.h
index 008050bdb..4f0bc5a11 100644
--- a/Cantera/src/zeroD/ReactorBase.h
+++ b/Cantera/src/zeroD/ReactorBase.h
@@ -133,7 +133,14 @@ namespace CanteraZeroD {
         /// the current time (s).
         doublereal time() const { return m_time; }
 
-        doublereal volume() const { return m_vol; }
+
+      //! Returns the current volume of the reactor
+      /*!
+       * @return  Return the volume in m**3
+       */
+      doublereal volume() const { 
+	return m_vol; 
+      }
         doublereal density() const { return m_state[1]; }
         doublereal temperature() const { return m_state[0]; }
         doublereal enthalpy_mass() const { return m_enthalpy; }
@@ -152,7 +159,9 @@ namespace CanteraZeroD {
 
     protected:
  
-        int m_nsp;
+      //! Number of homogeneous species in the mixture
+      int m_nsp;
+
         Cantera::thermo_t*  m_thermo;
         doublereal m_time;
         doublereal m_vol, m_vol0;