Criterion suitable for unsymmetric matrices. More...

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

Inheritance diagram for Dune::Amg::UnSymmetricCriterion< M, Norm >:

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
	UnSymmetricCriterion (const Parameters &parms)
	UnSymmetricCriterion ()
void	setDefaultValuesIsotropic (std::size_t dim, std::size_t diameter=2)
	Sets reasonable default values for an isotropic problem.
void	setDefaultValuesAnisotropic (std::size_t dim, std::size_t diameter=2)
	Sets reasonable default values for an aisotropic problem.
void	init (const Matrix *matrix)
void	initRow (const Row &row, int index)
void	examine (const ColIter &col)
bool	isIsolated ()
void	setDebugLevel (int level)
	Set the debugging level.
int	debugLevel () const
	Get the debugging Level.
void	setNoPreSmoothSteps (std::size_t steps)
	Set the number of presmoothing steps to apply.
std::size_t	getNoPreSmoothSteps () const
	Get the number of presmoothing steps to apply.
void	setNoPostSmoothSteps (std::size_t steps)
	Set the number of postsmoothing steps to apply.
std::size_t	getNoPostSmoothSteps () const
	Get the number of postsmoothing steps to apply.
void	setGamma (std::size_t gamma)
	Set the value of gamma; 1 for V-cycle, 2 for W-cycle.
std::size_t	getGamma () const
	Get the value of gamma; 1 for V-cycle, 2 for W-cycle.
void	setAdditive (bool additive)
	Set whether to use additive multigrid.
bool	getAdditive () const
	Get whether to use additive multigrid.
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 the data should be accumulated on fewer processes on coarser levels.
void	setAccumulate (bool accu)
bool	useFixedOrder () const
	Check if the indices for the coarser levels should be created in a fixed order.
void	setUseFixedOrder (bool useFixedOrder)
void	setProlongationDampingFactor (double d)
	Set the damping factor for the prolongation.
double	getProlongationDampingFactor () const
	Get the damping factor for the prolongation.
std::size_t	maxDistance () const
	Get the maximal distance allowed between two nodes in a aggregate.
void	setMaxDistance (std::size_t distance)
	Set the maximal distance allowed between two nodes in a aggregate.
bool	skipIsolated () const
	Whether isolated aggregates will not be represented on the coarse level.
void	setSkipIsolated (bool skip)
	Set whether isolated aggregates will not be represented on the coarse level.
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	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.

Protected Types
typedef Matrix::field_type	field_type
	The current max value.
typedef FieldTraits< field_type >::real_type	real_type

Protected Attributes
const Matrix *	matrix_
	The matrix we work on.
real_type	maxValue_
Norm	norm_
	The functor for calculating the norm.
int	row_
	index of the currently evaluated row.
real_type	diagonal_
	The norm of the current diagonal.

Detailed Description

template<class M, class Norm>
class Dune::Amg::UnSymmetricCriterion< M, Norm >

Criterion suitable for unsymmetric matrices.

Nevertheless the sparsity pattern has to be symmetric.

Template Parameters

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.

Member Typedef Documentation

◆ ColIter

typedef Matrix::ConstColIterator Dune::Amg::Dependency< M, Norm >::ColIter

inherited

Constant column iterator of the matrix.

◆ DependencyPolicy

typedef Dependency< M, Norm > Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::DependencyPolicy

inherited

The policy for calculating the dependency graph.

◆ field_type

typedef Matrix::field_type Dune::Amg::Dependency< M, Norm >::field_type

protectedinherited

The current max value.

◆ Matrix

typedef M Dune::Amg::Dependency< M, Norm >::Matrix

inherited

The matrix type we build the dependency of.

◆ Norm

typedef Norm Dune::Amg::Dependency< M, Norm >::Norm

inherited

The norm to use for examining the matrix entries.

◆ real_type

typedef FieldTraits<field_type>::real_type Dune::Amg::Dependency< M, Norm >::real_type

protectedinherited

◆ Row

typedef Matrix::row_type Dune::Amg::Dependency< M, Norm >::Row

inherited

Constant Row iterator of the matrix.

Member Function Documentation

◆ accumulate()

AccumulationMode Dune::Amg::CoarseningParameters::accumulate ( ) const

inlineinherited

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

◆ alpha()

double Dune::Amg::DependencyParameters::alpha ( ) const

inlineinherited

Get the scaling value for marking connections as strong. Default value is 1/3.

◆ beta()

double Dune::Amg::DependencyParameters::beta ( ) const

inlineinherited

Get the threshold for marking nodes as isolated. The default value is 1.0E-5.

Returns: beta

◆ coarsenTarget()

int Dune::Amg::CoarseningParameters::coarsenTarget ( ) const

inlineinherited

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

◆ debugLevel()

int Dune::Amg::Parameters::debugLevel ( ) const

inlineinherited

Get the debugging Level.

Returns: 0 if no debugging output will be generated.

◆ examine()

