Adapter for AmgX library from Nvidia. More...

#include <MueLu_AMGXOperator_fwd.hpp>

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

Public Member Functions
Teuchos::RCP< const Map >	getDomainMap () const
	Returns the Tpetra::Map object associated with the domain of this operator. More...

Teuchos::RCP< const Map >	getRangeMap () const
	Returns the Tpetra::Map object associated with the range of this operator. More...

void	apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
	Returns a solution for the linear system AX=Y in the Tpetra::MultiVector X. More...

bool	hasTransposeApply () const
	Indicates whether this operator supports applying the adjoint operator. More...

RCP< MueLu::Hierarchy< SC, LO, GO, NO > >	GetHierarchy () const

Public Member Functions inherited from MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const
	Returns the Tpetra::Map object associated with the domain of this operator. More...

Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const
	Returns the Tpetra::Map object associated with the range of this operator. More...

void	apply (const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::one()) const
	Returns in Y the result of a Tpetra::Operator applied to a Tpetra::MultiVector X. More...

bool	hasTransposeApply () const
	Indicates whether this operator supports applying the adjoint operator. More...

	TpetraOperator (const RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Op)
	Constructor. More...

	TpetraOperator (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H)
	Constructor. More...

virtual	~TpetraOperator ()
	Destructor. More...

RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	GetHierarchy () const
	Direct access to the underlying MueLu::Hierarchy. More...

RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	GetOperator () const
	Direct access to the underlying MueLu::Operator. More...

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

virtual std::string	description () const
	Return a simple one-line description of this object. More...

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)

Private Types
typedef Scalar	SC

typedef LocalOrdinal	LO

typedef GlobalOrdinal	GO

typedef Node	NO

typedef Tpetra::Map< LO, GO, NO >	Map

typedef Tpetra::MultiVector < SC, LO, GO, NO >	MultiVector

Constructor/Destructor
	AMGXOperator (const Teuchos::RCP< Tpetra::CrsMatrix< SC, LO, GO, NO > > &InA, Teuchos::ParameterList &paramListIn)
	Constructor. More...

virtual	~AMGXOperator ()
	Destructor. More...

Additional Inherited Members
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 Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	TpetraOperator ()=delete

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, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Adapter for AmgX library from Nvidia.

This templated version of the class throws errors in all methods as AmgX is not implemented for datatypes where scalar!=double/float and ordinal !=int

Creates an AmgX Solver object with a Tpetra Matrix. Partial specialization of the template for data types supported by AmgX.

Definition at line 18 of file MueLu_AMGXOperator_fwd.hpp.

Member Typedef Documentation

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

typedef Scalar MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SC

private

Definition at line 46 of file MueLu_AMGXOperator_decl.hpp.

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

typedef LocalOrdinal MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::LO

private

Definition at line 47 of file MueLu_AMGXOperator_decl.hpp.

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

typedef GlobalOrdinal MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GO

private

Definition at line 48 of file MueLu_AMGXOperator_decl.hpp.

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

typedef Node MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NO

private

Definition at line 49 of file MueLu_AMGXOperator_decl.hpp.

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

typedef Tpetra::Map<LO, GO, NO> MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map

private

Definition at line 51 of file MueLu_AMGXOperator_decl.hpp.

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

typedef Tpetra::MultiVector<SC, LO, GO, NO> MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MultiVector

private

Definition at line 52 of file MueLu_AMGXOperator_decl.hpp.

Constructor & Destructor Documentation

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

MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AMGXOperator	(	const Teuchos::RCP< Tpetra::CrsMatrix< SC, LO, GO, NO > > &	InA,
		Teuchos::ParameterList &	paramListIn
	)

inline

Constructor.

Definition at line 59 of file MueLu_AMGXOperator_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 62 of file MueLu_AMGXOperator_decl.hpp.

Member Function Documentation

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

Teuchos::RCP<const Map> MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const

inlinevirtual

Returns the Tpetra::Map object associated with the domain of this operator.

Implements Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 67 of file MueLu_AMGXOperator_decl.hpp.

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

Teuchos::RCP<const Map> MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const

inlinevirtual

Returns the Tpetra::Map object associated with the range of this operator.

Implements Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 72 of file MueLu_AMGXOperator_decl.hpp.

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

void MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply	(	const MultiVector &	X,
		MultiVector &	Y,
		Teuchos::ETransp	mode = `Teuchos::NO_TRANS`,
		Scalar	alpha = `Teuchos::ScalarTraits<Scalar>::one()`,
		Scalar	beta = `Teuchos::ScalarTraits<Scalar>::zero()`
	)		const

inline

Returns a solution for the linear system AX=Y in the Tpetra::MultiVector X.

Parameters

[in]	X	- Tpetra::MultiVector of dimension NumVectors that contains the solution to the linear system.
[out]	Y	-Tpetra::MultiVector of dimension NumVectors containing the RHS of the linear system.

Definition at line 81 of file MueLu_AMGXOperator_decl.hpp.

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

bool MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply ( ) const

inlinevirtual

Indicates whether this operator supports applying the adjoint operator.

Reimplemented from Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 87 of file MueLu_AMGXOperator_decl.hpp.

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

RCP<MueLu::Hierarchy<SC, LO, GO, NO> > MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetHierarchy ( ) const

inline

Definition at line 91 of file MueLu_AMGXOperator_decl.hpp.

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

Public Member Functions

Private Types

Constructor/Destructor

Additional Inherited Members

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node> class MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >