Interface to block smoothers in Teko package. More...

#include <MueLu_TekoSmoother_decl.hpp>

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

Private Types
typedef Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >	MapExtractorClass

Constructors / destructors
	TekoSmoother ()
	Constructor. More...

virtual	~TekoSmoother ()
	Destructor. More...

RCP< const ParameterList >	GetValidParameterList () const
	Input. More...

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

void	SetTekoParameters (RCP< ParameterList > tekoParams)

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Setup routine. More...

void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply the Teko smoother. More...

RCP< SmootherPrototype >	Copy () const

Overridden from Teuchos::Describable
std::string	type_
	smoother type 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...

size_t	getNodeSmootherComplexity () const
	Get a rough estimate of cost per iteration. More...

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	CallBuild (Level &) const

virtual void	CallDeclareInput (Level &requestedLevel) const

virtual RCP< SmootherPrototype >	Copy () const=0

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

virtual size_t	getNodeSmootherComplexity () const=0
	Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::OrdinalTraits<size_t>::invalid() if such an estimate cannot be computed. More...

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

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

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

Interface to block smoothers in Teko package.

This is a dummy implementation for arbitrary scalars (different than SC=double). We use Teko and the Teko::LinearOp which is declared as Teuchos::RCP<const Thyra::LinearOpBase<ST> > with ST=double. See e.g. Teko_ConfigDefs.hpp.

This is the specialization for SC=double and LO=int, which actually implements the Teko smoother interface. We use Teko and the Teko::LinearOp which is declared as Teuchos::RCP<const Thyra::LinearOpBase<ST> > with ST=double. See e.g. Teko_ConfigDefs.hpp.

In Teko SC=double and LO=int are hard-coded. The node is Tpetra::Map<>::node_type. The global ordinal GO is chosen as a conservative choice from what Tpetra supports (see Teko_ConfigDefs.hpp for more details)

Note, that the underlying Thyra package is only templated on the Scalar (not the node type).

Definition at line 86 of file MueLu_TekoSmoother_decl.hpp.

Member Typedef Documentation

◆ MapExtractorClass

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>

typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractorClass

private

Definition at line 88 of file MueLu_TekoSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ TekoSmoother()

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>

MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TekoSmoother ( )

inline

Constructor.

Definition at line 100 of file MueLu_TekoSmoother_decl.hpp.

◆ ~TekoSmoother()

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

inlinevirtual

Destructor.

Definition at line 105 of file MueLu_TekoSmoother_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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<const ParameterList> MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const

inlinevirtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 110 of file MueLu_TekoSmoother_decl.hpp.

◆ DeclareInput()

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::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

inlinevirtual

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 115 of file MueLu_TekoSmoother_decl.hpp.

◆ SetTekoParameters()

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::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetTekoParameters ( RCP< ParameterList > tekoParams )

inline

Definition at line 117 of file MueLu_TekoSmoother_decl.hpp.

◆ Setup()

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

inlinevirtual

Setup routine.

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 125 of file MueLu_TekoSmoother_decl.hpp.

◆ Apply()

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::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply	(	MultiVector &	X,
		const MultiVector &	B,
		bool	InitialGuessIsZero = `false`
	)		const

inlinevirtual

Apply the Teko smoother.

Parameters

X	initial guess
B	right-hand side
InitialGuessIsZero	This option has no effect.

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 133 of file MueLu_TekoSmoother_decl.hpp.

◆ Copy()

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<SmootherPrototype> MueLu::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const

inline

Definition at line 136 of file MueLu_TekoSmoother_decl.hpp.

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

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

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 142 of file MueLu_TekoSmoother_decl.hpp.

◆ print()

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::TekoSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print	(	Teuchos::FancyOStream &	out,
		const VerbLevel	verbLevel = `Default`
	)		const

inline

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

Definition at line 151 of file MueLu_TekoSmoother_decl.hpp.

◆ getNodeSmootherComplexity()

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

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

Get a rough estimate of cost per iteration.

Definition at line 56 of file MueLu_TekoSmoother_def.hpp.

Member Data Documentation

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

private

smoother type

Definition at line 169 of file MueLu_TekoSmoother_decl.hpp.

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

Private Types

Constructors / destructors

Setup and Apply methods.

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MapExtractorClass

Constructor & Destructor Documentation

◆ TekoSmoother()

◆ ~TekoSmoother()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ SetTekoParameters()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

Member Data Documentation

◆ type_