Interface to Zoltan library.This interface provides access to partitioning methods in Zoltan. Currently, it supports the RCB algorithm only. More...

#include <MueLu_ZoltanInterface_decl.hpp>

Inheritance diagram for MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

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

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

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

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 Private Member Functions
static ArrayRCP< typename Teuchos::ScalarTraits< Scalar > ::magnitudeType >	coalesceCoordinates (ArrayRCP< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > coord, LocalOrdinal blksize)

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

virtual	~ZoltanInterface ()
	Destructor. More...

Input
void	DeclareInput (Level &level) const
	Specifies the data that this class needs, and the factories that generate that data. More...

Build methods.
void	Build (Level &level) const
	Build an object with this factory. More...

Query methods (really functions) required by Zoltan.
static int	GetLocalNumberOfRows (void data, int ierr)

static void	GetLocalNumberOfNonzeros (void data, int NumGidEntries, int NumLidEntries, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int wgtDim, float weights, int *ierr)

static int	GetProblemDimension (void data, int ierr)

static void	GetProblemGeometry (void data, int numGIDEntries, int numLIDEntries, int numObjectIDs, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int dim, double coordinates, int *ierr)

Additional Inherited Members
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...

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

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

Static Protected Attributes inherited from MueLu::Factory
static bool	timerSync_ = false

Detailed Description

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

Interface to Zoltan library.

This interface provides access to partitioning methods in Zoltan. Currently, it supports the RCB algorithm only.

Input/output of ZoltanInterface

User parameters of ZoltanInterface

Parameter	type	default	validated	requested	description
A	Factory	null	*	*	Generating factory of the matrix A used during the prolongator smoothing process
Coordinates	Factory	null	*	*	Factory generating coordinates vector used for rebalancing (RCB algorithm)
number of partitions	GO	-			Short-cut parameter set by RepartitionFactory. Avoid repartitioning algorithms if only one partition is necessary (see details below)

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

Variables provided by ZoltanInterface

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

Parameter	generated by	description
Partition	ZoltanInterface	GOVector based on the Row map of A (DOF-based) containing the process id the DOF should be living in after rebalancing/repartitioning

The "Partition" vector is used as input for the RepartitionFactory class. If Re-partitioning/rebalancing is necessary it uses the "Partition" variable to create the corresponding Xpetra::Import object which then is used by the RebalanceFactory classes (e.g., RebalanceAcFactory, RebalanceTransferFactory,...) to rebalance the coarse level operators.

The RepartitionHeuristicFactory calculates how many partitions are to be built when performing rebalancing. It stores the result in the "number of partitions" variable on the current level (type = GO). If it is "number of partitions=1" we skip the Zoltan call and just create an dummy "Partition" vector containing zeros only. If no repartitioning is necessary (i.e., just keep the current partitioning) we return "Partition = Teuchos::null". If "number of partitions" > 1, the algorithm tries to find the requested number of partitions.

Note: : The ZoltanInterface class does not have all the features availabe in the Zoltan2Interface class

Definition at line 77 of file MueLu_ZoltanInterface_decl.hpp.

Constructor & Destructor Documentation

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

MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ZoltanInterface ( )

inline

Constructor.

Definition at line 86 of file MueLu_ZoltanInterface_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 89 of file MueLu_ZoltanInterface_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const ParameterList > MueLu::ZoltanInterface< Scalar, 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 27 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Specifies the data that this class needs, and the factories that generate that data.

If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 38 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 45 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

int MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetLocalNumberOfRows	(	void *	data,
		int *	ierr
	)

static

Callback function that returns the local number of objects. Required by Zoltan.

In this case, the number of objects is the number of local rows.

Parameters

data	(in) void pointer to an Xpetra::Matrix.
ierr	(out) error code.

Definition at line 168 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetLocalNumberOfNonzeros	(	void *	data,
		int	NumGidEntries,
		int	NumLidEntries,
		ZOLTAN_ID_PTR	gids,
		ZOLTAN_ID_PTR	lids,
		int	wgtDim,
		float *	weights,
		int *	ierr
	)

static

Callback function that returns the local number of nonzeros in the matrix. Required by Zoltan.

FIXME: Note that this will not work properly for non-point matrices.

Parameters

data	(in) void pointer to an Xpetra::Matrix
weights	(out) array whose `i`^th entry is the number of nonzeros in local row `i`.
ierr	(out) error code

Definition at line 188 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

int MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetProblemDimension	(	void *	data,
		int *	ierr
	)

static

Callback function that returns the problem dimension. Required by Zoltan.

Parameters

data	(in) void pointer to integer dimension
ierr	(out) error code

Definition at line 232 of file MueLu_ZoltanInterface_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetProblemGeometry	(	void *	data,
		int	numGIDEntries,
		int	numLIDEntries,
		int	numObjectIDs,
		ZOLTAN_ID_PTR	gids,
		ZOLTAN_ID_PTR	lids,
		int	dim,
		double *	coordinates,
		int *	ierr
	)

static

Callback function that returns the problem dimension. Required by Zoltan.

Parameters

data	(in) void pointer to Xpetra::MultiVector.
coordinates	(out) array of double coordinates, arranged like so: [x1 y1 z1 x2 y2 z2 ...].
ierr	(out) error code

TODO – should I return a view of the coordinates instead of copying them?

Definition at line 245 of file MueLu_ZoltanInterface_def.hpp.

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

static ArrayRCP<typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::ZoltanInterface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::coalesceCoordinates	(	ArrayRCP< typename Teuchos::ScalarTraits< Scalar >::magnitudeType >	coord,
		LocalOrdinal	blksize
	)

staticprivate

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

Public Member Functions

Static Private Member Functions

Constructors/Destructors

Input

Build methods.

Query methods (really functions) required by Zoltan.

Additional Inherited Members

Detailed Description

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

Input/output of ZoltanInterface

User parameters of ZoltanInterface

Variables provided by ZoltanInterface

Constructor & Destructor Documentation

Member Function Documentation

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