Among unaggregated points, see if we can make a reasonable size aggregate out of it. More...

#include <MueLu_AggregationPhase2aAlgorithm_decl.hpp>

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

Aggregation methods.
double	factorMLOverride_ = Teuchos::ScalarTraits<double>::nan()

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

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

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

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

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

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

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

virtual	~AggregationPhase2aAlgorithm ()
	Destructor.

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

Among unaggregated points, see if we can make a reasonable size aggregate out of it.

Idea

Among unaggregated points, see if we can make a reasonable size aggregate out of it. We do this by looking at neighbors and seeing how many are unaggregated and on my processor. Loosely, base the number of new aggregates created on the percentage of unaggregated nodes.

Parameters

Parameter	Meaning
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.

Definition at line 48 of file MueLu_AggregationPhase2aAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ AggregationPhase2aAlgorithm()

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

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

inline

Constructor.

Definition at line 57 of file MueLu_AggregationPhase2aAlgorithm_decl.hpp.

◆ ~AggregationPhase2aAlgorithm()

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

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

inlinevirtual

Destructor.

Definition at line 60 of file MueLu_AggregationPhase2aAlgorithm_decl.hpp.

Member Function Documentation

◆ SetupPhase()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AggregationPhase2aAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetupPhase	(	const ParameterList &	params,
		Teuchos::RCP< const Teuchos::Comm< int > > &	comm,
		LO &	numLocalNodes,
		LO &	numNonAggregatedNodes
	)

overridevirtual

Local aggregation.

Reimplemented from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 30 of file MueLu_AggregationPhase2aAlgorithm_def.hpp.

◆ BuildAggregatesNonKokkos()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

override

Definition at line 44 of file MueLu_AggregationPhase2aAlgorithm_def.hpp.

◆ BuildAggregates()

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

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

override

Definition at line 168 of file MueLu_AggregationPhase2aAlgorithm_def.hpp.

◆ BuildAggregatesRandom()

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

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

Definition at line 185 of file MueLu_AggregationPhase2aAlgorithm_def.hpp.

◆ BuildAggregatesDeterministic()

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

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

Definition at line 306 of file MueLu_AggregationPhase2aAlgorithm_def.hpp.

◆ description()

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

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

inlineoverridevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 92 of file MueLu_AggregationPhase2aAlgorithm_decl.hpp.

Member Data Documentation

◆ factorMLOverride_

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

double MueLu::AggregationPhase2aAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::factorMLOverride_ = Teuchos::ScalarTraits<double>::nan()

private

Definition at line 95 of file MueLu_AggregationPhase2aAlgorithm_decl.hpp.

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

Aggregation methods.

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Idea

Parameters

Comments

Constructor & Destructor Documentation

◆ AggregationPhase2aAlgorithm()

◆ ~AggregationPhase2aAlgorithm()

Member Function Documentation

◆ SetupPhase()

◆ BuildAggregatesNonKokkos()

◆ BuildAggregates()

◆ BuildAggregatesRandom()

◆ BuildAggregatesDeterministic()

◆ description()

Member Data Documentation

◆ factorMLOverride_