MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::IfpackSmoother< Node > Class Template Reference

Class that encapsulates Ifpack smoothers. More...

#include <MueLu_IfpackSmoother.hpp>

Inheritance diagram for MueLu::IfpackSmoother< Node >:
MueLu::SmootherPrototype< double, int, int, 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 Teuchos::VerboseObject< VerboseObject > Teuchos::Describable MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values. More...
 
- Public Member Functions inherited from MueLu::SmootherPrototype< double, int, int, 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- 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
 
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 Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () 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 ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase
GetFactory (const std::string &varName) const =0
 
- 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. More...
 
const ParameterEntryGetParameter (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
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
GetValidParameterList () const =0
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

Private Types

typedef double Scalar
 
typedef int LocalOrdinal
 
typedef int GlobalOrdinal
 

Private Member Functions

void SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
 

Private Attributes

std::string type_
 ifpack-specific key phrase that denote smoother type More...
 
LO overlap_
 overlap when using the smoother in additive Schwarz mode More...
 
RCP< Matrix > A_
 Matrix. Not used directly, but held inside of prec_. So we have to keep an RCP pointer to it! More...
 
RCP< Ifpack_Preconditionerprec_
 pointer to Ifpack solver object More...
 

Constructors / destructors

 IfpackSmoother (std::string const &type, Teuchos::ParameterList const &paramList=Teuchos::ParameterList(), LO const &overlap=0)
 Constructor. More...
 
virtual ~IfpackSmoother ()
 Destructor. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 

Computational methods.

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

Utilities

RCP< SmootherPrototypeCopy () const
 

Overridden from Teuchos::Describable

std::string description () const
 Return a simple one-line description of this object. More...
 
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
 Print the object with some verbosity level to an FancyOStream object. More...
 
size_t getNodeSmootherComplexity () const
 Get a rough estimate of cost per iteration. More...
 

Additional Inherited Members

- Public Types inherited from MueLu::SmootherPrototype< double, int, int, Node >
typedef double scalar_type
 
typedef int local_ordinal_type
 
typedef int 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 Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
class MueLu::IfpackSmoother< Node >

Class that encapsulates Ifpack smoothers.

This class creates an Ifpack 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 76 of file MueLu_IfpackSmoother.hpp.

Member Typedef Documentation

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
typedef double MueLu::IfpackSmoother< Node >::Scalar
private

Definition at line 77 of file MueLu_IfpackSmoother.hpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
typedef int MueLu::IfpackSmoother< Node >::LocalOrdinal
private

Definition at line 78 of file MueLu_IfpackSmoother.hpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
typedef int MueLu::IfpackSmoother< Node >::GlobalOrdinal
private

Definition at line 79 of file MueLu_IfpackSmoother.hpp.

Constructor & Destructor Documentation

template<class Node >
MueLu::IfpackSmoother< Node >::IfpackSmoother ( std::string const &  type,
Teuchos::ParameterList const &  paramList = Teuchos::ParameterList(),
LO const &  overlap = 0 
)

Constructor.

The options passed into IfpackSmoother are those given in the Ifpack user's manual.

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

Here is how to select some of the most common smoothers.

  • Gauss-Seidel
  • type = point relaxation stand-alone
  • parameter list options
  • relaxation: type = Gauss-Seidel
  • relaxation: damping factor
  • symmetric Gauss-Seidel
  • type = point relaxation stand-alone
  • parameter list options
  • relaxation: type = symmetric Gauss-Seidel
  • relaxation: damping factor
  • Chebyshev
  • type = Chebyshev
  • parameter list options
  • chebyshev: ratio eigenvalue
  • chebyshev: min eigenvalue
  • chebyshev: max eigenvalue
  • chebyshev: degree
  • chebyshev: zero starting solution (defaults to true)
  • ILU
  • type = ILU
  • parameter list options
  • fact: level-of-fill

See also Ifpack_PointRelaxation, Ifpack_Chebyshev, Ifpack_ILU.

Definition at line 62 of file MueLu_IfpackSmoother.cpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
virtual MueLu::IfpackSmoother< Node >::~IfpackSmoother ( )
inlinevirtual

Destructor.

Definition at line 125 of file MueLu_IfpackSmoother.hpp.

Member Function Documentation

template<class Node >
void MueLu::IfpackSmoother< 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 70 of file MueLu_IfpackSmoother.cpp.

template<class Node >
void MueLu::IfpackSmoother< Node >::DeclareInput ( Level currentLevel) const
virtual
template<class Node >
void MueLu::IfpackSmoother< Node >::Setup ( Level currentLevel)
virtual

Set up the smoother.

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

Implements MueLu::SmootherPrototype< double, int, int, Node >.

Definition at line 129 of file MueLu_IfpackSmoother.cpp.

template<class Node >
void MueLu::IfpackSmoother< 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 Ifpack implementation.

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

Definition at line 269 of file MueLu_IfpackSmoother.cpp.

template<class Node >
RCP< MueLu::SmootherPrototype< double, int, int, Node > > MueLu::IfpackSmoother< Node >::Copy ( ) const
virtual
template<class Node >
std::string MueLu::IfpackSmoother< Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 314 of file MueLu_IfpackSmoother.cpp.

template<class Node >
void MueLu::IfpackSmoother< Node >::print ( Teuchos::FancyOStream out,
const VerbLevel  verbLevel = Default 
) const

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

Definition at line 328 of file MueLu_IfpackSmoother.cpp.

template<class Node >
size_t MueLu::IfpackSmoother< Node >::getNodeSmootherComplexity ( ) const
virtual

Get a rough estimate of cost per iteration.

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

Definition at line 356 of file MueLu_IfpackSmoother.cpp.

template<class Node >
void MueLu::IfpackSmoother< Node >::SetPrecParameters ( const Teuchos::ParameterList list = Teuchos::ParameterList()) const
private

Definition at line 81 of file MueLu_IfpackSmoother.cpp.

Member Data Documentation

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
std::string MueLu::IfpackSmoother< Node >::type_
private

ifpack-specific key phrase that denote smoother type

Definition at line 189 of file MueLu_IfpackSmoother.hpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
LO MueLu::IfpackSmoother< Node >::overlap_
private

overlap when using the smoother in additive Schwarz mode

Definition at line 192 of file MueLu_IfpackSmoother.hpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
RCP<Matrix> MueLu::IfpackSmoother< Node >::A_
private

Matrix. Not used directly, but held inside of prec_. So we have to keep an RCP pointer to it!

Definition at line 195 of file MueLu_IfpackSmoother.hpp.

template<class Node = typename SmootherPrototype<double,int,int>::node_type>
RCP<Ifpack_Preconditioner> MueLu::IfpackSmoother< Node >::prec_
private

pointer to Ifpack solver object

Definition at line 199 of file MueLu_IfpackSmoother.hpp.


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