Class that encapsulates Ifpack2 smoothers. More...

#include <MueLu_Ifpack2Smoother_decl.hpp>

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

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	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values. More...

void	DeclareInput (Level &currentLevel) const
	Input. More...

Overridden from Teuchos::Describable
bool	constructionSuccessful_

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...

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...

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...

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)

Scalar	SetupChebyshevEigenvalues (Level &currentLevel, const std::string &matrixName, const std::string &label, Teuchos::ParameterList &paramList) const

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

Additional Inherited Members
Public Types inherited from MueLu::SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
typedef SmootherPrototype<>::scalar_type	scalar_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type	local_ordinal_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type	global_ordinal_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type	node_type

Public Types inherited from MueLu::SmootherBase< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
typedef SmootherPrototype<>::scalar_type	scalar_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type	local_ordinal_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type	global_ordinal_type

typedef typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type	node_type

Public Member Functions inherited from MueLu::SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
	SmootherPrototype ()
	@nameConstructors/Destructors. More...

virtual	~SmootherPrototype ()

virtual void	DeclareInput (Level &currentLevel) const=0
	Input. More...

virtual void	CallBuild (Level &) const

virtual void	CallDeclareInput (Level &requestedLevel) const

bool	IsSetup () const
	Get the state of a smoother prototype. More...

void	IsSetup (bool const &ToF)
	Set the state of a smoother prototype. More...

Public Member Functions inherited from MueLu::SmootherBase< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >
	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
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

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

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. 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...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

Public Member Functions inherited from MueLu::Factory
	Factory ()
	Constructor. More...

virtual	~Factory ()
	Destructor. More...

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
	Configuration. More...

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Default implementation of FactoryAcceptor::GetFactory() More...

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. More...

void	EnableMultipleCallCheck () const

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 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

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

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

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

Constructor & Destructor Documentation

◆ Ifpack2Smoother()

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 94 of file MueLu_Ifpack2Smoother_def.hpp.

◆ ~Ifpack2Smoother()

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

Member Function Documentation

◆ SetParameterList()

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 118 of file MueLu_Ifpack2Smoother_def.hpp.

◆ DeclareInput()

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< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 149 of file MueLu_Ifpack2Smoother_def.hpp.

◆ Setup()

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< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 208 of file MueLu_Ifpack2Smoother_def.hpp.

◆ Apply()

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< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 909 of file MueLu_Ifpack2Smoother_def.hpp.

◆ Copy()

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

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

virtual

Implements MueLu::SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 968 of file MueLu_Ifpack2Smoother_def.hpp.

◆ description()

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

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

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 975 of file MueLu_Ifpack2Smoother_def.hpp.

◆ print()

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 987 of file MueLu_Ifpack2Smoother_def.hpp.

◆ getPreconditioner()

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

◆ getNodeSmootherComplexity()

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

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

virtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type, typename SmootherPrototype< SmootherPrototype<>::scalar_type >::local_ordinal_type >::global_ordinal_type >::node_type >.

Definition at line 1014 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetPrecParameters()

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 129 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupSchwarz()

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

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

private

Definition at line 298 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupChebyshev()

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

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

private

Definition at line 667 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupLineSmoothing()

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

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

private

Definition at line 533 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupBlockRelaxation()

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

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

private

Definition at line 620 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupTopological()

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

◆ SetupAggregate()

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

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

private

Definition at line 408 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupHiptmair()

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

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

private

Definition at line 728 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupGeneric()

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

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

private

Definition at line 876 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupChebyshevEigenvalues()

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>

Scalar MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupChebyshevEigenvalues	(	Level &	currentLevel,
		const std::string &	matrixName,
		const std::string &	label,
		Teuchos::ParameterList &	paramList
	)		const

private

Definition at line 794 of file MueLu_Ifpack2Smoother_def.hpp.

Friends And Related Function Documentation

◆ Ifpack2Smoother

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

Definition at line 141 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Data Documentation

◆ constructionSuccessful_

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

private

Definition at line 225 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ type_

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

◆ overlap_

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

◆ prec_

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

◆ A_

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

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

Constructors / destructors

Overridden from Teuchos::Describable

Computational methods.

Utilities

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ifpack2Smoother()

◆ ~Ifpack2Smoother()

Member Function Documentation

◆ SetParameterList()

◆ DeclareInput()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getPreconditioner()

◆ getNodeSmootherComplexity()

◆ SetPrecParameters()

◆ SetupSchwarz()

◆ SetupChebyshev()

◆ SetupLineSmoothing()

◆ SetupBlockRelaxation()

◆ SetupTopological()

◆ SetupAggregate()

◆ SetupHiptmair()

◆ SetupGeneric()

◆ SetupChebyshevEigenvalues()

Friends And Related Function Documentation

◆ Ifpack2Smoother

Member Data Documentation

◆ constructionSuccessful_

◆ type_

◆ overlap_

◆ prec_

◆ A_