ViennaCL - The Vienna Computing Library  1.5.1
Public Member Functions
amg_precond< MatrixType > Class Template Reference

AMG preconditioner class, can be supplied to solve()-routines. More...

#include <amg.hpp>

Public Member Functions

 amg_precond ()
 
 amg_precond (MatrixType const &mat, amg_tag const &tag)
 The constructor. Saves system matrix, tag and builds data structures for setup. More...
 
void setup ()
 Start setup phase for this class and copy data structures. More...
 
void init_apply () const
 Prepare data structures for preconditioning: Build data structures for precondition phase. Do LU factorization on coarsest level. More...
 
template<typename VectorType >
ScalarType calc_complexity (VectorType &avgstencil)
 Returns complexity measures. More...
 
template<typename VectorType >
void apply (VectorType &vec) const
 Precondition Operation. More...
 
template<typename VectorType >
void smooth_jacobi (int level, int const iterations, VectorType &x, VectorType const &rhs) const
 (Weighted) Jacobi Smoother (CPU version) More...
 
amg_tagtag ()
 

Detailed Description

template<typename MatrixType>
class viennacl::linalg::amg_precond< MatrixType >

AMG preconditioner class, can be supplied to solve()-routines.

Constructor & Destructor Documentation

amg_precond ( )
inline
amg_precond ( MatrixType const &  mat,
amg_tag const &  tag 
)
inline

The constructor. Saves system matrix, tag and builds data structures for setup.

Parameters
matSystem matrix
tagThe AMG tag

Member Function Documentation

void apply ( VectorType &  vec) const
inline

Precondition Operation.

Parameters
vecThe vector to which preconditioning is applied to (ublas version)
ScalarType calc_complexity ( VectorType &  avgstencil)
inline

Returns complexity measures.

Parameters
avgstencilAverage stencil sizes on all levels
Returns
Operator complexity of AMG method
void init_apply ( ) const
inline

Prepare data structures for preconditioning: Build data structures for precondition phase. Do LU factorization on coarsest level.

void setup ( )
inline

Start setup phase for this class and copy data structures.

void smooth_jacobi ( int  level,
int const  iterations,
VectorType &  x,
VectorType const &  rhs 
) const
inline

(Weighted) Jacobi Smoother (CPU version)

Parameters
levelCoarse level to which smoother is applied to
iterationsNumber of smoother iterations
xThe vector smoothing is applied to
rhsThe right hand side of the equation for the smoother
amg_tag& tag ( )
inline

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