]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add to some documentation. 18368/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 19 Apr 2025 01:52:10 +0000 (19:52 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 19 Apr 2025 15:24:51 +0000 (09:24 -0600)
include/deal.II/lac/petsc_precondition.h
include/deal.II/lac/trilinos_precondition.h

index 9d5e117be8ca1c4680c2fe59b7b8ec7d18f257c5..a5169f9b06453342dfcf15acc7a8b44350471bad 100644 (file)
@@ -612,9 +612,15 @@ namespace PETScWrappers
    * multigrid preconditioner from the HYPRE suite. Note that PETSc has to be
    * configured with HYPRE (e.g. with \--download-hypre=1).
    *
-   * The preconditioner does support parallel distributed computations. See
+   * This preconditioner does support parallel distributed computations. See
    * step-40 for an example.
    *
+   * This class can be used as a preconditioner for linear solvers. It
+   * also provides a `vmult()` function (implemented in the
+   * PreconditionBase base class) that, when called, performs one
+   * multigrid cycle. By default, this is a V-cycle, but the
+   * AdditionalData class allows to also select a W-cycle.
+   *
    * @ingroup PETScWrappers
    */
   class PreconditionBoomerAMG : public PreconditionBase
index 11d1c16b797125997b8ffa888a0e4aa1242e2279..7c276c4be26f58a7bb3862dd9f55cf6813336cd3 100644 (file)
@@ -1308,6 +1308,12 @@ namespace TrilinosWrappers
    * many processors. SSOR, on the other hand, gets more Jacobi-like on many
    * processors.
    *
+   * This class can be used as a preconditioner for linear solvers. It
+   * also provides a `vmult()` function (implemented in the
+   * PreconditionBase base class) that, when called, performs one
+   * multigrid cycle. By default, this is a V-cycle, but the
+   * AdditionalData class allows to also select a W-cycle.
+   *
    * @ingroup TrilinosWrappers
    * @ingroup Preconditioners
    */
@@ -1692,9 +1698,17 @@ namespace TrilinosWrappers
    * on the Trilinos MueLu implementation, which is a black-box preconditioner
    * that works well for many PDE-based linear problems. The interface of
    * PreconditionerAMGMueLu is the same as the interface of PreconditionerAMG
-   * except for the higher_order_elements parameter which does not exist in
+   * (which, instead of the Trilinos package MueLu is built on the older
+   * Trilinos package ML). The only functional difference between the two
+   * classes is the `higher_order_elements` parameter which does not exist in
    * PreconditionerAMGMueLu.
    *
+   * This class can be used as a preconditioner for linear solvers. It
+   * also provides a `vmult()` function (implemented in the
+   * PreconditionBase base class) that, when called, performs one
+   * multigrid cycle. By default, this is a V-cycle, but the
+   * AdditionalData class allows to also select a W-cycle.
+   *
    * @note You need to configure Trilinos with MueLU support for this
    * preconditioner to work.
    *

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.