Adapter for AmgX library from Nvidia. More...

#include <MueLu_AMGXOperator_decl.hpp>

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

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.

virtual	~AMGXOperator ()
	Destructor.

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

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

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.

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

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

Additional Inherited Members
Public Member Functions inherited from MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	GetHierarchy () const
	Direct access to the underlying MueLu::Hierarchy.

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

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

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

virtual	~TpetraOperator ()
	Destructor.

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

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

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.

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

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

Public Member Functions inherited from MueLu::VerboseObject
	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

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

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.

Static Public Member Functions inherited from MueLu::VerboseObject
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 ()

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

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 44 of file MueLu_AMGXOperator_decl.hpp.

Member Typedef Documentation

◆ SC

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.

◆ LO

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.

◆ GO

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.

◆ NO

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.

◆ Map

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.

◆ MultiVector

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

◆ AMGXOperator()

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.

◆ ~AMGXOperator()

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

◆ getDomainMap()

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

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

inline

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

Definition at line 67 of file MueLu_AMGXOperator_decl.hpp.

◆ getRangeMap()

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

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

inline

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

Definition at line 72 of file MueLu_AMGXOperator_decl.hpp.

◆ apply()

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.