MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_TopRAPFactory_decl.hpp>

Inheritance diagram for MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::TwoLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

 TopRAPFactory (RCP< const FactoryManagerBase > parentFactoryManager)
 
 TopRAPFactory (RCP< const FactoryManagerBase > parentFactoryManagerFine, RCP< const FactoryManagerBase > parentFactoryManagerCoarse)
 
virtual ~TopRAPFactory ()
 
void DeclareInput (Level &fineLevel, Level &coarseLevel) const
 Input. More...
 
void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory. More...
 
- Public Member Functions inherited from MueLu::TwoLevelFactoryBase
 TwoLevelFactoryBase ()
 Constructor. More...
 
virtual ~TwoLevelFactoryBase ()
 Destructor. More...
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
virtual void CallBuild (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
virtual RCP< const ParameterListGetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
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< ParameterListRemoveFactoriesFromList (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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () 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 VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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 VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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 ParameterEntryGetParameter (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
 

Private Attributes

RCP< const FactoryBasePFact_
 
RCP< const FactoryBaseRFact_
 
RCP< const FactoryBaseAcFact_
 

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< FancyOStreamgetDefaultOStream ()
 
- 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 >
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
 
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 = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 35 of file MueLu_TopRAPFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TopRAPFactory ( RCP< const FactoryManagerBase parentFactoryManager)

Definition at line 29 of file MueLu_TopRAPFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TopRAPFactory ( RCP< const FactoryManagerBase parentFactoryManagerFine,
RCP< const FactoryManagerBase parentFactoryManagerCoarse 
)

Definition at line 35 of file MueLu_TopRAPFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~TopRAPFactory ( )
virtual

Definition at line 41 of file MueLu_TopRAPFactory_def.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level fineLevel,
Level coarseLevel 
) const
virtual

Input.

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

Definition at line 44 of file MueLu_TopRAPFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level fineLevel,
Level coarseLevel 
) const
virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 51 of file MueLu_TopRAPFactory_def.hpp.

Member Data Documentation

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
RCP<const FactoryBase> MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PFact_
private

Definition at line 50 of file MueLu_TopRAPFactory_decl.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
RCP<const FactoryBase> MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RFact_
private

Definition at line 51 of file MueLu_TopRAPFactory_decl.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
RCP<const FactoryBase> MueLu::TopRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AcFact_
private

Definition at line 52 of file MueLu_TopRAPFactory_decl.hpp.


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