]> https://gitweb.dealii.org/ - dealii.git/commitdiff
improve documentation for PETSc SNES 15231/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 17 May 2023 00:24:45 +0000 (20:24 -0400)
committerTimo Heister <timo.heister@gmail.com>
Wed, 17 May 2023 00:25:48 +0000 (20:25 -0400)
include/deal.II/lac/petsc_snes.h

index 19750041e59ed738bc20e5ad06dfaa033769d98a..7afa68ce9e77cde7230da9f748e710c76bb17419 100644 (file)
@@ -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;
 

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.