MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::IsolatedNodeAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Ignores isolated nodes during aggregation. Marks the node to be "aggregated" without adding real aggregates for them. More...

#include <MueLu_IsolatedNodeAggregationAlgorithm_decl.hpp>

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

Constructors/Destructors.

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

Aggregation methods.

void BuildAggregates (const ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
 Local aggregation.
 
std::string description () const
 Return a simple one-line description of this object.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
virtual ~AggregationAlgorithmBase ()
 Destructor.
 
virtual void BuildAggregates (const Teuchos::ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &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::IsolatedNodeAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >

Ignores isolated nodes during aggregation. Marks the node to be "aggregated" without adding real aggregates for them.

Idea

The isolated node aggregation algorithm loops over all non-aggregated nodes (with a state different than aggregated or ignored) which have only themselves as neighbor node. The state of these "isolated" nodes is then set to ignored such that they are not considered in the aggregation. This aggregation algorithm should run as one of the last aggregation algorithms in the aggregation method.

Comments

Only nodes with state different than READY or AGGREGATED are changed to IGNORED. After that, all nodes should have the state AGGREGATED or IGNORED.

Idea

The isolated node aggregation algorithm loops over all non-aggregated nodes (with a state different than aggregated or ignored) which have only themselves as neighbor node. The state of these "isolated" nodes is then set to ignored such that they are not considered in the aggregation. This aggregation algorithm should run as one of the last aggregation algorithms in the aggregation method.

Comments

Only nodes with state different than READY or AGGREGATED are changed to IGNORED. After that, all nodes should have the state AGGREGATED or IGNORED.

Definition at line 82 of file MueLu_IsolatedNodeAggregationAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ IsolatedNodeAggregationAlgorithm()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::IsolatedNodeAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::IsolatedNodeAggregationAlgorithm ( const RCP< const FactoryBase > & = Teuchos::null)
inline

Constructor.

Definition at line 92 of file MueLu_IsolatedNodeAggregationAlgorithm_decl.hpp.

◆ ~IsolatedNodeAggregationAlgorithm()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::IsolatedNodeAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::~IsolatedNodeAggregationAlgorithm ( )
inlinevirtual

Destructor.

Definition at line 95 of file MueLu_IsolatedNodeAggregationAlgorithm_decl.hpp.

Member Function Documentation

◆ BuildAggregates()

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

Local aggregation.

Definition at line 72 of file MueLu_IsolatedNodeAggregationAlgorithm_def.hpp.

◆ description()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::string MueLu::IsolatedNodeAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 108 of file MueLu_IsolatedNodeAggregationAlgorithm_decl.hpp.


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