From: Timo Heister Date: Fri, 14 Jan 2011 21:04:06 +0000 (+0000) Subject: better document SolverPreOnly. X-Git-Tag: v8.0.0~4487 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14c6b0b9bcd35bea5d9a4834c20eb2010a86f792;p=dealii.git better document SolverPreOnly. git-svn-id: https://svn.dealii.org/trunk@23192 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/lac/petsc_solver.h b/deal.II/include/deal.II/lac/petsc_solver.h index 545ce0d0ba..34368cd436 100644 --- a/deal.II/include/deal.II/lac/petsc_solver.h +++ b/deal.II/include/deal.II/lac/petsc_solver.h @@ -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 PreconditionLU , - * 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 PreconditionLU , which in + * conjunction with this solver class becomes a direct solver. * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004, Oliver Kayser-Herold, 2004