]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Doc update.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 5 May 2000 16:26:02 +0000 (16:26 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 5 May 2000 16:26:02 +0000 (16:26 +0000)
git-svn-id: https://svn.dealii.org/trunk@2811 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparse_matrix.h

index 29537c7049694ec51f55e10a19b4f62f992967d1..f2c55884ed14d9262e64479dde1bb09f879097a3 100644 (file)
@@ -435,11 +435,22 @@ class SparseMatrix : public Subscriptor
     somenumber residual (Vector<somenumber>       &dst,
                         const Vector<somenumber> &x,
                         const Vector<somenumber> &b) const;
-                                    //
+    
+                                    /**
+                                     * Apply the Jacobi
+                                     * preconditioner, which
+                                     * multiplies every element of
+                                     * the #src# vector by the
+                                     * inverse of the respective
+                                     * diagonal element and
+                                     * multiplies the result with the
+                                     * damping factor #omega#.
+                                     */
     template <typename somenumber>
     void precondition_Jacobi (Vector<somenumber>       &dst,
                              const Vector<somenumber> &src,
-                             const number              om = 1.) const;
+                             const number              omega = 1.) const;
+
                                     /**
                                      * Apply SOR preconditioning to
                                      * #src#.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.