Dune::Amg::CoarsenCriterion< T > Class Template Reference
[Parallel Algebraic Multigrid]

The criterion describing the stop criteria for the coarsening process. More...

#include <dune/istl/paamg/hierarchy.hh>

List of all members.

Public Types

typedef T DependencyCriterion
 The criterion for tagging connections as strong and nodes as isolated. This might be e.g. SymmetricDependency or UnSymmetricCriterion.

Public Member Functions

void setMaxLevel (int l)
 Set the maximum number of levels allowed in the hierarchy.
int maxLevel () const
 Get the maximum number of levels allowed in the hierarchy.
void setCoarsenTarget (int nodes)
 Set the maximum number of unknowns allowed on the coarsest level.
int coarsenTarget () const
 Get the maximum number of unknowns allowed on the coarsest level.
void setMinCoarsenRate (double rate)
 Set the minimum coarsening rate to be achieved in each coarsening.
double minCoarsenRate () const
 Get the minimum coarsening rate to be achieved.
AccumulationMode accumulate () const
 Whether the data should be accumulated on fewer processes on coarser levels.
void setAccumulate (AccumulationMode accu)
 Set whether he data should be accumulated on fewer processes on coarser levels.
void setAccumulate (bool accu)
void setProlongationDampingFactor (double d)
 Set the damping factor for the prolongation.
double getProlongationDampingFactor () const
 Get the damping factor for the prolongation.
 CoarsenCriterion (int maxLevel=100, int coarsenTarget=1000, double minCoarsenRate=1.2, double prolongDamp=1.6, AccumulationMode accumulate=successiveAccu)
 Constructor.

Detailed Description

template<class T>
class Dune::Amg::CoarsenCriterion< T >

The criterion describing the stop criteria for the coarsening process.


Member Typedef Documentation

template<class T >
typedef T Dune::Amg::CoarsenCriterion< T >::DependencyCriterion

The criterion for tagging connections as strong and nodes as isolated. This might be e.g. SymmetricDependency or UnSymmetricCriterion.


Constructor & Destructor Documentation

template<class T >
Dune::Amg::CoarsenCriterion< T >::CoarsenCriterion ( int  maxLevel = 100,
int  coarsenTarget = 1000,
double  minCoarsenRate = 1.2,
double  prolongDamp = 1.6,
AccumulationMode  accumulate = successiveAccu 
) [inline]

Constructor.

Parameters:
maxLevel The maximum number of levels allowed in the matrix hierarchy (default: 100).
coarsenTarget If the number of nodes in the matrix is below this threshold the coarsening will stop (default: 1000).
minCoarsenRate If the coarsening rate falls below this threshold the coarsening will stop (default: 1.2)
prolongDamp The damping factor to apply to the prolongated update (default: 1.6)
accumulate Whether to accumulate the data onto fewer processors on coarser levels.

Member Function Documentation

template<class T >
AccumulationMode Dune::Amg::CoarsenCriterion< T >::accumulate (  )  const [inline]

Whether the data should be accumulated on fewer processes on coarser levels.

template<class T >
int Dune::Amg::CoarsenCriterion< T >::coarsenTarget (  )  const [inline]

Get the maximum number of unknowns allowed on the coarsest level.

template<class T >
double Dune::Amg::CoarsenCriterion< T >::getProlongationDampingFactor (  )  const [inline]

Get the damping factor for the prolongation.

Returns:
d The damping factor.
template<class T >
int Dune::Amg::CoarsenCriterion< T >::maxLevel (  )  const [inline]

Get the maximum number of levels allowed in the hierarchy.

template<class T >
double Dune::Amg::CoarsenCriterion< T >::minCoarsenRate (  )  const [inline]

Get the minimum coarsening rate to be achieved.

template<class T >
void Dune::Amg::CoarsenCriterion< T >::setAccumulate ( bool  accu  )  [inline]
template<class T >
void Dune::Amg::CoarsenCriterion< T >::setAccumulate ( AccumulationMode  accu  )  [inline]

Set whether he data should be accumulated on fewer processes on coarser levels.

template<class T >
void Dune::Amg::CoarsenCriterion< T >::setCoarsenTarget ( int  nodes  )  [inline]

Set the maximum number of unknowns allowed on the coarsest level.

template<class T >
void Dune::Amg::CoarsenCriterion< T >::setMaxLevel ( int  l  )  [inline]

Set the maximum number of levels allowed in the hierarchy.

template<class T >
void Dune::Amg::CoarsenCriterion< T >::setMinCoarsenRate ( double  rate  )  [inline]

Set the minimum coarsening rate to be achieved in each coarsening.

The default value is 1.2

template<class T >
void Dune::Amg::CoarsenCriterion< T >::setProlongationDampingFactor ( double  d  )  [inline]

Set the damping factor for the prolongation.

Parameters:
d The new damping factor.

The documentation for this class was generated from the following file:
Generated on Sat Apr 24 11:13:51 2010 for dune-istl by  doxygen 1.6.3