fix doxygen comments of NewtonController, remove some commented code from BoxLocalJacobian

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4985 2fb0f335-1f38-0410-981e-8018bf24f1b0

dumux/boxmodels/common/boxlocaljacobian.hh

@@ -174,19 +174,11 @@ public:
 
         // update the secondary variables for the element at the last
         // and the current time levels
-/*        prevVolVars_.resize(numVertices);
-        for (int i = 0; i < numVertices; ++i)
-            prevVolVars_[i].setNoHint();
-*/
         prevVolVars_.update(problem_(),
                             elem_(),
                             fvElemGeom_,
                             true /* isOldSol? */);
 
-/*        curVolVars_.resize(numVertices);
-        for (int i = 0; i < numVertices; ++i)
-            curVolVars_[i].setHint(prevVolVars_[i]);
-*/
         curVolVars_.update(problem_(),
                            elem_(),
                            fvElemGeom_,
@@ -317,7 +309,7 @@ protected:
      *        an degree of freedom.
      *
      * This method can be overwritten by the implementation if a
-     * better scheme than central differences ought to be used.
+     * better scheme than numerical differentiation is available.
      *
      * The default implementation of this method uses numeric
      * differentiation, i.e. forward or backward differences (2nd
@@ -370,7 +362,7 @@ protected:
 
         if (numDiffMethod >= 0) { 
             // we are not using backward differences, i.e. we need to
-            // calculate f(x - \epsilon)
+            // calculate f(x + \epsilon)
 
             // deflect primary variables
             priVars[pvIdx] += eps;
@@ -394,7 +386,7 @@ protected:
         }
         else {
             // we are using backward differences, i.e. we don't need
-            // to calculate f(x - \epsilon) and we can recycle the
+            // to calculate f(x + \epsilon) and we can recycle the
             // (already calculated) residual f(x)
             dest = residual_;
         }
@@ -402,7 +394,7 @@ protected:
 
         if (numDiffMethod <= 0) { 
             // we are not using forward differences, i.e. we don't
-            // need to calculate f(x + \epsilon)
+            // need to calculate f(x - \epsilon)
 
             // deflect the primary variables
             priVars[pvIdx] -= delta + eps;
@@ -424,7 +416,7 @@ protected:
         }
         else {
             // we are using forward differences, i.e. we don't need to
-            // calculate f(x + \epsilon) and we can recycle the
+            // calculate f(x - \epsilon) and we can recycle the
             // (already calculated) residual f(x)
             dest -= residual_;
         }

dumux/nonlinear/newtoncontroller.hh

@@ -327,7 +327,7 @@ public:
     /*!
      * \brief Returns true if another iteration should be done.
      *
-     * \param u The current solution
+     * \param uCurrentIter The solution of the current newton iteration
      */
     bool newtonProceed(const SolutionVector &uCurrentIter)
     {
@@ -525,8 +525,8 @@ public:
     /*!
      * \brief Indicates that one newton iteration was finished.
      *
-     * \param u The solution after the current iteration
-     * \param uLastIter The solution at the beginning of the current iteration
+     * \param uCurrentIter The solution after the current Newton iteration
+     * \param uLastIter The solution at the beginning of the current Newton iteration
      */
     void newtonEndStep(const SolutionVector &uCurrentIter, 
                        const SolutionVector &uLastIter)