]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Modified a few comments in SparseDirectUMFPACK to match the actually
authorkayser-herold <kayser-herold@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Dec 2006 03:49:31 +0000 (03:49 +0000)
committerkayser-herold <kayser-herold@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Dec 2006 03:49:31 +0000 (03:49 +0000)
implemented behaviour of the methods.

git-svn-id: https://svn.dealii.org/trunk@14221 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparse_direct.h

index 685bdcfe8e1bae4b2b1ac79a59e809c5a38af714..2d088c5ff27d4a7ca843838e88eb7269d3a83c23 100644 (file)
@@ -298,7 +298,8 @@ class SparseDirectMA27 : public Subscriptor
     void solve (Vector<number> &rhs_and_solution) const;
 
                                     /**
-                                     * Call the three functions above
+                                     * Call the three functions 
+                                     * initialize, factorize and solve
                                      * in that order, i.e. perform
                                      * the whole solution process for
                                      * the given right hand side
@@ -764,7 +765,9 @@ class SparseDirectMA47 : public Subscriptor
     void solve (Vector<double> &rhs_and_solution);
 
                                     /**
-                                     * Call the three functions above
+                                     * Call the three functions
+                                     * initialize, factorize and
+                                     * solve
                                      * in that order, i.e. perform
                                      * the whole solution process for
                                      * the given right hand side
@@ -1089,11 +1092,13 @@ class SparseDirectUMFPACK : public Subscriptor
                                      * functionality may not always be of
                                      * large benefit.
                                      *
-                                     * If the initialization step has
-                                     * not been performed yet, then
-                                     * the initialize() function is
-                                     * called at the beginning of
-                                     * this function.
+                                     * In contrast to the other direct solver
+                                     * classes, the initialisation method
+                                     * does nothing. Therefore initialise 
+                                     * is not automatically called by this
+                                     * method, when
+                                     * the initialization step has
+                                     * not been performed yet.
                                      *
                                      * This function copies the contents of
                                      * the matrix into its own storage; the
@@ -1114,10 +1119,14 @@ class SparseDirectUMFPACK : public Subscriptor
     
                                     /**
                                      * Preconditioner interface
-                                     * function. Given the source
-                                     * vector, returns the
+                                     * function. Usually, given the source
+                                     * vector, this method returns an
                                      * approximated solution of <i>Ax
-                                     * = b</i>.
+                                     * = b</i>. As this class provides a
+                                     * wrapper to a direct solver, here
+                                     * it is actually the exact solution
+                                     * (exact within the range of numerical
+                                     * accuracy of course).
                                      */
     void vmult (Vector<double>&, const Vector<double>&) const;
 
@@ -1168,7 +1177,8 @@ class SparseDirectUMFPACK : public Subscriptor
     void solve (Vector<double> &rhs_and_solution) const;
 
                                     /**
-                                     * Call the three functions above
+                                     * Call the two functions 
+                                     * factorize and solve
                                      * in that order, i.e. perform
                                      * the whole solution process for
                                      * the given right hand side

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.