MueLu  Version of the Day
Private Types | List of all members
MueLu::AMGXOperator Class Reference

Adapter for AmgX library from Nvidia. More...

#include <MueLu_AMGXOperator_fwd.hpp>

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...
 
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
 

Detailed Description

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 54 of file MueLu_AMGXOperator_fwd.hpp.

Member Typedef Documentation

◆ SC

typedef Scalar MueLu::AMGXOperator::SC
private

Definition at line 83 of file MueLu_AMGXOperator_decl.hpp.

◆ LO

typedef LocalOrdinal MueLu::AMGXOperator::LO
private

Definition at line 84 of file MueLu_AMGXOperator_decl.hpp.

◆ GO

typedef GlobalOrdinal MueLu::AMGXOperator::GO
private

Definition at line 85 of file MueLu_AMGXOperator_decl.hpp.

◆ NO

typedef Node MueLu::AMGXOperator::NO
private

Definition at line 86 of file MueLu_AMGXOperator_decl.hpp.

◆ Map

typedef Tpetra::Map<LO,GO,NO> MueLu::AMGXOperator::Map
private

Definition at line 88 of file MueLu_AMGXOperator_decl.hpp.

◆ MultiVector

typedef Tpetra::MultiVector<SC,LO,GO,NO> MueLu::AMGXOperator::MultiVector
private

Definition at line 89 of file MueLu_AMGXOperator_decl.hpp.

Constructor & Destructor Documentation

◆ AMGXOperator()

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

Constructor.

Definition at line 97 of file MueLu_AMGXOperator_decl.hpp.

◆ ~AMGXOperator()

virtual MueLu::AMGXOperator::~AMGXOperator ( )
inlinevirtual

Destructor.

Definition at line 100 of file MueLu_AMGXOperator_decl.hpp.

Member Function Documentation

◆ getDomainMap()

Teuchos::RCP<const Map> MueLu::AMGXOperator::getDomainMap ( ) const
inline

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

Definition at line 105 of file MueLu_AMGXOperator_decl.hpp.

◆ getRangeMap()

Teuchos::RCP<const Map> MueLu::AMGXOperator::getRangeMap ( ) const
inline

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

Definition at line 110 of file MueLu_AMGXOperator_decl.hpp.

◆ apply()

void MueLu::AMGXOperator::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 119 of file MueLu_AMGXOperator_decl.hpp.

◆ hasTransposeApply()

bool MueLu::AMGXOperator::hasTransposeApply ( ) const
inline

Indicates whether this operator supports applying the adjoint operator.

Definition at line 125 of file MueLu_AMGXOperator_decl.hpp.

◆ GetHierarchy()

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

Definition at line 129 of file MueLu_AMGXOperator_decl.hpp.

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