MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode > Class Reference

#include <MueLu_Ifpack2Smoother_decl.hpp>

Inheritance diagram for MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >:

Public Member Functions
	Ifpack2Smoother (const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LocalOrdinal &overlap=0)
virtual	~Ifpack2Smoother ()
void	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values.
void	DeclareInput (Level &currentLevel) const
	Input.
void	Setup (Level &currentLevel)
void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply smoother.
RCP< SmootherPrototype >	Copy () const
std::string	description () const
	Return a simple one-line description of this object.
void	print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
size_t	getNodeSmootherComplexity () const
	Get a rough estimate of cost per iteration.
Public Member Functions inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
	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< double, int, int, Xpetra::EpetraNode >
	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 FactoryBase >	GetFactory (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
	ParameterListAcceptor ()
virtual	~ParameterListAcceptor ()=default

Private Types
typedef double	Scalar
typedef int	LocalOrdinal
typedef int	GlobalOrdinal
typedef Xpetra::EpetraNode	Node

Private Member Functions
void	SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const

Friends
template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
class	Ifpack2Smoother

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

Overridden from Teuchos::Describable
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.
RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > >	getPreconditioner ()
	For diagnostic purposes.
size_t	getNodeSmootherComplexity () const
	Get a rough estimate of cost per iteration.
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	SetupAggregate (Level &currentLevel)
void	SetupHiptmair (Level &currentLevel)
void	SetupGeneric (Level &currentLevel)
double	SetupChebyshevEigenvalues (Level &currentLevel, const std::string &matrixName, const std::string &label, Teuchos::ParameterList &paramList) const
bool	constructionSuccessful_
std::string	type_
	ifpack2-specific key phrase that denote smoother type
LO	overlap_
	overlap when using the smoother in additive Schwarz mode
RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > >	prec_
	pointer to Ifpack2 preconditioner object
RCP< Operator >	A_
	matrix, used in apply if solving residual equation

Additional Inherited Members
Public Types inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
typedef double	scalar_type
typedef int	local_ordinal_type
typedef int	global_ordinal_type
typedef Xpetra::EpetraNode	node_type
Public Types inherited from MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >
typedef double	scalar_type
typedef int	local_ordinal_type
typedef int	global_ordinal_type
typedef Xpetra::EpetraNode	node_type
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>
T	Get (Level &level, const std::string &varName) const
template<class T>
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

Definition at line 247 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Typedef Documentation

Scalar

typedef double MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Scalar

private

Definition at line 248 of file MueLu_Ifpack2Smoother_decl.hpp.

LocalOrdinal

typedef int MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::LocalOrdinal

private

Definition at line 249 of file MueLu_Ifpack2Smoother_decl.hpp.

GlobalOrdinal

typedef int MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::GlobalOrdinal

private

Definition at line 250 of file MueLu_Ifpack2Smoother_decl.hpp.

Node

typedef Xpetra::EpetraNode MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Node

private

Definition at line 251 of file MueLu_Ifpack2Smoother_decl.hpp.

Constructor & Destructor Documentation

Ifpack2Smoother() [1/2]

MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Ifpack2Smoother ( const std::string & type, const Teuchos::ParameterList & paramList = Teuchos::ParameterList(), const LocalOrdinal & overlap = 0 )

inline

Definition at line 262 of file MueLu_Ifpack2Smoother_decl.hpp.

~Ifpack2Smoother() [1/2]

virtual MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::~Ifpack2Smoother ( )

inlinevirtual

Definition at line 266 of file MueLu_Ifpack2Smoother_decl.hpp.

Ifpack2Smoother() [2/2]

MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Ifpack2Smoother	(	const std::string &	type,
		const Teuchos::ParameterList &	paramList = Teuchos::ParameterList(),
		const LO &	overlap = 0 )

Definition at line 144 of file MueLu_Ifpack2Smoother_def.hpp.

~Ifpack2Smoother() [2/2]

virtual MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::~Ifpack2Smoother ( )

inlinevirtual

Destructor.

Definition at line 147 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Function Documentation

SetParameterList() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetParameterList ( const Teuchos::ParameterList & paramList )

inlinevirtual

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

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 268 of file MueLu_Ifpack2Smoother_decl.hpp.

DeclareInput() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::DeclareInput ( Level & currentLevel ) const

inlinevirtual

Input.

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 269 of file MueLu_Ifpack2Smoother_decl.hpp.

Setup() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Setup ( Level & currentLevel )

inlinevirtual

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 270 of file MueLu_Ifpack2Smoother_decl.hpp.

Apply() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Apply ( MultiVector & x, const MultiVector & rhs, bool InitialGuessIsZero = false ) const

inlinevirtual

Apply smoother.

Implements MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >.

Definition at line 271 of file MueLu_Ifpack2Smoother_decl.hpp.

Copy() [1/2]

RCP< SmootherPrototype > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Copy ( ) const

inlinevirtual

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 272 of file MueLu_Ifpack2Smoother_decl.hpp.

description() [1/2]

std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 274 of file MueLu_Ifpack2Smoother_decl.hpp.

print() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::print ( Teuchos::FancyOStream & out, const VerbLevel verbLevel = Default ) const

inline

Definition at line 275 of file MueLu_Ifpack2Smoother_decl.hpp.

getNodeSmootherComplexity() [1/2]

size_t MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getNodeSmootherComplexity ( ) const

inlinevirtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >.

Definition at line 278 of file MueLu_Ifpack2Smoother_decl.hpp.

SetPrecParameters() [1/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetPrecParameters ( const Teuchos::ParameterList & list = Teuchos::ParameterList() ) const

inlineprivate

Definition at line 281 of file MueLu_Ifpack2Smoother_decl.hpp.

SetParameterList() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetParameterList ( const Teuchos::ParameterList & paramList )

virtual

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

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 151 of file MueLu_Ifpack2Smoother_def.hpp.

DeclareInput() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 156 of file MueLu_Ifpack2Smoother_def.hpp.

Setup() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::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< double, int, int, Xpetra::EpetraNode >.

Definition at line 170 of file MueLu_Ifpack2Smoother_def.hpp.

Apply() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::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< double, int, int, Xpetra::EpetraNode >.

Definition at line 180 of file MueLu_Ifpack2Smoother_def.hpp.

Copy() [2/2]

RCP< MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode > > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Copy ( ) const

virtual

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 187 of file MueLu_Ifpack2Smoother_def.hpp.

description() [2/2]

std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::description ( ) const

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 195 of file MueLu_Ifpack2Smoother_def.hpp.

print() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::print	(	Teuchos::FancyOStream &	out,
		const VerbLevel	verbLevel = Default ) const

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

Definition at line 200 of file MueLu_Ifpack2Smoother_def.hpp.

getPreconditioner()

RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getPreconditioner ( )

inline

For diagnostic purposes.

Definition at line 205 of file MueLu_Ifpack2Smoother_decl.hpp.

getNodeSmootherComplexity() [2/2]

size_t MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getNodeSmootherComplexity ( ) const

virtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >.

Definition at line 208 of file MueLu_Ifpack2Smoother_def.hpp.

SetPrecParameters() [2/2]

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetPrecParameters ( const Teuchos::ParameterList & list = Teuchos::ParameterList() ) const

private

Definition at line 211 of file MueLu_Ifpack2Smoother_def.hpp.

SetupSchwarz()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupSchwarz ( Level & currentLevel )

private

Definition at line 213 of file MueLu_Ifpack2Smoother_def.hpp.

SetupChebyshev()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupChebyshev ( Level & currentLevel )

private

Definition at line 214 of file MueLu_Ifpack2Smoother_def.hpp.

SetupLineSmoothing()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupLineSmoothing ( Level & currentLevel )

private

Definition at line 215 of file MueLu_Ifpack2Smoother_def.hpp.

SetupBlockRelaxation()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupBlockRelaxation ( Level & currentLevel )

private

Definition at line 216 of file MueLu_Ifpack2Smoother_def.hpp.

SetupTopological()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupTopological ( Level & currentLevel )

private

SetupAggregate()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupAggregate ( Level & currentLevel )

private

Definition at line 218 of file MueLu_Ifpack2Smoother_def.hpp.

SetupHiptmair()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupHiptmair ( Level & currentLevel )

private

Definition at line 219 of file MueLu_Ifpack2Smoother_def.hpp.

SetupGeneric()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupGeneric ( Level & currentLevel )

private

Definition at line 220 of file MueLu_Ifpack2Smoother_def.hpp.

SetupChebyshevEigenvalues()

double MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupChebyshevEigenvalues ( Level & currentLevel, const std::string & matrixName, const std::string & label, Teuchos::ParameterList & paramList ) const

private

Definition at line 221 of file MueLu_Ifpack2Smoother_def.hpp.

Friends And Related Symbol Documentation

Ifpack2Smoother [1/2]

template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>

friend class Ifpack2Smoother

friend

Definition at line 259 of file MueLu_Ifpack2Smoother_decl.hpp.

Ifpack2Smoother [2/2]

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 141 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Data Documentation

constructionSuccessful_

bool MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::constructionSuccessful_

private

Definition at line 225 of file MueLu_Ifpack2Smoother_decl.hpp.

type_

std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::type_

private

ifpack2-specific key phrase that denote smoother type

Definition at line 228 of file MueLu_Ifpack2Smoother_decl.hpp.

overlap_

LO MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::overlap_

private

overlap when using the smoother in additive Schwarz mode

Definition at line 231 of file MueLu_Ifpack2Smoother_decl.hpp.

prec_

RCP<Ifpack2::Preconditioner<double,int,int,Xpetra::EpetraNode> > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::prec_

private

pointer to Ifpack2 preconditioner object

Definition at line 234 of file MueLu_Ifpack2Smoother_decl.hpp.

A_

RCP<Operator> MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::A_

private

matrix, used in apply if solving residual equation

Definition at line 237 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