more doxygen documentation

[[Imported from SVN: r1024]]

solver/common/iterationstep.hh

@@ -43,15 +43,20 @@ namespace Dune {
     //! The grid level the iteration step is working on
     virtual int level() const {return level_;}
 
+    //! The solution container
     DiscFuncType* x_;
 
+    //! The container for the right hand side
     DiscFuncType* rhs_;
 
+    //! The linear operator
     OperatorType* mat_;
 
+    /** \brief A flag for each degree of freedom stating whether the
+     * dof is dirichlet or not */
     const std::vector<bool>* dirichletNodes_;
 
-    //! The level of a multigrid hierarchy that is iterator is supposed to work on
+    //! The level of a multigrid hierarchy that this iterator is supposed to work on
     int level_;
 
   };

solver/common/linearsolver.hh

@@ -8,20 +8,27 @@
 
 namespace Dune {
 
-  template <class OP_TYPE, class VEC_TYPE>
+  /** \brief A generic linear solver
+   *
+   *  This class basically implements a loop that calls
+   * an iteration procedure (which is to be supplied be
+   * the user).  It also monitors convergence. */
+  template <class OperatorType, class DiscFuncType>
   class LinearSolver : public Solver
   {
   public:
+    /** \brief Loop, call the iteration procedure
+     * and monitor convergence */
     virtual void solve();
 
-
-    //protected:
-
+    //! The maximum number of iterations
     int numIt;
 
-    IterationStep<OP_TYPE,VEC_TYPE>* iterationStep;
+    //! The iteration step used by the algorithm
+    IterationStep<OperatorType,DiscFuncType>* iterationStep;
 
-    Norm<VEC_TYPE>* errorNorm_;
+    //! The norm used to measure convergence
+    Norm<DiscFuncType>* errorNorm_;
 
   };
 

solver/common/solver.hh

@@ -7,14 +7,19 @@
 
 namespace Dune {
 
+  /** \brief The base class for all sorts of solver algorithms */
   class Solver : public NumProc
   {
   public:
 
+    /** \brief Do the necessary preprocessing */
     virtual void preprocess();
 
+    /** \brief Derived classes overload this with the actual
+     * solution algorithm */
     virtual void solve() = 0;
 
+    /** \brief The requested tolerance of the solver */
     double tolerance_;
 
   };