MueLu
Version of the Day
|
Algorithm for coarsening a graph with uncoupled aggregation. More...
#include <MueLu_AggregationPhase1Algorithm_decl.hpp>
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... | |
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 Teuchos::VerboseObject< VerboseObject > | |
VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (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 VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () 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 |
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) |
Private Member Functions | |
void | RandomReorder (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... | |
Constructors/Destructors. | |
AggregationPhase1Algorithm (const RCP< const FactoryBase > &=Teuchos::null) | |
Constructor. More... | |
virtual | ~AggregationPhase1Algorithm () |
Destructor. More... | |
Aggregation methods. | |
void | BuildAggregates (const ParameterList ¶ms, 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 | 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< FancyOStream > | getDefaultOStream () |
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 |
Algorithm for coarsening a graph with uncoupled aggregation.
Phase 1 tries to build new aggregates which fulfill the user chosen aggregation criteria (i.e. minimum and maximum size of aggregates). Especially the chosen ordering for the input nodes may have some influence on the final aggregates. Phase 1 is the most important aggregation routine for building new aggregates.
Parameter | Meaning |
---|---|
aggregation: ordering | Ordering of graph nodes in which the nodes are processed for aggregation. The options are natural, random and graph. |
aggregation: max selected neighbors | Maximum number of neighbor nodes which have already been added to aggregates. |
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 |
Only nodes with state READY are changed to AGGREGATED. Nodes with other states are not touched.
Definition at line 85 of file MueLu_AggregationPhase1Algorithm_decl.hpp.
|
inline |
Constructor.
Definition at line 95 of file MueLu_AggregationPhase1Algorithm_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 98 of file MueLu_AggregationPhase1Algorithm_decl.hpp.
|
virtual |
Local aggregation.
Implements MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 67 of file MueLu_AggregationPhase1Algorithm_def.hpp.
|
inlinevirtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 111 of file MueLu_AggregationPhase1Algorithm_decl.hpp.
|
private |
Utility to take a list of integers and reorder them randomly (by using a local permutation).
list | On input, a bunch of integers. On output, the same integers in a different order that is determined randomly. |
Definition at line 232 of file MueLu_AggregationPhase1Algorithm_def.hpp.
|
private |
Generate a random number in the range [min, max].
Definition at line 240 of file MueLu_AggregationPhase1Algorithm_def.hpp.