Merge pull request #15231 from tjhei/doc_petsc_snes

improve documentation for PETSc SNES
dealii · May 17, 2023 · 0ca6e8d · 0ca6e8d
2 parents beebf1a + 8f04855
commit 0ca6e8d
Showing 1 changed file with 9 additions and 2 deletions.
diff --git 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;