MueLu Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
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 MueLu::VerboseObject MueLu::Describable MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::AmesosSmoother< 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::IfpackSmoother< 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::RefMaxwellSmoother< 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
 

Public Member Functions

 SmootherPrototype ()
 @nameConstructors/Destructors.
 
virtual ~SmootherPrototype ()
 
virtual void DeclareInput (Level &currentLevel) const =0
 Input.
 
- 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.
 
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.
 
void declareConstructionOutcome (bool fail, std::string msg)
 
bool constructionSuccessful ()
 
std::string constructionErrorMsg ()
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor.
 
VerbLevel GetVerbLevel () const
 Get the verbosity level.
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object.
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose.
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing.
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type.
 
Teuchos::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type.
 
Teuchos::FancyOStream & GetBlackHole () const
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor.
 
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.
 
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.
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace.
 
- Public Member Functions inherited from MueLu::Factory
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration.
 
const RCP< const FactoryBase > GetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory()
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
virtual RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- 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.
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
virtual const Teuchos::ParameterList & GetParameterListWithoutValidation () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry.
 
const ParameterEntry & GetParameter (const std::string &name) const
 Retrieves a const entry with the name name.
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 

Implements FactoryBase interface

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

Build methods.

virtual void Setup (Level &)=0
 
virtual RCP< SmootherPrototype > Copy () const =0
 

Get/Set methods.

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

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level.
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level.
 
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetMueLuOStream ()
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- 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 >
T Get (Level &level, const std::string &varName) const
 
template<class T >
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
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

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 38 of file MueLu_SmootherPrototype_decl.hpp.

Member Typedef Documentation

◆ scalar_type

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 41 of file MueLu_SmootherPrototype_decl.hpp.

◆ local_ordinal_type

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 42 of file MueLu_SmootherPrototype_decl.hpp.

◆ global_ordinal_type

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 43 of file MueLu_SmootherPrototype_decl.hpp.

◆ node_type

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 44 of file MueLu_SmootherPrototype_decl.hpp.

Constructor & Destructor Documentation

◆ SmootherPrototype()

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

@nameConstructors/Destructors.

Definition at line 18 of file MueLu_SmootherPrototype_def.hpp.

◆ ~SmootherPrototype()

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

Definition at line 22 of file MueLu_SmootherPrototype_def.hpp.

Member Function Documentation

◆ DeclareInput()

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

Input.

Implemented in MueLu::MatlabSmoother< 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::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >, MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::AmesosSmoother< Node >, MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::IfpackSmoother< Node >, MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ Setup()

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

Implemented in MueLu::MatlabSmoother< 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::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >, MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::AmesosSmoother< Node >, MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::IfpackSmoother< Node >, MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ Copy()

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

Implemented in MueLu::MatlabSmoother< 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::IndefBlockedDiagonalSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SimpleSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >, MueLu::UzawaSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::AmesosSmoother< Node >, MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >, MueLu::DirectSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >, MueLu::IfpackSmoother< Node >, MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ProjectorSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::TrilinosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

◆ IsSetup() [1/2]

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 25 of file MueLu_SmootherPrototype_def.hpp.

◆ IsSetup() [2/2]

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 28 of file MueLu_SmootherPrototype_def.hpp.

◆ CallBuild()

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 90 of file MueLu_SmootherPrototype_decl.hpp.

◆ CallDeclareInput()

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 95 of file MueLu_SmootherPrototype_decl.hpp.

Member Data Documentation

◆ isSetup_

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 102 of file MueLu_SmootherPrototype_decl.hpp.

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