]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a comment for SSOR.
authorMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Wed, 29 Apr 2009 16:32:43 +0000 (16:32 +0000)
committerMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Wed, 29 Apr 2009 16:32:43 +0000 (16:32 +0000)
git-svn-id: https://svn.dealii.org/trunk@18791 0785d39b-7218-0410-832d-ea1e28bc413d

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

index b6cf3d02ba7226b8a5b077c54617af25104ce2df..1abfa7aecd9bdffbaea1e80876ee3bcb4a02fe46 100644 (file)
@@ -1503,12 +1503,19 @@ class SparseMatrix : public virtual Subscriptor
 
                                     /**
                                      * Apply SSOR preconditioning to
-                                     * <tt>src</tt>.
+                                     * <tt>src</tt> with damping
+                                     * <tt>omega</tt>. The optional
+                                     * argument
+                                     * <tt>pos_right_of_diagonal</tt> is
+                                     * supposed to provide an array where
+                                     * each entry specifies the position
+                                     * just right of the diagonal in the
+                                     * global array of nonzeros.
                                      */
     template <typename somenumber>
     void precondition_SSOR (Vector<somenumber>             &dst,
                            const Vector<somenumber>       &src,
-                           const number                    om = 1.,
+                           const number                    omega = 1.,
                            const std::vector<unsigned int>&pos_right_of_diagonal=std::vector<unsigned int>()) const;
 
                                     /**

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.