Référence du modèle de la classe Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >

Allows to use an AMG smoother as standalone preconditioner. Plus de détails...

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

Graphe de collaboration de Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >:

Types publics
typedef Backend	backend_type
typedef Relax< Backend >	smoother
typedef Backend::matrix	matrix
typedef Backend::vector	vector
typedef smoother::params	params
typedef Backend::params	backend_params
typedef Backend::value_type	value_type
typedef Backend::col_type	col_type
typedef Backend::ptr_type	ptr_type
typedef BuiltinBackend< value_type, col_type, ptr_type >::matrix	build_matrix

Fonctions membres publiques
template<class Matrix>
	RelaxationAsPreconditioner (const Matrix &M, const params &prm=params(), const backend_params &bprm=backend_params())
	RelaxationAsPreconditioner (std::shared_ptr< build_matrix > M, const params &prm=params(), const backend_params &bprm=backend_params())
template<class Vec1, class Vec2>
void	apply (const Vec1 &rhs, Vec2 &&x) const
const matrix &	system_matrix () const
std::shared_ptr< matrix >	system_matrix_ptr () const
size_t	bytes () const

Fonctions membres privées
void	init (std::shared_ptr< build_matrix > M, const backend_params &bprm)

Attributs privés
params	prm
std::shared_ptr< matrix >	A
std::shared_ptr< smoother >	S

Amis
std::ostream &	operator<< (std::ostream &os, const RelaxationAsPreconditioner &p)

Description détaillée

template<class Backend, template< class > class Relax>
class Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >

Allows to use an AMG smoother as standalone preconditioner.

Définition à la ligne 143 du fichier Relaxation.h.

Documentation des définitions de type membres

backend_params

template<class Backend, template< class > class Relax>

typedef Backend::params Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::backend_params

Définition à la ligne 154 du fichier Relaxation.h.

backend_type

template<class Backend, template< class > class Relax>

typedef Backend Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::backend_type

Définition à la ligne 147 du fichier Relaxation.h.

build_matrix

template<class Backend, template< class > class Relax>

typedef BuiltinBackend<value_type,col_type,ptr_type>::matrix Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::build_matrix

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

col_type

template<class Backend, template< class > class Relax>

typedef Backend::col_type Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::col_type

Définition à la ligne 157 du fichier Relaxation.h.

matrix

template<class Backend, template< class > class Relax>

typedef Backend::matrix Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::matrix

Définition à la ligne 151 du fichier Relaxation.h.

params

template<class Backend, template< class > class Relax>

typedef smoother::params Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::params

Définition à la ligne 153 du fichier Relaxation.h.

ptr_type

template<class Backend, template< class > class Relax>

typedef Backend::ptr_type Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::ptr_type

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

smoother

template<class Backend, template< class > class Relax>

typedef Relax<Backend> Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::smoother

Définition à la ligne 149 du fichier Relaxation.h.

value_type

template<class Backend, template< class > class Relax>

typedef Backend::value_type Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::value_type

Définition à la ligne 156 du fichier Relaxation.h.

vector

template<class Backend, template< class > class Relax>

typedef Backend::vector Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::vector

Définition à la ligne 152 du fichier Relaxation.h.

Documentation des constructeurs et destructeur

RelaxationAsPreconditioner() [1/2]

template<class Backend, template< class > class Relax>

template<class Matrix>

Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::RelaxationAsPreconditioner ( const Matrix & M, const params & prm = params(), const backend_params & bprm = backend_params() )

inline

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

RelaxationAsPreconditioner() [2/2]

template<class Backend, template< class > class Relax>

Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::RelaxationAsPreconditioner ( std::shared_ptr< build_matrix > M, const params & prm = params(), const backend_params & bprm = backend_params() )

inline

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

Documentation des fonctions membres

apply()

template<class Backend, template< class > class Relax>

template<class Vec1, class Vec2>

void Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::apply ( const Vec1 & rhs, Vec2 && x ) const

inline

Définition à la ligne 179 du fichier Relaxation.h.

bytes()

template<class Backend, template< class > class Relax>

size_t Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::bytes ( ) const

inline

Définition à la ligne 194 du fichier Relaxation.h.

init()

template<class Backend, template< class > class Relax>

void Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::init ( std::shared_ptr< build_matrix > M, const backend_params & bprm )

inlineprivate

Définition à la ligne 213 du fichier Relaxation.h.

system_matrix()

template<class Backend, template< class > class Relax>

const matrix & Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::system_matrix ( ) const

inline

Définition à la ligne 184 du fichier Relaxation.h.

system_matrix_ptr()

template<class Backend, template< class > class Relax>

std::shared_ptr< matrix > Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::system_matrix_ptr ( ) const

inline

Définition à la ligne 189 du fichier Relaxation.h.

Documentation des fonctions amies et associées

operator<<

template<class Backend, template< class > class Relax>

std::ostream & operator<< ( std::ostream & os, const RelaxationAsPreconditioner< Backend, Relax > & p )

friend

Définition à la ligne 219 du fichier Relaxation.h.

Documentation des données membres

A

template<class Backend, template< class > class Relax>

std::shared_ptr<matrix> Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::A

private

Définition à la ligne 210 du fichier Relaxation.h.

prm

template<class Backend, template< class > class Relax>

params Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::prm

private

Définition à la ligne 208 du fichier Relaxation.h.

S

template<class Backend, template< class > class Relax>

std::shared_ptr<smoother> Arcane::Alina::RelaxationAsPreconditioner< Backend, Relax >::S

private

Définition à la ligne 211 du fichier Relaxation.h.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Relaxation.h