MueLu Version of the Day
Loading...
Searching...
No Matches
Protected Member Functions | List of all members
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Wraps an existing MueLu::Hierarchy as a Tpetra::Operator. More...

#include <MueLu_TpetraOperator_decl.hpp>

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

Protected Member Functions

 TpetraOperator ()=delete
 

MueLu specific

RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Hierarchy_
 
RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Operator_
 
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.
 

Constructor/Destructor

 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.
 

Detailed Description

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Wraps an existing MueLu::Hierarchy as a Tpetra::Operator.

Definition at line 28 of file MueLu_TpetraOperator_decl.hpp.

Constructor & Destructor Documentation

◆ TpetraOperator() [1/3]

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( )
protecteddelete

◆ TpetraOperator() [2/3]

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( const RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  Op)
inline

Constructor.

Definition at line 37 of file MueLu_TpetraOperator_decl.hpp.

◆ TpetraOperator() [3/3]

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  H)
inline

Constructor.

Definition at line 41 of file MueLu_TpetraOperator_decl.hpp.

◆ ~TpetraOperator()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~TpetraOperator ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getDomainMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const

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

Definition at line 33 of file MueLu_TpetraOperator_def.hpp.

◆ getRangeMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const

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

Definition at line 52 of file MueLu_TpetraOperator_def.hpp.

◆ apply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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.

Parameters
[in]X- Tpetra::MultiVector of dimension NumVectors to multiply with matrix.
[out]Y-Tpetra::MultiVector of dimension NumVectors containing result.

Definition at line 71 of file MueLu_TpetraOperator_def.hpp.

◆ hasTransposeApply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply ( ) const

Indicates whether this operator supports applying the adjoint operator.

Definition at line 97 of file MueLu_TpetraOperator_def.hpp.

◆ GetHierarchy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetHierarchy ( ) const

Direct access to the underlying MueLu::Hierarchy.

Definition at line 103 of file MueLu_TpetraOperator_def.hpp.

◆ GetOperator()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetOperator ( ) const

Direct access to the underlying MueLu::Operator.

Definition at line 109 of file MueLu_TpetraOperator_def.hpp.

Member Data Documentation

◆ Hierarchy_

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Hierarchy_
private

Definition at line 81 of file MueLu_TpetraOperator_decl.hpp.

◆ Operator_

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Operator_
private

Definition at line 82 of file MueLu_TpetraOperator_decl.hpp.

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