BiCGStab(L) method. Plus de détails...

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

Graphe d'héritage de Arcane::Alina::BiCGStabLSolver< Backend, InnerProduct >:

Graphe de collaboration de Arcane::Alina::BiCGStabLSolver< Backend, InnerProduct >:

Types publics
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 = BiCGStabLSolverParams

Fonctions membres publiques
	BiCGStabLSolver (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
	Computes the solution for the given right-hand side.

size_t	bytes () const
	Memory used in bytes.

Attributs publics
params	prm

Fonctions membres privées
template<class Vec>
scalar_type	norm (const Vec &x) const

Attributs privés
size_t	n

std::shared_ptr< vector >	Rt

std::shared_ptr< vector >	X

std::shared_ptr< vector >	B

std::shared_ptr< vector >	T

std::vector< std::shared_ptr< vector > >	R

std::vector< std::shared_ptr< vector > >	U

multi_array< coef_type, 2 >	MZa

multi_array< coef_type, 2 >	MZb

std::vector< coef_type >	Y0

std::vector< coef_type >	YL

Alina::detail::QRFactorization< coef_type >	qr

InnerProduct	inner_product

Amis
std::ostream &	operator<< (std::ostream &os, const BiCGStabLSolver &s)

Description détaillée

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

BiCGStab(L) method.

Définition à la ligne 150 du fichier BiCGStabLSolver.h.

Documentation des définitions de type membres

◆ backend_params

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

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

Définition à la ligne 160 du fichier BiCGStabLSolver.h.

◆ backend_type

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

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

Définition à la ligne 155 du fichier BiCGStabLSolver.h.

◆ BackendType

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

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

Définition à la ligne 156 du fichier BiCGStabLSolver.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::BiCGStabLSolver< Backend, InnerProduct >::coef_type

Définition à la ligne 165 du fichier BiCGStabLSolver.h.

◆ params

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

using Arcane::Alina::BiCGStabLSolver< Backend, InnerProduct >::params = BiCGStabLSolverParams

Définition à la ligne 167 du fichier BiCGStabLSolver.h.

◆ scalar_type

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

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

Définition à la ligne 162 du fichier BiCGStabLSolver.h.

◆ value_type

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

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

Définition à la ligne 159 du fichier BiCGStabLSolver.h.

◆ vector

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

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

Définition à la ligne 158 du fichier BiCGStabLSolver.h.

Documentation des constructeurs et destructeur

◆ BiCGStabLSolver()

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

Arcane::Alina::BiCGStabLSolver< Backend, InnerProduct >::BiCGStabLSolver	(	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.

Définition à la ligne 170 du fichier BiCGStabLSolver.h.

Documentation des fonctions membres

◆ bytes()

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

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

inlinevirtual

Memory used in bytes.

Implémente Arcane::Alina::SolverBase.

Définition à la ligne 444 du fichier BiCGStabLSolver.h.

◆ norm()

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

template<class Vec>

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

inlineprivate

Définition à la ligne 500 du fichier BiCGStabLSolver.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::BiCGStabLSolver< Backend, InnerProduct >::operator()	(	const Matrix &	A,
		const Precond &	P,
		const Vec1 &	rhs,
		Vec2 &&	x ) const

inline

Définition à la ligne 212 du fichier BiCGStabLSolver.h.

◆ operator()() [2/2]

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

template<class Precond, class Vec1, class Vec2>

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

inline

Computes the solution for the given right-hand side.

Computes the solution for the given right-hand side rhs. The system matrix is the same that was used for the setup of the preconditioner P. Returns the number of iterations made and the achieved residual as a std::tuple. The solution vector x provides initial approximation in input and holds the computed solution on output.

Définition à la ligne 439 du fichier BiCGStabLSolver.h.