Public Types | List of all members
Xpetra::TpetraOperator< double, int, int, EpetraNode > Class Template Reference

#include <Xpetra_TpetraOperator.hpp>

Inheritance diagram for Xpetra::TpetraOperator< double, int, int, EpetraNode >:
Xpetra::Operator< double, int, int, EpetraNode >

Public Types

typedef double Scalar
 
typedef int GlobalOrdinal
 
typedef int LocalOrdinal
 
typedef EpetraNode Node
 
- Public Types inherited from Xpetra::Operator< double, int, int, EpetraNode >
typedef double scalar_type
 The type of the entries of the input and output multivectors. More...
 
typedef int local_ordinal_type
 The local index type. More...
 
typedef int global_ordinal_type
 The global index type. More...
 
typedef EpetraNode node_type
 The Kokkos Node type. More...
 
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap () const
 The Map associated with the domain of this operator, which must be compatible with X.getMap(). More...
 
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap () const
 The Map associated with the range of this operator, which must be compatible with Y.getMap(). More...
 
virtual void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
 Computes the operator-multivector application. More...
 
virtual bool hasTransposeApply () const
 Whether this operator supports applying the transpose or conjugate transpose. More...
 

Overridden from Teuchos::Describable

std::string description () const
 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 the given verbosity level to a FancyOStream. More...
 

Xpetra specific

 TpetraOperator (const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &op)
 TpetraOperator constructor to wrap a Tpetra::Operator object. More...
 

Additional Inherited Members

- Public Member Functions inherited from Xpetra::Operator< double, int, int, EpetraNode >
virtual ~Operator ()
 
virtual void removeEmptyProcessesInPlace (const RCP< const Map > &newMap)
 
virtual void apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, double alpha=Teuchos::ScalarTraits< double >::one(), double beta=Teuchos::ScalarTraits< double >::zero()) const=0
 Computes the operator-multivector application. More...
 

Detailed Description

template<>
class Xpetra::TpetraOperator< double, int, int, EpetraNode >

Definition at line 137 of file Xpetra_TpetraOperator.hpp.

Member Typedef Documentation

◆ Scalar

typedef double Xpetra::TpetraOperator< double, int, int, EpetraNode >::Scalar

Definition at line 140 of file Xpetra_TpetraOperator.hpp.

◆ GlobalOrdinal

typedef int Xpetra::TpetraOperator< double, int, int, EpetraNode >::GlobalOrdinal

Definition at line 141 of file Xpetra_TpetraOperator.hpp.

◆ LocalOrdinal

typedef int Xpetra::TpetraOperator< double, int, int, EpetraNode >::LocalOrdinal

Definition at line 142 of file Xpetra_TpetraOperator.hpp.

◆ Node

typedef EpetraNode Xpetra::TpetraOperator< double, int, int, EpetraNode >::Node

Definition at line 143 of file Xpetra_TpetraOperator.hpp.

Constructor & Destructor Documentation

◆ TpetraOperator()

Xpetra::TpetraOperator< double, int, int, EpetraNode >::TpetraOperator ( const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  op)
inline

TpetraOperator constructor to wrap a Tpetra::Operator object.

Definition at line 190 of file Xpetra_TpetraOperator.hpp.

Member Function Documentation

◆ getDomainMap()

virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > Xpetra::TpetraOperator< double, int, int, EpetraNode >::getDomainMap ( ) const
inlinevirtual

The Map associated with the domain of this operator, which must be compatible with X.getMap().

Implements Xpetra::Operator< double, int, int, EpetraNode >.

Definition at line 148 of file Xpetra_TpetraOperator.hpp.

◆ getRangeMap()

virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > Xpetra::TpetraOperator< double, int, int, EpetraNode >::getRangeMap ( ) const
inlinevirtual

The Map associated with the range of this operator, which must be compatible with Y.getMap().

Implements Xpetra::Operator< double, int, int, EpetraNode >.

Definition at line 153 of file Xpetra_TpetraOperator.hpp.

◆ apply()

virtual void Xpetra::TpetraOperator< double, int, int, EpetraNode >::apply ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  X,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
Scalar  alpha = Teuchos::ScalarTraits<Scalar>::one(),
Scalar  beta = Teuchos::ScalarTraits<Scalar>::zero() 
) const
inlinevirtual

Computes the operator-multivector application.

Loosely, performs $Y = \alpha \cdot A^{\textrm{mode}} \cdot X + \beta \cdot Y$. However, the details of operation vary according to the values of alpha and beta. Specifically

  • if beta == 0, apply() must overwrite Y, so that any values in Y (including NaNs) are ignored.
  • if alpha == 0, apply() may short-circuit the operator, so that any values in X (including NaNs) are ignored.

Definition at line 164 of file Xpetra_TpetraOperator.hpp.

◆ hasTransposeApply()

virtual bool Xpetra::TpetraOperator< double, int, int, EpetraNode >::hasTransposeApply ( ) const
inlinevirtual

Whether this operator supports applying the transpose or conjugate transpose.

Reimplemented from Xpetra::Operator< double, int, int, EpetraNode >.

Definition at line 171 of file Xpetra_TpetraOperator.hpp.

◆ description()

std::string Xpetra::TpetraOperator< double, int, int, EpetraNode >::description ( ) const
inline

A simple one-line description of this object.

Definition at line 179 of file Xpetra_TpetraOperator.hpp.

◆ describe()

void Xpetra::TpetraOperator< double, int, int, EpetraNode >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const
inline

Print the object with the given verbosity level to a FancyOStream.

Definition at line 182 of file Xpetra_TpetraOperator.hpp.


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