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

Distributed Preconditioner. Plus de détails...

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

Graphe de collaboration de Arcane::Alina::DistributedPreconditioner< Backend >:

Types publics
using	backend_type = Backend
using	BackendType = Backend
typedef backend_type::params	backend_params
typedef PropertyTree	params
typedef backend_type::value_type	value_type
typedef DistributedMatrix< backend_type >	matrix
using	AMGPrecondType

Fonctions membres publiques
template<class Matrix>
	DistributedPreconditioner (mpi_communicator comm, const Matrix &Astrip, params prm=params(), const backend_params &bprm=backend_params())
	DistributedPreconditioner (mpi_communicator, std::shared_ptr< matrix > A, params prm=params(), const backend_params &bprm=backend_params())
template<class Matrix>
void	rebuild (const Matrix &A, const backend_params &bprm=backend_params())
template<class Vec1, class Vec2>
void	apply (const Vec1 &rhs, Vec2 &&x) const
std::shared_ptr< matrix >	system_matrix_ptr () const
	Returns the system matrix from the finest level.
const matrix &	system_matrix () const

Fonctions membres privées
void	init (std::shared_ptr< matrix > A, params &prm, const backend_params &bprm)

Attributs privés
eDistributedPreconditionerType	_class
void *	handle

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

Description détaillée

template<class Backend>
class Arcane::Alina::DistributedPreconditioner< Backend >

Distributed Preconditioner.

Définition à la ligne 88 du fichier DistributedPreconditioner.h.

Documentation des définitions de type membres

AMGPrecondType

template<class Backend>

using Arcane::Alina::DistributedPreconditioner< Backend >::AMGPrecondType

Valeur initiale :

 DistributedAMG<Backend,
                                        DistributedCoarseningRuntime<Backend>,
                                        DistributedRelaxationRuntime<Backend>,
                                        DistributedDirectSolverRuntime<value_type>,
                                        MatrixPartitionerRuntime<Backend>>

Définition à la ligne 99 du fichier DistributedPreconditioner.h.

backend_params

template<class Backend>

typedef backend_type::params Arcane::Alina::DistributedPreconditioner< Backend >::backend_params

Définition à la ligne 94 du fichier DistributedPreconditioner.h.

backend_type

template<class Backend>

using Arcane::Alina::DistributedPreconditioner< Backend >::backend_type = Backend

Définition à la ligne 92 du fichier DistributedPreconditioner.h.

BackendType

template<class Backend>

using Arcane::Alina::DistributedPreconditioner< Backend >::BackendType = Backend

Définition à la ligne 93 du fichier DistributedPreconditioner.h.

matrix

template<class Backend>

typedef DistributedMatrix<backend_type> Arcane::Alina::DistributedPreconditioner< Backend >::matrix

Définition à la ligne 97 du fichier DistributedPreconditioner.h.

params

template<class Backend>

typedef PropertyTree Arcane::Alina::DistributedPreconditioner< Backend >::params

Définition à la ligne 95 du fichier DistributedPreconditioner.h.

value_type

template<class Backend>

typedef backend_type::value_type Arcane::Alina::DistributedPreconditioner< Backend >::value_type

Définition à la ligne 96 du fichier DistributedPreconditioner.h.

Documentation des constructeurs et destructeur

DistributedPreconditioner() [1/2]

template<class Backend>

template<class Matrix>

Arcane::Alina::DistributedPreconditioner< Backend >::DistributedPreconditioner ( mpi_communicator comm, const Matrix & Astrip, params prm = params(), const backend_params & bprm = backend_params() )

inline

Définition à la ligne 106 du fichier DistributedPreconditioner.h.

DistributedPreconditioner() [2/2]

template<class Backend>

Arcane::Alina::DistributedPreconditioner< Backend >::DistributedPreconditioner ( mpi_communicator , std::shared_ptr< matrix > A, params prm = params(), const backend_params & bprm = backend_params() )

inline

Définition à la ligne 116 du fichier DistributedPreconditioner.h.

~DistributedPreconditioner()

template<class Backend>

Arcane::Alina::DistributedPreconditioner< Backend >::~DistributedPreconditioner ( )

inline

Définition à la ligne 126 du fichier DistributedPreconditioner.h.

Documentation des fonctions membres

apply()

template<class Backend>

template<class Vec1, class Vec2>

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

inline

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

init()

template<class Backend>

void Arcane::Alina::DistributedPreconditioner< Backend >::init ( std::shared_ptr< matrix > A, params & prm, const backend_params & bprm )

inlineprivate

Définition à la ligne 217 du fichier DistributedPreconditioner.h.

rebuild()

template<class Backend>

template<class Matrix>

void Arcane::Alina::DistributedPreconditioner< Backend >::rebuild ( const Matrix & A, const backend_params & bprm = backend_params() )

inline

Définition à la ligne 144 du fichier DistributedPreconditioner.h.

system_matrix()

template<class Backend>

const matrix & Arcane::Alina::DistributedPreconditioner< Backend >::system_matrix ( ) const

inline

Définition à la ligne 191 du fichier DistributedPreconditioner.h.

system_matrix_ptr()

template<class Backend>

std::shared_ptr< matrix > Arcane::Alina::DistributedPreconditioner< Backend >::system_matrix_ptr ( ) const

inline

Returns the system matrix from the finest level.

Définition à la ligne 175 du fichier DistributedPreconditioner.h.

Références system_matrix_ptr().

Référencé par system_matrix_ptr().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des fonctions amies et associées

operator<<

template<class Backend>

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

friend

Définition à la ligne 196 du fichier DistributedPreconditioner.h.

Documentation des données membres

_class

template<class Backend>

eDistributedPreconditionerType Arcane::Alina::DistributedPreconditioner< Backend >::_class

private

Définition à la ligne 214 du fichier DistributedPreconditioner.h.

handle

template<class Backend>

void* Arcane::Alina::DistributedPreconditioner< Backend >::handle

private

Définition à la ligne 215 du fichier DistributedPreconditioner.h.

---

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

• DistributedPreconditioner.h