MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::TekoSmoother< double, int, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_TekoSmoother_decl.hpp>

Inheritance diagram for MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >:
MueLu::SmootherPrototype< double, int, GlobalOrdinal, Node > MueLu::SmootherPrototype< double, int, GlobalOrdinal, Node > MueLu::SmootherBase< double, int, GlobalOrdinal, Node > MueLu::Factory MueLu::SmootherBase< double, int, GlobalOrdinal, Node > MueLu::Factory MueLu::ParameterListAcceptorImpl MueLu::FactoryAcceptor MueLu::FactoryBase MueLu::BaseClass MueLu::ParameterListAcceptorImpl MueLu::FactoryAcceptor MueLu::FactoryBase MueLu::BaseClass

Private Types

typedef int LocalOrdinal
typedef double Scalar
typedef Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, NodeMapExtractorClass

Overridden from Teuchos::Describable

std::string type_
 smoother type
RCP< Matrix > A_
 block operator
RCP< BlockedCrsMatrix > bA_
RCP< const Thyra::BlockedLinearOpBase< Scalar > > bThyOp_
RCP< ParameterList > tekoParams_
 Teko parameters.
Teko::LinearOp inverseOp_
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
 Get a rough estimate of cost per iteration.

Constructors / destructors

 TekoSmoother ()
 Constructor.
virtual ~TekoSmoother ()
 Destructor.
RCP< const ParameterList > GetValidParameterList () const
 Input.
void DeclareInput (Level &currentLevel) const
 Input.
void SetTekoParameters (RCP< ParameterList > tekoParams)

Setup and Apply methods.

void Setup (Level &currentLevel)
 Setup routine.
void Apply (MultiVector &X, const MultiVector &B, bool=false) const
 Apply the Teko smoother.
RCP< SmootherPrototypeCopy () const

Additional Inherited Members

Public Types inherited from MueLu::SmootherPrototype< double, int, GlobalOrdinal, Node >
typedef double scalar_type
typedef int local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type
Public Types inherited from MueLu::SmootherBase< double, int, GlobalOrdinal, Node >
typedef double scalar_type
typedef int local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type
Public Member Functions inherited from MueLu::SmootherPrototype< double, int, 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.
Public Member Functions inherited from MueLu::SmootherBase< double, int, GlobalOrdinal, Node >
 SmootherBase ()
virtual ~SmootherBase ()
void declareConstructionOutcome (bool fail, std::string msg)
bool constructionSuccessful ()
std::string constructionErrorMsg ()
virtual ~BaseClass ()
 Destructor.
 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
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
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
 ParameterListAcceptor ()
virtual ~ParameterListAcceptor ()=default
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
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 GlobalOrdinal, class Node>
class MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >

Definition at line 146 of file MueLu_TekoSmoother_decl.hpp.

Member Typedef Documentation

◆ LocalOrdinal

template<class GlobalOrdinal, class Node>
typedef int MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::LocalOrdinal
private

Definition at line 147 of file MueLu_TekoSmoother_decl.hpp.

◆ Scalar

template<class GlobalOrdinal, class Node>
typedef double MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Scalar
private

Definition at line 148 of file MueLu_TekoSmoother_decl.hpp.

◆ MapExtractorClass

template<class GlobalOrdinal, class Node>
typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::MapExtractorClass
private

Definition at line 149 of file MueLu_TekoSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ TekoSmoother()

template<class GlobalOrdinal, class Node>
MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::TekoSmoother ( )
inline

Constructor.

Definition at line 160 of file MueLu_TekoSmoother_decl.hpp.

◆ ~TekoSmoother()

template<class GlobalOrdinal, class Node>
virtual MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::~TekoSmoother ( )
inlinevirtual

Destructor.

Definition at line 169 of file MueLu_TekoSmoother_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class GlobalOrdinal, class Node>
RCP< const ParameterList > MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::GetValidParameterList ( ) const
inlinevirtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 174 of file MueLu_TekoSmoother_decl.hpp.

◆ DeclareInput()

template<class GlobalOrdinal, class Node>
void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel) const
inlinevirtual

◆ SetTekoParameters()

template<class GlobalOrdinal, class Node>
void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::SetTekoParameters ( RCP< ParameterList > tekoParams)
inline

Definition at line 187 of file MueLu_TekoSmoother_decl.hpp.

◆ Setup()

template<class GlobalOrdinal, class Node>
void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Setup ( Level & currentLevel)
inlinevirtual

◆ Apply()

template<class GlobalOrdinal, class Node>
void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Apply ( MultiVector & X,
const MultiVector & B,
bool = false ) const
inlinevirtual

Apply the Teko smoother.

Parameters
Xinitial guess
Bright-hand side
InitialGuessIsZeroThis option has no effect.

Implements MueLu::SmootherBase< double, int, GlobalOrdinal, Node >.

Definition at line 242 of file MueLu_TekoSmoother_decl.hpp.

◆ Copy()

template<class GlobalOrdinal, class Node>
RCP< SmootherPrototype > MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Copy ( ) const
inlinevirtual

◆ description()

template<class GlobalOrdinal, class Node>
std::string MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 294 of file MueLu_TekoSmoother_decl.hpp.

◆ print()

template<class GlobalOrdinal, class Node>
void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::print ( Teuchos::FancyOStream & out,
const VerbLevel verbLevel = Default ) const
inline

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

Definition at line 303 of file MueLu_TekoSmoother_decl.hpp.

◆ getNodeSmootherComplexity()

template<class GlobalOrdinal, class Node>
size_t MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
inlinevirtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< double, int, GlobalOrdinal, Node >.

Definition at line 314 of file MueLu_TekoSmoother_decl.hpp.

Member Data Documentation

◆ type_

template<class GlobalOrdinal, class Node>
std::string MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::type_
private

smoother type

Definition at line 323 of file MueLu_TekoSmoother_decl.hpp.

◆ A_

template<class GlobalOrdinal, class Node>
RCP<Matrix> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::A_
private

block operator

Definition at line 326 of file MueLu_TekoSmoother_decl.hpp.

◆ bA_

template<class GlobalOrdinal, class Node>
RCP<BlockedCrsMatrix> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::bA_
private

Definition at line 327 of file MueLu_TekoSmoother_decl.hpp.

◆ bThyOp_

template<class GlobalOrdinal, class Node>
RCP<const Thyra::BlockedLinearOpBase<Scalar> > MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::bThyOp_
private

Definition at line 328 of file MueLu_TekoSmoother_decl.hpp.

◆ tekoParams_

template<class GlobalOrdinal, class Node>
RCP<ParameterList> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::tekoParams_
private

Teko parameters.

Definition at line 331 of file MueLu_TekoSmoother_decl.hpp.

◆ inverseOp_

template<class GlobalOrdinal, class Node>
Teko::LinearOp MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::inverseOp_
private

Definition at line 333 of file MueLu_TekoSmoother_decl.hpp.


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