]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation 1132/head
authorMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 14 Jul 2015 06:35:33 +0000 (08:35 +0200)
committerMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 14 Jul 2015 06:35:33 +0000 (08:35 +0200)
include/deal.II/lac/solver_gmres.h

index b5a832cc324aa9c8e58e8f6a297ae16adc38c4c8..c37f941d1a00178b6f8513b6f13643b51895201d 100644 (file)
@@ -396,7 +396,9 @@ private:
  * preconditioner in each iteration step. Therefore, it is also more robust
  * with respect to inaccurate evaluation of the preconditioner. An important
  * application is also the use of a Krylov space method inside the
- * preconditioner.
+ * preconditioner. As opposed to SolverGMRES which allows one to choose
+ * between left and right preconditioning, this solver always applies the
+ * preconditioner from the right.
  *
  * FGMRES needs two vectors in each iteration steps yielding a total of
  * <tt>2*SolverFGMRES::AdditionalData::max_basis_size+1</tt> auxiliary
@@ -417,9 +419,7 @@ public:
   struct AdditionalData
   {
     /**
-     * Constructor. By default, set the number of temporary vectors to 30,
-     * preconditioning from left and the residual of the stopping criterion to
-     * the default residual (cf. class documentation).
+     * Constructor. By default, set the maximum basis size to 30.
      */
     AdditionalData(const unsigned int max_basis_size = 30,
                    const bool /*use_default_residual*/ = true)
@@ -458,14 +458,17 @@ public:
          const PRECONDITIONER &precondition);
 
 private:
+
   /**
    * Additional flags.
    */
   AdditionalData additional_data;
+
   /**
    * Projected system matrix
    */
   FullMatrix<double> H;
+
   /**
    * Auxiliary matrix for inverting @p H
    */

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.