]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
More comments in the derived classes.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 30 Mar 2007 22:11:05 +0000 (22:11 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 30 Mar 2007 22:11:05 +0000 (22:11 +0000)
git-svn-id: https://svn.dealii.org/trunk@14612 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/petsc_precondition.h

index d4a36c3ec044794878e458ac9e19ea7abbe3e529..f8a77a4b6f6566c47abf620c692bbcdc2fc39335 100644 (file)
@@ -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
  */

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.