MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode > Class Reference

#include <MueLu_Zoltan2Interface_decl.hpp>

Inheritance diagram for MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >:
MueLu::SingleLevelFactoryBase MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable MueLu::VerboseObject MueLu::Describable

Public Types

typedef Teuchos::ScalarTraits< Scalar >::magnitudeType real_type
typedef Xpetra::MultiVector< real_type, LO, GO, NO > RealValuedMultiVector

Public Member Functions

 Zoltan2Interface ()
virtual ~Zoltan2Interface ()
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput (Level &currentLevel) const
 Specifies the data that this class needs, and the factories that generate that data.
void Build (Level &currentLevel) const
 Build an object with this factory.
 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
virtual ~BaseClass ()
 Destructor.
 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
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
 ParameterListAcceptor ()
virtual ~ParameterListAcceptor ()=default

Private Types

typedef double Scalar
typedef int LocalOrdinal
typedef int GlobalOrdinal
typedef Xpetra::EpetraNode Node

Private Attributes

RCP< Level > level_
RCP< ZoltanInterface > zoltanInterface_

Build methods.

RCP< ParameterList > defaultZoltan2Params

Additional Inherited Members

Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
static void DisableTimerSync ()
static void EnableMultipleCheckGlobally ()
static void DisableMultipleCheckGlobally ()
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

Definition at line 121 of file MueLu_Zoltan2Interface_decl.hpp.

Member Typedef Documentation

◆ Scalar

typedef double MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::Scalar
private

Definition at line 122 of file MueLu_Zoltan2Interface_decl.hpp.

◆ LocalOrdinal

typedef int MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::LocalOrdinal
private

Definition at line 123 of file MueLu_Zoltan2Interface_decl.hpp.

◆ GlobalOrdinal

typedef int MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::GlobalOrdinal
private

Definition at line 124 of file MueLu_Zoltan2Interface_decl.hpp.

◆ Node

typedef Xpetra::EpetraNode MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::Node
private

Definition at line 125 of file MueLu_Zoltan2Interface_decl.hpp.

◆ real_type

typedef Teuchos::ScalarTraits<Scalar>::magnitudeType MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::real_type

Definition at line 129 of file MueLu_Zoltan2Interface_decl.hpp.

◆ RealValuedMultiVector

typedef Xpetra::MultiVector<real_type, LO, GO, NO> MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::RealValuedMultiVector

Definition at line 130 of file MueLu_Zoltan2Interface_decl.hpp.

Constructor & Destructor Documentation

◆ Zoltan2Interface()

MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::Zoltan2Interface ( )
inline

Definition at line 132 of file MueLu_Zoltan2Interface_decl.hpp.

◆ ~Zoltan2Interface()

virtual MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::~Zoltan2Interface ( )
inlinevirtual

Definition at line 138 of file MueLu_Zoltan2Interface_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

RCP< const ParameterList > MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::GetValidParameterList ( ) const
inlinevirtual

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 142 of file MueLu_Zoltan2Interface_decl.hpp.

◆ DeclareInput()

void MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::DeclareInput ( Level & currentLevel) const
inlinevirtual

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 152 of file MueLu_Zoltan2Interface_decl.hpp.

◆ Build()

void MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::Build ( Level & currentLevel) const
inlinevirtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 167 of file MueLu_Zoltan2Interface_decl.hpp.

Member Data Documentation

◆ level_

RCP<Level> MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::level_
private

Definition at line 186 of file MueLu_Zoltan2Interface_decl.hpp.

◆ zoltanInterface_

RCP<ZoltanInterface> MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::zoltanInterface_
private

Definition at line 187 of file MueLu_Zoltan2Interface_decl.hpp.

◆ defaultZoltan2Params

RCP<ParameterList> MueLu::Zoltan2Interface< double, int, int, Xpetra::EpetraNode >::defaultZoltan2Params
private

Definition at line 108 of file MueLu_Zoltan2Interface_decl.hpp.

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