void Dune::Amg::Dependency< M, Norm >::examine ( const ColIter & col )

inherited

◆ getAdditive()

bool Dune::Amg::Parameters::getAdditive ( ) const

inlineinherited

Get whether to use additive multigrid.

Returns: True if multigrid should be additive.

◆ getGamma()

std::size_t Dune::Amg::Parameters::getGamma ( ) const

inlineinherited

Get the value of gamma; 1 for V-cycle, 2 for W-cycle.

◆ getNoPostSmoothSteps()

std::size_t Dune::Amg::Parameters::getNoPostSmoothSteps ( ) const

inlineinherited

Get the number of postsmoothing steps to apply.

Returns: The number of steps:

◆ getNoPreSmoothSteps()

std::size_t Dune::Amg::Parameters::getNoPreSmoothSteps ( ) const

inlineinherited

Get the number of presmoothing steps to apply.

Returns: The number of steps:

◆ getProlongationDampingFactor()

double Dune::Amg::CoarseningParameters::getProlongationDampingFactor ( ) const

inlineinherited

Get the damping factor for the prolongation.

Returns: d The damping factor.

◆ init()

void Dune::Amg::Dependency< M, Norm >::init ( const Matrix * matrix )

inherited

◆ initRow()

void Dune::Amg::Dependency< M, Norm >::initRow	(	const Row &	row,
		int	index )

inherited

◆ isIsolated()

bool Dune::Amg::Dependency< M, Norm >::isIsolated ( )

inherited

◆ maxAggregateSize()

std::size_t Dune::Amg::AggregationParameters::maxAggregateSize ( ) const

inlineinherited

Get the maximum number of nodes a aggregate is allowed to have.

Returns: The maximum number of nodes.

◆ maxConnectivity()

std::size_t Dune::Amg::AggregationParameters::maxConnectivity ( ) const

inlineinherited

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.

◆ maxDistance()

std::size_t Dune::Amg::AggregationParameters::maxDistance ( ) const

inlineinherited

Get the maximal distance allowed between two 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.

◆ maxLevel()

int Dune::Amg::CoarseningParameters::maxLevel ( ) const

inlineinherited

Get the maximum number of levels allowed in the hierarchy.

◆ minAggregateSize()

std::size_t Dune::Amg::AggregationParameters::minAggregateSize ( ) const

inlineinherited

Get the minimum number of nodes a aggregate has to consist of.

Returns: The minimum number of nodes.

◆ minCoarsenRate()

double Dune::Amg::CoarseningParameters::minCoarsenRate ( ) const

inlineinherited

Get the minimum coarsening rate to be achieved.

◆ setAccumulate() [1/2]

void Dune::Amg::CoarseningParameters::setAccumulate ( AccumulationMode accu )

inlineinherited

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

◆ setAccumulate() [2/2]

void Dune::Amg::CoarseningParameters::setAccumulate ( bool accu )

inlineinherited

◆ setAdditive()

void Dune::Amg::Parameters::setAdditive ( bool additive )

inlineinherited

Set whether to use additive multigrid.

Parameters

additive True if multigrid should be additive.

◆ setAlpha()

void Dune::Amg::DependencyParameters::setAlpha ( double a )

inlineinherited

Set the scaling value for marking connections as strong. Default value is 1/3.

◆ setBeta()

void Dune::Amg::DependencyParameters::setBeta ( double b )

inlineinherited

Set threshold for marking nodes as isolated. The default value is 1.0E-5.

◆ setCoarsenTarget()

void Dune::Amg::CoarseningParameters::setCoarsenTarget ( int nodes )

inlineinherited

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

◆ setDebugLevel()

void Dune::Amg::Parameters::setDebugLevel ( int level )

inlineinherited

Set the debugging level.

Parameters

level If 0 no debugging output will be generated.

Warning: In parallel the level has to be consistent over all procceses.

◆ setDefaultValuesAnisotropic()

void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setDefaultValuesAnisotropic	(	std::size_t	dim,
		std::size_t	diameter = 2 )

inlineinherited

Sets reasonable default values for an aisotropic problem.

Reasonable means that we should end up with cube aggregates with sides of diameter 2 and sides in one dimension that are longer (e.g. for 3D: 2x2x3).

Parameters

dim	The dimension of the problem.
diameter	The preferred diameter for the aggregation.

◆ setDefaultValuesIsotropic()

void Dune::Amg::AggregationCriterion< Dependency< M, Norm > >::setDefaultValuesIsotropic	(	std::size_t	dim,
		std::size_t	diameter = 2 )

inlineinherited

Sets reasonable default values for an isotropic problem.

Reasonable means that we should end up with cube aggregates of diameter 2.

Parameters

dim	The dimension of the problem.
diameter	The preferred diameter for the aggregation.

◆ setGamma()

void Dune::Amg::Parameters::setGamma ( std::size_t gamma )

inlineinherited

Set the value of gamma; 1 for V-cycle, 2 for W-cycle.

◆ setMaxAggregateSize()

