Public Member Functions

amg_tag Class Reference

A tag for algebraic multigrid (AMG). Used to transport information from the user to the implementation. More...

#include <amg_base.hpp>

Public Member Functions

 amg_tag (unsigned int coarse=1, unsigned int interpol=1, double threshold=0.25, double interpolweight=0.2, double jacobiweight=1, unsigned int presmooth=1, unsigned int postsmooth=1, unsigned int coarselevels=0)
 The constructor.
void set_coarse (unsigned int coarse)
unsigned int get_coarse () const
void set_interpol (unsigned int interpol)
unsigned int get_interpol () const
void set_threshold (double threshold)
double get_threshold () const
void set_as (double jacobiweight)
double get_interpolweight () const
void set_interpolweight (double interpolweight)
double get_jacobiweight () const
void set_presmooth (int presmooth)
unsigned int get_presmooth () const
void set_postsmooth (int postsmooth)
unsigned int get_postsmooth () const
void set_coarselevels (int coarselevels)
unsigned int get_coarselevels () const

Detailed Description

A tag for algebraic multigrid (AMG). Used to transport information from the user to the implementation.


Constructor & Destructor Documentation

amg_tag ( unsigned int  coarse = 1,
unsigned int  interpol = 1,
double  threshold = 0.25,
double  interpolweight = 0.2,
double  jacobiweight = 1,
unsigned int  presmooth = 1,
unsigned int  postsmooth = 1,
unsigned int  coarselevels = 0 
) [inline]

The constructor.

Parameters:
coarse Coarsening Routine (Default: VIENNACL_AMG_COARSE_CLASSIC)
interpol Interpolation routine (Default: VIENNACL_AMG_INTERPOL_DIRECT)
threshold Strength of dependence threshold for the coarsening process (Default: 0.25)
interpolweight Interpolation parameter for SA interpolation and truncation parameter for direct+classical interpolation
jacobiweight Weight of the weighted Jacobi smoother iteration step (Default: 1 = Regular Jacobi smoother)
presmooth Number of presmoothing operations on every level (Default: 1)
postsmooth Number of postsmoothing operations on every level (Default: 1)
coarselevels Number of coarse levels that are constructed (Default: 0 = Optimize coarse levels for direct solver such that coarsest level has a maximum of COARSE_LIMIT points) (Note: Coarsening stops when number of coarse points = 0 and overwrites the parameter with actual number of coarse levels)

Member Function Documentation

unsigned int get_coarse (  )  const [inline]
unsigned int get_coarselevels (  )  const [inline]
unsigned int get_interpol (  )  const [inline]
double get_interpolweight (  )  const [inline]
double get_jacobiweight (  )  const [inline]
unsigned int get_postsmooth (  )  const [inline]
unsigned int get_presmooth (  )  const [inline]
double get_threshold (  )  const [inline]
void set_as ( double  jacobiweight  )  [inline]
void set_coarse ( unsigned int  coarse  )  [inline]
void set_coarselevels ( int  coarselevels  )  [inline]
void set_interpol ( unsigned int  interpol  )  [inline]
void set_interpolweight ( double  interpolweight  )  [inline]
void set_postsmooth ( int  postsmooth  )  [inline]
void set_presmooth ( int  presmooth  )  [inline]
void set_threshold ( double  threshold  )  [inline]

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