correcting typos, adding minor comments, streamlining nomenclature in tutorial_coupled

examples/tutorial_coupled.cc

@@ -58,7 +58,7 @@ int main(int argc, char** argv)
             std::istringstream(argv[argPos++]) >> restartTime;
         }
 
-        // read the the initial time step and the end time
+        // read the initial time step and the end time
         if (argc - argPos != 2)
             usage(argv[0]);
 
@@ -77,7 +77,7 @@ int main(int argc, char** argv)
         timeManager.init(problem, 0, dt, tEnd, !restart);
         // load some previously saved state from disk
         if (restart)
-            problem.restart(restartTime); /*@\label{tutorial-coupled:restart}@*/
+            problem.restart(restartTime); /*@\label{tutorial-coupled:begin-restart}@*/
         // run the simulation
         timeManager.run(); /*@\label{tutorial-coupled:execute}@*/
         return 0;

examples/tutorialproblem_coupled.hh

@@ -127,7 +127,7 @@ public:
     {
     }
 
-    // Specified the problem name. This is used as a prefix for files
+    // Specifies the problem name. This is used as a prefix for files
     // generated by the simulation.
     const char *name() const
     { return "tutorial_coupled"; }
@@ -142,7 +142,7 @@ public:
 
     //! Returns true if the current solution should be written to disk (i.e. as a VTK file)
     /*! The default behaviour is to write out the solution for
-     *  every time step. Else, change divisor.
+     *  every time step. Else, the user has to change the divisor in this function.
      */
     bool shouldWriteOutput() const /*@\label{tutorial-coupled:output}@*/
     {

examples/tutorialspatialparameters_coupled.hh

@@ -97,6 +97,8 @@ public:
         BoxSpatialParameters<TypeTag>(gridView),
         K_(0)
     {
+        //set main diagonal entries of the permeability tensor to a value
+        //setting to one value means: isotropic, homogeneous
         for (int i = 0; i < dim; i++)
             K_[i][i] = 1e-7;
 
@@ -104,14 +106,14 @@ public:
         materialParams_.setSwr(0.0);                /*@\label{tutorial-coupled:setLawParams}@*/
         materialParams_.setSnr(0.0);
 
-        //linear material law
+        //parameters of Brooks & Corey Law
         materialParams_.setPe(500.0);
         materialParams_.setAlpha(2);
     }
 
 private:
     Dune::FieldMatrix<Scalar, dim, dim> K_;
-    // Object that helds the values/parameters of the selected material law.
+    // Object that holds the values/parameters of the selected material law.
     MaterialLawParams materialParams_;                 /*@\label{tutorial-coupled:matParamsObject}@*/
 };
 } // end namespace