Dune::Amg::CoarsenCriterion< T > Class Template Reference
[Parallel Algebraic Multigrid]
#include <hierarchy.hh>
Detailed Description
template<class T>
class Dune::Amg::CoarsenCriterion< T >
The criterion describing the stop criteria for the coarsening Process. 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. | |
bool | accumulate () const |
Whether the data should be accumulated on fewer processes on coarser levels. | |
CoarsenCriterion (int maxLevel=100, int coarsenTarget=1000, double minCoarsenRate=1.2) | |
Constructor. |
Constructor & Destructor Documentation
template<class T>
Dune::Amg::CoarsenCriterion< T >::CoarsenCriterion | ( | int | maxLevel = 100 , |
|
int | coarsenTarget = 1000 , |
|||
double | minCoarsenRate = 1.2 | |||
) | [inline] |
Constructor.
- Parameters:
-
maxLevel The macimum number of levels allowed in the matric 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)
Member Function Documentation
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
The documentation for this class was generated from the following file: