From fcadd3508707ece9ff946f03768960bc5eeb4aa8 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 30 Mar 2007 22:11:05 +0000 Subject: [PATCH] More comments in the derived classes. git-svn-id: https://svn.dealii.org/trunk@14612 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/petsc_precondition.h | 26 +++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/deal.II/lac/include/lac/petsc_precondition.h b/deal.II/lac/include/lac/petsc_precondition.h index d4a36c3ec0..f8a77a4b6f 100644 --- a/deal.II/lac/include/lac/petsc_precondition.h +++ b/deal.II/lac/include/lac/petsc_precondition.h @@ -41,7 +41,7 @@ namespace PETScWrappers * only to allow a similar interface as already used for the deal.II solver * and preconditioner classes. * - * Note that the classes here only provide interfaces to the relevant + * Note that derived classes only provide interfaces to the relevant * functionality of PETSc. PETSc does not implement all preconditioners for * all matrix types. In particular, some preconditioners are not going to work * for parallel jobs, such as for example the ILU preconditioner. @@ -105,6 +105,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Jacobi * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -158,6 +161,9 @@ namespace PETScWrappers * the matrix for preconditioning. This can be changed, as is explained in the * relevant section of the PETSc manual, but is not implemented here. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -204,6 +210,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc SOR * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -267,6 +276,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc SSOR * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -330,6 +342,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Eisenstat * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -393,6 +408,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc Incomplete Cholesky * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -456,6 +474,9 @@ namespace PETScWrappers * A class that implements the interface to use the PETSc ILU * preconditioner. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ @@ -521,6 +542,9 @@ namespace PETScWrappers * processor machines. It should provide a convenient interface to * another direct solver. * + * See the comment in the base class @ref PreconditionerBase for when this + * preconditioner may or may not work. + * * @ingroup PETScWrappers * @author Oliver Kayser-Herold, 2004 */ -- 2.39.5