Arcane::Alina::BiCGStabSolverParams Struct Reference

Parameters for BiConjugate Gradient Stabilized solver. More...

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

Collaboration diagram for Arcane::Alina::BiCGStabSolverParams:

Public Types
using	params = BiCGStabSolverParams

Public Member Functions
	BiCGStabSolverParams (const PropertyTree &p)
void	get (PropertyTree &p, const std::string &path) const

Public Attributes
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	check_after = false
	Always do at least one iteration.
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 BiConjugate Gradient Stabilized solver.

Definition at line 40 of file BiCGStabSolver.h.

Member Typedef Documentation

params

using Arcane::Alina::BiCGStabSolverParams::params = BiCGStabSolverParams

Definition at line 42 of file BiCGStabSolver.h.

Constructor & Destructor Documentation

BiCGStabSolverParams()

Arcane::Alina::BiCGStabSolverParams::BiCGStabSolverParams ( const PropertyTree & p )

inline

Definition at line 68 of file BiCGStabSolver.h.

Member Function Documentation

get()

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

inline

Definition at line 80 of file BiCGStabSolver.h.

Member Data Documentation

abstol

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

Target absolute residual error.

Definition at line 54 of file BiCGStabSolver.h.

check_after

bool Arcane::Alina::BiCGStabSolverParams::check_after = false

Always do at least one iteration.

Definition at line 57 of file BiCGStabSolver.h.

maxiter

Int32 Arcane::Alina::BiCGStabSolverParams::maxiter = 100

Maximum number of iterations.

Definition at line 48 of file BiCGStabSolver.h.

ns_search

bool Arcane::Alina::BiCGStabSolverParams::ns_search = false

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

Definition at line 61 of file BiCGStabSolver.h.

pside

ePreconditionerSideType Arcane::Alina::BiCGStabSolverParams::pside = ePreconditionerSideType::right

Preconditioning kind (left/right).

Definition at line 45 of file BiCGStabSolver.h.

tol

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

Target relative residual error.

Definition at line 51 of file BiCGStabSolver.h.

verbose

bool Arcane::Alina::BiCGStabSolverParams::verbose = false

Verbose output (show iterations and error).

Definition at line 64 of file BiCGStabSolver.h.

---

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

• BiCGStabSolver.h