From: Timo Heister Date: Wed, 17 May 2023 00:24:45 +0000 (-0400) Subject: improve documentation for PETSc SNES X-Git-Tag: v9.5.0-rc1~222^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8f04855644a073a8bcec1d044f968056a71ebe2b;p=dealii.git improve documentation for PETSc SNES --- diff --git a/include/deal.II/lac/petsc_snes.h b/include/deal.II/lac/petsc_snes.h index 19750041e5..7afa68ce9e 100644 --- a/include/deal.II/lac/petsc_snes.h +++ b/include/deal.II/lac/petsc_snes.h @@ -102,12 +102,19 @@ namespace PETScWrappers std::string options_prefix; /** - * PETSc solver type. + * PETSc nonlinear solver type. Valid options include "newtonls" + * (Newton with line search), "newtontr" (Newton with Trust + * Region), "nrichardson" (Picard), and many more. See + * https://petsc.org/release/manualpages/SNES/SNESType/ for more + * information. */ std::string snes_type; /** - * Linesearch type. + * Linesearch type. Valid options include "bt" (backtracking) and + * "basic" (no line search). See + * https://petsc.org/release/manualpages/SNES/SNESLineSearchType/ + * for more information. */ std::string snes_linesearch_type;