#include <MueLu_BelosSmoother_decl.hpp>

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

Public Member Functions
	BelosSmoother (const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LocalOrdinal &overlap=0)

virtual	~BelosSmoother ()

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

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

Overridden from Teuchos::Describable
typedef Tpetra::MultiVector< SC, LO, GO, NO >	tMV

typedef Tpetra::Operator< SC, LO, GO, NO >	tOP

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.

size_t	getNodeSmootherComplexity () const
	For diagnostic purposes.

std::string	type_

RCP< Belos::LinearProblem< double, tMV, tOP > >	tBelosProblem_

RCP< Belos::SolverManager< double, tMV, tOP > >	tSolver_

RCP< Matrix >	A_
	matrix, used in apply if solving residual equation

void	SetupBelos (Level &currentLevel)

Constructors / destructors
class	BelosSmoother
	Constructor.

	BelosSmoother (const std::string type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList())

virtual	~BelosSmoother ()=default
	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

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

Member Typedef Documentation

◆ Scalar

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

private

Definition at line 206 of file MueLu_BelosSmoother_decl.hpp.

◆ LocalOrdinal

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

private

Definition at line 207 of file MueLu_BelosSmoother_decl.hpp.

◆ GlobalOrdinal

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

private

Definition at line 208 of file MueLu_BelosSmoother_decl.hpp.

◆ Node

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

private

Definition at line 209 of file MueLu_BelosSmoother_decl.hpp.

◆ tMV

typedef Tpetra::MultiVector<SC, LO, GO, NO> MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >::tMV

private

Definition at line 187 of file MueLu_BelosSmoother_decl.hpp.

◆ tOP

typedef Tpetra::Operator<SC, LO, GO, NO> MueLu::BelosSmoother< double, int, int, Xpetra::EpetraNode >::tOP

private

Definition at line 188 of file MueLu_BelosSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ BelosSmoother() [1/2]

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

inline

Definition at line 220 of file MueLu_BelosSmoother_decl.hpp.

◆ ~BelosSmoother() [1/2]

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

inlinevirtual

Definition at line 224 of file MueLu_BelosSmoother_decl.hpp.

◆ BelosSmoother() [2/2]

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

Definition at line 115 of file MueLu_BelosSmoother_def.hpp.

◆ ~BelosSmoother() [2/2]

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

virtualdefault

Destructor.

Member Function Documentation

◆ SetParameterList() [1/2]

void MueLu::BelosSmoother< 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 226 of file MueLu_BelosSmoother_decl.hpp.

◆ DeclareInput() [1/2]

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

inlinevirtual

Input.

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

Definition at line 227 of file MueLu_BelosSmoother_decl.hpp.

◆ Setup() [1/2]

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

inlinevirtual

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

Definition at line 228 of file MueLu_BelosSmoother_decl.hpp.

◆ Apply() [1/2]

void MueLu::BelosSmoother< 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 229 of file MueLu_BelosSmoother_decl.hpp.

◆ Copy() [1/2]

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

inlinevirtual

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

Definition at line 230 of file MueLu_BelosSmoother_decl.hpp.

◆ description() [1/2]

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

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 232 of file MueLu_BelosSmoother_decl.hpp.

◆ print() [1/2]

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

inline

Definition at line 233 of file MueLu_BelosSmoother_decl.hpp.

◆ getNodeSmootherComplexity() [1/2]

size_t MueLu::BelosSmoother< 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 236 of file MueLu_BelosSmoother_decl.hpp.

◆ SetParameterList() [2/2]

void MueLu::BelosSmoother< 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 122 of file MueLu_BelosSmoother_def.hpp.

◆ DeclareInput() [2/2]

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

virtual

Input.

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

Definition at line 127 of file MueLu_BelosSmoother_def.hpp.

◆ Setup() [2/2]

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

virtual

Set up the smoother.

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

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

Definition at line 139 of file MueLu_BelosSmoother_def.hpp.

◆ Apply() [2/2]

void MueLu::BelosSmoother< 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 Belos implementation.

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

Definition at line 149 of file MueLu_BelosSmoother_def.hpp.