Add leftovers to existing aggregates. More...

#include <MueLu_AggregationPhase2bAlgorithm_decl.hpp>

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

Constructors/Destructors.
	AggregationPhase2bAlgorithm (const RCP< const FactoryBase > &=Teuchos::null)
	Constructor.
virtual	~AggregationPhase2bAlgorithm ()
	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 ParameterList &params, const LWGraph_kokkos &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &aggStat, LO &numNonAggregatedNodes) const
template<bool deterministic>
void	BuildAggregates (const ParameterList &params, 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.

Additional Inherited Members
Public Types inherited from MueLu::AggregationAlgorithmBase< DefaultLocalOrdinal, DefaultGlobalOrdinal, DefaultNode >
using	LWGraphHostType
using	AggStatHostType
using	LWGraphType
using	AggStatType
virtual	~AggregationAlgorithmBase ()
	Destructor.
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.
virtual	~BaseClass ()
	Destructor.
	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 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::AggregationPhase2bAlgorithm< LocalOrdinal, GlobalOrdinal, Node >

Add leftovers to existing aggregates.

Idea

In phase 2b non-aggregated nodes are added to existing aggregates. All neighbors of the unaggregated node are checked and the corresponding aggregate weight is increased. The unaggregated node is added to the aggregate with the best weight. A simple penalty strategy makes sure that the non-aggregated nodes are added to different aggregates. The routine runs twice to cover non-aggregate nodes which have a node distance of two to existing aggregates. Assuming that the node distance is not greater than 3 (the aggregate diameter size), running the algorithm only twice should be sufficient.

Comments

Only nodes with state READY are changed to AGGREGATED. There are no aggregation criteria considered. Especially the aggregation: max agg size criterion is ignored. This is not a problem, since after the previous aggregation phases one should not be able to build too large aggregates.

Definition at line 47 of file MueLu_AggregationPhase2bAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ AggregationPhase2bAlgorithm()

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

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

inline

Constructor.

Definition at line 56 of file MueLu_AggregationPhase2bAlgorithm_decl.hpp.

◆ ~AggregationPhase2bAlgorithm()

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

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

inlinevirtual

Destructor.

Definition at line 59 of file MueLu_AggregationPhase2bAlgorithm_decl.hpp.

Member Function Documentation

◆ BuildAggregatesNonKokkos()

template<class LocalOrdinal, class GlobalOrdinal, class Node>

void MueLu::AggregationPhase2bAlgorithm< 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 30 of file MueLu_AggregationPhase2bAlgorithm_def.hpp.

◆ BuildAggregates() [1/2]

template<class LocalOrdinal, class GlobalOrdinal, class Node>

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

Definition at line 113 of file MueLu_AggregationPhase2bAlgorithm_def.hpp.

◆ BuildAggregates() [2/2]

template<class LocalOrdinal, class GlobalOrdinal, class Node>

template<bool deterministic>

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

Definition at line 230 of file MueLu_AggregationPhase2bAlgorithm_def.hpp.

◆ description()

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

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

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 85 of file MueLu_AggregationPhase2bAlgorithm_decl.hpp.

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

Constructors/Destructors.

Aggregation methods.

Additional Inherited Members

Detailed Description

Idea

Comments

Constructor & Destructor Documentation

◆ AggregationPhase2bAlgorithm()

◆ ~AggregationPhase2bAlgorithm()

Member Function Documentation

◆ BuildAggregatesNonKokkos()

◆ BuildAggregates() [1/2]

◆ BuildAggregates() [2/2]

◆ description()