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

Richardson iteration. Plus de détails...

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

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

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

Types publics
typedef Backend	backend_type
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 = RichardsonSolverParams

Fonctions membres publiques
	RichardsonSolver (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
	Computes the solution for the given system matrix.
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 >	r
std::shared_ptr< vector >	s
InnerProduct	inner_product

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

Description détaillée

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

Richardson iteration.

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

Documentation des définitions de type membres

backend_params

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

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

Définition à la ligne 102 du fichier RichardsonSolver.h.

backend_type

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

typedef Backend Arcane::Alina::RichardsonSolver< Backend, InnerProduct >::backend_type

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

Définition à la ligne 107 du fichier RichardsonSolver.h.

params

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

using Arcane::Alina::RichardsonSolver< Backend, InnerProduct >::params = RichardsonSolverParams

Définition à la ligne 109 du fichier RichardsonSolver.h.

scalar_type

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

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

Définition à la ligne 104 du fichier RichardsonSolver.h.

value_type

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

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

Définition à la ligne 101 du fichier RichardsonSolver.h.

vector

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

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

Définition à la ligne 100 du fichier RichardsonSolver.h.

Documentation des constructeurs et destructeur

RichardsonSolver()

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

Arcane::Alina::RichardsonSolver< Backend, InnerProduct >::RichardsonSolver ( 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 114 du fichier RichardsonSolver.h.

Documentation des fonctions membres

bytes()

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

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

inlinevirtual

Memory used in bytes.

Implémente Arcane::Alina::SolverBase.

Définition à la ligne 193 du fichier RichardsonSolver.h.

norm()

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

template<class Vec>

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

inlineprivate

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

inline

Computes the solution for the given system matrix.

Computes the solution for the given system matrix A and the right-hand side rhs. 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.

The system matrix may differ from the matrix used during initialization. This may be used for the solution of non-stationary problems with slowly changing coefficients. There is a strong chance that a preconditioner built for a time step will act as a reasonably good preconditioner for several subsequent time steps [DeSh12]_.

Définition à la ligne 141 du fichier RichardsonSolver.h.

operator()() [2/2]

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

template<class Precond, class Vec1, class Vec2>

SolverResult Arcane::Alina::RichardsonSolver< 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 188 du fichier RichardsonSolver.h.

Documentation des fonctions amies et associées

operator<<

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

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

friend

Définition à la ligne 199 du fichier RichardsonSolver.h.

Documentation des données membres

inner_product

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

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

private

Définition à la ligne 218 du fichier RichardsonSolver.h.

n

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

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

private

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

prm

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

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

Définition à la ligne 209 du fichier RichardsonSolver.h.

r

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

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

private

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

s

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

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

private

Définition à la ligne 216 du fichier RichardsonSolver.h.

---

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

• RichardsonSolver.h