Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT > Class Template Reference

Collaboration diagram for Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >:

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

Private Attributes
AlgebraType &	m_algebra
MatrixType const &	m_matrix
AMGSolverType *	m_amg_solver = nullptr
ITraceMng *	m_trace_mng = nullptr

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.

Member Data Documentation

m_algebra

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>

AlgebraType& Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::m_algebra

private

Definition at line 73 of file AMGPreconditioner.h.

m_amg_solver

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>

AMGSolverType* Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::m_amg_solver = nullptr

private

Definition at line 76 of file AMGPreconditioner.h.

m_matrix

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>

MatrixType const& Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::m_matrix

private

Definition at line 74 of file AMGPreconditioner.h.

m_trace_mng

template<typename AlgebraT, typename MatrixT, typename VectorT, typename AMGSolverT>

ITraceMng* Alien::AMGPreconditioner< AlgebraT, MatrixT, VectorT, AMGSolverT >::m_trace_mng = nullptr

private

Definition at line 78 of file AMGPreconditioner.h.

---

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

• AMGPreconditioner.h