MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Class that encapsulates Ifpack2 smoothers. More...

#include <MueLu_Ifpack2Smoother_decl.hpp>

Inheritance diagram for MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Member Functions
void	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values. More...
RCP< Ifpack2::Preconditioner < Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getPreconditioner ()
	For diagnostic purposes. More...
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 ()
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 Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const
virtual const VerboseObject &	setOverridingVerbLevel (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 VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const
virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const
virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)
virtual RCP< FancyOStream >	getOStream () const
virtual RCP< FancyOStream >	getOverridingOStream () 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 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
virtual Teuchos::RCP< const Teuchos::ParameterList >	GetValidParameterList () const =0
	Return a const parameter list of valid parameters that setParameterList() will accept. More...

Private Member Functions
void	SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
void	SetupSchwarz (Level &currentLevel)
void	SetupChebyshev (Level &currentLevel)
void	SetupLineSmoothing (Level &currentLevel)
void	SetupBlockRelaxation (Level &currentLevel)
void	SetupTopological (Level &currentLevel)
void	SetupGeneric (Level &currentLevel)

Private Attributes
std::string	type_
	ifpack2-specific key phrase that denote smoother type More...
LO	overlap_
	overlap when using the smoother in additive Schwarz mode More...
RCP< Ifpack2::Preconditioner < Scalar, LocalOrdinal, GlobalOrdinal, Node > >	prec_
	pointer to Ifpack2 preconditioner object More...
RCP< Matrix >	A_
	matrix, used in apply if solving residual equation More...

Constructors / destructors
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
class	Ifpack2Smoother
	Constructor. More...
	Ifpack2Smoother (const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LO &overlap=0)
virtual	~Ifpack2Smoother ()
	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< SmootherPrototype >	Copy () 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...

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 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< FancyOStream >	getDefaultOStream ()
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 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::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Class that encapsulates Ifpack2 smoothers.

This class creates an Ifpack2 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 93 of file MueLu_Ifpack2Smoother_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Ifpack2Smoother	(	const std::string &	type,
		const Teuchos::ParameterList &	paramList = Teuchos::ParameterList(),
		const LO &	overlap = 0
	)

Definition at line 89 of file MueLu_Ifpack2Smoother_def.hpp.

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

inlinevirtual

Destructor.

Definition at line 146 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< 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 96 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level &  currentLevel ) const

virtual

Input.

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

Definition at line 119 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level &  currentLevel )

virtual

Set up the smoother.

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

TODO The eigenvalue estimate should come from A_, not the Ifpack2 parameter list.

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

Definition at line 167 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< 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

X	initial guess
B	right-hand side
InitialGuessIsZero	(optional) If false, some work can be avoided. Whether this actually saves any work depends on the underlying Ifpack2 implementation.

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

Definition at line 668 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const

virtual

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

Definition at line 733 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

std::string MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 740 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< 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 752 of file MueLu_Ifpack2Smoother_def.hpp.

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<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getPreconditioner ( )

inline

For diagnostic purposes.

Definition at line 212 of file MueLu_Ifpack2Smoother_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

size_t MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const

virtual

Get a rough estimate of cost per iteration.

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

Definition at line 779 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetPrecParameters ( const Teuchos::ParameterList &  list = Teuchos::ParameterList() ) const

private

Definition at line 107 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupSchwarz ( Level &  currentLevel )

private

Definition at line 227 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupChebyshev ( Level &  currentLevel )

private

Definition at line 542 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupLineSmoothing ( Level &  currentLevel )

private

Definition at line 419 of file MueLu_Ifpack2Smoother_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupBlockRelaxation ( Level &  currentLevel )

private

Definition at line 490 of file MueLu_Ifpack2Smoother_def.hpp.

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::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupTopological ( Level &  currentLevel )

private

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupGeneric ( Level &  currentLevel )

private

Definition at line 629 of file MueLu_Ifpack2Smoother_def.hpp.

Friends And Related Function Documentation

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 Ifpack2Smoother

friend

Constructor.

The options passed into Ifpack2Smoother are those given in the Ifpack2 user's manual.

Parameters

type	smoother type
list	options 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 Ifpack2::Relaxation, Ifpack2::Chebyshev, or Ifpack2::ILUT.

Definition at line 140 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Data Documentation

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::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_

private

ifpack2-specific key phrase that denote smoother type

Definition at line 230 of file MueLu_Ifpack2Smoother_decl.hpp.

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>

LO MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::overlap_

private

overlap when using the smoother in additive Schwarz mode

Definition at line 233 of file MueLu_Ifpack2Smoother_decl.hpp.

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<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::prec_

private

pointer to Ifpack2 preconditioner object

Definition at line 236 of file MueLu_Ifpack2Smoother_decl.hpp.

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::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_

private

matrix, used in apply if solving residual equation

Definition at line 239 of file MueLu_Ifpack2Smoother_decl.hpp.

---

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

• MueLu_Ifpack2Smoother_decl.hpp
• MueLu_Ifpack2Smoother_def.hpp