Xpetra
Version of the Day
|
#include <Xpetra_TpetraOperator.hpp>
Public Types | |
typedef double | Scalar |
typedef long long | GlobalOrdinal |
typedef int | LocalOrdinal |
typedef EpetraNode | Node |
Public Types inherited from Xpetra::Operator< double, int, long long, 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 long long | global_ordinal_type |
The global index type. More... | |
typedef EpetraNode | node_type |
The Kokkos Node type. More... | |
virtual Teuchos::RCP< const Xpetra::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 Xpetra::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 Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Xpetra::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... | |
RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | getOperator () |
Gets the operator out. More... | |
void | residual (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const |
Additional Inherited Members | |
Public Member Functions inherited from Xpetra::Operator< double, int, long long, EpetraNode > | |
virtual | ~Operator () |
virtual void | removeEmptyProcessesInPlace (const RCP< const map_type > &) |
virtual void | residual (const mv_type &X, const mv_type &B, mv_type &R) const =0 |
Compute a residual R = B - (*this) * X. More... | |
virtual void | apply (const mv_type &X, mv_type &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, doublealpha=Teuchos::ScalarTraits< double >::one(), doublebeta=Teuchos::ScalarTraits< double >::zero()) const =0 |
Computes the operator-multivector application. More... | |
Definition at line 227 of file Xpetra_TpetraOperator.hpp.
typedef double Xpetra::TpetraOperator< double, int, long long, EpetraNode >::Scalar |
Definition at line 230 of file Xpetra_TpetraOperator.hpp.
typedef long long Xpetra::TpetraOperator< double, int, long long, EpetraNode >::GlobalOrdinal |
Definition at line 231 of file Xpetra_TpetraOperator.hpp.
typedef int Xpetra::TpetraOperator< double, int, long long, EpetraNode >::LocalOrdinal |
Definition at line 232 of file Xpetra_TpetraOperator.hpp.
typedef EpetraNode Xpetra::TpetraOperator< double, int, long long, EpetraNode >::Node |
Definition at line 233 of file Xpetra_TpetraOperator.hpp.
|
inline |
TpetraOperator constructor to wrap a Tpetra::Operator object.
Definition at line 280 of file Xpetra_TpetraOperator.hpp.
|
inlinevirtual |
The Map associated with the domain of this operator, which must be compatible with X.getMap().
Implements Xpetra::Operator< double, int, long long, EpetraNode >.
Definition at line 238 of file Xpetra_TpetraOperator.hpp.
|
inlinevirtual |
The Map associated with the range of this operator, which must be compatible with Y.getMap().
Implements Xpetra::Operator< double, int, long long, EpetraNode >.
Definition at line 243 of file Xpetra_TpetraOperator.hpp.
|
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
beta == 0
, apply() must overwrite Y
, so that any values in Y
(including NaNs) are ignored.alpha == 0
, apply() may short-circuit the operator, so that any values in X
(including NaNs) are ignored. Definition at line 254 of file Xpetra_TpetraOperator.hpp.
|
inlinevirtual |
Whether this operator supports applying the transpose or conjugate transpose.
Reimplemented from Xpetra::Operator< double, int, long long, EpetraNode >.
Definition at line 261 of file Xpetra_TpetraOperator.hpp.
|
inline |
A simple one-line description of this object.
Definition at line 269 of file Xpetra_TpetraOperator.hpp.
|
inline |
Print the object with the given verbosity level to a FancyOStream.
Definition at line 272 of file Xpetra_TpetraOperator.hpp.
|
inline |
Gets the operator out.
Definition at line 283 of file Xpetra_TpetraOperator.hpp.
|
inline |
Definition at line 285 of file Xpetra_TpetraOperator.hpp.