MueLu  Version of the Day
MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_MergedSmoother_decl.hpp>

Inheritance diagram for MueLu::MergedSmoother< 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

Public Member Functions

void DeclareInput (Level &currentLevel) const
 Input. More...
 
void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Custom SetFactory. More...
 
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
 
void CopyParameters (RCP< SmootherPrototype > src)
 
ArrayRCP< RCP< SmootherPrototype > > SmootherListDeepCopy (const ArrayRCP< const RCP< SmootherPrototype > > &srcSmootherList)
 
size_t getNodeSmootherComplexity () const
 Get a rough estimate of cost per iteration. More...
 
- Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 SmootherPrototype ()
 /Destructors. More...
 
virtual ~SmootherPrototype ()
 
bool IsSetup () const
 Get the state of a smoother prototype. More...
 
void IsSetup (bool const &ToF)
 Set the state of a smoother prototype. More...
 
virtual void CallBuild (Level &) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- 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. 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...
 
- Public Member Functions inherited from MueLu::Factory
virtual RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
 Factory ()
 Constructor. More...
 
virtual ~Factory ()
 Destructor. More...
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) 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 ()
 
- 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 ParameterEntry & GetParameter (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
 

Private Attributes

ArrayRCP< RCP< SmootherPrototype > > smootherList_
 
bool reverseOrder_
 
bool verbose_
 

Constructors / destructors

 MergedSmoother (ArrayRCP< RCP< SmootherPrototype > > &smootherList, bool verbose=false)
 Constructor. More...
 
 MergedSmoother (const MergedSmoother &src)
 Copy constructor (performs a deep copy of input object) More...
 
RCP< SmootherPrototypeCopy () const
 Copy method (performs a deep copy of input object) More...
 
virtual ~MergedSmoother ()
 Destructor. More...
 

Set/Get methods

void StandardOrder ()
 
void ReverseOrder ()
 
bool GetReverseOrder () const
 
const ArrayRCP< const RCP< SmootherPrototype > > GetSmootherList () const
 

Setup and Apply methods.

void Setup (Level &level)
 Set up. More...
 
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply. More...
 

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
 
- 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...
 
- 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::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 65 of file MueLu_MergedSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ MergedSmoother() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MergedSmoother::MergedSmoother ( ArrayRCP< RCP< SmootherPrototype > > &  smootherList,
bool  verbose = false 
)

Constructor.

Definition at line 55 of file MueLu_MergedSmoother_def.hpp.

◆ MergedSmoother() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MergedSmoother::MergedSmoother ( const MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  src)

Copy constructor (performs a deep copy of input object)

Definition at line 63 of file MueLu_MergedSmoother_def.hpp.

◆ ~MergedSmoother()

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::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MergedSmoother ( )
inlinevirtual

Destructor.

Definition at line 83 of file MueLu_MergedSmoother_decl.hpp.

Member Function Documentation

◆ Copy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MergedSmoother::Copy ( ) const
virtual

Copy method (performs a deep copy of input object)

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

Definition at line 196 of file MueLu_MergedSmoother_def.hpp.

◆ StandardOrder()

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>
void MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::StandardOrder ( )
inline

Definition at line 89 of file MueLu_MergedSmoother_decl.hpp.

◆ ReverseOrder()

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>
void MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReverseOrder ( )
inline

Definition at line 90 of file MueLu_MergedSmoother_decl.hpp.

◆ GetReverseOrder()

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>
bool MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetReverseOrder ( ) const
inline

Definition at line 93 of file MueLu_MergedSmoother_decl.hpp.

◆ GetSmootherList()

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>
const ArrayRCP<const RCP<SmootherPrototype> > MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetSmootherList ( ) const
inline

Definition at line 96 of file MueLu_MergedSmoother_decl.hpp.

◆ DeclareInput()

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

◆ Setup()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MergedSmoother::Setup ( Level level)
virtual

◆ Apply()

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

Apply.

Solves the linear system AX=B using the smoothers of the list.

Parameters
Xinitial guess
Bright-hand side
InitialGuessIsZero

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

Definition at line 103 of file MueLu_MergedSmoother_def.hpp.

◆ SetFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MergedSmoother::SetFactory ( const std::string &  varName,
const RCP< const FactoryBase > &  factory 
)
virtual

Custom SetFactory.

Reimplemented from MueLu::Factory.

Definition at line 70 of file MueLu_MergedSmoother_def.hpp.

◆ print()

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

Definition at line 126 of file MueLu_MergedSmoother_def.hpp.

◆ CopyParameters()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MergedSmoother::CopyParameters ( RCP< SmootherPrototype src)

Definition at line 131 of file MueLu_MergedSmoother_def.hpp.

◆ SmootherListDeepCopy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
ArrayRCP< RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > > MergedSmoother::SmootherListDeepCopy ( const ArrayRCP< const RCP< SmootherPrototype > > &  srcSmootherList)

Definition at line 204 of file MueLu_MergedSmoother_def.hpp.

◆ getNodeSmootherComplexity()

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

Get a rough estimate of cost per iteration.

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

Definition at line 217 of file MueLu_MergedSmoother_def.hpp.

Member Data Documentation

◆ smootherList_

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>
ArrayRCP<RCP<SmootherPrototype> > MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::smootherList_
private

Definition at line 138 of file MueLu_MergedSmoother_decl.hpp.

◆ reverseOrder_

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>
bool MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::reverseOrder_
private

Definition at line 141 of file MueLu_MergedSmoother_decl.hpp.

◆ verbose_

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>
bool MueLu::MergedSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::verbose_
private

Definition at line 144 of file MueLu_MergedSmoother_decl.hpp.


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