]> https://gitweb.dealii.org/ - dealii.git/commitdiff
better document SolverPreOnly.
authorTimo Heister <timo.heister@gmail.com>
Fri, 14 Jan 2011 21:04:06 +0000 (21:04 +0000)
committerTimo Heister <timo.heister@gmail.com>
Fri, 14 Jan 2011 21:04:06 +0000 (21:04 +0000)
git-svn-id: https://svn.dealii.org/trunk@23192 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/lac/petsc_solver.h

index 545ce0d0ba40dcc60f68bdd8ca839f7e6594e556..34368cd4365f71fe0b755048b3bbba1ec4ea5105 100644 (file)
@@ -1040,11 +1040,12 @@ namespace PETScWrappers
 
 /**
  * An implementation of the solver interface using the PETSc PREONLY
- * solver. Actually this is NOT a real solution algorithm. Its only
- * purpose is to provide a solver object, when the preconditioner
- * should be used as real solver. It is very useful in conjunction with
- * the complete LU decomposition preconditioner <tt> PreconditionLU </tt>,
- * which in conjunction with this solver class becomes a direct solver.
+ * solver. Actually this is NOT a real solution algorithm. solve() only
+ * applies the preconditioner once and returns immediately. Its only purpose
+ * is to provide a solver object, when the preconditioner should be used as a
+ * real solver. It is very useful in conjunction with the complete LU
+ * decomposition preconditioner <tt> PreconditionLU </tt>, which in
+ * conjunction with this solver class becomes a direct solver.
  *
  * @ingroup PETScWrappers
  * @author Wolfgang Bangerth, 2004, Oliver Kayser-Herold, 2004

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.