BiConjugate Gradient Stabilized (BiCGSTAB) method. More...

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

Inheritance diagram for Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >:

Collaboration diagram for Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >:

Public Types
using	backend_type = Backend
using	BackendType = Backend
typedef Backend::vector	vector
typedef Backend::value_type	value_type
typedef Backend::params	backend_params
typedef math::scalar_of< value_type >::type	scalar_type
typedef math::inner_product_impl< typenamemath::rhs_of< value_type >::type >::return_type	coef_type
using	params = BiCGStabSolverParams

Public Member Functions
	BiCGStabSolver (size_t n, const params &prm=params(), const backend_params &backend_prm=backend_params(), const InnerProduct &inner_product=InnerProduct())
	Preallocates necessary data structures for the system of size `n`.
template<class Matrix, class Precond, class Vec1, class Vec2>
SolverResult	operator() (const Matrix &A, const Precond &P, const Vec1 &rhs, Vec2 &&x) const
template<class Precond, class Vec1, class Vec2>
SolverResult	operator() (const Precond &P, const Vec1 &rhs, Vec2 &&x) const
size_t	bytes () const
	Memory used in bytes.

Public Attributes
params	prm

Private Member Functions
template<class Vec>
scalar_type	norm (const Vec &x) const

Private Attributes
size_t	n
std::shared_ptr< vector >	r
std::shared_ptr< vector >	p
std::shared_ptr< vector >	v
std::shared_ptr< vector >	s
std::shared_ptr< vector >	t
std::shared_ptr< vector >	rh
std::shared_ptr< vector >	T
InnerProduct	inner_product

Friends
std::ostream &	operator<< (std::ostream &os, const BiCGStabSolver &s)

Detailed Description

template<class Backend, class InnerProduct = detail::default_inner_product>
class Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >

BiConjugate Gradient Stabilized (BiCGSTAB) method.

The BiConjugate Gradient Stabilized method (Bi-CGSTAB) was developed to solve nonsymmetric linear systems while avoiding the often irregular convergence patterns of the Conjugate Gradient [Barr94]_.

Definition at line 102 of file BiCGStabSolver.h.

Member Typedef Documentation

◆ backend_params

template<class Backend, class InnerProduct = detail::default_inner_product>

typedef Backend::params Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::backend_params

Definition at line 112 of file BiCGStabSolver.h.

◆ backend_type

template<class Backend, class InnerProduct = detail::default_inner_product>

using Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::backend_type = Backend

Definition at line 107 of file BiCGStabSolver.h.

◆ BackendType

template<class Backend, class InnerProduct = detail::default_inner_product>

using Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::BackendType = Backend

Definition at line 108 of file BiCGStabSolver.h.

◆ coef_type

template<class Backend, class InnerProduct = detail::default_inner_product>

typedef math::inner_product_impl<typenamemath::rhs_of<value_type>::type>::return_type Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::coef_type

Definition at line 117 of file BiCGStabSolver.h.

◆ params

template<class Backend, class InnerProduct = detail::default_inner_product>

using Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::params = BiCGStabSolverParams

Definition at line 119 of file BiCGStabSolver.h.

◆ scalar_type

template<class Backend, class InnerProduct = detail::default_inner_product>

typedef math::scalar_of<value_type>::type Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::scalar_type

Definition at line 114 of file BiCGStabSolver.h.

◆ value_type

template<class Backend, class InnerProduct = detail::default_inner_product>

typedef Backend::value_type Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::value_type

Definition at line 111 of file BiCGStabSolver.h.

◆ vector

template<class Backend, class InnerProduct = detail::default_inner_product>

typedef Backend::vector Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::vector

Definition at line 110 of file BiCGStabSolver.h.

Constructor & Destructor Documentation

◆ BiCGStabSolver()

template<class Backend, class InnerProduct = detail::default_inner_product>

Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::BiCGStabSolver	(	size_t	n,
		const params &	prm = params(),
		const backend_params &	backend_prm = backend_params(),
		const InnerProduct &	inner_product = InnerProduct() )

inline

Preallocates necessary data structures for the system of size n.

Definition at line 122 of file BiCGStabSolver.h.

Member Function Documentation

◆ bytes()

template<class Backend, class InnerProduct = detail::default_inner_product>

size_t Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::bytes ( ) const

inlinevirtual

Memory used in bytes.

Implements Arcane::Alina::SolverBase.

Definition at line 255 of file BiCGStabSolver.h.

◆ norm()

template<class Backend, class InnerProduct = detail::default_inner_product>

template<class Vec>

scalar_type Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::norm ( const Vec & x ) const

inlineprivate

Definition at line 293 of file BiCGStabSolver.h.

◆ operator()() [1/2]

template<class Backend, class InnerProduct = detail::default_inner_product>

template<class Matrix, class Precond, class Vec1, class Vec2>

SolverResult Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::operator()	(	const Matrix &	A,
		const Precond &	P,
		const Vec1 &	rhs,
		Vec2 &&	x ) const

inline

Definition at line 151 of file BiCGStabSolver.h.

◆ operator()() [2/2]

template<class Backend, class InnerProduct = detail::default_inner_product>

template<class Precond, class Vec1, class Vec2>

SolverResult Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::operator()	(	const Precond &	P,
		const Vec1 &	rhs,
		Vec2 &&	x ) const

inline

Definition at line 250 of file BiCGStabSolver.h.

◆ operator<<

template<class Backend, class InnerProduct = detail::default_inner_product>

std::ostream & operator<<	(	std::ostream &	os,
		const BiCGStabSolver< Backend, InnerProduct > &	s )

friend

Definition at line 266 of file BiCGStabSolver.h.

Member Data Documentation

◆ inner_product

template<class Backend, class InnerProduct = detail::default_inner_product>

InnerProduct Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::inner_product

private

Definition at line 290 of file BiCGStabSolver.h.

◆ n

template<class Backend, class InnerProduct = detail::default_inner_product>

size_t Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::n

private

Definition at line 280 of file BiCGStabSolver.h.

◆ p

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::p

private

Definition at line 283 of file BiCGStabSolver.h.

◆ prm

template<class Backend, class InnerProduct = detail::default_inner_product>

params Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::prm

Definition at line 276 of file BiCGStabSolver.h.

◆ r

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::r

private

Definition at line 282 of file BiCGStabSolver.h.

◆ rh

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::rh

private

Definition at line 287 of file BiCGStabSolver.h.

◆ s

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::s

private

Definition at line 285 of file BiCGStabSolver.h.

◆ T

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::T

private

Definition at line 288 of file BiCGStabSolver.h.

◆ t

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::t

private

Definition at line 286 of file BiCGStabSolver.h.

◆ v

template<class Backend, class InnerProduct = detail::default_inner_product>

std::shared_ptr<vector> Arcane::Alina::BiCGStabSolver< Backend, InnerProduct >::v

private

Definition at line 284 of file BiCGStabSolver.h.

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

BiCGStabSolver.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ backend_params

◆ backend_type

◆ BackendType

◆ coef_type

◆ params

◆ scalar_type

◆ value_type

◆ vector

Constructor & Destructor Documentation

◆ BiCGStabSolver()

Member Function Documentation

◆ bytes()

◆ norm()

◆ operator()() [1/2]

◆ operator()() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ inner_product

◆ n

◆ p

◆ prm

◆ r

◆ rh

◆ s

◆ T

◆ t

◆ v