Arcane::Alina::ConjugateGradientSolverParams Struct Reference

Parameters for Conjugate Gradient solver. More...

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

Collaboration diagram for Arcane::Alina::ConjugateGradientSolverParams:

Public Types
using	params = ConjugateGradientSolverParams

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

Public Attributes
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 Conjugate Gradient solver.

Definition at line 42 of file ConjugateGradientSolver.h.

Member Typedef Documentation

params

using Arcane::Alina::ConjugateGradientSolverParams::params = ConjugateGradientSolverParams

Definition at line 44 of file ConjugateGradientSolver.h.

Constructor & Destructor Documentation

ConjugateGradientSolverParams()

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

inline

Definition at line 67 of file ConjugateGradientSolver.h.

Member Function Documentation

get()

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

inline

Definition at line 77 of file ConjugateGradientSolver.h.

Member Data Documentation

abstol

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

Target absolute residual error.

Definition at line 53 of file ConjugateGradientSolver.h.

maxiter

Int32 Arcane::Alina::ConjugateGradientSolverParams::maxiter = 100

Maximum number of iterations.

Definition at line 47 of file ConjugateGradientSolver.h.

ns_search

bool Arcane::Alina::ConjugateGradientSolverParams::ns_search = false

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

Useful for searching for the null-space vectors of the system.

Definition at line 60 of file ConjugateGradientSolver.h.

tol

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

Target relative residual error.

Definition at line 50 of file ConjugateGradientSolver.h.

verbose

bool Arcane::Alina::ConjugateGradientSolverParams::verbose = false

Verbose output (show iterations and error).

Definition at line 63 of file ConjugateGradientSolver.h.

---

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

• ConjugateGradientSolver.h