Reference documentation for deal.II version GIT e8f57130d0 2023-09-28 07:00:03+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
petsc_snes.cc
Go to the documentation of this file.
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2023 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef DOXYGEN
17 
18 # include <deal.II/base/config.h>
19 
20 # ifdef DEAL_II_WITH_PETSC
21 
23 # include <deal.II/lac/petsc_snes.templates.h>
24 
26 
27 namespace PETScWrappers
28 {
29  void
31  {
32  prm.enter_subsection("Running parameters");
33  prm.add_parameter(
34  "options prefix",
36  "The string indicating the options prefix for command line customization.");
37  prm.add_parameter("solver type",
38  snes_type,
39  "The string indicating the PETSc SNES type.");
40  prm.add_parameter("linesearch type",
42  "The string indicating the PETSc linesearch type.");
43  prm.add_parameter("absolute error tolerance",
45  "Absolute error tolerance.");
46  prm.add_parameter("relative error tolerance",
48  "Relative error tolerance.");
49  prm.add_parameter("step tolerance", step_tolerance, "Step tolerance.");
50  prm.add_parameter("maximum iterations",
52  "Maximum number of iterations allowed.");
53  prm.add_parameter("maximum function evaluations",
55  "Maximum number of function evaluations allowed.");
56  prm.leave_subsection();
57  }
58 
59 } // namespace PETScWrappers
60 
66 template class PETScWrappers::NonlinearSolver<
69 
70 
72 
73 # endif // DEAL_II_WITH_PETSC
74 #endif
void add_parameters(ParameterHandler &prm)
void add_parameter(const std::string &entry, ParameterType &parameter, const std::string &documentation="", const Patterns::PatternBase &pattern= *Patterns::Tools::Convert< ParameterType >::to_pattern(), const bool has_to_be_set=false)
void enter_subsection(const std::string &subsection)
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:477
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:478
BlockVector< double > BlockVector