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

Base class for smoother prototypes. More...

#include <MueLu_SmootherPrototype_decl.hpp>

Inheritance diagram for MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
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 MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BlockedDirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BlockedGaussSeidelSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Public Types

typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node 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
 

Private Attributes

bool isSetup_
 
 SmootherPrototype ()
 /Destructors. More...
 
virtual ~SmootherPrototype ()
 
virtual void DeclareInput (Level &currentLevel) const =0
 Input. More...
 

Build methods.

virtual void Setup (Level &)=0
 
virtual RCP< SmootherPrototypeCopy () const =0
 

Get/Set methods.

bool IsSetup () const
 Get the state of a smoother prototype. More...
 
void IsSetup (bool const &ToF)
 Set the state of a smoother prototype. More...
 

Implements FactoryBase interface

virtual void CallBuild (Level &) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 SmootherBase ()
 
virtual ~SmootherBase ()
 
virtual void Apply (MultiVector &x, const MultiVector &rhs, bool InitialGuessIsZero=false) const =0
 Apply smoother. More...
 
virtual size_t getNodeSmootherComplexity () const =0
 Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::OrdinalTraits<size_t>::invalid() if such an estimate cannot be computed. 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::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 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
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
GetValidParameterList () const =0
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
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 Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Base class for smoother prototypes.

A smoother prototype is a smoother which can be in two states:

  • ready to be duplicated (parameters defined)
  • ready to be used (setup phase completed)

'Smoother prototypes' can be fully copied using the Copy() method.

Definition at line 74 of file MueLu_SmootherPrototype_decl.hpp.

Member Typedef Documentation

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Scalar MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 79 of file MueLu_SmootherPrototype_decl.hpp.

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef LocalOrdinal MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 80 of file MueLu_SmootherPrototype_decl.hpp.

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef GlobalOrdinal MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 81 of file MueLu_SmootherPrototype_decl.hpp.

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Node MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 82 of file MueLu_SmootherPrototype_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SmootherPrototype ( )

/Destructors.

Definition at line 54 of file MueLu_SmootherPrototype_def.hpp.

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

Definition at line 57 of file MueLu_SmootherPrototype_def.hpp.

Member Function Documentation

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual void MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
pure virtual
template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual void MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level )
pure virtual
template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual RCP<SmootherPrototype> MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const
pure virtual
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::IsSetup ( ) const

Get the state of a smoother prototype.

Definition at line 60 of file MueLu_SmootherPrototype_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::IsSetup ( bool const &  ToF)

Set the state of a smoother prototype.

Definition at line 63 of file MueLu_SmootherPrototype_def.hpp.

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual void MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CallBuild ( Level ) const
inlinevirtual

Implements MueLu::FactoryBase.

Definition at line 128 of file MueLu_SmootherPrototype_decl.hpp.

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual void MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CallDeclareInput ( Level requestedLevel) const
inlinevirtual

Implements MueLu::FactoryBase.

Definition at line 133 of file MueLu_SmootherPrototype_decl.hpp.

Member Data Documentation

template<class Scalar = SmootherBase<>::scalar_type, class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
bool MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isSetup_
private

Definition at line 140 of file MueLu_SmootherPrototype_decl.hpp.


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