Alien  1.3.0
User documentation
Loading...
Searching...
No Matches
Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT > Class Template Reference

Public Types

using AlgebraType = AlgebraT
using MatrixType = MatrixT
using VectorType = VectorT
using AMGSolverType = AMGSolverT

Public Member Functions

 AMGPreconditioner (AlgebraType &alg, MatrixType const &matrix, AMGSolverType *amg_solver, ITraceMng *trace_mng=nullptr)
void init ()
void end ()
void solve (AlgebraType &alg, VectorType const &y, VectorType &x) const

Detailed Description

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
class Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >

Definition at line 17 of file AMGPreconditioner.h.

Member Typedef Documentation

◆ AlgebraType

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
using Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::AlgebraType = AlgebraT

Definition at line 20 of file AMGPreconditioner.h.

◆ AMGSolverType

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
using Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::AMGSolverType = AMGSolverT

Definition at line 23 of file AMGPreconditioner.h.

◆ MatrixType

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
using Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::MatrixType = MatrixT

Definition at line 21 of file AMGPreconditioner.h.

◆ VectorType

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
using Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::VectorType = VectorT

Definition at line 22 of file AMGPreconditioner.h.

Constructor & Destructor Documentation

◆ AMGPreconditioner()

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::AMGPreconditioner ( AlgebraType & alg,
MatrixType const & matrix,
AMGSolverType * amg_solver,
ITraceMng * trace_mng = nullptr )
inline

Definition at line 26 of file AMGPreconditioner.h.

◆ ~AMGPreconditioner()

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
virtual Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::~AMGPreconditioner ( )
inlinevirtual

Definition at line 38 of file AMGPreconditioner.h.

Member Function Documentation

◆ end()

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
void Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::end ( )
inline

Definition at line 53 of file AMGPreconditioner.h.

◆ init()

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
void Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::init ( )
inline

Definition at line 43 of file AMGPreconditioner.h.

◆ solve()

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>
void Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::solve ( AlgebraType & alg,
VectorType const & y,
VectorType & x ) const
inline

Definition at line 59 of file AMGPreconditioner.h.


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