Class that encapsulates Amesos2 direct solvers. More...

#include <MueLu_Amesos2Smoother_decl.hpp>

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

Public Member Functions
RCP< SmootherPrototype >	Copy () const

Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, 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 Tpetra::CrsMatrix < Scalar, LocalOrdinal, GlobalOrdinal, Node >	Tpetra_CrsMatrix

typedef Tpetra::MultiVector < Scalar, LocalOrdinal, GlobalOrdinal, Node >	Tpetra_MultiVector

Private Attributes
std::string	type_
	amesos2-specific key phrase that denote smoother type More...

RCP< Amesos2::Solver < Tpetra_CrsMatrix, Tpetra_MultiVector > >	prec_
	pointer to Amesos2 solver object More...

bool	useTransformation_

RCP< MultiVector >	X_

RCP< MultiVector >	B_

RCP< Projection< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	projection_

Constructors / destructors
	Amesos2Smoother (const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
	Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default. More...

virtual	~Amesos2Smoother ()
	Destructor. More...

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

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

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Set up the direct solver. This creates the underlying Amesos2 solver object according to the parameter list options passed into the Amesos2Smoother constructor. This includes doing a numeric factorization of the matrix. More...

void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply the direct solver. Solves the linear system `AX=B` using the constructed solver. 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< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar	scalar_type

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

Class that encapsulates Amesos2 direct solvers.

This class creates an Amesos2 preconditioner factory. The factory is capable of generating direct solvers based on the type and ParameterList passed into the constructor. See the constructor for more information.

Definition at line 95 of file MueLu_Amesos2Smoother_decl.hpp.

Member Typedef Documentation

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 Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Tpetra_CrsMatrix

private

Definition at line 159 of file MueLu_Amesos2Smoother_decl.hpp.

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 Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Tpetra_MultiVector

private

Definition at line 160 of file MueLu_Amesos2Smoother_decl.hpp.

Constructor & Destructor Documentation

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

MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Amesos2Smoother	(	const std::string &	type = `""`,
		const Teuchos::ParameterList &	paramList = `Teuchos::ParameterList()`
	)

Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default.

Definition at line 133 of file MueLu_Amesos2Smoother_def.hpp.

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

MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Amesos2Smoother ( )

virtual

Destructor.

Definition at line 177 of file MueLu_Amesos2Smoother_def.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const

virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Implements MueLu::ParameterListAcceptor.

Definition at line 180 of file MueLu_Amesos2Smoother_def.hpp.

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

void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

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

Definition at line 192 of file MueLu_Amesos2Smoother_def.hpp.

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

void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level & currentLevel )

virtual

Set up the direct solver. This creates the underlying Amesos2 solver object according to the parameter list options passed into the Amesos2Smoother constructor. This includes doing a numeric factorization of the matrix.

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

Definition at line 201 of file MueLu_Amesos2Smoother_def.hpp.

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

void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply	(	MultiVector &	X,
		const MultiVector &	B,
		bool	InitialGuessIsZero = `false`
	)		const

virtual

Apply the direct solver. Solves the linear system AX=B using the constructed solver.

Parameters

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

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

Definition at line 347 of file MueLu_Amesos2Smoother_def.hpp.

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

RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const

virtual

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

Definition at line 403 of file MueLu_Amesos2Smoother_def.hpp.

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

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

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 408 of file MueLu_Amesos2Smoother_def.hpp.

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

void MueLu::Amesos2Smoother< 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 422 of file MueLu_Amesos2Smoother_def.hpp.

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

size_t MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const

virtual

Get a rough estimate of cost per iteration.

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

Definition at line 446 of file MueLu_Amesos2Smoother_def.hpp.

Member Data Documentation

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

private

amesos2-specific key phrase that denote smoother type

Definition at line 163 of file MueLu_Amesos2Smoother_decl.hpp.

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<Amesos2::Solver<Tpetra_CrsMatrix, Tpetra_MultiVector> > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::prec_

private

pointer to Amesos2 solver object

Definition at line 166 of file MueLu_Amesos2Smoother_decl.hpp.

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

private

Definition at line 168 of file MueLu_Amesos2Smoother_decl.hpp.

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<MultiVector> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::X_

private

Definition at line 169 of file MueLu_Amesos2Smoother_decl.hpp.

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<MultiVector> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::B_

private

Definition at line 169 of file MueLu_Amesos2Smoother_decl.hpp.

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<Projection<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::projection_

private

Definition at line 171 of file MueLu_Amesos2Smoother_decl.hpp.

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

Public Member Functions

Private Types

Private Attributes

Constructors / destructors

Setup and Apply methods.

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation