MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Class that encapsulates Belos smoothers. More...

#include <MueLu_BelosSmoother_decl.hpp>

Inheritance diagram for MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
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

Overridden from Teuchos::Describable

typedef Tpetra::MultiVector< SC, LO, GO, NO > tMV
 
typedef Tpetra::Operator< SC, LO, GO, NO > tOP
 
std::string type_
 
RCP< Belos::LinearProblem< Scalar, tMV, tOP > > tBelosProblem_
 
RCP< Belos::SolverManager< Scalar, tMV, tOP > > tSolver_
 
RCP< Matrix > A_
 matrix, used in apply if solving residual equation
 
std::string description () const
 Return a simple one-line description of this object.
 
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
 Print the object with some verbosity level to an FancyOStream object.
 
size_t getNodeSmootherComplexity () const
 For diagnostic purposes.
 
void SetupBelos (Level &currentLevel)
 

Constructors / destructors

template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
class BelosSmoother
 Constructor.
 
 BelosSmoother (const std::string type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
 
virtual ~BelosSmoother ()=default
 Destructor.
 
void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values.
 
void DeclareInput (Level &currentLevel) const
 Input.
 

Computational methods.

void Setup (Level &currentLevel)
 Set up the smoother.
 
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply the preconditioner.
 

Utilities

RCP< SmootherPrototypeCopy () const
 

Additional Inherited Members

- Public Types inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
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 inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 SmootherPrototype ()
 @nameConstructors/Destructors.
 
virtual ~SmootherPrototype ()
 
virtual void CallBuild (Level &) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
bool IsSetup () const
 Get the state of a smoother prototype.
 
void IsSetup (bool const &ToF)
 Set the state of a smoother prototype.
 
- 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.
 
- 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
 
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 FactoryBaseGetFactory (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 const Teuchos::ParameterList & GetParameterList () 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
 
- 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 >
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
 
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 = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Class that encapsulates Belos smoothers.

This class creates an Belos preconditioner factory. The factory creates a smoother based on the type and ParameterList passed into the constructor. See the constructor for more information.

Definition at line 91 of file MueLu_BelosSmoother_decl.hpp.

Member Typedef Documentation

◆ tMV

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Tpetra::MultiVector<SC, LO, GO, NO> MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tMV
private

Definition at line 187 of file MueLu_BelosSmoother_decl.hpp.

◆ tOP

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Tpetra::Operator<SC, LO, GO, NO> MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tOP
private

Definition at line 188 of file MueLu_BelosSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ BelosSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BelosSmoother ( const std::string type,
const Teuchos::ParameterList & paramList = Teuchos::ParameterList() )

Definition at line 76 of file MueLu_BelosSmoother_def.hpp.

◆ ~BelosSmoother()

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
virtual MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~BelosSmoother ( )
virtualdefault

Destructor.

Member Function Documentation

◆ SetParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetParameterList ( const Teuchos::ParameterList & paramList)
virtual

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

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 105 of file MueLu_BelosSmoother_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel) const
virtual

◆ Setup()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level & currentLevel)
virtual

Set up the smoother.

This creates the underlying Belos smoother object, copies any parameter list options supplied to the constructor to the Belos object, and computes the preconditioner.

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

Definition at line 117 of file MueLu_BelosSmoother_def.hpp.

◆ Apply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( MultiVector & X,
const MultiVector & B,
bool InitialGuessIsZero = false ) const
virtual

Apply the preconditioner.

Solves the linear system AX=B using the constructed smoother.

Parameters
Xinitial guess
Bright-hand side
InitialGuessIsZero(optional) If false, some work can be avoided. Whether this actually saves any work depends on the underlying Belos implementation.

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

Definition at line 148 of file MueLu_BelosSmoother_def.hpp.

◆ Copy()

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 192 of file MueLu_BelosSmoother_def.hpp.

◆ print()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print ( Teuchos::FancyOStream & out,
const VerbLevel verbLevel = Default ) const

Print the object with some verbosity level to an FancyOStream object.

Definition at line 207 of file MueLu_BelosSmoother_def.hpp.

◆ getNodeSmootherComplexity()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
virtual

For diagnostic purposes.

Get a rough estimate of cost per iteration

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

Definition at line 237 of file MueLu_BelosSmoother_def.hpp.

◆ SetupBelos()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupBelos ( Level & currentLevel)
private

Definition at line 128 of file MueLu_BelosSmoother_def.hpp.

Friends And Related Symbol Documentation

◆ BelosSmoother

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
friend class BelosSmoother
friend

Constructor.

The options passed into BelosSmoother are those given in the Belos user's manual.

Parameters
typesmoother type
listoptions for the particular smoother (e.g., fill factor or damping parameter)

Definition at line 112 of file MueLu_BelosSmoother_decl.hpp.

Member Data Documentation

◆ type_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
std::string MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_
private

Definition at line 184 of file MueLu_BelosSmoother_decl.hpp.

◆ tBelosProblem_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Belos::LinearProblem<Scalar, tMV, tOP> > MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tBelosProblem_
private

Definition at line 189 of file MueLu_BelosSmoother_decl.hpp.

◆ tSolver_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Belos::SolverManager<Scalar, tMV, tOP> > MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tSolver_
private

Definition at line 190 of file MueLu_BelosSmoother_decl.hpp.

◆ A_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Matrix> MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_
private

matrix, used in apply if solving residual equation

Definition at line 194 of file MueLu_BelosSmoother_decl.hpp.


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