Factory for building uncoupled aggregates. More...

#include <MueLu_UncoupledAggregationFactory_decl.hpp>

Inheritance diagram for MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >:

Private Attributes
std::vector< RCP < MueLu::AggregationAlgorithmBase < LocalOrdinal, GlobalOrdinal, Node > > >	algos_
	Append a new aggregation algorithm to list of aggregation algorithms. More...

bool	bDefinitionPhase_

Constructors/Destructors.
	UncoupledAggregationFactory ()
	Constructor. More...

virtual	~UncoupledAggregationFactory ()
	Destructor. More...

RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept. More...

Set/get methods.
void	SetOrdering (const std::string &ordering)

void	SetMaxNeighAlreadySelected (int maxNeighAlreadySelected)

void	SetMinNodesPerAggregate (int minNodesPerAggregate)

void	SetOnePtMapName (const std::string name, Teuchos::RCP< const FactoryBase > mapFact)

const std::string &	GetOrdering () const

int	GetMaxNeighAlreadySelected () const

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
void	EnableMultipleCallCheck () const
	Constructor. More...

void	DisableMultipleCallCheck () const

void	ResetDebugData () 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 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

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)

Public Member Functions inherited from MueLu::FactoryAcceptor
virtual	~FactoryAcceptor ()

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
	Configuration. More...

virtual const RCP< const FactoryBase >	GetFactory (const std::string &varName) const =0

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	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...

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

Detailed Description

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

Factory for building uncoupled aggregates.

Factory for creating uncoupled aggregates from the amalgamated graph of A. The uncoupled aggregation method uses several aggregation phases which put together all nodes into aggregates.

Aggregation phases

AggregationAlgorithm	Short description
PreserveDirichletAggregationAlgorithm	Handle Dirichlet nodes. Decide whether to drop/ignore them in the aggregation or keep them as singleton nodes.
OnePtAggregationAlgorithm	Special handling for nodes with status ONEPT. A user can mark special nodes for singleton aggregates or a user-specified handling. This aggregation phase has to be switched on by the user if necessary (default = off).
AggregationPhase1Algorithm	Build new aggregates
AggregationPhase2aAlgorithm	Build aggregates of reasonable size from leftover nodes
AggregationPhase2bAlgorithm	Add leftover nodes to existing aggregates
AggregationPhase3Algorithm	Handle leftover nodes. Try to avoid singletons
IsolatedNodeAggregationAlgorithm	Drop/ignore leftover nodes

Internally, each node has a status which can be one of the following:

Node status	Meaning
READY	Node is not aggregated and can be used for building a new aggregate or can be added to an existing aggregate.
AGGREGATED	Node is aggregated.
IGNORED	Node is not considered for aggregation (it may have been dropped or put into a singleton aggregate)
BOUNDARY	Node is a Dirichlet boundary node (with one or more Dirichlet boundary conditions).
ONEPT	The user forces the aggregation algorithm to treat the node as a singleton. Important: Do not forget to set aggregation: allow user-specified singletons to true! Otherwise Phase3 will just handle the ONEPT nodes and probably not build singletons

Input/output of UncoupledAggregationFactory

User parameters of UncoupledAggregationFactory

Parameter	type	default	master.xml	validated	requested	description
Graph	Factory	null		*	*	Generating factory of the graph of A
DofsPerNode	Factory	null		*	*	Generating factory for variable 'DofsPerNode', usually the same as for 'Graph'
OnePt aggregate map name	string			*	*	Name of input map for single node aggregates (default=''). Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true.
OnePt aggregate map factory	Factory	null		*	*	Generating factory of (DOF) map for single node aggregates. Makes only sense if the parameter 'aggregation: allow user-specified singletons' is set to true.
aggregation: max agg size	int	see master.xml	*	*		Maximum number of nodes per aggregate.
aggregation: min agg size	int	see master.xml	*	*		Minimum number of nodes necessary to build a new aggregate.
aggregation: max selected neighbors	int	see master.xml	*	*		Maximum number of neighbor nodes already in aggregate (needed in Phase1)
aggregation: ordering	string	"natural"	*	*		Ordering of node aggregation (can be either "natural", "graph" or "random").
aggregation: enable phase 1	bool	true	*	*		Turn on/off phase 1 aggregation
aggregation: enable phase 2a	bool	true	*	*		Turn on/off phase 2a aggregation
aggregation: enable phase 2b	bool	true	*	*		Turn on/off phase 2b aggregation
aggregation: enable phase 3	bool	true	*	*		Turn on/off phase 3 aggregation
aggregation: preserve Dirichlet points	bool	false	*	*		preserve Dirichlet points as singleton nodes (default=false, i.e., drop Dirichlet nodes during aggregation)
aggregation: allow user-specified singletons	bool	false	*	*		Turn on/off OnePtAggregationAlgorithm (default=false)

The * in the master.xml column denotes that the parameter is defined in the master.xml file.
The * in the validated column means that the parameter is declared in the list of valid input parameters (see UncoupledAggregationFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see UncoupledAggregationFactory::DeclareInput).

Variables provided by UncoupledAggregationFactory

After UncoupledAggregationFactory::Build the following data is available (if requested)

Parameter	generated by	description
Aggregates	UncoupledAggregationFactory	Container class with aggregation information. See also Aggregates.

Definition at line 145 of file MueLu_UncoupledAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >

MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::UncoupledAggregationFactory ( )

Constructor.

Definition at line 79 of file MueLu_UncoupledAggregationFactory_def.hpp.

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

virtual MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::~UncoupledAggregationFactory ( )

inlinevirtual

Destructor.

Definition at line 157 of file MueLu_UncoupledAggregationFactory_decl.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const ParameterList > MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const

virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Implements MueLu::ParameterListAcceptor.

Definition at line 84 of file MueLu_UncoupledAggregationFactory_def.hpp.

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

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetOrdering ( const std::string & ordering )

inline

Definition at line 169 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetMaxNeighAlreadySelected ( int maxNeighAlreadySelected )

inline

Definition at line 173 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetMinNodesPerAggregate ( int minNodesPerAggregate )

inline

Definition at line 177 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::SetOnePtMapName	(	const std::string	name,
		Teuchos::RCP< const FactoryBase >	mapFact
	)

inline

Definition at line 181 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

const std::string& MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetOrdering ( ) const

inline

Definition at line 187 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

int MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetMaxNeighAlreadySelected ( ) const

inline

Definition at line 192 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

int MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::GetMinNodesPerAggregate ( ) const

inline

Definition at line 197 of file MueLu_UncoupledAggregationFactory_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 131 of file MueLu_UncoupledAggregationFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( Level & currentLevel ) const

virtual

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 170 of file MueLu_UncoupledAggregationFactory_def.hpp.

Member Data Documentation

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

std::vector<RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > > MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::algos_

mutableprivate

Append a new aggregation algorithm to list of aggregation algorithms.

Remove all aggregation algorithms from list aggregation algorithms

Definition at line 233 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

bool MueLu::UncoupledAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::bDefinitionPhase_

mutableprivate

boolean flag: definition phase if true, the aggregation algorithms still can be set and changed. if false, no change in aggregation algorithms is possible any more

Definition at line 238 of file MueLu_UncoupledAggregationFactory_decl.hpp.

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

Private Attributes

Constructors/Destructors.

Set/get methods.

Build methods.

Additional Inherited Members

Detailed Description

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

Aggregation phases

Input/output of UncoupledAggregationFactory

User parameters of UncoupledAggregationFactory

Variables provided by UncoupledAggregationFactory

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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