#include <MueLu_TekoSmoother_decl.hpp>

Inheritance diagram for MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >:

Public Member Functions
RCP< SmootherPrototype >	Copy () const

Public Member Functions inherited from MueLu::SmootherPrototype< double, int, 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 ()

void	declareConstructionOutcome (bool fail, std::string msg)

bool	constructionSuccessful ()

std::string	constructionErrorMsg ()

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
VerbLevel	GetVerbLevel () const
	Get the verbosity level. More...

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object. More...

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose. More...

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing. More...

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type. More...

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

Private Types
typedef int	LocalOrdinal

typedef double	Scalar

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

Private Attributes
std::string	type_
	smoother type More...

RCP< Matrix >	A_
	block operator More...

RCP< BlockedCrsMatrix >	bA_

RCP< const Thyra::BlockedLinearOpBase < Scalar > >	bThyOp_

RCP< ParameterList >	tekoParams_
	Teko parameters. More...

Teko::LinearOp	inverseOp_

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=false) const
	Apply the Teko smoother. More...

Overridden from Teuchos::Describable
std::string	description () const
	Return a simple one-line description of this object. More...

void	print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
	Print the object with some verbosity level to an FancyOStream object. More...

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

Additional Inherited Members
Public Types inherited from MueLu::SmootherPrototype< double, int, GlobalOrdinal, Node >
typedef double	scalar_type

typedef int	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 void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP < Teuchos::FancyOStream >	GetMueLuOStream ()

static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

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

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< 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 GlobalOrdinal, class Node>
class MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >

Definition at line 184 of file MueLu_TekoSmoother_decl.hpp.

Member Typedef Documentation

template<class GlobalOrdinal , class Node >

typedef int MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::LocalOrdinal

private

Definition at line 185 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

typedef double MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Scalar

private

Definition at line 186 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

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

private

Definition at line 187 of file MueLu_TekoSmoother_decl.hpp.

Constructor & Destructor Documentation

template<class GlobalOrdinal , class Node >

MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::TekoSmoother ( )

inline

Constructor.

Definition at line 198 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

virtual MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::~TekoSmoother ( )

inlinevirtual

Destructor.

Definition at line 207 of file MueLu_TekoSmoother_decl.hpp.

Member Function Documentation

template<class GlobalOrdinal , class Node >

RCP<const ParameterList> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::GetValidParameterList ( ) const

inlinevirtual

Input.

Implements MueLu::ParameterListAcceptor.

Definition at line 212 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

inlinevirtual

Input.

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

Definition at line 221 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::SetTekoParameters ( RCP< ParameterList > tekoParams )

inline

Definition at line 225 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Setup ( Level & currentLevel )

inlinevirtual

Setup routine.

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

Definition at line 233 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

void MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Apply	(	MultiVector &	X,
		const MultiVector &	B,
		bool	= `false`
	)		const

inlinevirtual

Apply the Teko smoother.

Parameters

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

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

Definition at line 280 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

RCP<SmootherPrototype> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::Copy ( ) const

inlinevirtual

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

Definition at line 326 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

std::string MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 332 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

void MueLu::TekoSmoother< double, int, 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 341 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

size_t MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const

inlinevirtual

Get a rough estimate of cost per iteration.

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

Definition at line 352 of file MueLu_TekoSmoother_decl.hpp.

Member Data Documentation

template<class GlobalOrdinal , class Node >

std::string MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::type_

private

smoother type

Definition at line 361 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

RCP<Matrix> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::A_

private

block operator

Definition at line 364 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

RCP<BlockedCrsMatrix> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::bA_

private

Definition at line 365 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

RCP<const Thyra::BlockedLinearOpBase<Scalar> > MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::bThyOp_

private

Definition at line 366 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

RCP<ParameterList> MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::tekoParams_

private

Teko parameters.

Definition at line 369 of file MueLu_TekoSmoother_decl.hpp.

template<class GlobalOrdinal , class Node >

Teko::LinearOp MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >::inverseOp_

private

Definition at line 371 of file MueLu_TekoSmoother_decl.hpp.

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

MueLu_TekoSmoother_decl.hpp

Public Member Functions

Private Types

Private Attributes

Constructors / destructors

Setup and Apply methods.

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class GlobalOrdinal, class Node> class MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class GlobalOrdinal, class Node>
class MueLu::TekoSmoother< double, int, GlobalOrdinal, Node >