Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_Matrix.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Xpetra: A linear algebra interface package
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 
47 // WARNING: This code is experimental. Backwards compatibility should not be expected.
48 
49 #ifndef XPETRA_MATRIX_HPP
50 #define XPETRA_MATRIX_HPP
51 
52 #include <Tpetra_KokkosCompat_DefaultNode.hpp>
53 
54 #include "Xpetra_ConfigDefs.hpp"
55 #include "Xpetra_Exceptions.hpp"
56 
57 #include "Xpetra_MultiVector.hpp"
58 #include "Xpetra_CrsGraph.hpp"
59 #include "Xpetra_CrsMatrix.hpp"
61 #include "Xpetra_MatrixView.hpp"
62 #include "Xpetra_Operator.hpp"
63 #include "Xpetra_StridedMap.hpp"
64 #include "Xpetra_StridedMapFactory.hpp"
65 
66 #include <Teuchos_SerialDenseMatrix.hpp>
67 #include <Teuchos_Hashtable.hpp>
68 
73 namespace Xpetra {
74 
91 typedef std::string viewLabel_t;
92 
93 template <class Scalar,
94  class LocalOrdinal,
95  class GlobalOrdinal,
96  class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
97 class Matrix : public Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
103 
104  public:
105  typedef Scalar scalar_type;
106  typedef LocalOrdinal local_ordinal_type;
107  typedef GlobalOrdinal global_ordinal_type;
108  typedef Node node_type;
109 
110 #ifdef HAVE_XPETRA_TPETRA
112 #endif
113 
115 
116 
117  Matrix() {}
118 
120  virtual ~Matrix() {}
121 
123 
125 
126  void CreateView(viewLabel_t viewLabel, const RCP<const Map> &rowMap, const RCP<const Map> &colMap) {
127  TEUCHOS_TEST_FOR_EXCEPTION(operatorViewTable_.containsKey(viewLabel) == true, Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.CreateView(): a view labeled '" + viewLabel + "' already exist.");
128  RCP<MatrixView> view = rcp(new MatrixView(rowMap, colMap));
129  operatorViewTable_.put(viewLabel, view);
130  }
131 
132  // JG TODO: why this is a member function??
133  void CreateView(const viewLabel_t viewLabel, const RCP<const Matrix> &A, bool transposeA = false, const RCP<const Matrix> &B = Teuchos::null, bool transposeB = false) {
134  RCP<const Map> domainMap = Teuchos::null;
135  RCP<const Map> rangeMap = Teuchos::null;
136 
137  const size_t blkSize = 1;
138  std::vector<size_t> stridingInfo(1, blkSize);
139  LocalOrdinal stridedBlockId = -1;
140 
141  if (A->IsView(viewLabel)) {
142  rangeMap = transposeA ? A->getColMap(viewLabel) : A->getRowMap(viewLabel);
143  domainMap = transposeA ? A->getRowMap(viewLabel) : A->getColMap(viewLabel); // will be overwritten if B != Teuchos::null
144 
145  } else {
146  rangeMap = transposeA ? A->getDomainMap() : A->getRangeMap();
147  domainMap = transposeA ? A->getRangeMap() : A->getDomainMap();
148 
149  if (viewLabel == "stridedMaps") {
150  rangeMap = Xpetra::StridedMapFactory<LocalOrdinal, GlobalOrdinal, Node>::Build(rangeMap, stridingInfo, stridedBlockId);
151  domainMap = Xpetra::StridedMapFactory<LocalOrdinal, GlobalOrdinal, Node>::Build(domainMap, stridingInfo, stridedBlockId);
152  }
153  }
154 
155  if (B != Teuchos::null) {
156  // B has strided Maps
157 
158  if (B->IsView(viewLabel)) {
159  domainMap = transposeB ? B->getRowMap(viewLabel) : B->getColMap(viewLabel);
160 
161  } else {
162  domainMap = transposeB ? B->getRangeMap() : B->getDomainMap();
163 
164  if (viewLabel == "stridedMaps")
165  domainMap = Xpetra::StridedMapFactory<LocalOrdinal, GlobalOrdinal, Node>::Build(domainMap, stridingInfo, stridedBlockId);
166  }
167  }
168 
169  if (IsView(viewLabel))
170  RemoveView(viewLabel);
171 
172  CreateView(viewLabel, rangeMap, domainMap);
173  }
174 
176  void PrintViews(Teuchos::FancyOStream &out) const {
177  int last = out.getOutputToRootOnly();
178  Teuchos::OSTab tab(out);
179  out.setOutputToRootOnly(0);
180  Teuchos::Array<viewLabel_t> viewLabels;
181  Teuchos::Array<RCP<MatrixView> > viewList;
182  operatorViewTable_.arrayify(viewLabels, viewList);
183  out << "views associated with this operator" << std::endl;
184  for (int i = 0; i < viewLabels.size(); ++i)
185  out << viewLabels[i] << std::endl;
186  out.setOutputToRootOnly(last);
187  }
188 
189  void RemoveView(const viewLabel_t viewLabel) {
190  TEUCHOS_TEST_FOR_EXCEPTION(operatorViewTable_.containsKey(viewLabel) == false, Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.RemoveView(): view '" + viewLabel + "' does not exist.");
191  TEUCHOS_TEST_FOR_EXCEPTION(viewLabel == GetDefaultViewLabel(), Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.RemoveView(): view '" + viewLabel + "' is the default view and cannot be removed.");
192  operatorViewTable_.remove(viewLabel);
193  }
194 
195  const viewLabel_t SwitchToView(const viewLabel_t viewLabel) {
196  TEUCHOS_TEST_FOR_EXCEPTION(operatorViewTable_.containsKey(viewLabel) == false, Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.SwitchToView(): view '" + viewLabel + "' does not exist.");
197  viewLabel_t oldViewLabel = GetCurrentViewLabel();
198  currentViewLabel_ = viewLabel;
199  return oldViewLabel;
200  }
201 
202  bool IsView(const viewLabel_t viewLabel) const {
203  return operatorViewTable_.containsKey(viewLabel);
204  }
205 
207 
209 
211 
213 
215 
216 
218 
229  virtual void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView<const GlobalOrdinal> &cols, const ArrayView<const Scalar> &vals) = 0;
230 
232 
239  virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView<const LocalOrdinal> &cols, const ArrayView<const Scalar> &vals) = 0;
240 
242 
247  virtual void replaceGlobalValues(GlobalOrdinal globalRow,
248  const ArrayView<const GlobalOrdinal> &cols,
249  const ArrayView<const Scalar> &vals) = 0;
250 
252 
255  virtual void replaceLocalValues(LocalOrdinal localRow,
256  const ArrayView<const LocalOrdinal> &cols,
257  const ArrayView<const Scalar> &vals) = 0;
258 
260  virtual void setAllToScalar(const Scalar &alpha) = 0;
261 
263  virtual void scale(const Scalar &alpha) = 0;
264 
266 
268 
269 
278  virtual void resumeFill(const RCP<ParameterList> &params = null) = 0;
279 
291  virtual void fillComplete(const RCP<const Map> &domainMap, const RCP<const Map> &rangeMap, const RCP<ParameterList> &params = null) = 0;
292 
306  // TODO : Get ride of "Tpetra"::OptimizeOption
307  virtual void fillComplete(const RCP<ParameterList> &params = null) = 0;
308 
310 
312 
313 
315  virtual const RCP<const Map> &getRowMap() const { return getRowMap(GetCurrentViewLabel()); }
316 
318  virtual const RCP<const Map> &getRowMap(viewLabel_t viewLabel) const {
319  TEUCHOS_TEST_FOR_EXCEPTION(operatorViewTable_.containsKey(viewLabel) == false, Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.GetRowMap(): view '" + viewLabel + "' does not exist.");
320  return operatorViewTable_.get(viewLabel)->GetRowMap();
321  }
322 
325  virtual const RCP<const Map> &getColMap() const { return getColMap(GetCurrentViewLabel()); }
326 
328  virtual const RCP<const Map> &getColMap(viewLabel_t viewLabel) const {
329  TEUCHOS_TEST_FOR_EXCEPTION(operatorViewTable_.containsKey(viewLabel) == false, Xpetra::Exceptions::RuntimeError, "Xpetra::Matrix.GetColMap(): view '" + viewLabel + "' does not exist.");
330  return operatorViewTable_.get(viewLabel)->GetColMap();
331  }
332 
334 
336  virtual global_size_t getGlobalNumRows() const = 0;
337 
339 
341  virtual global_size_t getGlobalNumCols() const = 0;
342 
344  virtual size_t getLocalNumRows() const = 0;
345 
347  virtual global_size_t getGlobalNumEntries() const = 0;
348 
350  virtual size_t getLocalNumEntries() const = 0;
351 
353 
354  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
355 
357 
358  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
359 
361 
363  virtual size_t getGlobalMaxNumRowEntries() const = 0;
364 
366 
368  virtual size_t getLocalMaxNumRowEntries() const = 0;
369 
371  virtual bool isLocallyIndexed() const = 0;
372 
374  virtual bool isGloballyIndexed() const = 0;
375 
377  virtual bool isFillComplete() const = 0;
378 
380 
392  virtual void getLocalRowCopy(LocalOrdinal LocalRow,
393  const ArrayView<LocalOrdinal> &Indices,
394  const ArrayView<Scalar> &Values,
395  size_t &NumEntries) const = 0;
396 
398 
407  virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal> &indices, ArrayView<const Scalar> &values) const = 0;
408 
410 
419  virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal> &indices, ArrayView<const Scalar> &values) const = 0;
420 
422 
425 
427  virtual typename ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const = 0;
428 
431 
434 
436  virtual bool haveGlobalConstants() const = 0;
437 
439 
441  //{@
442 
444  virtual const Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getMap() const = 0;
445 
446  // TODO: first argument of doImport/doExport should be a Xpetra::DistObject
447 
449  virtual void doImport(const Matrix &source,
451 
453  virtual void doExport(const Matrix &dest,
455 
457  virtual void doImport(const Matrix &source,
459 
461  virtual void doExport(const Matrix &dest,
463 
464  // @}
465 
467 
468 
470 
471 
473  virtual std::string description() const = 0;
474 
476  virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const = 0;
478 
480 
481  virtual void setObjectLabel(const std::string &objectLabel) = 0;
483 
484  // JG: Added:
485 
487  virtual bool hasCrsGraph() const = 0;
488 
490  virtual RCP<const CrsGraph> getCrsGraph() const = 0;
491 
492  // To keep the normal virtual matrix-multivector definition of apply before overloading with the region variant
494 
498  Teuchos::ETransp mode,
499  Scalar alpha,
500  Scalar beta,
501  bool sumInterfaceValues,
502  const RCP<Import<LocalOrdinal, GlobalOrdinal, Node> > &regionInterfaceImporter,
503  const Teuchos::ArrayRCP<LocalOrdinal> &regionInterfaceLIDs) const = 0;
504 
505  // ----------------------------------------------------------------------------------
506  // "TEMPORARY" VIEW MECHANISM
513  void SetFixedBlockSize(LocalOrdinal blksize, GlobalOrdinal offset = 0) {
514  TEUCHOS_TEST_FOR_EXCEPTION(isFillComplete() == false, Exceptions::RuntimeError, "Xpetra::Matrix::SetFixedBlockSize(): operator is not filled and completed."); // TODO: do we need this? we just wanna "copy" the domain and range map
515 
516  std::vector<size_t> stridingInfo;
517  stridingInfo.push_back(Teuchos::as<size_t>(blksize));
518  LocalOrdinal stridedBlockId = -1;
519 
520  RCP<const Xpetra::StridedMap<LocalOrdinal, GlobalOrdinal, Node> > stridedRangeMap = Xpetra::StridedMapFactory<LocalOrdinal, GlobalOrdinal, Node>::Build(
521  this->getRangeMap(),
522  stridingInfo,
523  stridedBlockId,
524  offset);
526  this->getDomainMap(),
527  stridingInfo,
528  stridedBlockId,
529  offset);
530 
531  if (IsFixedBlockSizeSet()) RemoveView("stridedMaps");
532  CreateView("stridedMaps", stridedRangeMap, stridedDomainMap);
533  }
534 
535  //==========================================================================
536 
537  LocalOrdinal GetFixedBlockSize() const {
538  if (IsFixedBlockSizeSet()) {
539  Teuchos::RCP<const StridedMap<LocalOrdinal, GlobalOrdinal, Node> > rangeMap = Teuchos::rcp_dynamic_cast<const StridedMap<LocalOrdinal, GlobalOrdinal, Node> >(getRowMap("stridedMaps"));
540  Teuchos::RCP<const StridedMap<LocalOrdinal, GlobalOrdinal, Node> > domainMap = Teuchos::rcp_dynamic_cast<const StridedMap<LocalOrdinal, GlobalOrdinal, Node> >(getColMap("stridedMaps"));
541  TEUCHOS_TEST_FOR_EXCEPTION(rangeMap == Teuchos::null, Exceptions::BadCast, "Xpetra::Matrix::GetFixedBlockSize(): rangeMap is not of type StridedMap");
542  TEUCHOS_TEST_FOR_EXCEPTION(domainMap == Teuchos::null, Exceptions::BadCast, "Xpetra::Matrix::GetFixedBlockSize(): domainMap is not of type StridedMap");
543  TEUCHOS_TEST_FOR_EXCEPTION(domainMap->getFixedBlockSize() != rangeMap->getFixedBlockSize(), Exceptions::RuntimeError, "Xpetra::Matrix::GetFixedBlockSize(): block size of rangeMap and domainMap are different.");
544  return Teuchos::as<LocalOrdinal>(domainMap->getFixedBlockSize()); // TODO: why LocalOrdinal?
545  } else
546  // TEUCHOS_TEST_FOR_EXCEPTION(false, Exceptions::RuntimeError, "Xpetra::Matrix::GetFixedBlockSize(): no strided maps available."); // TODO remove this
547  return 1;
548  }; // TODO: why LocalOrdinal?
549 
551  bool IsFixedBlockSizeSet() const {
552  return IsView("stridedMaps");
553  };
554 
556  virtual LocalOrdinal GetStorageBlockSize() const = 0;
557 
558  // ----------------------------------------------------------------------------------
559 
560  virtual void SetMaxEigenvalueEstimate(Scalar const &sigma) {
561  operatorViewTable_.get(GetCurrentViewLabel())->SetMaxEigenvalueEstimate(sigma);
562  }
563 
564  // ----------------------------------------------------------------------------------
565 
566  virtual Scalar GetMaxEigenvalueEstimate() const {
567  return operatorViewTable_.get(GetCurrentViewLabel())->GetMaxEigenvalueEstimate();
568  }
569 
570  // ----------------------------------------------------------------------------------
571 #ifdef HAVE_XPETRA_TPETRA
572  virtual local_matrix_type getLocalMatrixDevice() const = 0;
573  virtual typename local_matrix_type::HostMirror getLocalMatrixHost() const = 0;
574 #else
575 #ifdef __GNUC__
576 #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."
577 #endif
578 #endif
579  // ----------------------------------------------------------------------------------
580 
585 
586  protected:
587  Teuchos::Hashtable<viewLabel_t, RCP<MatrixView> > operatorViewTable_; // hashtable storing the operator views (keys = view names, values = views).
588 
589  viewLabel_t defaultViewLabel_; // label of the view associated with inital Matrix construction
590  viewLabel_t currentViewLabel_; // label of the current view
591 
592 }; // class Matrix
593 
594 } // namespace Xpetra
595 
596 #define XPETRA_MATRIX_SHORT
597 #endif // XPETRA_MATRIX_DECL_HPP
virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using local IDs.
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in this matrix.
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
Extract a const, non-persisting view of global indices in a specified row of the matrix.
void RemoveView(const viewLabel_t viewLabel)
virtual global_size_t getGlobalNumCols() const =0
Returns the number of global columns in the matrix.
LocalOrdinal local_ordinal_type
virtual ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const =0
Get Frobenius norm of the matrix.
virtual void resumeFill(const RCP< ParameterList > &params=null)=0
virtual LocalOrdinal GetStorageBlockSize() const =0
Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatri...
Exception throws to report errors in the internal logical of the program.
virtual size_t getGlobalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on all nodes.
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > operatorViewTable_
virtual const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const =0
Implements DistObject interface.
virtual bool isGloballyIndexed() const =0
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
virtual void doExport(const Matrix &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
Export.
virtual const RCP< const Map > & getColMap() const
Returns the Map that describes the column distribution in this matrix. This might be null until fillC...
Exception indicating invalid cast attempted.
virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &regionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > &regionInterfaceLIDs) const =0
Computes the matrix-multivector multiplication for region layout matrices.
virtual void SetMaxEigenvalueEstimate(Scalar const &sigma)
virtual void fillComplete(const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< ParameterList > &params=null)=0
Signal that data entry is complete, specifying domain and range maps.
Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrix
virtual void setObjectLabel(const std::string &objectLabel)=0
virtual ~Matrix()
Destructor.
virtual void getLocalDiagCopy(Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const =0
Get a copy of the diagonal entries owned by this node, with local row indices.
virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
Extract a const, non-persisting view of local indices in a specified row of the matrix.
virtual void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const =0
Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calli...
viewLabel_t defaultViewLabel_
virtual void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using global IDs.
void SetFixedBlockSize(LocalOrdinal blksize, GlobalOrdinal offset=0)
virtual bool haveGlobalConstants() const =0
Returns true if globalConstants have been computed; false otherwise.
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries in the specified global row.
virtual void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Right scale matrix using the given vector entries.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print the object with some verbosity level to an FancyOStream object.
bool IsView(const viewLabel_t viewLabel) const
const viewLabel_t & GetCurrentViewLabel() const
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Map
virtual size_t getLocalNumEntries() const =0
Returns the local number of entries in this matrix.
virtual bool isFillComplete() const =0
Returns true if fillComplete() has been called and the matrix is in compute mode. ...
void CreateView(viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap)
virtual void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using local IDs.
virtual const RCP< const Map > & getColMap(viewLabel_t viewLabel) const
Returns the Map that describes the column distribution in this matrix.
viewLabel_t currentViewLabel_
const viewLabel_t SwitchToDefaultView()
virtual void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Left scale matrix using the given vector entries.
virtual const Teuchos::RCP< const map_type > getRangeMap() const =0
The Map associated with the range of this operator, which must be compatible with Y...
void PrintViews(Teuchos::FancyOStream &out) const
Print all of the views associated with the Matrix.
LocalOrdinal GetFixedBlockSize() const
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
std::string viewLabel_t
Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > CrsGraph
size_t global_size_t
Global size_t object.
virtual size_t getLocalNumRows() const =0
Returns the number of matrix rows owned on the calling node.
virtual void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using global IDs.
virtual void doImport(const Matrix &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
Import.
virtual RCP< const CrsGraph > getCrsGraph() const =0
Returns the CrsGraph associated with this matrix.
CrsMatrix::local_matrix_type local_matrix_type
virtual std::string description() const =0
Return a simple one-line description of this object.
virtual bool isLocallyIndexed() const =0
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
virtual Scalar GetMaxEigenvalueEstimate() const
virtual local_matrix_type::HostMirror getLocalMatrixHost() const =0
bool IsFixedBlockSizeSet() const
Returns true, if SetFixedBlockSize has been called before.
virtual void residual(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const =0
Compute a residual R = B - (*this) * X.
virtual global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in this matrix.
virtual const Teuchos::RCP< const map_type > getDomainMap() const =0
The Map associated with the domain of this operator, which must be compatible with X...
virtual size_t getLocalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
CombineMode
Xpetra::Combine Mode enumerable type.
static RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Build(UnderlyingLib lib, global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=Xpetra::GloballyDistributed)
Map constructor with Xpetra-defined contiguous uniform distribution.
virtual const RCP< const Map > & getRowMap() const
Returns the Map that describes the row distribution in this matrix.
void CreateView(const viewLabel_t viewLabel, const RCP< const Matrix > &A, bool transposeA=false, const RCP< const Matrix > &B=Teuchos::null, bool transposeB=false)
virtual void scale(const Scalar &alpha)=0
Scale the current values of a matrix, this = alpha*this.
const viewLabel_t & GetDefaultViewLabel() const
Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node > MatrixView
virtual const RCP< const Map > & getRowMap(viewLabel_t viewLabel) const
Returns the Map that describes the row distribution in this matrix.
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...
virtual void setAllToScalar(const Scalar &alpha)=0
Set all matrix entries equal to scalar.
Xpetra::CrsMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrixFactory
virtual local_matrix_type getLocalMatrixDevice() const =0
Xpetra-specific matrix class.
Class that stores a strided map.
const viewLabel_t SwitchToView(const viewLabel_t viewLabel)
virtual bool hasCrsGraph() const =0
Supports the getCrsGraph() call.
GlobalOrdinal global_ordinal_type