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>
35 : finalDefaultView_(false) {
40template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
42 size_t maxNumEntriesPerRow)
43 : finalDefaultView_(false) {
48template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
51 : finalDefaultView_(false) {
56template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
58 : finalDefaultView_(false) {
66template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
68 : finalDefaultView_(false) {
76#ifdef HAVE_XPETRA_TPETRA
77template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
79 : finalDefaultView_(false) {
87template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
91 : finalDefaultView_(false) {
100#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
104template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
106 : finalDefaultView_(matrix->isFillComplete()) {
114template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
116 : finalDefaultView_(false) {
124template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
129 : finalDefaultView_(false) {
137template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
140template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
142 matrixData_->insertGlobalValues(globalRow, cols, vals);
145template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
147 matrixData_->insertLocalValues(localRow, cols, vals);
150template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
155template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
160template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
163template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
165 matrixData_->scale(alpha);
168template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
170 matrixData_->resumeFill(params);
173template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
175 matrixData_->fillComplete(domainMap, rangeMap, params);
181template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
183 matrixData_->fillComplete(params);
189template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
191 return matrixData_->getGlobalNumRows();
194template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
196 return matrixData_->getGlobalNumCols();
199template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
201 return matrixData_->getLocalNumRows();
204template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
206 return matrixData_->getGlobalNumEntries();
209template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
211 return matrixData_->getLocalNumEntries();
214template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
216 return matrixData_->getNumEntriesInLocalRow(localRow);
219template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
221 return matrixData_->getNumEntriesInGlobalRow(globalRow);
224template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
226 return matrixData_->getGlobalMaxNumRowEntries();
229template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
231 return matrixData_->getLocalMaxNumRowEntries();
234template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
236 return matrixData_->isLocallyIndexed();
239template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
241 return matrixData_->isGloballyIndexed();
244template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
246 return matrixData_->isFillComplete();
249template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
253 size_t &NumEntries)
const {
254 matrixData_->getLocalRowCopy(LocalRow, Indices, Values, NumEntries);
257template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
259 matrixData_->getGlobalRowView(GlobalRow, indices, values);
262template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
264 matrixData_->getLocalRowView(LocalRow, indices, values);
267template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
269 matrixData_->getLocalDiagCopy(diag);
272template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
274 matrixData_->getLocalDiagOffsets(offsets);
277template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
279 matrixData_->getLocalDiagCopy(diag, offsets);
282template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
284 return matrixData_->getFrobeniusNorm();
287template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
289 matrixData_->leftScale(x);
292template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
294 matrixData_->rightScale(x);
297template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
299 return matrixData_->haveGlobalConstants();
302template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
308 matrixData_->apply(X, Y, mode, alpha, beta);
311template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
317 bool sumInterfaceValues,
320 matrixData_->apply(X, Y, mode, alpha, beta, sumInterfaceValues, regionInterfaceImporter, regionInterfaceLIDs);
323template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
325 return matrixData_->getDomainMap();
328template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
330 return matrixData_->getRangeMap();
333template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
336template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
343template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
345 matrixData_->removeEmptyProcessesInPlace(newMap);
346 this->operatorViewTable_.get(this->GetCurrentViewLabel())->SetRowMap(matrixData_->getRowMap());
347 this->operatorViewTable_.get(this->GetCurrentViewLabel())->SetColMap(matrixData_->getColMap());
350template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
352 return matrixData_->getMap();
355template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
362template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
369template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
376template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
383template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
385 return "Xpetra::CrsMatrixWrap";
388template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
398 matrixData_->describe(out, verbLevel);
403template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
406 matrixData_->setObjectLabel(objectLabel);
409#ifdef HAVE_XPETRA_TPETRA
410template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
411#if KOKKOS_VERSION >= 40799
419template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
422 return matrixData_->getLocalMatrixDevice();
426#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
430template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
433template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
436template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
441template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
444 this->defaultViewLabel_ =
"point";
445 this->CreateView(this->GetDefaultViewLabel(), matrixData_->getRowMap(), matrixData_->getColMap());
448 this->currentViewLabel_ = this->GetDefaultViewLabel();
451template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
453 if ((finalDefaultView_ ==
false) && matrixData_->isFillComplete()) {
456 finalDefaultView_ =
true;
461template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
467 finalDefaultView_ = M->isFillComplete();
475template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
477 return matrixData_->GetStorageBlockSize();
480template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
485 matrixData_->residual(X, B, R);
virtual void setObjectLabel(const std::string &objectLabel)
static RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap)
Constructor for empty matrix (intended use is an import/export target - can't insert entries directly...
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...
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.
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.
CrsMatrix::local_matrix_type local_matrix_type
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.
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...
Exception throws to report errors in the internal logical of the program.
Xpetra-specific matrix class.
const viewLabel_t & GetCurrentViewLabel() const
const viewLabel_t & GetDefaultViewLabel() const
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > operatorViewTable_
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
size_t global_size_t
Global size_t object.
CombineMode
Xpetra::Combine Mode enumerable type.