MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode > Class Template Reference

#include <MueLu_Ifpack2Smoother_decl.hpp>

Inheritance diagram for MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >:
MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode > MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Factory MueLu::BaseClass MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::VerboseObject MueLu::Describable MueLu::BaseClass MueLu::ParameterListAcceptor Teuchos::VerboseObject< VerboseObject > Teuchos::Describable MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

 Ifpack2Smoother (const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LocalOrdinal &overlap=0)
 
virtual ~Ifpack2Smoother ()
 
void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 
void Setup (Level &currentLevel)
 
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply smoother. More...
 
RCP< SmootherPrototypeCopy () const
 
std::string description () const
 Return a simple one-line description of this object. More...
 
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
 
size_t getNodeSmootherComplexity () const
 Get a rough estimate of cost per iteration. More...
 
- Public Member Functions inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
 SmootherPrototype ()
 /Destructors. More...
 
virtual ~SmootherPrototype ()
 
bool IsSetup () const
 Get the state of a smoother prototype. More...
 
void IsSetup (bool const &ToF)
 Set the state of a smoother prototype. More...
 
virtual void CallBuild (Level &) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 SmootherBase ()
 
virtual ~SmootherBase ()
 
void declareConstructionOutcome (bool fail, std::string msg)
 
bool constructionSuccessful ()
 
std::string constructionErrorMsg ()
 
- 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
 
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::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () 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::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase
GetFactory (const std::string &varName) const =0
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
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
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
GetValidParameterList () const =0
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

Private Types

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

Private Member Functions

void SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
 

Friends

template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
class Ifpack2Smoother
 

Additional Inherited Members

- Public Types inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
typedef double scalar_type
 
typedef int local_ordinal_type
 
typedef int global_ordinal_type
 
typedef Xpetra::EpetraNode node_type
 
- Public Types inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- 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 Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- 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
 

Detailed Description

template<>
class MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >

Definition at line 243 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Typedef Documentation

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

Definition at line 244 of file MueLu_Ifpack2Smoother_decl.hpp.

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

Definition at line 245 of file MueLu_Ifpack2Smoother_decl.hpp.

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

Definition at line 246 of file MueLu_Ifpack2Smoother_decl.hpp.

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

Definition at line 247 of file MueLu_Ifpack2Smoother_decl.hpp.

Constructor & Destructor Documentation

MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Ifpack2Smoother ( const std::string &  type,
const Teuchos::ParameterList paramList = Teuchos::ParameterList(),
const LocalOrdinal overlap = 0 
)
inline

Definition at line 258 of file MueLu_Ifpack2Smoother_decl.hpp.

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

Definition at line 262 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Function Documentation

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetParameterList ( const Teuchos::ParameterList paramList)
inlinevirtual

Set parameters from a parameter list and return with default values.

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 264 of file MueLu_Ifpack2Smoother_decl.hpp.

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::DeclareInput ( Level currentLevel) const
inlinevirtual
void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Setup ( Level currentLevel)
inlinevirtual
void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Apply ( MultiVector &  x,
const MultiVector &  rhs,
bool  InitialGuessIsZero = false 
) const
inlinevirtual
std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 270 of file MueLu_Ifpack2Smoother_decl.hpp.

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::print ( Teuchos::FancyOStream out,
const VerbLevel  verbLevel = Default 
) const
inline

Definition at line 271 of file MueLu_Ifpack2Smoother_decl.hpp.

size_t MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getNodeSmootherComplexity ( ) const
inlinevirtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 274 of file MueLu_Ifpack2Smoother_decl.hpp.

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetPrecParameters ( const Teuchos::ParameterList list = Teuchos::ParameterList()) const
inlineprivate

Definition at line 280 of file MueLu_Ifpack2Smoother_decl.hpp.

Friends And Related Function Documentation

template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
friend class Ifpack2Smoother
friend

Definition at line 255 of file MueLu_Ifpack2Smoother_decl.hpp.


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