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

#include <MueLu_HierarchyManager.hpp>

Inheritance diagram for MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::HierarchyFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::MLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::ParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef std::map< std::string, RCP< const FactoryBase > > FactoryMap
 

Public Member Functions

 HierarchyManager (int numDesiredLevel=MasterList::getDefault< int >("max levels"))
 
virtual ~HierarchyManager ()
 
void AddFactoryManager (int startLevel, int numDesiredLevel, RCP< FactoryManagerBase > manager)
 
RCP< FactoryManagerBaseGetFactoryManager (int levelID) const
 
size_t getNumFactoryManagers () const
 returns number of factory managers stored in levelManagers_ vector. More...
 
void CheckConfig ()
 
- Public Member Functions inherited from MueLu::HierarchyFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual ~HierarchyFactory ()
 Destructor. 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...
 

Protected Member Functions

virtual void SetupOperator (Operator &Op) const
 Setup Matrix object. More...
 
virtual void SetupExtra (Hierarchy &H) const
 Setup extra data. More...
 
Teuchos::RCP< FactoryManagerBaseLvlMngr (int levelID, int lastLevelID) const
 

Protected Attributes

int numDesiredLevel_
 
Xpetra::global_size_t maxCoarseSize_
 
MsgType verbosity_
 
bool doPRrebalance_
 
bool implicitTranspose_
 
int graphOutputLevel_
 
Teuchos::Array< int > matricesToPrint_
 
Teuchos::Array< int > prolongatorsToPrint_
 
Teuchos::Array< int > restrictorsToPrint_
 
Teuchos::Array< int > nullspaceToPrint_
 
Teuchos::Array< int > coordinatesToPrint_
 
std::map< int, std::vector< keep_pair > > keep_
 

Private Types

typedef std::pair< std::string, const FactoryBase * > keep_pair
 

Private Member Functions

template<class T >
void WriteData (Hierarchy &H, const Teuchos::Array< int > &data, const std::string &name) const
 

Private Attributes

Array< RCP< FactoryManagerBase > > levelManagers_
 
virtual RCP< HierarchyCreateHierarchy () const
 Create an empty Hierarchy object. More...
 
virtual void SetupHierarchy (Hierarchy &H) const
 Setup Hierarchy object. More...
 

Additional Inherited Members

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

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 73 of file MueLu_HierarchyManager.hpp.

Member Typedef Documentation

◆ keep_pair

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef std::pair<std::string, const FactoryBase*> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::keep_pair
private

Definition at line 76 of file MueLu_HierarchyManager.hpp.

◆ FactoryMap

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef std::map<std::string, RCP<const FactoryBase> > MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryMap

Definition at line 228 of file MueLu_HierarchyManager.hpp.

Constructor & Destructor Documentation

◆ HierarchyManager()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::HierarchyManager ( int  numDesiredLevel = MasterList::getDefault<int>("max levels"))
inline

Definition at line 81 of file MueLu_HierarchyManager.hpp.

◆ ~HierarchyManager()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~HierarchyManager ( )
inlinevirtual

Definition at line 90 of file MueLu_HierarchyManager.hpp.

Member Function Documentation

◆ AddFactoryManager()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager ( int  startLevel,
int  numDesiredLevel,
RCP< FactoryManagerBase manager 
)
inline

Definition at line 93 of file MueLu_HierarchyManager.hpp.

◆ GetFactoryManager()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<FactoryManagerBase> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetFactoryManager ( int  levelID) const
inline

Definition at line 103 of file MueLu_HierarchyManager.hpp.

◆ getNumFactoryManagers()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
size_t MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumFactoryManagers ( ) const
inline

returns number of factory managers stored in levelManagers_ vector.

Definition at line 109 of file MueLu_HierarchyManager.hpp.

◆ CheckConfig()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CheckConfig ( )
inline

Definition at line 114 of file MueLu_HierarchyManager.hpp.

◆ CreateHierarchy()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual RCP<Hierarchy> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CreateHierarchy ( ) const
inlinevirtual

◆ SetupHierarchy()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupHierarchy ( Hierarchy H) const
inlinevirtual

◆ SetupOperator()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupOperator ( Operator &  Op) const
inlineprotectedvirtual

◆ SetupExtra()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupExtra ( Hierarchy H) const
inlineprotectedvirtual

Setup extra data.

Definition at line 237 of file MueLu_HierarchyManager.hpp.

◆ LvlMngr()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP<FactoryManagerBase> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::LvlMngr ( int  levelID,
int  lastLevelID 
) const
inlineprotected

Definition at line 242 of file MueLu_HierarchyManager.hpp.

◆ WriteData()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
template<class T >
void MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteData ( Hierarchy H,
const Teuchos::Array< int > &  data,
const std::string &  name 
) const
inlineprivate

Definition at line 277 of file MueLu_HierarchyManager.hpp.

Member Data Documentation

◆ numDesiredLevel_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numDesiredLevel_
mutableprotected

Definition at line 260 of file MueLu_HierarchyManager.hpp.

◆ maxCoarseSize_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Xpetra::global_size_t MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::maxCoarseSize_
protected

Definition at line 261 of file MueLu_HierarchyManager.hpp.

◆ verbosity_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MsgType MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::verbosity_
protected

Definition at line 262 of file MueLu_HierarchyManager.hpp.

◆ doPRrebalance_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
bool MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::doPRrebalance_
protected

Definition at line 263 of file MueLu_HierarchyManager.hpp.

◆ implicitTranspose_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
bool MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::implicitTranspose_
protected

Definition at line 264 of file MueLu_HierarchyManager.hpp.

◆ graphOutputLevel_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::graphOutputLevel_
protected

Definition at line 265 of file MueLu_HierarchyManager.hpp.

◆ matricesToPrint_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::Array<int> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::matricesToPrint_
protected

Definition at line 266 of file MueLu_HierarchyManager.hpp.

◆ prolongatorsToPrint_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::Array<int> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::prolongatorsToPrint_
protected

Definition at line 267 of file MueLu_HierarchyManager.hpp.

◆ restrictorsToPrint_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::Array<int> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::restrictorsToPrint_
protected

Definition at line 268 of file MueLu_HierarchyManager.hpp.

◆ nullspaceToPrint_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::Array<int> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nullspaceToPrint_
protected

Definition at line 269 of file MueLu_HierarchyManager.hpp.

◆ coordinatesToPrint_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::Array<int> MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::coordinatesToPrint_
protected

Definition at line 270 of file MueLu_HierarchyManager.hpp.

◆ keep_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::map<int, std::vector<keep_pair> > MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::keep_
protected

Definition at line 272 of file MueLu_HierarchyManager.hpp.

◆ levelManagers_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Array<RCP<FactoryManagerBase> > MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::levelManagers_
private

Definition at line 294 of file MueLu_HierarchyManager.hpp.


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