From: Wolfgang Bangerth Date: Sat, 19 Apr 2025 01:52:10 +0000 (-0600) Subject: Add to some documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e7d5988d1939f8e02baa8351bf786ce01c21be84;p=dealii.git Add to some documentation. --- diff --git a/include/deal.II/lac/petsc_precondition.h b/include/deal.II/lac/petsc_precondition.h index 9d5e117be8..a5169f9b06 100644 --- a/include/deal.II/lac/petsc_precondition.h +++ b/include/deal.II/lac/petsc_precondition.h @@ -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 diff --git a/include/deal.II/lac/trilinos_precondition.h b/include/deal.II/lac/trilinos_precondition.h index 11d1c16b79..7c276c4be2 100644 --- a/include/deal.II/lac/trilinos_precondition.h +++ b/include/deal.II/lac/trilinos_precondition.h @@ -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. *