Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::Alina::GMRESSolverParams Struct Reference

Parameters for GMRES solver. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/alina/arccore/alina/GMRESSolver.h>

Collaboration diagram for Arcane::Alina::GMRESSolverParams:

Public Types

using params = GMRESSolverParams

Public Member Functions

 GMRESSolverParams (const PropertyTree &p)
void get (PropertyTree &p, const std::string &path) const

Public Attributes

Int32 M = 30
 Number of iterations before restart.
ePreconditionerSideType pside = ePreconditionerSideType::right
 Preconditioning kind (left/right).
Int32 maxiter = 100
 Maximum number of iterations.
double tol = 1.0e-8
 Target relative residual error.
double abstol = std::numeric_limits<double>::min()
 Target absolute residual error.
bool ns_search = false
 Ignore the trivial solution x=0 when rhs is zero.
bool verbose = false
 Verbose output (show iterations and error).

Detailed Description

Parameters for GMRES solver.

Definition at line 40 of file GMRESSolver.h.

Member Typedef Documentation

◆ params

using Arcane::Alina::GMRESSolverParams::params = GMRESSolverParams

Definition at line 42 of file GMRESSolver.h.

Constructor & Destructor Documentation

◆ GMRESSolverParams()

Arcane::Alina::GMRESSolverParams::GMRESSolverParams ( const PropertyTree & p)
inline

Definition at line 68 of file GMRESSolver.h.

Member Function Documentation

◆ get()

void Arcane::Alina::GMRESSolverParams::get ( PropertyTree & p,
const std::string & path ) const
inline

Definition at line 80 of file GMRESSolver.h.

Member Data Documentation

◆ abstol

double Arcane::Alina::GMRESSolverParams::abstol = std::numeric_limits<double>::min()

Target absolute residual error.

Definition at line 57 of file GMRESSolver.h.

◆ M

Int32 Arcane::Alina::GMRESSolverParams::M = 30

Number of iterations before restart.

Definition at line 45 of file GMRESSolver.h.

◆ maxiter

Int32 Arcane::Alina::GMRESSolverParams::maxiter = 100

Maximum number of iterations.

Definition at line 51 of file GMRESSolver.h.

◆ ns_search

bool Arcane::Alina::GMRESSolverParams::ns_search = false

Ignore the trivial solution x=0 when rhs is zero.

Definition at line 61 of file GMRESSolver.h.

◆ pside

ePreconditionerSideType Arcane::Alina::GMRESSolverParams::pside = ePreconditionerSideType::right

Preconditioning kind (left/right).

Definition at line 48 of file GMRESSolver.h.

◆ tol

double Arcane::Alina::GMRESSolverParams::tol = 1.0e-8

Target relative residual error.

Definition at line 54 of file GMRESSolver.h.

◆ verbose

bool Arcane::Alina::GMRESSolverParams::verbose = false

Verbose output (show iterations and error).

Definition at line 64 of file GMRESSolver.h.


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