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

#include <MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp>

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

Private Member Functions

void SetupInitHierarchy (Hierarchy &H) const
 
void AddInitFactoryManager (int startLevel, int numDesiredLevel, RCP< FactoryManagerBase > manager)
 internal routine to add a new factory manager used for the initialization phase More...
 
Teuchos::RCP< FactoryManagerBaseInitLvlMngr (int levelID, int lastLevelID) const
 

Private Attributes

int nullspaceDim_
 nullspace can be embedded in the ML parameter list More...
 
double * nullspace_
 
bool bExportAggregates_
 export aggregates More...
 
std::vector< RCP< FactoryBase > > TransferFacts_
 
Array< RCP< FactoryManagerBase > > init_levelManagers_
 

Constructors/Destructors.

 AdaptiveSaMLParameterListInterpreter ()
 Constructor. More...
 
 AdaptiveSaMLParameterListInterpreter (Teuchos::ParameterList &paramList, std::vector< RCP< FactoryBase > > factoryList=std::vector< RCP< FactoryBase > >(0))
 
 AdaptiveSaMLParameterListInterpreter (const std::string &xmlFileName, std::vector< RCP< FactoryBase > > factoryList=std::vector< RCP< FactoryBase > >(0))
 
virtual ~AdaptiveSaMLParameterListInterpreter ()
 Destructor. More...
 
void SetParameterList (const Teuchos::ParameterList &paramList)
 
virtual void SetupHierarchy (Hierarchy &H) const
 Setup Hierarchy object. More...
 

Handling of additional user-specific transfer factories

void AddTransferFactory (const RCP< FactoryBase > &factory)
 Add transfer factory in the end of list of transfer factories for RAPFactory. More...
 
size_t NumTransferFactories () const
 Returns number of transfer factories. More...
 
int blksize_
 Matrix configuration storage. More...
 
virtual void SetupOperator (Operator &Op) const
 

Additional Inherited Members

- Public Types inherited from MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef std::map< std::string, RCP< const FactoryBase > > FactoryMap
 
- Public Member Functions inherited from MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 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 ()
 
virtual RCP< HierarchyCreateHierarchy () const
 Create an empty Hierarchy object. More...
 
- 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...
 
- 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::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual void SetupExtra (Hierarchy &H) const
 Setup extra data. More...
 
Teuchos::RCP< FactoryManagerBaseLvlMngr (int levelID, int lastLevelID) const
 
- Protected Attributes inherited from MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >
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_
 
std::map< int, std::vector< keep_pair > > keep_
 

Detailed Description

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

Definition at line 74 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 84 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AdaptiveSaMLParameterListInterpreter ( Teuchos::ParameterList &  paramList,
std::vector< RCP< FactoryBase > >  factoryList = std::vector<RCP<FactoryBase> >(0) 
)

Constructor.

Parameters
paramListparameter list with ML parameters
nspVectorMultiVector with fine-level nullspace approximation
factoryListvector with RCP of FactoryBase objects

The factories in factoryList allow the user to add user-specific factories to the MueLu Hierarchy. The idea is to be able to add some factories that write out some debug information etc. which are not handled by the ML Parameter List itself. See information about the RAPFactory::AddTransferFactory method, too!

Definition at line 71 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AdaptiveSaMLParameterListInterpreter ( const std::string &  xmlFileName,
std::vector< RCP< FactoryBase > >  factoryList = std::vector<RCP<FactoryBase> >(0) 
)

Constructor.

Parameters
xmlFileNamefile name for XML file with ML parameters
factoryListvector with RCP of FactoryBase objects

The factories in factoryList allow the user to add user-specific factories to the MueLu Hierarchy. The idea is to be able to add some factories that write out some debug information etc. which are not handled by the ML Parameter List itself. See information about the RAPFactory::AddTransferFactory method, too!

Definition at line 76 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

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

Destructor.

Definition at line 106 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetParameterList ( const Teuchos::ParameterList &  paramList)
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupHierarchy ( Hierarchy H) const
virtual
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddTransferFactory ( const RCP< FactoryBase > &  factory)

Add transfer factory in the end of list of transfer factories for RAPFactory.

This allows the user to add user-specific factories to the MueLu Hierarchy. The idea is to be able to add some factories that write out some debug information etc. which are not handled by the ML Parameter List itself. See information about the RAPFactory::AddTransferFactory method, too!

Definition at line 434 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumTransferFactories ( ) const

Returns number of transfer factories.

Definition at line 441 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupInitHierarchy ( Hierarchy H) const
private

build multigrid hierarchy for improving nullspace use ML settings that are also used for the final full multigrid hierarchy. In contrary to the final multigrid hierarchy use only nonsmoothed transfer operators (safe time of prolongator smoothing) and cheap level smoothers (no direct solver on coarsest level).

Definition at line 329 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

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

internal routine to add a new factory manager used for the initialization phase

Definition at line 149 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

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

Used in SetupInitHierarchy() to access levelManagers_ Inputs i=-1 and i=size() are allowed to simplify calls to hierarchy->Setup()

Definition at line 160 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupOperator ( Operator &  Op) const
privatevirtual

Setup Operator object overloaded from HierarchyManager to set nDofsPerNode

Reimplemented from MueLu::HierarchyManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 446 of file MueLu_AdaptiveSaMLParameterListInterpreter_def.hpp.

Member Data Documentation

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

nullspace can be embedded in the ML parameter list

Definition at line 178 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
double* MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nullspace_
private
template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
bool MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bExportAggregates_
private

export aggregates

if set to true an AggregationExportFactory is used to export aggregation information (default = false)

Definition at line 182 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<RCP<FactoryBase> > MueLu::AdaptiveSaMLParameterListInterpreter< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TransferFacts_
private

list of user-defined transfer Factories We use this vector to add some special user-given factories to the Hierarchy (RAPFactory) This way the user can extend the standard functionality of the MLParameterListInterpreter beyond the capabibilities of ML.

Definition at line 188 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

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

list of levelManagers for adaptive smoothed aggregation initialization phase

Definition at line 192 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.

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

Matrix configuration storage.

Definition at line 201 of file MueLu_AdaptiveSaMLParameterListInterpreter_decl.hpp.


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