Xpetra
Version of the Day
|
#include <Xpetra_TpetraRowMatrix.hpp>
Private Attributes | |
RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | mtx_ |
Destructor Method | |
virtual | ~TpetraRowMatrix ()=default |
Destructor. More... | |
Matrix Query Methods | |
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | getRowMap () const |
Returns the Map that describes the row distribution in this matrix. More... | |
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | getColMap () const |
Returns the Map that describes the column distribution in this matrix. More... | |
Tpetra::global_size_t | getGlobalNumRows () const |
Returns the number of global rows in this matrix. More... | |
Tpetra::global_size_t | getGlobalNumCols () const |
Returns the number of global columns in this matrix. More... | |
size_t | getLocalNumRows () const |
Returns the number of rows owned on the calling node. More... | |
size_t | getLocalNumCols () const |
Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map. More... | |
Tpetra::global_size_t | getGlobalNumEntries () const |
Returns the global number of entries in this matrix. More... | |
size_t | getNodeNumEntries () const |
Returns the local number of entries in this matrix. More... | |
size_t | getNumEntriesInLocalRow (LocalOrdinal localRow) const |
Returns the current number of entries on this node in the specified local row. More... | |
size_t | getGlobalMaxNumRowEntries () const |
Returns the maximum number of entries across all rows/columns on all nodes. More... | |
size_t | getLocalMaxNumRowEntries () const |
Returns the maximum number of entries across all rows/columns on this node. More... | |
bool | isLocallyIndexed () const |
If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. */. More... | |
bool | isGloballyIndexed () const |
If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. */. More... | |
bool | isFillComplete () const |
Returns true if fillComplete() has been called. More... | |
bool | supportsRowViews () const |
Returns true if getLocalRowView() and getGlobalRowView() are valid for this class. More... | |
Extraction Methods | |
void | getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const |
Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine. More... | |
void | getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const |
Extract a const, non-persisting view of global indices in a specified row of the matrix. More... | |
void | getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const |
Extract a const, non-persisting view of local indices in a specified row of the matrix. More... | |
void | getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const |
Get a copy of the diagonal entries owned by this node, with local row indices. More... | |
Mathematical Methods | |
ScalarTraits< Scalar > ::magnitudeType | getFrobeniusNorm () const |
Returns the Frobenius norm of the matrix. More... | |
Pure virtual functions to be overridden by subclasses. | |
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | getDomainMap () const |
Returns the Map associated with the domain of this operator, which must be compatible with X.getMap(). More... | |
const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > | getRangeMap () const |
Returns the Map associated with the range of this operator, which must be compatible with Y.getMap(). More... | |
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... | |
Xpetra specific | |
TpetraRowMatrix ()=default | |
TpetraRowMatrix (const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx) | |
TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object. More... | |
void | setTpetra_RowMatrix (const Teuchos::RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &mtx) |
Set the underlying Tpetra matrix. More... | |
RCP< const Tpetra::RowMatrix < Scalar, LocalOrdinal, GlobalOrdinal, Node > > | getTpetra_RowMatrix () const |
Get the underlying Tpetra matrix. More... | |
RCP< Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | getTpetra_RowMatrixNonConst () const |
Get the underlying Tpetra matrix. More... | |
Additional Inherited Members | |
Public Types inherited from Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Public Types inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
typedef Scalar | scalar_type |
The type of the entries of the input and output multivectors. More... | |
typedef LocalOrdinal | local_ordinal_type |
The local index type. More... | |
typedef GlobalOrdinal | global_ordinal_type |
The global index type. More... | |
typedef Node | node_type |
The Kokkos Node type. More... | |
Public Member Functions inherited from Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
virtual | ~RowMatrix () |
Destructor. More... | |
virtual size_t | getLocalNumEntries () const =0 |
Returns the local number of entries in this matrix. More... | |
Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
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 bool | hasTransposeApply () const |
Whether this operator supports applying the transpose or conjugate transpose. More... | |
Definition at line 35 of file Xpetra_TpetraRowMatrix.hpp.
|
virtualdefault |
Destructor.
|
default |
|
inline |
TpetraCrsMatrix constructor to wrap a Tpetra::CrsMatrix object.
Definition at line 223 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the Map that describes the row distribution in this matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 50 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the Map that describes the column distribution in this matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 56 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the number of global rows in this matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 62 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the number of global columns in this matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 68 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the number of rows owned on the calling node.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 74 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 80 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the global number of entries in this matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 86 of file Xpetra_TpetraRowMatrix.hpp.
|
inline |
Returns the local number of entries in this matrix.
Definition at line 92 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the current number of entries on this node in the specified local row.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 98 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the maximum number of entries across all rows/columns on all nodes.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 104 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the maximum number of entries across all rows/columns on this node.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 110 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
If matrix indices are in the local range, this function returns true. Otherwise, this function returns false. */.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 116 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. */.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 122 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns true if fillComplete() has been called.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 128 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 134 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 145 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 158 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 169 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Get a copy of the diagonal entries owned by this node, with local row indices.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 180 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the Frobenius norm of the matrix.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 189 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the Map associated with the domain of this operator, which must be compatible with X.getMap().
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 200 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 206 of file Xpetra_TpetraRowMatrix.hpp.
|
inlinevirtual |
Computes the operator-multivector application.
Implements Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 212 of file Xpetra_TpetraRowMatrix.hpp.
|
inline |
Set the underlying Tpetra matrix.
Definition at line 227 of file Xpetra_TpetraRowMatrix.hpp.
|
inline |
Get the underlying Tpetra matrix.
Definition at line 230 of file Xpetra_TpetraRowMatrix.hpp.
|
inline |
Get the underlying Tpetra matrix.
Definition at line 233 of file Xpetra_TpetraRowMatrix.hpp.
|
private |
Definition at line 238 of file Xpetra_TpetraRowMatrix.hpp.