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

#include <MueLu_AggregationPhase1Algorithm_decl.hpp>

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

Constructors/Destructors.
	AggregationPhase1Algorithm (const RCP< const FactoryBase > &=Teuchos::null)
	Constructor.

virtual	~AggregationPhase1Algorithm ()
	Destructor.

Aggregation methods.
void	BuildAggregatesNonKokkos (const ParameterList &params, const LWGraph &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType &aggStat, LO &numNonAggregatedNodes) const
	Local aggregation.

void	BuildAggregates (const Teuchos::ParameterList &params, const LWGraph_kokkos &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &aggStat, LO &numNonAggregatedNodes) const

void	BuildAggregatesRandom (const LO maxAggSize, const LWGraph_kokkos &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &aggStat, LO &numNonAggregatedNodes) const

void	BuildAggregatesDeterministic (const LO maxAggSize, const LWGraph_kokkos &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &aggStat, LO &numNonAggregatedNodes) const

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

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

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

Additional Inherited Members
Public Types inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
using	LWGraphHostType = LWGraph

using	AggStatHostType = Kokkos::View< unsigned *, typename LWGraphHostType::device_type >

using	LWGraphType = LWGraph_kokkos

using	AggStatType = Kokkos::View< unsigned *, typename LWGraphType::device_type >

Public Member Functions inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
virtual	~AggregationAlgorithmBase ()
	Destructor.

virtual void	SetupPhase (const ParameterList &params, Teuchos::RCP< const Teuchos::Comm< int > > &comm, LO &numLocalNodes, LO &numNonAggregatedNodes)

virtual void	BuildAggregatesNonKokkos (const Teuchos::ParameterList &params, const LWGraphHostType &graph, Aggregates &aggregates, AggStatHostType &aggStat, LO &numNonAggregatedNodes) const =0
	BuildAggregatesNonKokkos routine.

virtual void	BuildAggregates (const Teuchos::ParameterList &params, const LWGraphType &graph, Aggregates &aggregates, AggStatType &aggStat, LO &numNonAggregatedNodes) const =0
	BuildAggregates routine.

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

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

virtual	~VerboseObject ()
	Destructor.

VerbLevel	GetVerbLevel () const
	Get the verbosity level.

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

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

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

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

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

Teuchos::FancyOStream &	GetBlackHole () const

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

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

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.

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

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

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

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::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >

Algorithm for coarsening a graph with uncoupled aggregation.

Idea

Phase 1 tries to build new aggregates which fulfill the user chosen aggregation criteria (i.e. minimum and maximum size of aggregates). Especially the chosen ordering for the input nodes may have some influence on the final aggregates. Phase 1 is the most important aggregation routine for building new aggregates.

Parameters

Parameter	Meaning
aggregation: ordering	Ordering of graph nodes in which the nodes are processed for aggregation. The options are natural, random and graph.
aggregation: max selected neighbors	Maximum number of neighbor nodes which have already been added to aggregates.
aggregation: min agg size	minimum number of nodes which have to be in an aggregate.
aggregation: max agg size	maximum allowed number of nodes in an aggregate

Comments

Only nodes with state READY are changed to AGGREGATED. Nodes with other states are not touched.

Definition at line 49 of file MueLu_AggregationPhase1Algorithm_decl.hpp.

Constructor & Destructor Documentation

◆ AggregationPhase1Algorithm()

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

MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::AggregationPhase1Algorithm ( const RCP< const FactoryBase > & = Teuchos::null )

inline

Constructor.

Definition at line 58 of file MueLu_AggregationPhase1Algorithm_decl.hpp.

◆ ~AggregationPhase1Algorithm()

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

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

inlinevirtual

Destructor.

Definition at line 61 of file MueLu_AggregationPhase1Algorithm_decl.hpp.

Member Function Documentation

◆ BuildAggregatesNonKokkos()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregatesNonKokkos	(	const ParameterList &	params,
		const LWGraph &	graph,
		Aggregates &	aggregates,
		typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType &	aggStat,
		LO &	numNonAggregatedNodes
	)		const

Local aggregation.

Definition at line 33 of file MueLu_AggregationPhase1Algorithm_def.hpp.

◆ BuildAggregates()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates	(	const Teuchos::ParameterList &	params,
		const LWGraph_kokkos &	graph,
		Aggregates &	aggregates,
		typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &	aggStat,
		LO &	numNonAggregatedNodes
	)		const

Definition at line 215 of file MueLu_AggregationPhase1Algorithm_def.hpp.

◆ BuildAggregatesRandom()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregatesRandom	(	const LO	maxAggSize,
		const LWGraph_kokkos &	graph,
		Aggregates &	aggregates,
		typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &	aggStat,
		LO &	numNonAggregatedNodes
	)		const

Definition at line 246 of file MueLu_AggregationPhase1Algorithm_def.hpp.

◆ BuildAggregatesDeterministic()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregatesDeterministic	(	const LO	maxAggSize,
		const LWGraph_kokkos &	graph,
		Aggregates &	aggregates,
		typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &	aggStat,
		LO &	numNonAggregatedNodes
	)		const

Definition at line 354 of file MueLu_AggregationPhase1Algorithm_def.hpp.

◆ description()

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

std::string MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 91 of file MueLu_AggregationPhase1Algorithm_decl.hpp.

◆ RandomReorder()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase1Algorithm< LocalOrdinal, GlobalOrdinal, Node >::RandomReorder ( 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 202 of file MueLu_AggregationPhase1Algorithm_def.hpp.

◆ RandomOrdinal()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

private

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

Definition at line 210 of file MueLu_AggregationPhase1Algorithm_def.hpp.

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

Constructors/Destructors.

Aggregation methods.

Additional Inherited Members

Detailed Description

Idea

Parameters

Comments

Constructor & Destructor Documentation

◆ AggregationPhase1Algorithm()

◆ ~AggregationPhase1Algorithm()

Member Function Documentation

◆ BuildAggregatesNonKokkos()

◆ BuildAggregates()

◆ BuildAggregatesRandom()

◆ BuildAggregatesDeterministic()

◆ description()

◆ RandomReorder()

◆ RandomOrdinal()