MueLu  Version of the Day
MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <MueLu_Zoltan2Interface_decl.hpp>

Inheritance diagram for MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

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 FactoryBaseGetFactory (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 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 MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()
 
virtual void SetParameterList (const 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 ()
 

Private Attributes

RCP< ParameterList > defaultZoltan2Params
 

Constructors/Destructors

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

Input

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

Build methods.

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

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- 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 >
Get (Level &level, const std::string &varName) const
 
template<class 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
 
bool IsAvailable (Level &level, const std::string &varName) const
 

Detailed Description

template<class Scalar, class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Interface to Zoltan2 library.

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

Input/output of Zoltan2Interface

User parameters of Zoltan2Interface

Parameter type default master.xml 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)
rowWeight int 0 * Default weight to rows (total weight = nnz + rowWeight")
ParameterList ParamterList null * Zoltan2 parameters
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 Zoltan2Interface::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see Zoltan2Interface::DeclareInput).

Variables provided by Zoltan2Interface

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

Parameter generated by description
Partition Zoltan2Interface 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 Zoltan2 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.

Definition at line 118 of file MueLu_Zoltan2Interface_decl.hpp.

Constructor & Destructor Documentation

◆ Zoltan2Interface()

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

Constructor.

Definition at line 70 of file MueLu_Zoltan2Interface_def.hpp.

◆ ~Zoltan2Interface()

template<class Scalar , class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Zoltan2Interface ( )
inlinevirtual

Destructor.

Definition at line 131 of file MueLu_Zoltan2Interface_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::Zoltan2Interface< 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 77 of file MueLu_Zoltan2Interface_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Zoltan2Interface< 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 92 of file MueLu_Zoltan2Interface_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 99 of file MueLu_Zoltan2Interface_def.hpp.

Member Data Documentation

◆ defaultZoltan2Params

template<class Scalar , class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<ParameterList> MueLu::Zoltan2Interface< Scalar, LocalOrdinal, GlobalOrdinal, Node >::defaultZoltan2Params
private

Definition at line 148 of file MueLu_Zoltan2Interface_decl.hpp.


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