12#ifndef XPETRA_CRSMATRIXWRAP_DEF_HPP
13#define XPETRA_CRSMATRIXWRAP_DEF_HPP
15#include <Tpetra_KokkosCompat_DefaultNode.hpp>
23#include "Xpetra_MultiVector.hpp"
28#include "Xpetra_Matrix.hpp"
33template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
40template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
42 size_t maxNumEntriesPerRow)
48template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
56template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
66template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
76template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
86template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
98template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
108template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
118template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
131template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
134template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
136 matrixData_->insertGlobalValues(globalRow, cols, vals);
139template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
141 matrixData_->insertLocalValues(localRow, cols, vals);
144template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
149template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
154template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
157template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
162template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
167template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
169 matrixData_->fillComplete(domainMap, rangeMap, params);
175template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
183template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
188template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
193template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
198template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
203template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
208template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
210 return matrixData_->getNumEntriesInLocalRow(localRow);
213template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
215 return matrixData_->getNumEntriesInGlobalRow(globalRow);
218template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
223template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
228template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
233template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
238template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
243template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
247 size_t &NumEntries)
const {
248 matrixData_->getLocalRowCopy(LocalRow, Indices, Values, NumEntries);
251template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
253 matrixData_->getGlobalRowView(GlobalRow, indices, values);
256template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
258 matrixData_->getLocalRowView(LocalRow, indices, values);
261template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
266template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
271template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
276template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
281template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
286template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
291template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
296template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
305template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
311 bool sumInterfaceValues,
314 matrixData_->apply(X, Y, mode, alpha, beta, sumInterfaceValues, regionInterfaceImporter, regionInterfaceLIDs);
317template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
322template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
327template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
330template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
337template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
344template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
349template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
356template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
363template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
370template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
377template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
379 return "Xpetra::CrsMatrixWrap";
382template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
397template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
403template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
404#if KOKKOS_VERSION >= 40799
412template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
418template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
421template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
424template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
429template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
439template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
449template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
463template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
468template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
virtual void setObjectLabel(const std::string &objectLabel)
static RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap)
KokkosSparse::CrsMatrix< impl_scalar_type, LocalOrdinal, execution_space, void, typename local_graph_type::size_type > local_matrix_type
The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI pro...
Concrete implementation of Xpetra::Matrix.
void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Left scale matrix using the given vector entries.
LocalOrdinal GetStorageBlockSize() const
Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatri...
void residual(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
Compute a residual R = B - (*this) * X.
size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries in the specified global row.
RCP< const CrsGraph > getCrsGraph() const
Returns the CrsGraph associated with this matrix.
size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Matrix
void fillComplete(const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< Teuchos::ParameterList > ¶ms=null)
Signal that data entry is complete, specifying domain and range maps.
global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Right scale matrix using the given vector entries.
ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const
Get Frobenius norm of the matrix.
std::string description() const
Return a simple one-line description of this object.
void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using global IDs.
void updateDefaultView() const
size_t getLocalNumEntries() const
Returns the local number of entries in this matrix.
bool hasCrsGraph() const
Supports the getCrsGraph() call.
RCP< CrsMatrix > matrixData_
void scale(const Scalar &alpha)
Scale the current values of a matrix, this = alpha*this.
void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using global IDs.
typename Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type local_matrix_type
void resumeFill(const RCP< ParameterList > ¶ms=null)
global_size_t getGlobalNumCols() const
Returns the number of global columns in the matrix.
void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using local IDs.
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const
Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calli...
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.
void setObjectLabel(const std::string &objectLabel)
const RCP< const Map > & getColMap() const
Returns the Map that describes the column distribution in this matrix. This might be null until fillC...
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map associated with the domain of this operator. This will be null until fillComplete() i...
const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const
Implements DistObject interface.
virtual local_matrix_type getLocalMatrixDevice() const
size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
void replaceCrsMatrix(RCP< CrsMatrix > &M)
Expert only.
void getLocalDiagOffsets(Teuchos::ArrayRCP< size_t > &offsets) const
Get offsets of the diagonal entries in the matrix.
void doExport(const Matrix &dest, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Export.
void getLocalDiagCopy(Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
Get a copy of the diagonal entries owned by this node, with local row idices.
virtual ~CrsMatrixWrap()
Destructor.
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
virtual local_matrix_type::HostMirror getLocalMatrixHost() const
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.
size_t getLocalNumRows() const
Returns the number of matrix rows owned on the calling node.
void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using local IDs.
CrsMatrixWrap(const RCP< const Map > &rowMap)
Constructor for a dynamic profile matrix (Epetra only).
void doImport(const Matrix &source, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Import.
bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
void removeEmptyProcessesInPlace(const Teuchos::RCP< const Map > &newMap)
bool haveGlobalConstants() const
Returns true if globalConstants have been computed; false otherwise.
RCP< CrsMatrix > getCrsMatrix() const
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=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const
Computes the sparse matrix-multivector multiplication.
bool isFillComplete() const
Returns true if fillComplete() has been called and the matrix is in compute mode.
virtual void setAllToScalar(const Scalar &alpha)
Set all matrix entries equal to scalar.
Exception throws to report errors in the internal logical of the program.
const viewLabel_t & GetCurrentViewLabel() const
void CreateView(viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap)
viewLabel_t currentViewLabel_
const viewLabel_t & GetDefaultViewLabel() const
viewLabel_t defaultViewLabel_
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > operatorViewTable_
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
basic_FancyOStream< char > FancyOStream
size_t global_size_t
Global size_t object.
CombineMode
Xpetra::Combine Mode enumerable type.