MueLu  Version of the Day
MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

Base class for smoothers. More...

#include <MueLu_SmootherBase.hpp>

Inheritance diagram for MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SmootherPrototype< double, int, GlobalOrdinal, Node > MueLu::SmootherPrototype< double, int, int, Node > MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BelosSmoother< 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 > MueLu::TekoSmoother< double, int, GlobalOrdinal, Node > MueLu::AmesosSmoother< Node > MueLu::IfpackSmoother< Node > MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode > MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >

Public Types

typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Private Attributes

bool constructionSuccessful_
 
std::string constructionErrorMsg_
 
 SmootherBase ()
 
virtual ~SmootherBase ()
 

Apply methods.

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...
 
void declareConstructionOutcome (bool fail, std::string msg)
 
bool constructionSuccessful ()
 
std::string constructionErrorMsg ()
 

Additional Inherited Members

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

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Base class for smoothers.

This has the signature for the required Apply function and contains data that is generic across all smoothers.

Definition at line 68 of file MueLu_SmootherBase.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
typedef Scalar MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 70 of file MueLu_SmootherBase.hpp.

◆ local_ordinal_type

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
typedef LocalOrdinal MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 71 of file MueLu_SmootherBase.hpp.

◆ global_ordinal_type

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
typedef GlobalOrdinal MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 72 of file MueLu_SmootherBase.hpp.

◆ node_type

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
typedef Node MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 73 of file MueLu_SmootherBase.hpp.

Constructor & Destructor Documentation

◆ SmootherBase()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SmootherBase ( )
inline

Definition at line 82 of file MueLu_SmootherBase.hpp.

◆ ~SmootherBase()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~SmootherBase ( )
inlinevirtual

Definition at line 84 of file MueLu_SmootherBase.hpp.

Member Function Documentation

◆ Apply()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual void MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( MultiVector &  x,
const MultiVector &  rhs,
bool  InitialGuessIsZero = false 
) const
pure virtual

Apply smoother.

Implemented in MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::BlockedGaussSeidelSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IfpackSmoother< Node >, MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::AmesosSmoother< Node >, MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedDirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ getNodeSmootherComplexity()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual size_t MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
pure virtual

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.

Implemented in MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedGaussSeidelSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IfpackSmoother< Node >, MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::AmesosSmoother< Node >, MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedDirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ declareConstructionOutcome()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::declareConstructionOutcome ( bool  fail,
std::string  msg 
)
inline

Definition at line 96 of file MueLu_SmootherBase.hpp.

◆ constructionSuccessful()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
bool MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constructionSuccessful ( )
inline

Definition at line 103 of file MueLu_SmootherBase.hpp.

◆ constructionErrorMsg()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::string MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constructionErrorMsg ( )
inline

Definition at line 104 of file MueLu_SmootherBase.hpp.

Member Data Documentation

◆ constructionSuccessful_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
bool MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constructionSuccessful_
private

Definition at line 109 of file MueLu_SmootherBase.hpp.

◆ constructionErrorMsg_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::string MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constructionErrorMsg_
private

Definition at line 110 of file MueLu_SmootherBase.hpp.


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