Arcane::Alina::DampedJacobiRelaxation< Backend > Struct Template Reference

Damped Jacobi relaxation. More...

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

Inheritance diagram for Arcane::Alina::DampedJacobiRelaxation< Backend >:

Collaboration diagram for Arcane::Alina::DampedJacobiRelaxation< Backend >:

Classes
struct	params
	Relaxation parameters. More...

Public Types
typedef Backend::value_type	value_type
typedef math::scalar_of< value_type >::type	scalar_type

Public Member Functions
template<class Matrix>
	DampedJacobiRelaxation (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 &tmp) const
	Apply pre-relaxation.
template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>
void	apply_post (const Matrix &A, const VectorRHS &rhs, VectorX &x, VectorTMP &tmp) const
	Apply post-relaxation.
template<class Matrix, class VectorRHS, class VectorX>
void	apply (const Matrix &, const VectorRHS &rhs, VectorX &x) const
size_t	bytes () const
	Memory used in bytes.

Public Attributes
struct Arcane::Alina::DampedJacobiRelaxation::params	prm
std::shared_ptr< typename Backend::matrix_diagonal >	dia

Detailed Description

template<class Backend>
struct Arcane::Alina::DampedJacobiRelaxation< Backend >

Damped Jacobi relaxation.

Parameters

Backend

Backend for temporary structures allocation.

Definition at line 407 of file Relaxation.h.

Member Typedef Documentation

scalar_type

template<class Backend>

typedef math::scalar_of<value_type>::type Arcane::Alina::DampedJacobiRelaxation< Backend >::scalar_type

Definition at line 411 of file Relaxation.h.

value_type

template<class Backend>

typedef Backend::value_type Arcane::Alina::DampedJacobiRelaxation< Backend >::value_type

Definition at line 410 of file Relaxation.h.

Constructor & Destructor Documentation

DampedJacobiRelaxation()

template<class Backend>

template<class Matrix>

Arcane::Alina::DampedJacobiRelaxation< Backend >::DampedJacobiRelaxation ( const Matrix & A, const params & prm, const typename Backend::params & backend_prm )

inline

Constructs smoother for the system matrix.

Parameters

A	The system matrix.
prm	Relaxation parameters.
backend_prm	Backend parameters.

Definition at line 446 of file Relaxation.h.

Member Function Documentation

apply()

template<class Backend>

template<class Matrix, class VectorRHS, class VectorX>

void Arcane::Alina::DampedJacobiRelaxation< Backend >::apply ( const Matrix & , const VectorRHS & rhs, VectorX & x ) const

inline

Definition at line 484 of file Relaxation.h.

apply_post()

template<class Backend>

template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>

void Arcane::Alina::DampedJacobiRelaxation< Backend >::apply_post ( const Matrix & A, const VectorRHS & rhs, VectorX & x, VectorTMP & tmp ) const

inline

Apply post-relaxation.

Parameters

A	System matrix.
rhs	Right-hand side.
x	Solution vector.
tmp	Scratch vector.
prm	Relaxation parameters.

Definition at line 477 of file Relaxation.h.

apply_pre()

template<class Backend>

template<class Matrix, class VectorRHS, class VectorX, class VectorTMP>

void Arcane::Alina::DampedJacobiRelaxation< Backend >::apply_pre ( const Matrix & A, const VectorRHS & rhs, VectorX & x, VectorTMP & tmp ) const

inline

Apply pre-relaxation.

Parameters

A	System matrix.
rhs	Right-hand side.
x	Solution vector.
tmp	Scratch vector.
prm	Relaxation parameters.

Definition at line 462 of file Relaxation.h.

bytes()

template<class Backend>

size_t Arcane::Alina::DampedJacobiRelaxation< Backend >::bytes ( ) const

inlinevirtual

Memory used in bytes.

Implements Arcane::Alina::RelaxationBase.

Definition at line 489 of file Relaxation.h.

Member Data Documentation

dia

template<class Backend>

std::shared_ptr<typename Backend::matrix_diagonal> Arcane::Alina::DampedJacobiRelaxation< Backend >::dia

Definition at line 437 of file Relaxation.h.

---

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

• Relaxation.h