MueLu  Version of the Day
MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Handle leftover nodes. Try to avoid singleton nodes

Idea

In phase 3 we try to stick unaggregated nodes into a neighboring aggregate. We try to avoid singletons: we first try to build a new aggregate containing all neighboring non-aggregated nodes. If we cannot build a new aggregate, we add the non-aggregated node to the first adjacent aggregate. Only if there is no adjacent aggregate, we create a singleton node aggregate. More...

#include <MueLu_AggregationPhase3Algorithm_decl.hpp>

Inheritance diagram for MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >:
MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Public Member Functions

std::string description () const
 Return a simple one-line description of this object. More...
 
- Public Member Functions inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
virtual ~AggregationAlgorithmBase ()
 Destructor. More...
 
virtual void BuildAggregates (const Teuchos::ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const =0
 BuildAggregates routine. More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
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
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
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. More...
 

Constructors/Destructors.

 AggregationPhase3Algorithm (const RCP< const FactoryBase > &graphFact=Teuchos::null)
 Constructor. More...
 
virtual ~AggregationPhase3Algorithm ()
 Destructor. More...
 

Aggregation methods.

void BuildAggregates (const ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
 Local aggregation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >

Handle leftover nodes. Try to avoid singleton nodes

Idea

In phase 3 we try to stick unaggregated nodes into a neighboring aggregate. We try to avoid singletons: we first try to build a new aggregate containing all neighboring non-aggregated nodes. If we cannot build a new aggregate, we add the non-aggregated node to the first adjacent aggregate. Only if there is no adjacent aggregate, we create a singleton node aggregate.

Comments

Only nodes with state READY are changed to AGGREGATED.

Definition at line 78 of file MueLu_AggregationPhase3Algorithm_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >::AggregationPhase3Algorithm ( const RCP< const FactoryBase > &  graphFact = Teuchos::null)
inline

Constructor.

Definition at line 88 of file MueLu_AggregationPhase3Algorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >::~AggregationPhase3Algorithm ( )
inlinevirtual

Destructor.

Definition at line 91 of file MueLu_AggregationPhase3Algorithm_decl.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates ( const ParameterList &  params,
const GraphBase graph,
Aggregates aggregates,
std::vector< unsigned > &  aggStat,
LO &  numNonAggregatedNodes 
) const

Local aggregation.

Definition at line 66 of file MueLu_AggregationPhase3Algorithm_def.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::string MueLu::AggregationPhase3Algorithm< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 104 of file MueLu_AggregationPhase3Algorithm_decl.hpp.


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