Factory for building aggregates on meshes partly structured and partly unstructured. More...

#include <MueLu_HybridAggregationFactory_decl.hpp>

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

Build methods.
std::vector< RCP< MueLu::AggregationAlgorithmBase< LO, GO, Node > > >	algos_
	aggregation algorithms

bool	bDefinitionPhase_

void	Build (Level &currentLevel) const
	Build aggregates.

void	BuildInterfaceAggregates (Level &currentLevel, RCP< Aggregates > aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType &aggStat, LO &numNonAggregatedNodes, Array< LO > coarseRate) const
	Specifically build aggregates along interfaces.

Constructors/Destructors.
	HybridAggregationFactory ()
	Constructor.

virtual	~HybridAggregationFactory ()
	Destructor.

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

void	DeclareInput (Level &currentLevel) const
	Input.

Additional Inherited Members
Public Member Functions inherited from MueLu::SingleLevelFactoryBase
	SingleLevelFactoryBase ()
	Constructor.

virtual	~SingleLevelFactoryBase ()
	Destructor.

virtual void	CallBuild (Level &requestedLevel) const

virtual void	CallDeclareInput (Level &requestedLevel) const

Public Member Functions inherited from MueLu::Factory
	Factory ()
	Constructor.

virtual	~Factory ()
	Destructor.

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

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Default implementation of FactoryAcceptor::GetFactory()

RCP< ParameterList >	RemoveFactoriesFromList (const ParameterList &list) const

void	EnableMultipleCallCheck () const

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor.

virtual	~FactoryBase ()
	Destructor.

int	GetID () const
	return unique factory id

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

virtual std::string	description () const
	Return a simple one-line description of this object.

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.

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.

virtual const Teuchos::ParameterList &	GetParameterList () const

virtual const Teuchos::ParameterList &	GetParameterListWithoutValidation () const

void	SetParameter (const std::string &name, const ParameterEntry &entry)
	Set a parameter directly as a ParameterEntry.

const ParameterEntry &	GetParameter (const std::string &name) const
	Retrieves a const entry with the name name.

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

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 >
T	Get (Level &level, const std::string &varName) const

template<class T >
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

template<class T >
bool	IsType (Level &level, const std::string &varName) 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, class GlobalOrdinal, class Node>
class MueLu::HybridAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >

Factory for building aggregates on meshes partly structured and partly unstructured.

Factory for creating aggregates from partly structured grids. The hybrid aggregation method returns an aggregate structure used by prolongator factories.

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 HybridAggregationFactory

User parameters of HybridAggregationFactory

Parameter	type	default	master.xml	validated	requested	description
Graph	Factory	null		*	*	Generating factory for variable 'Graph'
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)
aggregationRegionType	Factory	null		*	*	Factory generating the type of aggregation to use on the region

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 HybridAggregationFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see HybridAggregationFactory::DeclareInput).

Variables provided by HybridAggregationFactory

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

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

Definition at line 96 of file MueLu_HybridAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ HybridAggregationFactory()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

Constructor.

Definition at line 47 of file MueLu_HybridAggregationFactory_def.hpp.

◆ ~HybridAggregationFactory()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

inlinevirtual

Destructor.

Definition at line 108 of file MueLu_HybridAggregationFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const ParameterList > MueLu::HybridAggregationFactory< 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.

Reimplemented from MueLu::Factory.

Definition at line 52 of file MueLu_HybridAggregationFactory_def.hpp.

◆ DeclareInput()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 120 of file MueLu_HybridAggregationFactory_def.hpp.

◆ Build()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 197 of file MueLu_HybridAggregationFactory_def.hpp.

◆ BuildInterfaceAggregates()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::HybridAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::BuildInterfaceAggregates	(	Level &	currentLevel,
		RCP< Aggregates >	aggregates,
		typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType &	aggStat,
		LO &	numNonAggregatedNodes,
		Array< LO >	coarseRate
	)		const

Specifically build aggregates along interfaces.

Definition at line 400 of file MueLu_HybridAggregationFactory_def.hpp.

Member Data Documentation

◆ algos_

template<class LocalOrdinal , class GlobalOrdinal , class Node >

std::vector<RCP<MueLu::AggregationAlgorithmBase<LO, GO, Node> > > MueLu::HybridAggregationFactory< LocalOrdinal, GlobalOrdinal, Node >::algos_

mutableprivate

aggregation algorithms

Definition at line 139 of file MueLu_HybridAggregationFactory_decl.hpp.

◆ bDefinitionPhase_

template<class LocalOrdinal , class GlobalOrdinal , class Node >

bool MueLu::HybridAggregationFactory< 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 144 of file MueLu_HybridAggregationFactory_decl.hpp.

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

Build methods.

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Input/output of HybridAggregationFactory

User parameters of HybridAggregationFactory

Variables provided by HybridAggregationFactory

Constructor & Destructor Documentation

◆ HybridAggregationFactory()

◆ ~HybridAggregationFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ BuildInterfaceAggregates()

Member Data Documentation

◆ algos_

◆ bDefinitionPhase_