Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::Alina::ChebyshevRelaxation< Backend > Class Template Reference

Chebyshev polynomial smoother. More...

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

Inheritance diagram for Arcane::Alina::ChebyshevRelaxation< Backend >:
Collaboration diagram for Arcane::Alina::ChebyshevRelaxation< Backend >:

Classes

struct  params
 Relaxation parameters. More...

Public Types

typedef Backend::value_type value_type
typedef Backend::vector vector
typedef math::scalar_of< value_type >::type scalar_type

Public Member Functions

template<class Matrix>
 ChebyshevRelaxation (const Matrix &A, const params &prm, const typename Backend::params &backend_prm)
 Constructs smoother for the system matrix.
template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>
void apply_pre (const Matrix &A, const VectorRHS &rhs, VectorX &x, VectorTMP &) const
template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>
void apply_post (const Matrix &A, const VectorRHS &rhs, VectorX &x, VectorTMP &) const
template<class Matrix, class VectorRHS, class VectorX>
void apply (const Matrix &A, const VectorRHS &rhs, VectorX &x) const
size_t bytes () const
 Memory used in bytes.

Public Attributes

struct Arcane::Alina::ChebyshevRelaxation::params prm

Private Member Functions

template<class Matrix, class VectorB, class VectorX>
void solve (const Matrix &A, const VectorB &b, VectorX &x) const

Private Attributes

std::shared_ptr< typename Backend::matrix_diagonal > M
std::shared_ptr< vector > p
std::shared_ptr< vector > r
scalar_type c
scalar_type d

Detailed Description

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

Chebyshev polynomial smoother.

Parameters
BackendBackend for temporary structures allocation.

Implements Algorithm 1 from P. Ghysels, P. Kłosiewicz, and W. Vanroose. "Improving the arithmetic intensity of multigrid with the help of polynomial smoothers". Numer. Linear Algebra Appl. 2012;19:253-267. DOI: 10.1002/nla.1808

Definition at line 244 of file Relaxation.h.

Member Typedef Documentation

◆ scalar_type

template<class Backend>
typedef math::scalar_of<value_type>::type Arcane::Alina::ChebyshevRelaxation< Backend >::scalar_type

Definition at line 252 of file Relaxation.h.

◆ value_type

template<class Backend>
typedef Backend::value_type Arcane::Alina::ChebyshevRelaxation< Backend >::value_type

Definition at line 249 of file Relaxation.h.

◆ vector

template<class Backend>
typedef Backend::vector Arcane::Alina::ChebyshevRelaxation< Backend >::vector

Definition at line 250 of file Relaxation.h.

Constructor & Destructor Documentation

◆ ChebyshevRelaxation()

template<class Backend>
template<class Matrix>
Arcane::Alina::ChebyshevRelaxation< Backend >::ChebyshevRelaxation ( const Matrix & A,
const params & prm,
const typename Backend::params & backend_prm )
inline

Constructs smoother for the system matrix.

Parameters
AThe system matrix.
prmRelaxation parameters.
backend_prmBackend parameters.

Definition at line 303 of file Relaxation.h.

Member Function Documentation

◆ apply()

template<class Backend>
template<class Matrix, class VectorRHS, class VectorX>
void Arcane::Alina::ChebyshevRelaxation< Backend >::apply ( const Matrix & A,
const VectorRHS & rhs,
VectorX & x ) const
inline

Definition at line 344 of file Relaxation.h.

◆ apply_post()

template<class Backend>
template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>
void Arcane::Alina::ChebyshevRelaxation< Backend >::apply_post ( const Matrix & A,
const VectorRHS & rhs,
VectorX & x,
VectorTMP &  ) const
inline

Definition at line 338 of file Relaxation.h.

◆ apply_pre()

template<class Backend>
template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>
void Arcane::Alina::ChebyshevRelaxation< Backend >::apply_pre ( const Matrix & A,
const VectorRHS & rhs,
VectorX & x,
VectorTMP &  ) const
inline

Definition at line 332 of file Relaxation.h.

◆ bytes()

template<class Backend>
size_t Arcane::Alina::ChebyshevRelaxation< Backend >::bytes ( ) const
inlinevirtual

Memory used in bytes.

Implements Arcane::Alina::RelaxationBase.

Definition at line 350 of file Relaxation.h.

◆ solve()

template<class Backend>
template<class Matrix, class VectorB, class VectorX>
void Arcane::Alina::ChebyshevRelaxation< Backend >::solve ( const Matrix & A,
const VectorB & b,
VectorX & x ) const
inlineprivate

Definition at line 366 of file Relaxation.h.

Member Data Documentation

◆ c

template<class Backend>
scalar_type Arcane::Alina::ChebyshevRelaxation< Backend >::c
private

Definition at line 363 of file Relaxation.h.

◆ d

template<class Backend>
scalar_type Arcane::Alina::ChebyshevRelaxation< Backend >::d
private

Definition at line 363 of file Relaxation.h.

◆ M

template<class Backend>
std::shared_ptr<typename Backend::matrix_diagonal> Arcane::Alina::ChebyshevRelaxation< Backend >::M
private

Definition at line 360 of file Relaxation.h.

◆ p

template<class Backend>
std::shared_ptr<vector> Arcane::Alina::ChebyshevRelaxation< Backend >::p
mutableprivate

Definition at line 361 of file Relaxation.h.

◆ r

template<class Backend>
std::shared_ptr<vector> Arcane::Alina::ChebyshevRelaxation< Backend >::r
private

Definition at line 361 of file Relaxation.h.


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