Richardson iteration. More...

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

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

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

Public Types
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

Public Member Functions
	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.

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 >	s
InnerProduct	inner_product

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

Detailed Description

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

Richardson iteration.

Definition at line 93 of file RichardsonSolver.h.

Member Typedef Documentation

◆ backend_params

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

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

Definition at line 102 of file RichardsonSolver.h.

◆ backend_type

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

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

Definition at line 98 of file 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

Definition at line 107 of file RichardsonSolver.h.

◆ params

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

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

Definition at line 109 of file 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

Definition at line 104 of file RichardsonSolver.h.

◆ value_type

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

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

Definition at line 101 of file RichardsonSolver.h.

◆ vector

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

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

Definition at line 100 of file RichardsonSolver.h.

Constructor & Destructor Documentation

◆ 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.

Definition at line 114 of file RichardsonSolver.h.

Member Function Documentation

◆ bytes()

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

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

inlinevirtual

Memory used in bytes.

Implements Arcane::Alina::SolverBase.

Definition at line 193 of file 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

Definition at line 221 of file 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]_.

Definition at line 141 of file 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.

Definition at line 188 of file RichardsonSolver.h.

◆ operator<<

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

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

friend

Definition at line 199 of file RichardsonSolver.h.

Member Data Documentation

◆ inner_product

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

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

private

Definition at line 218 of file RichardsonSolver.h.

◆ n

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

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

private

Definition at line 213 of file RichardsonSolver.h.

◆ prm

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

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

Definition at line 209 of file RichardsonSolver.h.

◆ r

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

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

private

Definition at line 215 of file RichardsonSolver.h.

◆ s

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

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

private

Definition at line 216 of file RichardsonSolver.h.

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

RichardsonSolver.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ backend_params

◆ backend_type

◆ coef_type

◆ params

◆ scalar_type

◆ value_type

◆ vector

Constructor & Destructor Documentation

◆ RichardsonSolver()

Member Function Documentation

◆ bytes()

◆ norm()

◆ operator()() [1/2]

◆ operator()() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ inner_product

◆ n

◆ prm

◆ r

◆ s