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

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

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

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

Classes
struct	params
	Relaxation parameters. More...

Public Types
typedef Backend::value_type	value_type
typedef Backend::col_type	col_type
typedef Backend::ptr_type	ptr_type
typedef Backend::vector	vector
typedef Backend::matrix	matrix
typedef Backend::matrix_diagonal	matrix_diagonal
typedef math::scalar_of< value_type >::type	scalar_type
typedef Impl::ILUSolver< Backend >	ilu_solve

Public Member Functions
template<class Matrix>
	ILU0Relaxation (const Matrix &A, const params &prm, const typename Backend::params &bprm)
	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
	Apply post-relaxation.
size_t	bytes () const
	Memory used in bytes.

Public Attributes
struct Arcane::Alina::ILU0Relaxation::params	prm

Private Attributes
std::shared_ptr< ilu_solve >	ilu

Detailed Description

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

Note

ILU(0) is a serial algorithm and is only applicable to backends that support matrix row iteration (e.g. backend::builtin or backend::eigen).

Parameters

Backend

Backend for temporary structures allocation.

Definition at line 832 of file Relaxation.h.

Member Typedef Documentation

col_type

template<class Backend>

typedef Backend::col_type Arcane::Alina::ILU0Relaxation< Backend >::col_type

Definition at line 836 of file Relaxation.h.

ilu_solve

template<class Backend>

typedef Impl::ILUSolver<Backend> Arcane::Alina::ILU0Relaxation< Backend >::ilu_solve

Definition at line 843 of file Relaxation.h.

matrix

template<class Backend>

typedef Backend::matrix Arcane::Alina::ILU0Relaxation< Backend >::matrix

Definition at line 839 of file Relaxation.h.

matrix_diagonal

template<class Backend>

typedef Backend::matrix_diagonal Arcane::Alina::ILU0Relaxation< Backend >::matrix_diagonal

Definition at line 840 of file Relaxation.h.

ptr_type

template<class Backend>

typedef Backend::ptr_type Arcane::Alina::ILU0Relaxation< Backend >::ptr_type

Definition at line 837 of file Relaxation.h.

scalar_type

template<class Backend>

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

Definition at line 842 of file Relaxation.h.

value_type

template<class Backend>

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

Definition at line 835 of file Relaxation.h.

vector

template<class Backend>

typedef Backend::vector Arcane::Alina::ILU0Relaxation< Backend >::vector

Definition at line 838 of file Relaxation.h.

Constructor & Destructor Documentation

ILU0Relaxation()

template<class Backend>

template<class Matrix>

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

inline

Constructs smoother for the system matrix.

Parameters

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

Definition at line 874 of file Relaxation.h.

Member Function Documentation

apply()

template<class Backend>

template<class Matrix, class VectorRHS, class VectorX>

void Arcane::Alina::ILU0Relaxation< Backend >::apply ( const Matrix & , const VectorRHS & rhs, VectorX & x ) 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 1020 of file Relaxation.h.

apply_post()

template<class Backend>

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

void Arcane::Alina::ILU0Relaxation< 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 1011 of file Relaxation.h.

apply_pre()

template<class Backend>

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

void Arcane::Alina::ILU0Relaxation< 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 1002 of file Relaxation.h.

bytes()

template<class Backend>

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

inlinevirtual

Memory used in bytes.

Implements Arcane::Alina::RelaxationBase.

Definition at line 1026 of file Relaxation.h.

Member Data Documentation

ilu

template<class Backend>

std::shared_ptr<ilu_solve> Arcane::Alina::ILU0Relaxation< Backend >::ilu

private

Definition at line 1033 of file Relaxation.h.

---

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

• Relaxation.h