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

ILU(k) smoother. More...

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

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

Classes

struct  params
 Relaxation parameters. More...

Public Types

typedef Backend::value_type value_type
typedef ILU0Relaxation< Backend > Base

Public Member Functions

template<class Matrix>
 ILUPRelaxation (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 &A, const VectorRHS &rhs, VectorX &x) const
size_t bytes () const
 Memory used in bytes.

Public Attributes

Arcane::Alina::ILUPRelaxation::params prm

Private Attributes

std::shared_ptr< Base > base

Detailed Description

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

ILU(k) smoother.

Definition at line 1385 of file Relaxation.h.

Member Typedef Documentation

◆ Base

template<class Backend>
typedef ILU0Relaxation<Backend> Arcane::Alina::ILUPRelaxation< Backend >::Base

Definition at line 1390 of file Relaxation.h.

◆ value_type

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

Definition at line 1388 of file Relaxation.h.

Constructor & Destructor Documentation

◆ ILUPRelaxation()

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

Constructs smoother for the system matrix.

Parameters
AThe system matrix.
prmRelaxation parameters.
backend_prmBackend parameters.

Definition at line 1420 of file Relaxation.h.

References Arcane::arccoreParallelFor().

Here is the call graph for this function:

Member Function Documentation

◆ apply()

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

Definition at line 1473 of file Relaxation.h.

◆ apply_post()

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

Apply post-relaxation.

Parameters
ASystem matrix.
rhsRight-hand side.
xSolution vector.
tmpScratch vector.
prmRelaxation parameters.

Definition at line 1467 of file Relaxation.h.

◆ apply_pre()

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

Apply pre-relaxation.

Parameters
ASystem matrix.
rhsRight-hand side.
xSolution vector.
tmpScratch vector.
prmRelaxation parameters.

Definition at line 1460 of file Relaxation.h.

◆ bytes()

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

Memory used in bytes.

Implements Arcane::Alina::RelaxationBase.

Definition at line 1478 of file Relaxation.h.

Member Data Documentation

◆ base

template<class Backend>
std::shared_ptr<Base> Arcane::Alina::ILUPRelaxation< Backend >::base
private

Definition at line 1485 of file Relaxation.h.


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