void Dune::Amg::AggregationParameters::setMaxAggregateSize ( std::size_t size )

inlineinherited

Set the maximum number of nodes a aggregate is allowed to have.

The default values is 6.

Parameters

size	The maximum number of nodes.

◆ setMaxConnectivity()

void Dune::Amg::AggregationParameters::setMaxConnectivity ( std::size_t connectivity )

inlineinherited

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.

◆ setMaxDistance()

void Dune::Amg::AggregationParameters::setMaxDistance ( std::size_t distance )

inlineinherited

Set the maximal distance allowed between two 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.

◆ setMaxLevel()

void Dune::Amg::CoarseningParameters::setMaxLevel ( int l )

inlineinherited

Set the maximum number of levels allowed in the hierarchy.

◆ setMinAggregateSize()

void Dune::Amg::AggregationParameters::setMinAggregateSize ( std::size_t size )

inlineinherited

Set the minimum number of nodes a aggregate has to consist of.

the default value is 4.

◆ setMinCoarsenRate()

void Dune::Amg::CoarseningParameters::setMinCoarsenRate ( double rate )

inlineinherited

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

The default value is 1.2

◆ setNoPostSmoothSteps()

void Dune::Amg::Parameters::setNoPostSmoothSteps ( std::size_t steps )

inlineinherited

Set the number of postsmoothing steps to apply.

Parameters

steps The number of steps:

◆ setNoPreSmoothSteps()

void Dune::Amg::Parameters::setNoPreSmoothSteps ( std::size_t steps )

inlineinherited

Set the number of presmoothing steps to apply.

Parameters

steps The number of steps:

◆ setProlongationDampingFactor()

void Dune::Amg::CoarseningParameters::setProlongationDampingFactor ( double d )

inlineinherited

Set the damping factor for the prolongation.

Parameters

d	The new damping factor.

◆ setSkipIsolated()

void Dune::Amg::AggregationParameters::setSkipIsolated ( bool skip )

inlineinherited

Set whether isolated aggregates will not be represented on the coarse level.

Parameters

skip	True if these aggregates will be skipped.

◆ setUseFixedOrder()

void Dune::Amg::CoarseningParameters::setUseFixedOrder ( bool useFixedOrder )

inlineinherited

◆ skipIsolated()

bool Dune::Amg::AggregationParameters::skipIsolated ( ) const

inlineinherited

Whether isolated aggregates will not be represented on the coarse level.

Returns: True if these aggregates will be skipped.

◆ useFixedOrder()

bool Dune::Amg::CoarseningParameters::useFixedOrder ( ) const

inlineinherited

Check if the indices for the coarser levels should be created in a fixed order.

Member Data Documentation

◆ diagonal_

real_type Dune::Amg::Dependency< M, Norm >::diagonal_

protectedinherited

The norm of the current diagonal.

◆ matrix_

const Matrix* Dune::Amg::Dependency< M, Norm >::matrix_

protectedinherited

The matrix we work on.

◆ maxValue_

real_type Dune::Amg::Dependency< M, Norm >::maxValue_

protectedinherited

◆ norm_

Norm Dune::Amg::Dependency< M, Norm >::norm_

protectedinherited

The functor for calculating the norm.

◆ row_

int Dune::Amg::Dependency< M, Norm >::row_

protectedinherited

index of the currently evaluated row.

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

aggregates.hh

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ColIter

◆ DependencyPolicy

◆ field_type

◆ Matrix

◆ Norm

◆ real_type

◆ Row

Member Function Documentation

◆ accumulate()

◆ alpha()

◆ beta()

◆ coarsenTarget()

◆ debugLevel()

◆ examine()

◆ getAdditive()

◆ getGamma()

◆ getNoPostSmoothSteps()

◆ getNoPreSmoothSteps()

◆ getProlongationDampingFactor()

◆ init()

◆ initRow()

◆ isIsolated()

◆ maxAggregateSize()

◆ maxConnectivity()

◆ maxDistance()

◆ maxLevel()

◆ minAggregateSize()

◆ minCoarsenRate()

◆ setAccumulate() [1/2]

◆ setAccumulate() [2/2]

◆ setAdditive()

◆ setAlpha()

◆ setBeta()

◆ setCoarsenTarget()

◆ setDebugLevel()

◆ setDefaultValuesAnisotropic()

◆ setDefaultValuesIsotropic()

◆ setGamma()

◆ setMaxAggregateSize()

◆ setMaxConnectivity()

◆ setMaxDistance()

◆ setMaxLevel()

◆ setMinAggregateSize()

◆ setMinCoarsenRate()

◆ setNoPostSmoothSteps()

◆ setNoPreSmoothSteps()

◆ setProlongationDampingFactor()

◆ setSkipIsolated()

◆ setUseFixedOrder()

◆ skipIsolated()

◆ useFixedOrder()

Member Data Documentation

◆ diagonal_

◆ matrix_

◆ maxValue_

◆ norm_

◆ row_