MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <MueLu_LocalAggregationAlgorithm_decl.hpp>

Inheritance diagram for MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Private Types

typedef GO global_size_t
 
typedef LO my_size_t
 

Constructors/Destructors.

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

Set/get methods.

void SetOrdering (const std::string &ordering)
 
void SetMinNodesPerAggregate (int minNodesPerAggregate)
 
void SetMaxNeighAlreadySelected (int maxNeighAlreadySelected)
 
const std::string & GetOrdering () const
 
int GetMinNodesPerAggregate () const
 
int GetMaxNeighAlreadySelected () const
 

Aggregation methods.

std::string ordering_
 Aggregation options (TODO: Teuchos::ParameterList?) More...
 
int minNodesPerAggregate_
 
int maxNeighAlreadySelected_
 
void CoarsenUncoupled (GraphBase const &graph, Aggregates &aggregates) const
 Local aggregation. More...
 

Utilities

void RandomReorder (Teuchos::ArrayRCP< LO > list) const
 Utility to take a list of integers and reorder them randomly (by using a local permutation). More...
 
int RandomOrdinal (int min, int max) const
 Generate a random number in the range [min, max]. More...
 

Additional Inherited Members

- 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- 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 Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
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...
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

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

Algorithm 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 96 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Member Typedef Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef GO MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::global_size_t
private

Definition at line 100 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef LO MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::my_size_t
private

Definition at line 101 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 66 of file MueLu_LocalAggregationAlgorithm_def.hpp.

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

Destructor.

Definition at line 111 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

Member Function Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetOrdering ( const std::string &  ordering)
inline

Definition at line 118 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetMinNodesPerAggregate ( int  minNodesPerAggregate)
inline

Definition at line 119 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::SetMaxNeighAlreadySelected ( int  maxNeighAlreadySelected)
inline

Definition at line 120 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
const std::string& MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetOrdering ( ) const
inline

Definition at line 122 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetMinNodesPerAggregate ( ) const
inline

Definition at line 123 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::GetMaxNeighAlreadySelected ( ) const
inline

Definition at line 124 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::CoarsenUncoupled ( GraphBase const &  graph,
Aggregates aggregates 
) const

Local aggregation.

Definition at line 71 of file MueLu_LocalAggregationAlgorithm_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::RandomReorder ( Teuchos::ArrayRCP< LO list) const
private

Utility to take a list of integers and reorder them randomly (by using a local permutation).

Parameters
listOn input, a bunch of integers. On output, the same integers in a different order that is determined randomly.

Definition at line 335 of file MueLu_LocalAggregationAlgorithm_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::RandomOrdinal ( int  min,
int  max 
) const
private

Generate a random number in the range [min, max].

Definition at line 344 of file MueLu_LocalAggregationAlgorithm_def.hpp.

Member Data Documentation

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::string MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ordering_
private

Aggregation options (TODO: Teuchos::ParameterList?)

natural, random, graph

Definition at line 136 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::minNodesPerAggregate_
private

aggregate size control

Definition at line 137 of file MueLu_LocalAggregationAlgorithm_decl.hpp.

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::LocalAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::maxNeighAlreadySelected_
private

complexity control

Definition at line 138 of file MueLu_LocalAggregationAlgorithm_decl.hpp.


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