Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::NonLinearSolver Struct Reference

#include <parameters.h>

Public Types

enum class  SolverType : std::int8_t { newton , inexact_newton , kinsol_newton }
enum class  KinsolStrategy : std::int8_t { normal_newton , line_search , picard }

Public Member Functions

void parse_parameters (ParameterHandler &prm, const std::string &physics_name)

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm, const std::string &physics_name)

Public Attributes

Verbosity verbosity = Verbosity::verbose
SolverType solver = SolverType::newton
KinsolStrategy kinsol_strategy = KinsolStrategy::line_search
double tolerance = 1e-6
unsigned int max_iterations = 10
bool force_rhs_calculation = false
double matrix_tolerance = 0.1
double step_tolerance = 0.9
bool reuse_matrix = false
bool reuse_preconditioner = false
bool abort_at_convergence_failure = false

Detailed Description

NonLinearSolver - Parameter that controls the solution of the non-linear problems.

Definition at line 1707 of file parameters.h.

Member Enumeration Documentation

◆ KinsolStrategy

enum class Parameters::NonLinearSolver::KinsolStrategy : std::int8_t
strong
Enumerator
normal_newton 
line_search 
picard 

Definition at line 1718 of file parameters.h.

◆ SolverType

enum class Parameters::NonLinearSolver::SolverType : std::int8_t
strong
Enumerator
newton 
inexact_newton 
kinsol_newton 

Definition at line 1710 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

void Parameters::NonLinearSolver::declare_parameters ( ParameterHandler & prm,
const std::string & physics_name )
static

Declare the parameters.

Parameters
[in,out]prmParameterHandler object.
[in]physics_nameName of the current physics

Definition at line 3057 of file parameters.cc.

References abort_at_convergence_failure, declare_enum_entry(), Parameters::deprecated_verbosity_names(), force_rhs_calculation, kinsol_strategy, matrix_tolerance, max_iterations, Parameters::quiet_or_verbose(), reuse_matrix, reuse_preconditioner, solver, step_tolerance, tolerance, and verbosity.

◆ parse_parameters()

void Parameters::NonLinearSolver::parse_parameters ( ParameterHandler & prm,
const std::string & physics_name )

Parse the parameters.

Parameters
[in]prmParameterHandler object.
[in]physics_nameName of the current physics

Definition at line 3155 of file parameters.cc.

References abort_at_convergence_failure, Parameters::deprecated_verbosity_names(), force_rhs_calculation, kinsol_strategy, matrix_tolerance, max_iterations, reuse_matrix, reuse_preconditioner, solver, step_tolerance, string_to_enum(), tolerance, and verbosity.

Member Data Documentation

◆ abort_at_convergence_failure

bool Parameters::NonLinearSolver::abort_at_convergence_failure = false

Definition at line 1763 of file parameters.h.

◆ force_rhs_calculation

bool Parameters::NonLinearSolver::force_rhs_calculation = false

Definition at line 1744 of file parameters.h.

◆ kinsol_strategy

KinsolStrategy Parameters::NonLinearSolver::kinsol_strategy = KinsolStrategy::line_search

Definition at line 1731 of file parameters.h.

◆ matrix_tolerance

double Parameters::NonLinearSolver::matrix_tolerance = 0.1

Definition at line 1751 of file parameters.h.

◆ max_iterations

unsigned int Parameters::NonLinearSolver::max_iterations = 10

Definition at line 1737 of file parameters.h.

◆ reuse_matrix

bool Parameters::NonLinearSolver::reuse_matrix = false

Definition at line 1757 of file parameters.h.

◆ reuse_preconditioner

bool Parameters::NonLinearSolver::reuse_preconditioner = false

Definition at line 1760 of file parameters.h.

◆ solver

SolverType Parameters::NonLinearSolver::solver = SolverType::newton

Definition at line 1728 of file parameters.h.

◆ step_tolerance

double Parameters::NonLinearSolver::step_tolerance = 0.9

Definition at line 1754 of file parameters.h.

◆ tolerance

double Parameters::NonLinearSolver::tolerance = 1e-6

Definition at line 1734 of file parameters.h.

◆ verbosity

Verbosity Parameters::NonLinearSolver::verbosity = Verbosity::verbose

Definition at line 1725 of file parameters.h.


The documentation for this struct was generated from the following files: