Algorithm for coarsening a graph with uncoupled aggregation. More...

#include <MueLu_LocalAggregationAlgorithm_decl.hpp>

Inheritance diagram for MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >:

Private Types
typedef GO	global_size_t

typedef LO	my_size_t

Aggregation methods.
std::string	ordering_
	Aggregation options (TODO: Teuchos::ParameterList?) More...

int	minNodesPerAggregate_

int	maxNeighAlreadySelected_

void	CoarsenUncoupled (GraphBase const &graph, Aggregates &aggregates) const
	Local aggregation. More...

Constructors/Destructors.
	LocalAggregationAlgorithm ()
	Constructor. More...

virtual	~LocalAggregationAlgorithm ()
	Destructor. More...

Set/get methods.
void	SetOrdering (const std::string &ordering)

void	SetMinNodesPerAggregate (int minNodesPerAggregate)

void	SetMaxNeighAlreadySelected (int maxNeighAlreadySelected)

const std::string &	GetOrdering () const

int	GetMinNodesPerAggregate () const

int	GetMaxNeighAlreadySelected () const

Utilities
void	RandomReorder (Teuchos::ArrayRCP< LO > list) const
	Utility to take a list of integers and reorder them randomly (by using a local permutation). More...

int	RandomOrdinal (int min, int max) const
	Generate a random number in the range [min, max]. More...

Additional Inherited Members
Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

VerbLevel	GetVerbLevel () const
	Get the verbosity level. More...

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object. More...

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose. More...

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing. More...

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type. More...

Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type. More...

Teuchos::FancyOStream &	GetBlackHole () const

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. More...

virtual void	describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const

virtual std::string	description () const
	Return a simple one-line description of this object. More...

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object. More...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP< Teuchos::FancyOStream >	GetMueLuOStream ()

Detailed Description

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >

Algorithm for coarsening a graph with uncoupled aggregation.

This method has two phases. The first is a local clustering algorithm. The second creates aggregates that can include unknowns from more than one process.

Definition at line 98 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Member Typedef Documentation

◆ global_size_t

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

typedef GO MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::global_size_t

private

Definition at line 102 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ my_size_t

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

typedef LO MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::my_size_t

private

Definition at line 103 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ LocalAggregationAlgorithm()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::LocalAggregationAlgorithm

Constructor.

Definition at line 66 of file MueLu_LocalAggregationAlgorithm_def.hpp.

◆ ~LocalAggregationAlgorithm()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

virtual MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::~LocalAggregationAlgorithm ( )

inlinevirtual

Destructor.

Definition at line 113 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Member Function Documentation

◆ SetOrdering()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetOrdering ( const std::string & ordering )

inline

Definition at line 120 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ SetMinNodesPerAggregate()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetMinNodesPerAggregate ( int minNodesPerAggregate )

inline

Definition at line 121 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ SetMaxNeighAlreadySelected()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetMaxNeighAlreadySelected ( int maxNeighAlreadySelected )

inline

Definition at line 122 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ GetOrdering()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

const std::string & MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetOrdering ( ) const

inline

Definition at line 124 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ GetMinNodesPerAggregate()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetMinNodesPerAggregate ( ) const

inline

Definition at line 125 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ GetMaxNeighAlreadySelected()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetMaxNeighAlreadySelected ( ) const

inline

Definition at line 126 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ CoarsenUncoupled()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::CoarsenUncoupled	(	GraphBase const &	graph,
		Aggregates &	aggregates
	)		const

Local aggregation.

Definition at line 71 of file MueLu_LocalAggregationAlgorithm_def.hpp.

◆ RandomReorder()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::RandomReorder ( Teuchos::ArrayRCP< LO > list ) const

private

Utility to take a list of integers and reorder them randomly (by using a local permutation).

Parameters

list	On input, a bunch of integers. On output, the same integers in a different order that is determined randomly.

Definition at line 335 of file MueLu_LocalAggregationAlgorithm_def.hpp.

◆ RandomOrdinal()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::RandomOrdinal	(	int	min,
		int	max
	)		const

private

Generate a random number in the range [min, max].

Definition at line 344 of file MueLu_LocalAggregationAlgorithm_def.hpp.

Member Data Documentation

◆ ordering_

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

std::string MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ordering_

private

Aggregation options (TODO: Teuchos::ParameterList?)

natural, random, graph

Definition at line 138 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ minNodesPerAggregate_

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::minNodesPerAggregate_

private

aggregate size control

Definition at line 139 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

◆ maxNeighAlreadySelected_

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::maxNeighAlreadySelected_

private

complexity control

Definition at line 140 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

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

Private Types

Aggregation methods.

Constructors/Destructors.

Set/get methods.

Utilities

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ global_size_t

◆ my_size_t

Constructor & Destructor Documentation

◆ LocalAggregationAlgorithm()

◆ ~LocalAggregationAlgorithm()

Member Function Documentation

◆ SetOrdering()

◆ SetMinNodesPerAggregate()

◆ SetMaxNeighAlreadySelected()

◆ GetOrdering()

◆ GetMinNodesPerAggregate()

◆ GetMaxNeighAlreadySelected()

◆ CoarsenUncoupled()

◆ RandomReorder()

◆ RandomOrdinal()

Member Data Documentation

◆ ordering_

◆ minNodesPerAggregate_

◆ maxNeighAlreadySelected_