PETScWrappers::NonlinearSolverData Class Reference

#include <deal.II/lac/petsc_snes.h>

Public Types
using	real_type = PetscReal

Public Member Functions
	NonlinearSolverData (const std::string &options_prefix="", const std::string &snes_type="", const std::string &snes_linesearch_type="", const real_type absolute_tolerance=0, const real_type relative_tolerance=0, const real_type step_tolerance=0, const int maximum_non_linear_iterations=-1, const int max_n_function_evaluations=-1)
void	add_parameters (ParameterHandler &prm)

Public Attributes
std::string	options_prefix
std::string	snes_type
std::string	snes_linesearch_type
real_type	absolute_tolerance
real_type	relative_tolerance
real_type	step_tolerance
int	maximum_non_linear_iterations
int	max_n_function_evaluations

Detailed Description

Additional parameters that can be passed to the NonlinearSolver class.

Definition at line 45 of file petsc_snes.h.

Member Typedef Documentation

real_type

using PETScWrappers::NonlinearSolverData::real_type = PetscReal

Type that holds real-valued numbers.

Used to represent norms.

Definition at line 53 of file petsc_snes.h.

Member Function Documentation

add_parameters()

void PETScWrappers::NonlinearSolverData::add_parameters

(

ParameterHandler &

prm

)

Import parameter values.

Member Data Documentation

options_prefix

std::string PETScWrappers::NonlinearSolverData::options_prefix

Options database prefix.

Definition at line 103 of file petsc_snes.h.

snes_type

std::string PETScWrappers::NonlinearSolverData::snes_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.

Definition at line 112 of file petsc_snes.h.

snes_linesearch_type

std::string PETScWrappers::NonlinearSolverData::snes_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.

Definition at line 120 of file petsc_snes.h.

absolute_tolerance

real_type PETScWrappers::NonlinearSolverData::absolute_tolerance

Absolute error tolerance for function evaluation.

Note

Non-positive values indicate to use PETSc's default.

Definition at line 127 of file petsc_snes.h.

relative_tolerance

real_type PETScWrappers::NonlinearSolverData::relative_tolerance

Relative error tolerance for function evaluation.

Note

Non-positive values indicate to use PETSc's default.

Definition at line 134 of file petsc_snes.h.

step_tolerance

real_type PETScWrappers::NonlinearSolverData::step_tolerance

Step tolerance for solution update.

Note

Non-positive values indicate to use PETSc's default.

Definition at line 141 of file petsc_snes.h.

maximum_non_linear_iterations

int PETScWrappers::NonlinearSolverData::maximum_non_linear_iterations

Maximum number of nonlinear iterations allowed.

Note

Negative values indicate to use PETSc's default.

Definition at line 148 of file petsc_snes.h.

max_n_function_evaluations

int PETScWrappers::NonlinearSolverData::max_n_function_evaluations

Maximum number of function evaluations allowed.

Note

Negative values indicate to use PETSc's default.

Definition at line 155 of file petsc_snes.h.

---

The documentation for this class was generated from the following file:

• include/deal.II/lac/petsc_snes.h