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

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

#include <MueLu_CoupledAggregationFactory_decl.hpp>

Inheritance diagram for MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Private Attributes

LocalAggregationAlgorithm algo1_
 Algorithms. More...
 
LeftoverAggregationAlgorithm algo2_
 

Constructors/Destructors.

 CoupledAggregationFactory ()
 Constructor. More...
 
virtual ~CoupledAggregationFactory ()
 Destructor. More...
 

Set/get methods.

void SetOrdering (const std::string &ordering)
 
void SetMaxNeighAlreadySelected (int maxNeighAlreadySelected)
 
const std::string & GetOrdering () const
 
int GetMaxNeighAlreadySelected () const
 
void SetPhase3AggCreation (double phase3AggCreation)
 
double GetPhase3AggCreation () const
 
void SetMinNodesPerAggregate (int minNodesPerAggregate)
 
int GetMinNodesPerAggregate () const
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 

Build methods.

void Build (Level &currentLevel) const
 Build aggregates. More...
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor. More...
 
virtual ~SingleLevelFactoryBase ()
 Destructor. More...
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
virtual RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
 Factory ()
 Constructor. More...
 
virtual ~Factory ()
 Destructor. More...
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration. More...
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor. More...
 
virtual ~FactoryBase ()
 Destructor. More...
 
int GetID () const
 return unique factory id 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
 
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
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...
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
virtual void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values. More...
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry. More...
 
const ParameterEntry & GetParameter (const std::string &name) const
 Retrieves a const entry with the name name. More...
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetMueLuOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- Protected Member Functions inherited from MueLu::Factory
void Input (Level &level, const std::string &varName) const
 
void Input (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
Get (Level &level, const std::string &varName) const
 
template<class T >
Get (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
void Set (Level &level, const std::string &varName, const T &data) const
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

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

Factory for coarsening a graph with uncoupled aggregation.

This method has two phases. The first is a local clustering algorithm. The second creates aggregates that can include unknowns from more than one process.

Definition at line 84 of file MueLu_CoupledAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ CoupledAggregationFactory()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::CoupledAggregationFactory ( )

Constructor.

Definition at line 59 of file MueLu_CoupledAggregationFactory_def.hpp.

◆ ~CoupledAggregationFactory()

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

Destructor.

Definition at line 96 of file MueLu_CoupledAggregationFactory_decl.hpp.

Member Function Documentation

◆ SetOrdering()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetOrdering ( const std::string &  ordering)
inline

Definition at line 104 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ SetMaxNeighAlreadySelected()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetMaxNeighAlreadySelected ( int  maxNeighAlreadySelected)
inline

Definition at line 105 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ GetOrdering()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
const std::string& MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetOrdering ( ) const
inline

Definition at line 106 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ GetMaxNeighAlreadySelected()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
int MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetMaxNeighAlreadySelected ( ) const
inline

Definition at line 107 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ SetPhase3AggCreation()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetPhase3AggCreation ( double  phase3AggCreation)
inline

Definition at line 110 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ GetPhase3AggCreation()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
double MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetPhase3AggCreation ( ) const
inline

Definition at line 111 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ SetMinNodesPerAggregate()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetMinNodesPerAggregate ( int  minNodesPerAggregate)
inline

Definition at line 114 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ GetMinNodesPerAggregate()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
int MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetMinNodesPerAggregate ( ) const
inline

Definition at line 115 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ DeclareInput()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 65 of file MueLu_CoupledAggregationFactory_def.hpp.

◆ Build()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
virtual

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 71 of file MueLu_CoupledAggregationFactory_def.hpp.

Member Data Documentation

◆ algo1_

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
LocalAggregationAlgorithm MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::algo1_
private

Algorithms.

Definition at line 138 of file MueLu_CoupledAggregationFactory_decl.hpp.

◆ algo2_

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
LeftoverAggregationAlgorithm MueLu::CoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::algo2_
private

Definition at line 139 of file MueLu_CoupledAggregationFactory_decl.hpp.


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