Dune::Amg::UnSymmetricCriterion< M, Norm > Class Template Reference
[Parallel Algebraic Multigrid]
#include <aggregates.hh>
Inheritance diagram for Dune::Amg::UnSymmetricCriterion< M, Norm >:

Detailed Description
template<class M, class Norm>
class Dune::Amg::UnSymmetricCriterion< M, Norm >
Criterion suited for unsymmetric matrices.
Nevertheless the sparsity pattern has to be symmetric.
The two template parameters are:
- M
- The type of the matrix the amg coarsening works on, e. g. BCRSMatrix
- Norm
- The norm to use to determine the strong couplings between the nodes, e.g. FirstDiagonal or RowSum.
Public Types | |
typedef Dependency< M, Norm > | DependencyPolicy |
The policy for calculating the dependency graph. | |
typedef M | Matrix |
The matrix type we build the dependency of. | |
typedef Norm | Norm |
The norm to use for examining the matrix entries. | |
typedef Matrix::row_type | Row |
Constant Row iterator of the matrix. | |
typedef Matrix::ConstColIterator | ColIter |
Constant column iterator of the matrix. | |
Public Member Functions | |
std::size_t | maxDistance () const |
Get the maximal distance allowed between to nodes in a aggregate. | |
void | setMaxDistance (std::size_t distance) |
Set the maximal distance allowed between to nodes in a aggregate. | |
std::size_t | minAggregateSize () const |
Get the minimum number of nodes a aggregate has to consist of. | |
void | setMinAggregateSize (std::size_t size) |
Set the minimum number of nodes a aggregate has to consist of. | |
std::size_t | maxAggregateSize () const |
Get the maximum number of nodes a aggregate is allowed to have. | |
void | setMaxAggregateSize (std::size_t size) |
Set the maximum number of nodes a aggregate is allowed to have. | |
std::size_t | maxConnectivity () const |
Get the maximum number of connections a aggregate is allowed to have. | |
void | setMaxConnectivity (std::size_t connectivity) |
Set the maximum number of connections a aggregate is allowed to have. | |
void | setDebugLevel (int level) |
Set the debugging level. | |
int | debugLevel () const |
Get the debugging Level. | |
void | setBeta (double b) |
Set threshold for marking nodes as isolated. The default value is 1.0E-5. | |
double | beta () const |
Get the threshold for marking nodes as isolated. The default value is 1.0E-5. | |
void | setAlpha (double a) |
Set the scaling value for marking connections as strong. Default value is 1/3. | |
double | alpha () const |
Get the scaling value for marking connections as strong. Default value is 1/3. |
Member Function Documentation
std::size_t Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::maxDistance | ( | ) | const [inline, inherited] |
Get the maximal distance allowed between to nodes in a aggregate.
The distance between two nodes in a aggregate is the minimal number of edges it takes to travel from one node to the other without leaving the aggregate.
- Returns:
- The maximum distance allowed.
void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setMaxDistance | ( | std::size_t | distance | ) | [inline, inherited] |
Set the maximal distance allowed between to nodes in a aggregate.
The distance between two nodes in a aggregate is the minimal number of edges it takes to travel from one node to the other without leaving the aggregate. The default value is 2.
- Parameters:
-
distance The maximum distance allowed.
std::size_t Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::minAggregateSize | ( | ) | const [inline, inherited] |
Get the minimum number of nodes a aggregate has to consist of.
- Returns:
- The minimum number of nodes.
void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setMinAggregateSize | ( | std::size_t | size | ) | [inline, inherited] |
Set the minimum number of nodes a aggregate has to consist of.
the default value is 4.
- Returns:
- The minimum number of nodes.
std::size_t Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::maxAggregateSize | ( | ) | const [inline, inherited] |
Get the maximum number of nodes a aggregate is allowed to have.
- Returns:
- The maximum number of nodes.
void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setMaxAggregateSize | ( | std::size_t | size | ) | [inline, inherited] |
Set the maximum number of nodes a aggregate is allowed to have.
The default values is 6.
- Parameters:
-
size The maximum number of nodes.
std::size_t Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::maxConnectivity | ( | ) | const [inline, inherited] |
Get the maximum number of connections a aggregate is allowed to have.
This limit exists to achieve sparsity of the coarse matrix. the default value is 15.
- Returns:
- The maximum number of connections a aggregate is allowed to have.
void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setMaxConnectivity | ( | std::size_t | connectivity | ) | [inline, inherited] |
Set the maximum number of connections a aggregate is allowed to have.
This limit exists to achieve sparsity of the coarse matrix. the default value is 15.
- Parameters:
-
connectivity The maximum number of connections a aggregate is allowed to have.
void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setDebugLevel | ( | int | level | ) | [inline, inherited] |
Set the debugging level.
- Parameters:
-
level If 0 no debugging output will be generated.
int Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::debugLevel | ( | ) | const [inline, inherited] |
Get the debugging Level.
- Returns:
- 0 if no debugging output will be generated.
The documentation for this class was generated from the following file: