#include <MueLu_Amesos2Smoother_decl.hpp>

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

Public Member Functions
	Amesos2Smoother (const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
virtual	~Amesos2Smoother ()
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.
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
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 void	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values.
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

Overridden from Teuchos::Describable
typedef Tpetra::CrsMatrix< double, int, int, Xpetra::EpetraNode >	Tpetra_CrsMatrix
typedef Tpetra::MultiVector< double, int, int, Xpetra::EpetraNode >	Tpetra_MultiVector
std::string	type_
	amesos2-specific key phrase that denote smoother type
RCP< Amesos2::Solver< Tpetra_CrsMatrix, Tpetra_MultiVector > >	prec_
	pointer to Amesos2 solver object
bool	useTransformation_
RCP< MultiVector >	X_
RCP< MultiVector >	B_
RCP< Projection< double, int, int, Xpetra::EpetraNode > >	projection_

Constructors / destructors
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.

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
template<class T>
bool	IsType (Level &level, const std::string &varName) 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 145 of file MueLu_Amesos2Smoother_decl.hpp.

Member Typedef Documentation

◆ Scalar

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

private

Definition at line 146 of file MueLu_Amesos2Smoother_decl.hpp.

◆ LocalOrdinal

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

private

Definition at line 147 of file MueLu_Amesos2Smoother_decl.hpp.

◆ GlobalOrdinal

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

private

Definition at line 148 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Node

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

private

Definition at line 149 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Tpetra_CrsMatrix

typedef Tpetra::CrsMatrix<double, int, int, Xpetra::EpetraNode> MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >::Tpetra_CrsMatrix

private

Definition at line 123 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Tpetra_MultiVector

typedef Tpetra::MultiVector<double, int, int, Xpetra::EpetraNode> MueLu::Amesos2Smoother< double, int, int, Xpetra::EpetraNode >::Tpetra_MultiVector

private

Definition at line 124 of file MueLu_Amesos2Smoother_decl.hpp.

Constructor & Destructor Documentation

◆ Amesos2Smoother()

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

inline

Definition at line 154 of file MueLu_Amesos2Smoother_decl.hpp.

◆ ~Amesos2Smoother()

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

inlinevirtual

Definition at line 157 of file MueLu_Amesos2Smoother_decl.hpp.

Member Function Documentation

◆ DeclareInput()

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

inlinevirtual

Input.

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

Definition at line 158 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Setup()

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

inlinevirtual

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

Definition at line 159 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Apply()

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