49 #ifndef XPETRA_CRSMATRIXWRAP_DEF_HPP
50 #define XPETRA_CRSMATRIXWRAP_DEF_HPP
71 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
73 size_t maxNumEntriesPerRow,
75 : finalDefaultView_ (false)
81 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
85 : finalDefaultView_ (false)
91 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
93 : finalDefaultView_(false)
102 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
104 : finalDefaultView_(false)
113 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
114 #ifdef HAVE_XPETRA_TPETRA
115 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
117 : finalDefaultView_(false)
126 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
128 const RCP<const Map>& domainMap,
const RCP<const Map>& rangeMap,
130 : finalDefaultView_(false)
140 #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."
145 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
147 : finalDefaultView_(matrix->isFillComplete())
156 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
158 : finalDefaultView_(false)
167 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
170 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
172 matrixData_->insertGlobalValues(globalRow, cols, vals);
175 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
177 matrixData_->insertLocalValues(localRow, cols, vals);
180 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
185 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
190 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
193 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
195 matrixData_->scale(alpha);
198 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
200 matrixData_->resumeFill(params);
203 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
205 matrixData_->fillComplete(domainMap, rangeMap, params);
211 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
213 matrixData_->fillComplete(params);
219 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
221 return matrixData_->getGlobalNumRows();
224 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
226 return matrixData_->getGlobalNumCols();
229 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
231 return matrixData_->getNodeNumRows();
234 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
236 return matrixData_->getGlobalNumEntries();
239 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
241 return matrixData_->getNodeNumEntries();
244 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
246 return matrixData_->getNumEntriesInLocalRow(localRow);
249 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
251 return matrixData_->getNumEntriesInGlobalRow(globalRow);
254 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
256 return matrixData_->getGlobalMaxNumRowEntries();
259 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
261 return matrixData_->getNodeMaxNumRowEntries();
264 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
266 return matrixData_->isLocallyIndexed();
269 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
271 return matrixData_->isGloballyIndexed();
274 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
276 return matrixData_->isFillComplete();
279 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
285 matrixData_->getLocalRowCopy(LocalRow, Indices, Values, NumEntries);
288 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
290 matrixData_->getGlobalRowView(GlobalRow, indices, values);
293 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
295 matrixData_->getLocalRowView(LocalRow, indices, values);
298 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
300 matrixData_->getLocalDiagCopy(diag);
303 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
305 matrixData_->getLocalDiagOffsets(offsets);
308 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
310 matrixData_->getLocalDiagCopy(diag,offsets);
313 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
315 return matrixData_->getFrobeniusNorm();
318 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
320 matrixData_->leftScale(x);
323 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
325 matrixData_->rightScale(x);
328 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
330 return matrixData_->haveGlobalConstants();
333 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
340 matrixData_->apply(X,Y,mode,alpha,beta);
343 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
345 return matrixData_->getDomainMap();
348 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
350 return matrixData_->getRangeMap();
353 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
356 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
363 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
365 matrixData_->removeEmptyProcessesInPlace(newMap);
366 this->operatorViewTable_.get(this->GetCurrentViewLabel())->SetRowMap(matrixData_->getRowMap());
367 this->operatorViewTable_.get(this->GetCurrentViewLabel())->SetColMap(matrixData_->getColMap());
370 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
372 return matrixData_->getMap();
375 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
382 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
389 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
396 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
403 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
405 return "Xpetra::CrsMatrixWrap";
408 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
418 matrixData_->describe(out,verbLevel);
423 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
425 Teuchos::LabeledObject::setObjectLabel(objectLabel);
426 matrixData_->setObjectLabel(objectLabel);
429 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
430 #ifdef HAVE_XPETRA_TPETRA
431 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
434 return matrixData_->getLocalMatrix();
438 #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."
443 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
447 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
451 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
454 #ifdef XPETRA_ENABLE_DEPRECATED_CODE
455 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
456 template <
class Node2>
458 #ifdef HAVE_XPETRA_TPETRA
461 if (tMatrix == Teuchos::null)
467 return Teuchos::null;
474 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
478 this->defaultViewLabel_ =
"point";
479 this->CreateView(this->GetDefaultViewLabel(), matrixData_->getRowMap(), matrixData_->getColMap());
482 this->currentViewLabel_ = this->GetDefaultViewLabel();
485 template <
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node>
487 if ((finalDefaultView_ ==
false) && matrixData_->isFillComplete() ) {
490 finalDefaultView_ =
true;
496 #endif //ifndef XPETRA_CRSMATRIXWRAP_DEF_HPP
void setObjectLabel(const std::string &objectLabel)
RCP< CrsMatrix > getCrsMatrix() const
RCP< Map< LocalOrdinal, GlobalOrdinal, Node2 > > clone(const Map< LocalOrdinal, GlobalOrdinal, Node1 > &map, const RCP< Node2 > &node2)
void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Right scale matrix using the given vector entries.
size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using global IDs.
global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const
Implements DistObject interface.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
static RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, size_t maxNumEntriesPerRow, Xpetra::ProfileType pftype=Xpetra::DynamicProfile, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
Constructor specifying fixed number of entries for each row.
bool hasCrsGraph() const
Supports the getCrsGraph() call.
void scale(const Scalar &alpha)
Scale the current values of a matrix, this = alpha*this.
Exception throws to report errors in the internal logical of the program.
void removeEmptyProcessesInPlace(const Teuchos::RCP< const Map > &newMap)
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.
CrsMatrixWrap(const RCP< const Map > &rowMap, size_t maxNumEntriesPerRow, Xpetra::ProfileType pftype=Xpetra::DynamicProfile)
Constructor specifying fixed number of entries for each row.
void doExport(const Matrix &dest, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Export.
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > operatorViewTable_
void updateDefaultView() const
size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const
Get Frobenius norm of the matrix.
void doImport(const Matrix &source, const Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Import.
std::string description() const
Return a simple one-line description of this object.
void getLocalDiagOffsets(Teuchos::ArrayRCP< size_t > &offsets) const
Get offsets of the diagonal entries in the matrix.
const viewLabel_t & GetCurrentViewLabel() const
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.
size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
RCP< const CrsGraph > getCrsGraph() const
Returns the CrsGraph associated with this matrix.
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.
size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
size_t global_size_t
Global size_t object.
void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using global IDs.
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.
RCP< CrsMatrix > matrixData_
bool haveGlobalConstants() const
Returns true if globalConstants have been computed; false otherwise.
virtual ~CrsMatrixWrap()
Destructor.
const RCP< const Map > & getColMap() const
Returns the Map that describes the column distribution in this matrix. This might be null until fillC...
void resumeFill(const RCP< ParameterList > ¶ms=null)
bool isFillComplete() const
Returns true if fillComplete() has been called and the matrix is in compute mode. ...
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...
virtual void setAllToScalar(const Scalar &alpha)
Set all matrix entries equal to scalar.
size_t getNodeNumRows() const
Returns the number of matrix rows owned on the calling node.
Concrete implementation of Xpetra::Matrix.
global_size_t getGlobalNumCols() const
Returns the number of global columns in the matrix.
void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using local IDs.
CombineMode
Xpetra::Combine Mode enumerable type.
void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Left scale matrix using the given vector entries.
bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
const viewLabel_t & GetDefaultViewLabel() 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.
size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries in the specified global row.
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
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 replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using local IDs.
Xpetra-specific matrix class.
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...