Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_CrsMatrix_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Tpetra: Templated Linear Algebra Services Package
4 //
5 // Copyright 2008 NTESS and the Tpetra contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 // clang-format off
11 #ifndef TPETRA_CRSMATRIX_DECL_HPP
12 #define TPETRA_CRSMATRIX_DECL_HPP
13 
16 
17 #include "Tpetra_CrsMatrix_fwd.hpp"
18 #include "TpetraExt_MatrixMatrix_fwd.hpp"
19 #include "KokkosSparse_Utils.hpp"
20 #include "KokkosSparse_CrsMatrix.hpp"
21 #include "Tpetra_Details_MatrixApplyHelper.hpp"
22 #include "Tpetra_RowMatrix_decl.hpp"
23 #include "Tpetra_Exceptions.hpp"
24 #include "Tpetra_DistObject.hpp"
25 #include "Tpetra_CrsGraph.hpp"
26 #include "Tpetra_Vector.hpp"
27 #include "Tpetra_Details_PackTraits.hpp" // unused here, could delete
28 #include "Tpetra_Details_ExecutionSpacesUser.hpp"
29 #include "Teuchos_DataAccess.hpp"
30 
31 
32 #include <memory> // std::shared_ptr
33 
34 namespace Tpetra {
35 
36  // Forward declaration for CrsMatrix::swap() test
37  template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node> class crsMatrix_Swap_Tester;
38 
90  template<class CrsMatrixType>
91  Teuchos::RCP<CrsMatrixType>
92  importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
93  const Import<typename CrsMatrixType::local_ordinal_type,
94  typename CrsMatrixType::global_ordinal_type,
95  typename CrsMatrixType::node_type>& importer,
96  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
97  typename CrsMatrixType::global_ordinal_type,
98  typename CrsMatrixType::node_type> >& domainMap = Teuchos::null,
99  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
100  typename CrsMatrixType::global_ordinal_type,
101  typename CrsMatrixType::node_type> >& rangeMap = Teuchos::null,
102  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
103 
157  template<class CrsMatrixType>
158  Teuchos::RCP<CrsMatrixType>
159  importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
160  const Import<typename CrsMatrixType::local_ordinal_type,
161  typename CrsMatrixType::global_ordinal_type,
162  typename CrsMatrixType::node_type>& rowImporter,
163  const Import<typename CrsMatrixType::local_ordinal_type,
164  typename CrsMatrixType::global_ordinal_type,
165  typename CrsMatrixType::node_type>& domainImporter,
166  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
167  typename CrsMatrixType::global_ordinal_type,
168  typename CrsMatrixType::node_type> >& domainMap,
169  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
170  typename CrsMatrixType::global_ordinal_type,
171  typename CrsMatrixType::node_type> >& rangeMap,
172  const Teuchos::RCP<Teuchos::ParameterList>& params);
173 
207  template<class CrsMatrixType>
208  Teuchos::RCP<CrsMatrixType>
209  exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
210  const Export<typename CrsMatrixType::local_ordinal_type,
211  typename CrsMatrixType::global_ordinal_type,
212  typename CrsMatrixType::node_type>& exporter,
213  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
214  typename CrsMatrixType::global_ordinal_type,
215  typename CrsMatrixType::node_type> >& domainMap = Teuchos::null,
216  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
217  typename CrsMatrixType::global_ordinal_type,
218  typename CrsMatrixType::node_type> >& rangeMap = Teuchos::null,
219  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
220 
254  template<class CrsMatrixType>
255  Teuchos::RCP<CrsMatrixType>
256  exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
257  const Export<typename CrsMatrixType::local_ordinal_type,
258  typename CrsMatrixType::global_ordinal_type,
259  typename CrsMatrixType::node_type>& rowExporter,
260  const Export<typename CrsMatrixType::local_ordinal_type,
261  typename CrsMatrixType::global_ordinal_type,
262  typename CrsMatrixType::node_type>& domainExporter,
263  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
264  typename CrsMatrixType::global_ordinal_type,
265  typename CrsMatrixType::node_type> >& domainMap,
266  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
267  typename CrsMatrixType::global_ordinal_type,
268  typename CrsMatrixType::node_type> >& rangeMap,
269  const Teuchos::RCP<Teuchos::ParameterList>& params);
270 
273  namespace Details {
274  template<class SC, class LO, class GO, class NO>
275  void residual(const Operator<SC,LO,GO,NO> & A,
276  const MultiVector<SC,LO,GO,NO> & X,
277  const MultiVector<SC,LO,GO,NO> & B,
278  MultiVector<SC,LO,GO,NO> & R);
279  }
280 
394  template <class Scalar,
395  class LocalOrdinal,
396  class GlobalOrdinal,
397  class Node>
398  class CrsMatrix :
399  public RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
400  public DistObject<char, LocalOrdinal, GlobalOrdinal, Node>,
401  public Details::Spaces::User
402  {
403  // clang-format on
404 private:
405  using dist_object_type =
406  DistObject<char, LocalOrdinal, GlobalOrdinal,
407  Node>;
408  // clang-format off
410 
411  public:
413 
414 
416  using scalar_type = Scalar;
418  using local_ordinal_type = LocalOrdinal;
420  using global_ordinal_type = GlobalOrdinal;
422  using device_type = typename Node::device_type;
424  using execution_space = typename device_type::execution_space;
426  using memory_space = typename device_type::memory_space;
427 
432  using node_type = Node;
433 
435  using map_type = Map<LocalOrdinal, GlobalOrdinal, Node>;
436 
438  using import_type = Import<LocalOrdinal, GlobalOrdinal, Node>;
439 
441  using export_type = Export<LocalOrdinal, GlobalOrdinal, Node>;
442 
444  using row_matrix_type = RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
445 
455  using impl_scalar_type = typename row_matrix_type::impl_scalar_type;
461  using mag_type = typename Kokkos::ArithTraits<impl_scalar_type>::mag_type;
462 
464  using crs_graph_type = CrsGraph<LocalOrdinal, GlobalOrdinal, Node>;
465 
467  using local_graph_device_type = typename crs_graph_type::local_graph_device_type;
468  using local_graph_host_type = typename crs_graph_type::local_graph_host_type;
469 
472  using local_matrix_device_type =
473  KokkosSparse::CrsMatrix<impl_scalar_type,
474  local_ordinal_type,
475  device_type,
476  void,
477  typename local_graph_device_type::size_type>;
478 #if KOKKOS_VERSION >= 40799
479  using local_matrix_host_type =
480  typename local_matrix_device_type::host_mirror_type;
481 #else
482  using local_matrix_host_type =
483  typename local_matrix_device_type::HostMirror;
484 #endif
485 
486  using row_ptrs_device_view_type =
487  typename row_matrix_type::row_ptrs_device_view_type;
488  using row_ptrs_host_view_type =
489  typename row_matrix_type::row_ptrs_host_view_type;
490 
491 
492  using local_inds_device_view_type =
493  typename row_matrix_type::local_inds_device_view_type;
494  using local_inds_host_view_type =
495  typename row_matrix_type::local_inds_host_view_type;
496  using nonconst_local_inds_host_view_type =
497  typename row_matrix_type::nonconst_local_inds_host_view_type;
498 
499  using global_inds_device_view_type =
500  typename row_matrix_type::global_inds_device_view_type;
501  using global_inds_host_view_type =
502  typename row_matrix_type::global_inds_host_view_type;
503  using nonconst_global_inds_host_view_type =
504  typename row_matrix_type::nonconst_global_inds_host_view_type;
505 
506  using values_device_view_type =
507  typename row_matrix_type::values_device_view_type;
508  using values_host_view_type =
509  typename row_matrix_type::values_host_view_type;
510  using nonconst_values_host_view_type =
511  typename row_matrix_type::nonconst_values_host_view_type;
512 
514 
516 
518  CrsMatrix (const CrsMatrix<Scalar, LocalOrdinal,
519  GlobalOrdinal, Node>&) = default;
520 
522  CrsMatrix (CrsMatrix<Scalar, LocalOrdinal,
523  GlobalOrdinal, Node>&&) = default;
524 
526  CrsMatrix&
527  operator= (const CrsMatrix<Scalar, LocalOrdinal,
528  GlobalOrdinal, Node>&) = default;
529 
531  CrsMatrix&
532  operator= (CrsMatrix<Scalar, LocalOrdinal,
533  GlobalOrdinal, Node>&&) = default;
534 
548  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
549  const size_t maxNumEntriesPerRow,
550  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
551 
564  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
565  const Teuchos::ArrayView<const size_t>& numEntPerRowToAlloc,
566  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
567 
568 
587  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
588  const Teuchos::RCP<const map_type>& colMap,
589  const size_t maxNumEntPerRow,
590  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
591 
610  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
611  const Teuchos::RCP<const map_type>& colMap,
612  const Teuchos::ArrayView<const size_t>& numEntPerRowToAlloc,
613  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
614 
643  explicit CrsMatrix (CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& matrix,
644  const Teuchos::RCP<const crs_graph_type>& graph,
645  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
646 
671  explicit CrsMatrix (const Teuchos::RCP<const crs_graph_type>& graph,
672  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
673 
702  explicit CrsMatrix (const Teuchos::RCP<const crs_graph_type>& graph,
703  const typename local_matrix_device_type::values_type& values,
704  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
705 
732  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
733  const Teuchos::RCP<const map_type>& colMap,
734  const typename local_graph_device_type::row_map_type& rowPointers,
735  const typename local_graph_device_type::entries_type::non_const_type& columnIndices,
736  const typename local_matrix_device_type::values_type& values,
737  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
738 
765  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
766  const Teuchos::RCP<const map_type>& colMap,
767  const Teuchos::ArrayRCP<size_t>& rowPointers,
768  const Teuchos::ArrayRCP<LocalOrdinal>& columnIndices,
769  const Teuchos::ArrayRCP<Scalar>& values,
770  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
771 
793  CrsMatrix (const Teuchos::RCP<const map_type>& rowMap,
794  const Teuchos::RCP<const map_type>& colMap,
795  const local_matrix_device_type& lclMatrix,
796  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
797 
828  CrsMatrix (const local_matrix_device_type& lclMatrix,
829  const Teuchos::RCP<const map_type>& rowMap,
830  const Teuchos::RCP<const map_type>& colMap,
831  const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
832  const Teuchos::RCP<const map_type>& rangeMap = Teuchos::null,
833  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
834 
839  CrsMatrix (const local_matrix_device_type& lclMatrix,
840  const Teuchos::RCP<const map_type>& rowMap,
841  const Teuchos::RCP<const map_type>& colMap,
842  const Teuchos::RCP<const map_type>& domainMap,
843  const Teuchos::RCP<const map_type>& rangeMap,
844  const Teuchos::RCP<const import_type>& importer,
845  const Teuchos::RCP<const export_type>& exporter,
846  const Teuchos::RCP<Teuchos::ParameterList>& params =
847  Teuchos::null);
848 
850  // This function in 'Copy' mode is only guaranteed to work correctly for matrices
851  // which are fillComplete.
852  CrsMatrix (const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& source,
853  const Teuchos::DataAccess copyOrView);
854 
864  virtual ~CrsMatrix () = default;
865 
866  // This friend declaration makes the clone() method work.
867  template <class S2, class LO2, class GO2, class N2>
868  friend class CrsMatrix;
869 
870  // This friend declaration allows for fused residual calculation
871  template <class S2, class LO2, class GO2, class N2>
872  friend void Details::residual(const Operator<S2,LO2,GO2,N2> & A,
873  const MultiVector<S2,LO2,GO2,N2> & X,
874  const MultiVector<S2,LO2,GO2,N2> & B,
875  MultiVector<S2,LO2,GO2,N2> & R);
876 
877  // This friend declaration allows for batching of apply calls
878  template <class MatrixArray, class MultiVectorArray>
879  friend void batchedApply(const MatrixArray &Matrices,
880  const typename std::remove_pointer<typename MultiVectorArray::value_type>::type & X,
881  MultiVectorArray &Y,
882  typename std::remove_pointer<typename MatrixArray::value_type>::type::scalar_type alpha,
883  typename std::remove_pointer<typename MatrixArray::value_type>::type::scalar_type beta,
884  Teuchos::RCP<Teuchos::ParameterList> params);
885 
886  public:
888 
890 
914  //
956  void
957  insertGlobalValues (const GlobalOrdinal globalRow,
958  const Teuchos::ArrayView<const GlobalOrdinal>& cols,
959  const Teuchos::ArrayView<const Scalar>& vals);
960 
975  void
976  insertGlobalValues (const GlobalOrdinal globalRow,
977  const LocalOrdinal numEnt,
978  const Scalar vals[],
979  const GlobalOrdinal inds[]);
980 
1023  void
1024  insertLocalValues (const LocalOrdinal localRow,
1025  const Teuchos::ArrayView<const LocalOrdinal> &cols,
1026  const Teuchos::ArrayView<const Scalar> &vals,
1027  const CombineMode CM=ADD);
1028 
1048  void
1049  insertLocalValues (const LocalOrdinal localRow,
1050  const LocalOrdinal numEnt,
1051  const Scalar vals[],
1052  const LocalOrdinal cols[],
1053  const CombineMode CM=ADD);
1054 
1055  protected:
1066  virtual LocalOrdinal
1067  replaceGlobalValuesImpl (impl_scalar_type rowVals[],
1068  const crs_graph_type& graph,
1069  const RowInfo& rowInfo,
1070  const GlobalOrdinal inds[],
1071  const impl_scalar_type newVals[],
1072  const LocalOrdinal numElts);
1073 
1074  public:
1111  local_ordinal_type
1112  replaceGlobalValues(
1113  const global_ordinal_type globalRow,
1114  const Kokkos::View<const global_ordinal_type*, Kokkos::AnonymousSpace>& inputInds,
1115  const Kokkos::View<const impl_scalar_type*, Kokkos::AnonymousSpace>& inputVals);
1116 
1119  LocalOrdinal
1120  replaceGlobalValues (const GlobalOrdinal globalRow,
1121  const Teuchos::ArrayView<const GlobalOrdinal>& cols,
1122  const Teuchos::ArrayView<const Scalar>& vals);
1123 
1138  LocalOrdinal
1139  replaceGlobalValues (const GlobalOrdinal globalRow,
1140  const LocalOrdinal numEnt,
1141  const Scalar vals[],
1142  const GlobalOrdinal cols[]);
1143 
1144  protected:
1155  virtual LocalOrdinal
1156  replaceLocalValuesImpl (impl_scalar_type rowVals[],
1157  const crs_graph_type& graph,
1158  const RowInfo& rowInfo,
1159  const LocalOrdinal inds[],
1160  const impl_scalar_type newVals[],
1161  const LocalOrdinal numElts);
1162 
1163  public:
1199  local_ordinal_type
1200  replaceLocalValues(
1201  const local_ordinal_type localRow,
1202  const Kokkos::View<const local_ordinal_type*, Kokkos::AnonymousSpace>& inputInds,
1203  const Kokkos::View<const impl_scalar_type*, Kokkos::AnonymousSpace>& inputVals);
1204 
1208  LocalOrdinal
1209  replaceLocalValues (const LocalOrdinal localRow,
1210  const Teuchos::ArrayView<const LocalOrdinal>& cols,
1211  const Teuchos::ArrayView<const Scalar>& vals);
1212 
1230  LocalOrdinal
1231  replaceLocalValues (const LocalOrdinal localRow,
1232  const LocalOrdinal numEnt,
1233  const Scalar inputVals[],
1234  const LocalOrdinal inputCols[]);
1235 
1236  private:
1241  static const bool useAtomicUpdatesByDefault =
1242 #ifdef KOKKOS_ENABLE_SERIAL
1243  ! std::is_same<execution_space, Kokkos::Serial>::value;
1244 #else
1245  true;
1246 #endif // KOKKOS_ENABLE_SERIAL
1247 
1271  protected:
1272  virtual LocalOrdinal
1273  sumIntoGlobalValuesImpl (impl_scalar_type rowVals[],
1274  const crs_graph_type& graph,
1275  const RowInfo& rowInfo,
1276  const GlobalOrdinal inds[],
1277  const impl_scalar_type newVals[],
1278  const LocalOrdinal numElts,
1279  const bool atomic = useAtomicUpdatesByDefault);
1280 
1281  public:
1318  LocalOrdinal
1319  sumIntoGlobalValues (const GlobalOrdinal globalRow,
1320  const Teuchos::ArrayView<const GlobalOrdinal>& cols,
1321  const Teuchos::ArrayView<const Scalar>& vals,
1322  const bool atomic = useAtomicUpdatesByDefault);
1323 
1346  LocalOrdinal
1347  sumIntoGlobalValues (const GlobalOrdinal globalRow,
1348  const LocalOrdinal numEnt,
1349  const Scalar vals[],
1350  const GlobalOrdinal cols[],
1351  const bool atomic = useAtomicUpdatesByDefault);
1352 
1353  protected:
1366  virtual LocalOrdinal
1367  sumIntoLocalValuesImpl (impl_scalar_type rowVals[],
1368  const crs_graph_type& graph,
1369  const RowInfo& rowInfo,
1370  const LocalOrdinal inds[],
1371  const impl_scalar_type newVals[],
1372  const LocalOrdinal numElts,
1373  const bool atomic = useAtomicUpdatesByDefault);
1374 
1375  public:
1412  local_ordinal_type
1413  sumIntoLocalValues(
1414  const local_ordinal_type localRow,
1415  const Kokkos::View<const local_ordinal_type*, Kokkos::AnonymousSpace>& inputInds,
1416  const Kokkos::View<const impl_scalar_type*, Kokkos::AnonymousSpace>& inputVals,
1417  const bool atomic = useAtomicUpdatesByDefault);
1418 
1448  LocalOrdinal
1449  sumIntoLocalValues (const LocalOrdinal localRow,
1450  const Teuchos::ArrayView<const LocalOrdinal>& cols,
1451  const Teuchos::ArrayView<const Scalar>& vals,
1452  const bool atomic = useAtomicUpdatesByDefault);
1453 
1475  LocalOrdinal
1476  sumIntoLocalValues (const LocalOrdinal localRow,
1477  const LocalOrdinal numEnt,
1478  const Scalar vals[],
1479  const LocalOrdinal cols[],
1480  const bool atomic = useAtomicUpdatesByDefault);
1481 
1482  private:
1513  LocalOrdinal
1514  transformLocalValues (impl_scalar_type rowVals[],
1515  const crs_graph_type& graph,
1516  const RowInfo& rowInfo,
1517  const LocalOrdinal inds[],
1518  const impl_scalar_type newVals[],
1519  const LocalOrdinal numElts,
1520  std::function<impl_scalar_type (const impl_scalar_type&, const impl_scalar_type&) > f,
1521  const bool atomic = useAtomicUpdatesByDefault);
1522 
1553  LocalOrdinal
1554  transformGlobalValues (impl_scalar_type rowVals[],
1555  const crs_graph_type& graph,
1556  const RowInfo& rowInfo,
1557  const GlobalOrdinal inds[],
1558  const impl_scalar_type newVals[],
1559  const LocalOrdinal numElts,
1560  std::function<impl_scalar_type (const impl_scalar_type&, const impl_scalar_type&) > f,
1561  const bool atomic = useAtomicUpdatesByDefault);
1562 
1589  LocalOrdinal
1590  transformLocalValues (const LocalOrdinal lclRow,
1591  const LocalOrdinal numInputEnt,
1592  const impl_scalar_type inputVals[],
1593  const LocalOrdinal inputCols[],
1594  std::function<impl_scalar_type (const impl_scalar_type&, const impl_scalar_type&) > f,
1595  const bool atomic = useAtomicUpdatesByDefault);
1596 
1623  LocalOrdinal
1624  transformGlobalValues (const GlobalOrdinal gblRow,
1625  const LocalOrdinal numInputEnt,
1626  const impl_scalar_type inputVals[],
1627  const GlobalOrdinal inputCols[],
1628  std::function<impl_scalar_type (const impl_scalar_type&, const impl_scalar_type&) > f,
1629  const bool atomic = useAtomicUpdatesByDefault);
1630 
1631  public:
1675  template<class LocalIndicesViewType,
1676  class ImplScalarViewType,
1677  class BinaryFunction>
1678  LocalOrdinal
1679  transformLocalValues (const LocalOrdinal lclRow,
1680  const typename UnmanagedView<LocalIndicesViewType>::type& inputInds,
1681  const typename UnmanagedView<ImplScalarViewType>::type& inputVals,
1682  BinaryFunction f,
1683  const bool atomic = useAtomicUpdatesByDefault)
1684  {
1685  // We use static_assert here to check the template parameters,
1686  // rather than std::enable_if (e.g., on the return value, to
1687  // enable compilation only if the template parameters match the
1688  // desired attributes). This turns obscure link errors into
1689  // clear compilation errors. It also makes the return value a
1690  // lot easier to see.
1691  static_assert (Kokkos::is_view<LocalIndicesViewType>::value,
1692  "First template parameter LocalIndicesViewType must be "
1693  "a Kokkos::View.");
1694  static_assert (Kokkos::is_view<ImplScalarViewType>::value,
1695  "Second template parameter ImplScalarViewType must be a "
1696  "Kokkos::View.");
1697  static_assert (static_cast<int> (LocalIndicesViewType::rank) == 1,
1698  "First template parameter LocalIndicesViewType must "
1699  "have rank 1.");
1700  static_assert (static_cast<int> (ImplScalarViewType::rank) == 1,
1701  "Second template parameter ImplScalarViewType must have "
1702  "rank 1.");
1703  static_assert (std::is_same<
1704  typename LocalIndicesViewType::non_const_value_type,
1705  local_ordinal_type>::value,
1706  "First template parameter LocalIndicesViewType must "
1707  "contain values of type local_ordinal_type.");
1708  static_assert (std::is_same<
1709  typename ImplScalarViewType::non_const_value_type,
1710  impl_scalar_type>::value,
1711  "Second template parameter ImplScalarViewType must "
1712  "contain values of type impl_scalar_type.");
1713  typedef LocalOrdinal LO;
1714  const LO numInputEnt = inputInds.extent (0);
1715  if (static_cast<LO> (inputVals.extent (0)) != numInputEnt) {
1716  return Teuchos::OrdinalTraits<LO>::invalid ();
1717  }
1718  return this->transformLocalValues (lclRow,
1719  numInputEnt,
1720  inputVals.data (),
1721  inputInds.data (),
1722  f,
1723  atomic);
1724  }
1725 
1767  template<class BinaryFunction, class InputMemorySpace>
1768  LocalOrdinal
1769  transformGlobalValues (const GlobalOrdinal gblRow,
1770  const Kokkos::View<const GlobalOrdinal*,
1771  InputMemorySpace,
1772  Kokkos::MemoryUnmanaged>& inputInds,
1773  const Kokkos::View<const impl_scalar_type*,
1774  InputMemorySpace,
1775  Kokkos::MemoryUnmanaged>& inputVals,
1776  BinaryFunction f,
1777  const bool atomic = useAtomicUpdatesByDefault)
1778  {
1779  typedef LocalOrdinal LO;
1780  const LO numInputEnt = inputInds.extent (0);
1781  if (static_cast<LO> (inputVals.extent (0)) != numInputEnt) {
1782  return Teuchos::OrdinalTraits<LO>::invalid ();
1783  }
1784  return this->transformGlobalValues (gblRow,
1785  numInputEnt,
1786  inputVals.data (),
1787  inputInds.data (),
1788  f,
1789  atomic);
1790  }
1791 
1793  void setAllToScalar (const Scalar& alpha);
1794 
1796  void scale (const Scalar& alpha);
1797 
1822  void
1823  setAllValues (const typename local_graph_device_type::row_map_type& ptr,
1824  const typename local_graph_device_type::entries_type::non_const_type& ind,
1825  const typename local_matrix_device_type::values_type& val);
1826 
1847  void
1848  setAllValues (const local_matrix_device_type& localMatrix);
1849 
1874  void
1875  setAllValues (const Teuchos::ArrayRCP<size_t>& ptr,
1876  const Teuchos::ArrayRCP<LocalOrdinal>& ind,
1877  const Teuchos::ArrayRCP<Scalar>& val);
1878 
1880  row_ptrs_host_view_type getLocalRowPtrsHost () const
1881  { return getCrsGraph()->getLocalRowPtrsHost(); }
1882 
1884  row_ptrs_device_view_type getLocalRowPtrsDevice () const
1885  { return getCrsGraph()->getLocalRowPtrsDevice(); }
1886 
1888  local_inds_host_view_type getLocalIndicesHost () const
1889  { return getCrsGraph()->getLocalIndicesHost(); }
1890 
1892  local_inds_device_view_type getLocalIndicesDevice () const
1893  { return getCrsGraph()->getLocalIndicesDevice(); }
1894 
1896 
1898 
1927  void globalAssemble();
1928 
1942  void resumeFill (const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
1943 
2001  void
2002  fillComplete (const Teuchos::RCP<const map_type>& domainMap,
2003  const Teuchos::RCP<const map_type>& rangeMap,
2004  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
2005 
2032  void
2033  fillComplete (const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
2034 
2061  void
2062  expertStaticFillComplete (const Teuchos::RCP<const map_type>& domainMap,
2063  const Teuchos::RCP<const map_type>& rangeMap,
2064  const Teuchos::RCP<const import_type>& importer = Teuchos::null,
2065  const Teuchos::RCP<const export_type>& exporter = Teuchos::null,
2066  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
2067 
2085  void
2086  replaceColMap (const Teuchos::RCP<const map_type>& newColMap);
2087 
2169  void
2170  reindexColumns (crs_graph_type* const graph,
2171  const Teuchos::RCP<const map_type>& newColMap,
2172  const Teuchos::RCP<const import_type>& newImport = Teuchos::null,
2173  const bool sortEachRow = true);
2174 
2184  void
2185  replaceDomainMap (const Teuchos::RCP<const map_type>& newDomainMap);
2186 
2200  void
2201  replaceDomainMapAndImporter (const Teuchos::RCP<const map_type>& newDomainMap,
2202  Teuchos::RCP<const import_type>& newImporter);
2203 
2213  void
2214  replaceRangeMap (const Teuchos::RCP<const map_type>& newRangeMap);
2215 
2229  void
2230  replaceRangeMapAndExporter (const Teuchos::RCP<const map_type>& newRangeMap,
2231  Teuchos::RCP<const export_type>& newExporter);
2232 
2246  virtual void
2247  removeEmptyProcessesInPlace (const Teuchos::RCP<const map_type>& newMap) override;
2248 
2250 
2252 
2254  Teuchos::RCP<const Teuchos::Comm<int> > getComm() const override;
2255 
2256 
2258  Teuchos::RCP<const map_type> getRowMap () const override;
2259 
2261  Teuchos::RCP<const map_type> getColMap () const override;
2262 
2264  Teuchos::RCP<const RowGraph<LocalOrdinal, GlobalOrdinal, Node> >
2265  getGraph () const override;
2266 
2268  Teuchos::RCP<const crs_graph_type> getCrsGraph () const;
2269 
2270  private:
2281  const crs_graph_type& getCrsGraphRef () const;
2282 
2283  public:
2284 #if __armclang_major__ == 22 && __armclang_minor__ == 1
2285  // On Stria, PR 13052 caused a 25% performance regression in the
2286  // CGSolve performance test that is fixed by forcing
2287  // getLocalMatrixDevice to always be inlined. Restrict the fix
2288  // to the specific toolchain where the problem was observed
2289 #define TPETRA_DETAILS_ALWAYS_INLINE __attribute__((always_inline))
2290 #else
2291 #define TPETRA_DETAILS_ALWAYS_INLINE
2292 #endif
2293  TPETRA_DETAILS_ALWAYS_INLINE local_matrix_device_type
2306  getLocalMatrixDevice () const;
2307  local_matrix_host_type getLocalMatrixHost () const;
2308 #undef TPETRA_DETAILS_ALWAYS_INLINE
2309 
2329  global_size_t getGlobalNumRows() const override;
2330 
2336  global_size_t getGlobalNumCols() const override;
2337 
2344  size_t getLocalNumRows() const override;
2345 
2349  size_t getLocalNumCols() const override;
2350 
2352  GlobalOrdinal getIndexBase() const override;
2353 
2355  global_size_t getGlobalNumEntries() const override;
2356 
2358  size_t getLocalNumEntries() const override;
2359 
2366  size_t getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const override;
2367 
2374  size_t getNumEntriesInLocalRow (local_ordinal_type localRow) const override;
2375 
2383  size_t getGlobalMaxNumRowEntries () const override;
2384 
2392  size_t getLocalMaxNumRowEntries () const override;
2393 
2395  virtual LocalOrdinal getBlockSize () const override { return 1; }
2396 
2398  bool hasColMap () const override;
2399 
2400 
2421  bool isLocallyIndexed() const override;
2422 
2443  bool isGloballyIndexed() const override;
2444 
2467  bool isFillComplete() const override;
2468 
2491  bool isFillActive() const;
2492 
2494 
2500  bool isStorageOptimized () const;
2501 
2503  bool isStaticGraph () const;
2504 
2512  mag_type getNormInf () const;
2513 
2517  //
2523  mag_type getNorm1 (bool assumeSymmetric = false) const;
2524 
2532  mag_type getFrobeniusNorm () const override;
2533 
2536  virtual bool supportsRowViews () const override;
2537 
2538 protected:
2539  using values_dualv_type =
2540  Kokkos::DualView<impl_scalar_type*, device_type>;
2541  using values_wdv_type =
2542  Details::WrappedDualView<values_dualv_type>;
2543  values_wdv_type valuesUnpacked_wdv;
2544  mutable values_wdv_type valuesPacked_wdv;
2545 
2546 public:
2547 
2596  void
2597  getGlobalRowCopy (GlobalOrdinal GlobalRow,
2598  nonconst_global_inds_host_view_type &Indices,
2599  nonconst_values_host_view_type &Values,
2600  size_t& NumEntries) const override;
2616  void
2617  getLocalRowCopy (LocalOrdinal LocalRow,
2618  nonconst_local_inds_host_view_type &Indices,
2619  nonconst_values_host_view_type &Values,
2620  size_t& NumEntries) const override;
2621 
2634 
2635  void
2636  getGlobalRowView (GlobalOrdinal GlobalRow,
2637  global_inds_host_view_type &indices,
2638  values_host_view_type &values) const override;
2639 
2652  void
2653  getLocalRowView(LocalOrdinal LocalRow,
2654  local_inds_host_view_type &indices,
2655  values_host_view_type &values) const override;
2656 
2664 
2671  void
2672  getLocalDiagCopy (Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& diag) const override;
2673 
2717  void getLocalDiagOffsets (Teuchos::ArrayRCP<size_t>& offsets) const;
2718 
2740  void
2741  getLocalDiagCopy (Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& diag,
2742  const Kokkos::View<const size_t*, device_type,
2743  Kokkos::MemoryUnmanaged>& offsets) const;
2744 
2767  void
2768  getLocalDiagCopy (Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& diag,
2769  const Teuchos::ArrayView<const size_t>& offsets) const;
2770 
2775  void
2776  leftScale (const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x) override;
2777 
2782  void
2783  rightScale (const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x) override;
2784 
2786 
2788 
2850  void
2851  localApply (const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& X,
2852  MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&Y,
2853  const Teuchos::ETransp mode = Teuchos::NO_TRANS,
2854  const Scalar& alpha = Teuchos::ScalarTraits<Scalar>::one (),
2855  const Scalar& beta = Teuchos::ScalarTraits<Scalar>::zero ()) const;
2856 
2859  template <class T>
2860  Teuchos::RCP<CrsMatrix<T, LocalOrdinal, GlobalOrdinal, Node> >
2861  convert () const;
2862 
2864 
2866 
2877  void
2878  apply (const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& X,
2879  MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&Y,
2880  Teuchos::ETransp mode = Teuchos::NO_TRANS,
2881  Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
2882  Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const override;
2883 
2886  bool hasTransposeApply () const override;
2887 
2894  Teuchos::RCP<const map_type> getDomainMap () const override;
2895 
2902  Teuchos::RCP<const map_type> getRangeMap () const override;
2903 
2905 
2907 
2918  virtual Teuchos::RCP<RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
2919  add (const Scalar& alpha,
2920  const RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
2921  const Scalar& beta,
2922  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& domainMap,
2923  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& rangeMap,
2924  const Teuchos::RCP<Teuchos::ParameterList>& params) const override;
2925 
2927 
2929 
2931  std::string description () const override;
2932 
2935  void
2936  describe (Teuchos::FancyOStream& out,
2937  const Teuchos::EVerbosityLevel verbLevel =
2938  Teuchos::Describable::verbLevel_default) const override;
2939 
2941 
2943 
2948  typedef typename DistObject<Scalar, LocalOrdinal, GlobalOrdinal,
2949  Node>::buffer_device_type buffer_device_type;
2950 
2951  virtual bool
2952  checkSizes (const SrcDistObject& source) override;
2953 
2954  void
2955  applyCrsPadding(
2956  const typename crs_graph_type::padding_type& padding,
2957  const bool verbose);
2958 
2959  private:
2960  void
2961  copyAndPermuteStaticGraph(
2962  const RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& source,
2963  const size_t numSameIDs,
2964  const LocalOrdinal permuteToLIDs[],
2965  const LocalOrdinal permuteFromLIDs[],
2966  const size_t numPermutes);
2967 
2968  void
2969  copyAndPermuteNonStaticGraph(
2970  const RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& source,
2971  const size_t numSameIDs,
2972  const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& permuteToLIDs_dv,
2973  const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& permuteFromLIDs_dv,
2974  const size_t numPermutes);
2975 
2976  protected:
2977 
2978  // clang-format on
2979  using dist_object_type::
2980  copyAndPermute;
2981  // clang-format off
2983 
2984  virtual void
2985  copyAndPermute
2986  (const SrcDistObject& source,
2987  const size_t numSameIDs,
2988  const Kokkos::DualView<
2989  const local_ordinal_type*,
2990  buffer_device_type>& permuteToLIDs,
2991  const Kokkos::DualView<
2992  const local_ordinal_type*,
2993  buffer_device_type>& permuteFromLIDs,
2994  const CombineMode CM) override;
2995 
2996  virtual void
2997  packAndPrepare
2998  (const SrcDistObject& source,
2999  const Kokkos::DualView<
3000  const local_ordinal_type*,
3001  buffer_device_type>& exportLIDs,
3002  Kokkos::DualView<char*, buffer_device_type>& exports,
3003  Kokkos::DualView<size_t*, buffer_device_type> numPacketsPerLID,
3004  size_t& constantNumPackets) override;
3005 
3006  // clang-format on
3007  using dist_object_type::packAndPrepare;
3008  // clang-format off
3012 
3013  private:
3016  void
3017  unpackAndCombineImpl(
3018  const Kokkos::DualView<const local_ordinal_type*,
3019  buffer_device_type>& importLIDs,
3020  Kokkos::DualView<char*, buffer_device_type> imports,
3021  Kokkos::DualView<size_t*, buffer_device_type> numPacketsPerLID,
3022  const size_t constantNumPackets,
3023  const CombineMode combineMode,
3024  const bool verbose);
3025 
3028  void
3029  unpackAndCombineImplNonStatic(
3030  const Kokkos::DualView<const local_ordinal_type*,
3031  buffer_device_type>& importLIDs,
3032  Kokkos::DualView<char*, buffer_device_type> imports,
3033  Kokkos::DualView<size_t*, buffer_device_type> numPacketsPerLID,
3034  const size_t constantNumPackets,
3035  const CombineMode combineMode);
3036 
3037  public:
3047  void
3048  unpackAndCombine
3049  (const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& importLIDs,
3050  Kokkos::DualView<char*, buffer_device_type> imports,
3051  Kokkos::DualView<size_t*, buffer_device_type> numPacketsPerLID,
3052  const size_t constantNumPackets,
3053  const CombineMode CM) override;
3054 
3055  // clang-format on
3056  using dist_object_type::unpackAndCombine;
3057  // clang-format off
3061 
3167  void
3168  packNew (const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& exportLIDs,
3169  Kokkos::DualView<char*, buffer_device_type>& exports,
3170  const Kokkos::DualView<size_t*, buffer_device_type>& numPacketsPerLID,
3171  size_t& constantNumPackets) const;
3172 
3173  private:
3180  void
3181  packNonStaticNew (const Kokkos::DualView<const local_ordinal_type*, buffer_device_type>& exportLIDs,
3182  Kokkos::DualView<char*, buffer_device_type>& exports,
3183  const Kokkos::DualView<size_t*, buffer_device_type>& numPacketsPerLID,
3184  size_t& constantNumPackets) const;
3185 
3215  size_t
3216  packRow (char exports[],
3217  const size_t offset,
3218  const size_t numEnt,
3219  const GlobalOrdinal gidsIn[],
3220  const impl_scalar_type valsIn[],
3221  const size_t numBytesPerValue) const;
3222 
3246  bool
3247  packRowStatic (char* const numEntOut,
3248  char* const valOut,
3249  char* const indOut,
3250  const size_t numEnt,
3251  const LocalOrdinal lclRow) const;
3252 
3278  size_t
3279  unpackRow (GlobalOrdinal gidsOut[],
3280  impl_scalar_type valsOut[],
3281  const char imports[],
3282  const size_t offset,
3283  const size_t numBytes,
3284  const size_t numEnt,
3285  const size_t numBytesPerValue);
3286 
3295  void
3296  allocatePackSpaceNew (Kokkos::DualView<char*, buffer_device_type>& exports,
3297  size_t& totalNumEntries,
3298  const Kokkos::DualView<const local_ordinal_type*,
3299  buffer_device_type>& exportLIDs) const;
3301 
3302  public:
3304  typename local_matrix_host_type::values_type::const_type
3305  getLocalValuesHost (Access::ReadOnlyStruct s) const
3306  {
3307  return valuesPacked_wdv.getHostView(s);
3308  }
3309 
3311  typename local_matrix_host_type::values_type
3312  getLocalValuesHost (Access::ReadWriteStruct s)
3313  {
3314  return valuesPacked_wdv.getHostView(s);
3315  }
3316 
3318  typename local_matrix_host_type::values_type
3319  getLocalValuesHost (Access::OverwriteAllStruct s)
3320  {
3321  return valuesPacked_wdv.getHostView(s);
3322  }
3323 
3325  typename local_matrix_device_type::values_type::const_type
3326  getLocalValuesDevice (Access::ReadOnlyStruct s) const
3327  {
3328  return valuesPacked_wdv.getDeviceView(s);
3329  }
3330 
3332  typename local_matrix_device_type::values_type
3333  getLocalValuesDevice (Access::ReadWriteStruct s)
3334  {
3335  return valuesPacked_wdv.getDeviceView(s);
3336  }
3337 
3339  typename local_matrix_device_type::values_type
3340  getLocalValuesDevice (Access::OverwriteAllStruct s)
3341  {
3342  return valuesPacked_wdv.getDeviceView(s);
3343  }
3344 
3345  private:
3346  // Friend declaration for nonmember function.
3347  template<class CrsMatrixType>
3348  friend Teuchos::RCP<CrsMatrixType>
3349  Tpetra::importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
3350  const Import<typename CrsMatrixType::local_ordinal_type,
3351  typename CrsMatrixType::global_ordinal_type,
3352  typename CrsMatrixType::node_type>& importer,
3353  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3354  typename CrsMatrixType::global_ordinal_type,
3355  typename CrsMatrixType::node_type> >& domainMap,
3356  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3357  typename CrsMatrixType::global_ordinal_type,
3358  typename CrsMatrixType::node_type> >& rangeMap,
3359  const Teuchos::RCP<Teuchos::ParameterList>& params);
3360 
3361  // Friend declaration for nonmember function.
3362  template<class CrsMatrixType>
3363  friend Teuchos::RCP<CrsMatrixType>
3364  Tpetra::importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
3365  const Import<typename CrsMatrixType::local_ordinal_type,
3366  typename CrsMatrixType::global_ordinal_type,
3367  typename CrsMatrixType::node_type>& rowImporter,
3368  const Import<typename CrsMatrixType::local_ordinal_type,
3369  typename CrsMatrixType::global_ordinal_type,
3370  typename CrsMatrixType::node_type>& domainImporter,
3371  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3372  typename CrsMatrixType::global_ordinal_type,
3373  typename CrsMatrixType::node_type> >& domainMap,
3374  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3375  typename CrsMatrixType::global_ordinal_type,
3376  typename CrsMatrixType::node_type> >& rangeMap,
3377  const Teuchos::RCP<Teuchos::ParameterList>& params);
3378 
3379 
3380  // Friend declaration for nonmember function.
3381  template<class CrsMatrixType>
3382  friend Teuchos::RCP<CrsMatrixType>
3383  Tpetra::exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
3384  const Export<typename CrsMatrixType::local_ordinal_type,
3385  typename CrsMatrixType::global_ordinal_type,
3386  typename CrsMatrixType::node_type>& exporter,
3387  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3388  typename CrsMatrixType::global_ordinal_type,
3389  typename CrsMatrixType::node_type> >& domainMap,
3390  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3391  typename CrsMatrixType::global_ordinal_type,
3392  typename CrsMatrixType::node_type> >& rangeMap,
3393  const Teuchos::RCP<Teuchos::ParameterList>& params);
3394 
3395  // Friend declaration for nonmember function.
3396  template<class CrsMatrixType>
3397  friend Teuchos::RCP<CrsMatrixType>
3398  Tpetra::exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
3399  const Export<typename CrsMatrixType::local_ordinal_type,
3400  typename CrsMatrixType::global_ordinal_type,
3401  typename CrsMatrixType::node_type>& rowExporter,
3402  const Export<typename CrsMatrixType::local_ordinal_type,
3403  typename CrsMatrixType::global_ordinal_type,
3404  typename CrsMatrixType::node_type>& domainExporter,
3405  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3406  typename CrsMatrixType::global_ordinal_type,
3407  typename CrsMatrixType::node_type> >& domainMap,
3408  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
3409  typename CrsMatrixType::global_ordinal_type,
3410  typename CrsMatrixType::node_type> >& rangeMap,
3411  const Teuchos::RCP<Teuchos::ParameterList>& params);
3412 
3413  public:
3429  void
3430  importAndFillComplete (Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& destMatrix,
3431  const import_type& importer,
3432  const Teuchos::RCP<const map_type>& domainMap,
3433  const Teuchos::RCP<const map_type>& rangeMap,
3434  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null) const;
3435 
3451  void
3452  importAndFillComplete (Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& destMatrix,
3453  const import_type& rowImporter,
3454  const import_type& domainImporter,
3455  const Teuchos::RCP<const map_type>& domainMap,
3456  const Teuchos::RCP<const map_type>& rangeMap,
3457  const Teuchos::RCP<Teuchos::ParameterList>& params) const;
3458 
3459 
3475  void
3476  exportAndFillComplete (Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& destMatrix,
3477  const export_type& exporter,
3478  const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
3479  const Teuchos::RCP<const map_type>& rangeMap = Teuchos::null,
3480  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null) const;
3481 
3497  void
3498  exportAndFillComplete (Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& destMatrix,
3499  const export_type& rowExporter,
3500  const export_type& domainExporter,
3501  const Teuchos::RCP<const map_type>& domainMap,
3502  const Teuchos::RCP<const map_type>& rangeMap,
3503  const Teuchos::RCP<Teuchos::ParameterList>& params) const;
3504 
3505 
3506  private:
3527  void
3528  transferAndFillComplete (Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& destMatrix,
3529  const ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node>& rowTransfer,
3530  const Teuchos::RCP<const ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node> > & domainTransfer,
3531  const Teuchos::RCP<const map_type>& domainMap = Teuchos::null,
3532  const Teuchos::RCP<const map_type>& rangeMap = Teuchos::null,
3533  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null) const;
3534 
3546  protected:
3547  virtual void
3548  insertGlobalValuesImpl (crs_graph_type& graph,
3549  RowInfo& rowInfo,
3550  const GlobalOrdinal gblColInds[],
3551  const impl_scalar_type vals[],
3552  const size_t numInputEnt);
3553 
3554  private:
3564  void
3565  insertGlobalValuesFiltered(
3566  const GlobalOrdinal globalRow,
3567  const Teuchos::ArrayView<const GlobalOrdinal>& indices,
3568  const Teuchos::ArrayView<const Scalar>& values,
3569  const bool debug);
3570 
3573  void
3574  insertGlobalValuesFilteredChecked(
3575  const GlobalOrdinal globalRow,
3576  const Teuchos::ArrayView<const GlobalOrdinal>& indices,
3577  const Teuchos::ArrayView<const Scalar>& values,
3578  const char* const prefix,
3579  const bool debug,
3580  const bool verbose);
3581 
3593  void
3594  combineGlobalValues(
3595  const GlobalOrdinal globalRowIndex,
3596  const Teuchos::ArrayView<const GlobalOrdinal>& columnIndices,
3597  const Teuchos::ArrayView<const Scalar>& values,
3598  const Tpetra::CombineMode combineMode,
3599  const char* const prefix,
3600  const bool debug,
3601  const bool verbose);
3602 
3624  LocalOrdinal
3625  combineGlobalValuesRaw(const LocalOrdinal lclRow,
3626  const LocalOrdinal numEnt,
3627  const impl_scalar_type vals[],
3628  const GlobalOrdinal cols[],
3629  const Tpetra::CombineMode combineMode,
3630  const char* const prefix,
3631  const bool debug,
3632  const bool verbose);
3633 
3645  template<class BinaryFunction>
3646  LocalOrdinal
3647  transformGlobalValues (const GlobalOrdinal globalRow,
3648  const Teuchos::ArrayView<const GlobalOrdinal>& indices,
3649  const Teuchos::ArrayView<const Scalar>& values,
3650  BinaryFunction f,
3651  const bool atomic = useAtomicUpdatesByDefault)
3652  {
3653  typedef impl_scalar_type IST;
3654  typedef LocalOrdinal LO;
3655  typedef GlobalOrdinal GO;
3656 
3657  const LO numInputEnt = static_cast<LO> (indices.size ());
3658  if (static_cast<LO> (values.size ()) != numInputEnt) {
3659  return Teuchos::OrdinalTraits<LO>::invalid ();
3660  }
3661 
3662  const GO* const inputCols = indices.getRawPtr ();
3663  const IST* const inputVals =
3664  reinterpret_cast<const IST*> (values.getRawPtr ());
3665  return this->transformGlobalValues (globalRow, numInputEnt, inputVals,
3666  inputCols, f, atomic);
3667  }
3668 
3675  void
3676  insertNonownedGlobalValues (const GlobalOrdinal globalRow,
3677  const Teuchos::ArrayView<const GlobalOrdinal>& indices,
3678  const Teuchos::ArrayView<const Scalar>& values);
3679 
3722  void
3723  insertIndicesAndValues (crs_graph_type& graph,
3724  RowInfo& rowInfo,
3725  const typename crs_graph_type::SLocalGlobalViews& newInds,
3726  const Teuchos::ArrayView<impl_scalar_type>& oldRowVals,
3727  const Teuchos::ArrayView<const impl_scalar_type>& newRowVals,
3728  const ELocalGlobal lg,
3729  const ELocalGlobal I);
3730 
3731  protected:
3732  // useful typedefs
3733  typedef Teuchos::OrdinalTraits<LocalOrdinal> OTL;
3734  typedef Kokkos::ArithTraits<impl_scalar_type> STS;
3735  typedef Kokkos::ArithTraits<mag_type> STM;
3736  typedef MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> MV;
3737  typedef Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> V;
3738  typedef crs_graph_type Graph;
3739 
3740  // Enums
3741  enum GraphAllocationStatus {
3742  GraphAlreadyAllocated,
3743  GraphNotYetAllocated
3744  };
3745 
3746  protected:
3765  void allocateValues (ELocalGlobal lg, GraphAllocationStatus gas,
3766  const bool verbose);
3767 
3778  static size_t
3779  mergeRowIndicesAndValues (size_t rowLen, local_ordinal_type* cols, impl_scalar_type* vals);
3780 
3795  void
3796  sortAndMergeIndicesAndValues (const bool sorted,
3797  const bool merged);
3798 
3799  public:
3800 
3802  bool haveGlobalConstants() const;
3803 
3804  protected:
3817  mutable Teuchos::RCP<MV> importMV_;
3818 
3831  mutable Teuchos::RCP<MV> exportMV_;
3832 
3852  Teuchos::RCP<MV>
3853  getColumnMapMultiVector (const MV& X_domainMap,
3854  const bool force = false) const;
3855 
3877  Teuchos::RCP<MV>
3878  getRowMapMultiVector (const MV& Y_rangeMap,
3879  const bool force = false) const;
3880 
3882  void
3883  applyNonTranspose (const MV& X_in,
3884  MV& Y_in,
3885  Scalar alpha,
3886  Scalar beta) const;
3887 
3889  void
3890  applyTranspose (const MV& X_in,
3891  MV& Y_in,
3892  const Teuchos::ETransp mode,
3893  Scalar alpha,
3894  Scalar beta) const;
3895 
3896  // matrix data accessors
3897 
3900  typename values_dualv_type::t_host::const_type
3901  getValuesViewHost (const RowInfo& rowinfo) const;
3902 
3905  typename values_dualv_type::t_dev::const_type
3906  getValuesViewDevice (const RowInfo& rowinfo) const;
3907 
3910  typename values_dualv_type::t_host
3911  getValuesViewHostNonConst (const RowInfo& rowinfo);
3912 
3915  typename values_dualv_type::t_dev
3916  getValuesViewDeviceNonConst (const RowInfo& rowinfo);
3917 
3918 private:
3919  // TODO: When KokkosKernels 4.4 is released, local_matrix_device_type can be permanently modified to use the default_size_type
3920  // of KK. This is always a type that is enabled by KK's ETI (preferring int if both or neither int and size_t are enabled).
3921  //
3922  // At that point the ApplyHelper can be replaced with just a SPMVHandle.
3923  using local_matrix_int_rowptrs_device_type =
3924  KokkosSparse::CrsMatrix<impl_scalar_type,
3925  local_ordinal_type,
3926  device_type,
3927  void,
3928  int>;
3929 
3931  using ApplyHelper = Details::MatrixApplyHelper<
3932  local_matrix_device_type,
3933  local_matrix_int_rowptrs_device_type,
3934  typename MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::device_view_type>;
3935 
3936 
3937  std::shared_ptr<ApplyHelper> getApplyHelper() const {
3938  if (!applyHelper) {
3939  auto A_lcl = getLocalMatrixDevice();
3940  applyHelper = std::make_shared<ApplyHelper>(A_lcl.nnz(), A_lcl.graph.row_map);
3941  }
3942  return applyHelper;
3943  }
3944 
3945  protected:
3946 
3947  // Friend the tester for CrsMatrix::swap
3948  friend class Tpetra::crsMatrix_Swap_Tester<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
3949 
3950  // Friend the matrix multiply kernels so they can access internally-cached integer
3951  // row pointers without making them part of the CrsMatrix interface
3952  template<typename S, typename LO, typename GO, typename NODE, typename LOV> friend struct Tpetra::MMdetails::KernelWrappers;
3953  template<typename S, typename LO, typename GO, typename NODE, typename LOV> friend struct Tpetra::MMdetails::KernelWrappers2;
3954 
3955 
3956  // friend Matrix Matrix utility function that needs to access integer-typed rowptrs
3957  friend
3958  void Tpetra::MMdetails::import_and_extract_views<Scalar, LocalOrdinal, GlobalOrdinal, Node>(
3959  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
3960  Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > targetMap,
3961  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
3962  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > prototypeImporter,
3963  bool userAssertsThereAreNoRemotes,
3964  const std::string& label,
3965  const Teuchos::RCP<Teuchos::ParameterList>& params);
3966 
3970  void swap(CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> & matrix);
3971 
3972 
3973  protected:
3974 
3980  void fillLocalMatrix (const Teuchos::RCP<Teuchos::ParameterList>& params);
3981 
3987  void fillLocalGraphAndMatrix (const Teuchos::RCP<Teuchos::ParameterList>& params);
3988 
3990  void checkInternalState () const;
3991 
4003 
4004  Teuchos::RCP<const Graph> staticGraph_;
4005  Teuchos::RCP< Graph> myGraph_;
4007 
4008 protected:
4018  Details::EStorageStatus storageStatus_ =
4019  Details::STORAGE_1D_UNPACKED;
4020 
4022  bool fillComplete_ = false;
4023 
4051  std::map<GlobalOrdinal, std::pair<Teuchos::Array<GlobalOrdinal>,
4052  Teuchos::Array<Scalar> > > nonlocals_;
4053 
4054  private:
4060  mutable std::shared_ptr<ApplyHelper> applyHelper;
4061 
4062  public:
4063  // FIXME (mfh 24 Feb 2014) Is it _really_ necessary to make this a
4064  // public inner class of CrsMatrix? It looks like it doesn't
4065  // depend on any implementation details of CrsMatrix at all. It
4066  // should really be declared and defined outside of CrsMatrix.
4067  template<class DestViewType, class SrcViewType,
4068  class DestOffsetViewType, class SrcOffsetViewType>
4069  struct pack_functor {
4070  typedef typename DestViewType::execution_space execution_space;
4071  SrcViewType src_;
4072  DestViewType dst_;
4073  SrcOffsetViewType src_offset_;
4074  DestOffsetViewType dst_offset_;
4075  typedef typename DestOffsetViewType::non_const_value_type scalar_index_type;
4076 
4077  pack_functor (DestViewType dst,
4078  const SrcViewType src,
4079  DestOffsetViewType dst_offset,
4080  const SrcOffsetViewType src_offset) :
4081  src_ (src),
4082  dst_ (dst),
4083  src_offset_ (src_offset),
4084  dst_offset_ (dst_offset)
4085  {}
4086 
4087  KOKKOS_INLINE_FUNCTION
4088  void operator () (const LocalOrdinal row) const {
4089  scalar_index_type srcPos = src_offset_(row);
4090  const scalar_index_type dstEnd = dst_offset_(row+1);
4091  scalar_index_type dstPos = dst_offset_(row);
4092  for ( ; dstPos < dstEnd; ++dstPos, ++srcPos) {
4093  dst_(dstPos) = src_(srcPos);
4094  }
4095  }
4096  };
4097  }; // class CrsMatrix
4098 
4103  template<class Scalar,
4104  class LocalOrdinal,
4105  class GlobalOrdinal,
4106  class Node>
4107  Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
4108  createCrsMatrix(
4109  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& map,
4110  const size_t maxNumEntriesPerRow = 0,
4111  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null)
4112  {
4113  using matrix_type =
4114  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>;
4115  return Teuchos::rcp(new matrix_type(map, maxNumEntriesPerRow,
4116  params));
4117  }
4118 
4119  template<class CrsMatrixType>
4120  Teuchos::RCP<CrsMatrixType>
4121  importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
4122  const Import<typename CrsMatrixType::local_ordinal_type,
4123  typename CrsMatrixType::global_ordinal_type,
4124  typename CrsMatrixType::node_type>& importer,
4125  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4126  typename CrsMatrixType::global_ordinal_type,
4127  typename CrsMatrixType::node_type> >& domainMap,
4128  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4129  typename CrsMatrixType::global_ordinal_type,
4130  typename CrsMatrixType::node_type> >& rangeMap,
4131  const Teuchos::RCP<Teuchos::ParameterList>& params)
4132  {
4133  Teuchos::RCP<CrsMatrixType> destMatrix;
4134  sourceMatrix->importAndFillComplete (destMatrix, importer, domainMap, rangeMap, params);
4135  return destMatrix;
4136  }
4137 
4138  template<class CrsMatrixType>
4139  Teuchos::RCP<CrsMatrixType>
4140  importAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
4141  const Import<typename CrsMatrixType::local_ordinal_type,
4142  typename CrsMatrixType::global_ordinal_type,
4143  typename CrsMatrixType::node_type>& rowImporter,
4144  const Import<typename CrsMatrixType::local_ordinal_type,
4145  typename CrsMatrixType::global_ordinal_type,
4146  typename CrsMatrixType::node_type>& domainImporter,
4147  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4148  typename CrsMatrixType::global_ordinal_type,
4149  typename CrsMatrixType::node_type> >& domainMap,
4150  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4151  typename CrsMatrixType::global_ordinal_type,
4152  typename CrsMatrixType::node_type> >& rangeMap,
4153  const Teuchos::RCP<Teuchos::ParameterList>& params)
4154  {
4155  Teuchos::RCP<CrsMatrixType> destMatrix;
4156  sourceMatrix->importAndFillComplete (destMatrix, rowImporter, domainImporter, domainMap, rangeMap, params);
4157  return destMatrix;
4158  }
4159 
4160  template<class CrsMatrixType>
4161  Teuchos::RCP<CrsMatrixType>
4162  exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
4163  const Export<typename CrsMatrixType::local_ordinal_type,
4164  typename CrsMatrixType::global_ordinal_type,
4165  typename CrsMatrixType::node_type>& exporter,
4166  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4167  typename CrsMatrixType::global_ordinal_type,
4168  typename CrsMatrixType::node_type> >& domainMap,
4169  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4170  typename CrsMatrixType::global_ordinal_type,
4171  typename CrsMatrixType::node_type> >& rangeMap,
4172  const Teuchos::RCP<Teuchos::ParameterList>& params)
4173  {
4174  Teuchos::RCP<CrsMatrixType> destMatrix;
4175  sourceMatrix->exportAndFillComplete (destMatrix, exporter, domainMap, rangeMap, params);
4176  return destMatrix;
4177  }
4178 
4179  template<class CrsMatrixType>
4180  Teuchos::RCP<CrsMatrixType>
4181  exportAndFillCompleteCrsMatrix (const Teuchos::RCP<const CrsMatrixType>& sourceMatrix,
4182  const Export<typename CrsMatrixType::local_ordinal_type,
4183  typename CrsMatrixType::global_ordinal_type,
4184  typename CrsMatrixType::node_type>& rowExporter,
4185  const Export<typename CrsMatrixType::local_ordinal_type,
4186  typename CrsMatrixType::global_ordinal_type,
4187  typename CrsMatrixType::node_type>& domainExporter,
4188  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4189  typename CrsMatrixType::global_ordinal_type,
4190  typename CrsMatrixType::node_type> >& domainMap,
4191  const Teuchos::RCP<const Map<typename CrsMatrixType::local_ordinal_type,
4192  typename CrsMatrixType::global_ordinal_type,
4193  typename CrsMatrixType::node_type> >& rangeMap,
4194  const Teuchos::RCP<Teuchos::ParameterList>& params)
4195  {
4196  Teuchos::RCP<CrsMatrixType> destMatrix;
4197  sourceMatrix->exportAndFillComplete (destMatrix, rowExporter, domainExporter, domainMap, rangeMap, params);
4198  return destMatrix;
4199  }
4200 
4207  template<class CrsMatrixType>
4208  void
4209  removeCrsMatrixZeros(CrsMatrixType& matrix,
4210  typename Teuchos::ScalarTraits<typename CrsMatrixType::scalar_type>::magnitudeType const & threshold =
4211  Teuchos::ScalarTraits<typename CrsMatrixType::scalar_type>::magnitude( Teuchos::ScalarTraits<typename CrsMatrixType::scalar_type>::zero() ))
4212  {
4213  auto localMatrix = matrix.getLocalMatrixDevice();
4214  size_t nnzBefore = localMatrix.nnz();
4215  localMatrix = KokkosSparse::removeCrsMatrixZeros(localMatrix,threshold);
4216  size_t localNNZRemoved = nnzBefore - localMatrix.nnz();
4217  //Skip the expertStaticFillComplete if no entries were removed on any process.
4218  //The fill complete can perform MPI collectives, so it can only be skipped on all processes or none.
4219  size_t globalNNZRemoved = 0;
4220  Teuchos::reduceAll<int, size_t> (*(matrix.getComm()), Teuchos::REDUCE_SUM, 1, &localNNZRemoved, &globalNNZRemoved);
4221  if(globalNNZRemoved != size_t(0)) {
4222  matrix.resumeFill();
4223  matrix.setAllValues(localMatrix);
4224  matrix.expertStaticFillComplete(matrix.getDomainMap(),matrix.getRangeMap());
4225  }
4226  }
4227 
4228 } // namespace Tpetra
4229 
4237 #endif // TPETRA_CRSMATRIX_DECL_HPP
Tpetra::CrsMatrix::operator=
CrsMatrix & operator=(const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &)=default
Copy assignment.
Tpetra::Import
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Definition: Tpetra_Import_decl.hpp:77
Tpetra::CrsMatrix::hasColMap
bool hasColMap() const override
Whether the matrix has a well-defined column Map.
Definition: Tpetra_CrsMatrix_def.hpp:825
Tpetra::CrsMatrix::getGlobalNumCols
global_size_t getGlobalNumCols() const override
The number of global columns in the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:853
Tpetra::CrsGraph::local_graph_device_type
KokkosSparse::StaticCrsGraph< local_ordinal_type, Kokkos::LayoutLeft, device_type, void, size_t > local_graph_device_type
The type of the part of the sparse graph on each MPI process.
Definition: Tpetra_CrsGraph_decl.hpp:227
Tpetra::CrsMatrix::checkInternalState
void checkInternalState() const
Check that this object&#39;s state is sane; throw if it&#39;s not.
Definition: Tpetra_CrsMatrix_def.hpp:5165
Tpetra::CrsMatrix
Sparse matrix that presents a row-oriented interface that lets users read or modify entries...
Definition: Tpetra_CrsMatrix_decl.hpp:398
Tpetra::exportAndFillCompleteCrsMatrix
Teuchos::RCP< CrsMatrixType > exportAndFillCompleteCrsMatrix(const Teuchos::RCP< const CrsMatrixType > &sourceMatrix, const Export< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > &exporter, const Teuchos::RCP< const Map< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Nonmember CrsMatrix constructor that fuses Export and fillComplete().
Definition: Tpetra_CrsMatrix_decl.hpp:4162
Tpetra::CrsMatrix::crs_graph_type
CrsGraph< LocalOrdinal, GlobalOrdinal, Node > crs_graph_type
The CrsGraph specialization suitable for this CrsMatrix specialization.
Definition: Tpetra_CrsMatrix_decl.hpp:464
Tpetra::CrsMatrix::replaceColMap
void replaceColMap(const Teuchos::RCP< const map_type > &newColMap)
Replace the matrix&#39;s column Map with the given Map.
Definition: Tpetra_CrsMatrix_def.hpp:3883
Tpetra::CrsMatrix::replaceGlobalValuesImpl
virtual LocalOrdinal replaceGlobalValuesImpl(impl_scalar_type rowVals[], const crs_graph_type &graph, const RowInfo &rowInfo, const GlobalOrdinal inds[], const impl_scalar_type newVals[], const LocalOrdinal numElts)
Implementation detail of replaceGlobalValues.
Definition: Tpetra_CrsMatrix_def.hpp:2385
Tpetra::CrsMatrix::supportsRowViews
virtual bool supportsRowViews() const override
Return true if getLocalRowView() and getGlobalRowView() are valid for this object.
Definition: Tpetra_CrsMatrix_def.hpp:1022
Tpetra::CrsMatrix::getNormInf
mag_type getNormInf() const
Compute and return the infinity norm of the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:3791
Tpetra::CrsMatrix::replaceDomainMapAndImporter
void replaceDomainMapAndImporter(const Teuchos::RCP< const map_type > &newDomainMap, Teuchos::RCP< const import_type > &newImporter)
Replace the current domain Map and Import with the given objects.
Definition: Tpetra_CrsMatrix_def.hpp:3952
Tpetra::CrsMatrix::mergeRowIndicesAndValues
static size_t mergeRowIndicesAndValues(size_t rowLen, local_ordinal_type *cols, impl_scalar_type *vals)
Merge duplicate row indices in the given row, along with their corresponding values.
Definition: Tpetra_CrsMatrix_def.hpp:4582
Tpetra::CrsMatrix::getGlobalRowCopy
void getGlobalRowCopy(GlobalOrdinal GlobalRow, nonconst_global_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const override
Fill given arrays with a deep copy of the locally owned entries of the matrix in a given row...
Definition: Tpetra_CrsMatrix_def.hpp:3179
Tpetra::DistObject< char, LocalOrdinal, GlobalOrdinal, Node >::copyAndPermute
virtual void copyAndPermute(const SrcDistObject &source, const size_t numSameIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteToLIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteFromLIDs, const CombineMode CM)
Perform copies and permutations that are local to the calling (MPI) process.
Tpetra::CrsMatrix::getRangeMap
Teuchos::RCP< const map_type > getRangeMap() const override
The range Map of this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:932
Tpetra::CrsMatrix::getGlobalNumRows
global_size_t getGlobalNumRows() const override
Number of global elements in the row map of this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:846
Tpetra::CrsMatrix::nonlocals_
std::map< GlobalOrdinal, std::pair< Teuchos::Array< GlobalOrdinal >, Teuchos::Array< Scalar > > > nonlocals_
Nonlocal data added using insertGlobalValues().
Definition: Tpetra_CrsMatrix_decl.hpp:4052
Tpetra::CrsMatrix::sortAndMergeIndicesAndValues
void sortAndMergeIndicesAndValues(const bool sorted, const bool merged)
Sort and merge duplicate local column indices in all rows on the calling process, along with their co...
Definition: Tpetra_CrsMatrix_def.hpp:4618
Tpetra::CrsMatrix::execution_space
typename device_type::execution_space execution_space
The Kokkos execution space.
Definition: Tpetra_CrsMatrix_decl.hpp:424
Tpetra::CrsMatrix::packNew
void packNew(const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &exportLIDs, Kokkos::DualView< char *, buffer_device_type > &exports, const Kokkos::DualView< size_t *, buffer_device_type > &numPacketsPerLID, size_t &constantNumPackets) const
Pack this object&#39;s data for an Import or Export.
Definition: Tpetra_CrsMatrix_def.hpp:6573
Tpetra::CrsMatrix::insertGlobalValuesImpl
virtual void insertGlobalValuesImpl(crs_graph_type &graph, RowInfo &rowInfo, const GlobalOrdinal gblColInds[], const impl_scalar_type vals[], const size_t numInputEnt)
Common implementation detail of insertGlobalValues and insertGlobalValuesFiltered.
Definition: Tpetra_CrsMatrix_def.hpp:1822
Tpetra::CrsMatrix::getLocalRowPtrsDevice
row_ptrs_device_view_type getLocalRowPtrsDevice() const
Get a device view of the CRS packed row pointers.
Definition: Tpetra_CrsMatrix_decl.hpp:1884
Tpetra::CrsMatrix::getLocalValuesDevice
local_matrix_device_type::values_type getLocalValuesDevice(Access::OverwriteAllStruct s)
Get the Kokkos local values on device, overwrite all.
Definition: Tpetra_CrsMatrix_decl.hpp:3340
Tpetra::CrsMatrix::mag_type
typename Kokkos::ArithTraits< impl_scalar_type >::mag_type mag_type
Type of a norm result.
Definition: Tpetra_CrsMatrix_decl.hpp:461
Tpetra::CrsMatrix::getGlobalRowView
void getGlobalRowView(GlobalOrdinal GlobalRow, global_inds_host_view_type &indices, values_host_view_type &values) const override
Get a constant, nonpersisting view of a row of this matrix, using global row and column indices...
Definition: Tpetra_CrsMatrix_def.hpp:3285
Tpetra::CrsMatrix::setAllToScalar
void setAllToScalar(const Scalar &alpha)
Set all matrix entries equal to alpha.
Definition: Tpetra_CrsMatrix_def.hpp:3363
Tpetra::CrsMatrix::getNorm1
mag_type getNorm1(bool assumeSymmetric=false) const
Compute and return the 1-norm of the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:3810
Tpetra::CrsMatrix::replaceRangeMapAndExporter
void replaceRangeMapAndExporter(const Teuchos::RCP< const map_type > &newRangeMap, Teuchos::RCP< const export_type > &newExporter)
Replace the current Range Map and Export with the given objects.
Definition: Tpetra_CrsMatrix_def.hpp:3983
Tpetra::MultiVector
One or more distributed dense vectors.
Definition: Tpetra_Details_WrappedDualView.hpp:49
Tpetra::CrsMatrix::scale
void scale(const Scalar &alpha)
Scale the matrix&#39;s values: this := alpha*this.
Definition: Tpetra_CrsMatrix_def.hpp:3342
Tpetra::CrsMatrix::getLocalNumCols
size_t getLocalNumCols() const override
The number of columns connected to the locally owned rows of this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:868
Tpetra::CrsMatrix::fillLocalGraphAndMatrix
void fillLocalGraphAndMatrix(const Teuchos::RCP< Teuchos::ParameterList > &params)
Fill data into the local graph and matrix.
Definition: Tpetra_CrsMatrix_def.hpp:1139
Tpetra::CrsMatrix::resumeFill
void resumeFill(const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Resume operations that may change the values or structure of the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:4274
Tpetra::CrsMatrix::leftScale
void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x) override
Scale the matrix on the left with the given Vector.
Definition: Tpetra_CrsMatrix_def.hpp:3683
Tpetra::CrsMatrix::global_ordinal_type
GlobalOrdinal global_ordinal_type
The type of each global index in the matrix.
Definition: Tpetra_CrsMatrix_decl.hpp:420
Tpetra_Details_PackTraits.hpp
Declaration and generic definition of traits class that tells Tpetra::CrsMatrix how to pack and unpac...
Tpetra::CrsMatrix::getLocalIndicesHost
local_inds_host_view_type getLocalIndicesHost() const
Get a host view of the CRS packed column indicies.
Definition: Tpetra_CrsMatrix_decl.hpp:1888
Tpetra::CrsMatrix::memory_space
typename device_type::memory_space memory_space
The Kokkos memory space.
Definition: Tpetra_CrsMatrix_decl.hpp:426
Tpetra::CrsMatrix::~CrsMatrix
virtual ~CrsMatrix()=default
Destructor (virtual for memory safety of derived classes).
Tpetra::CrsMatrix::reindexColumns
void reindexColumns(crs_graph_type *const graph, const Teuchos::RCP< const map_type > &newColMap, const Teuchos::RCP< const import_type > &newImport=Teuchos::null, const bool sortEachRow=true)
Reindex the column indices in place, and replace the column Map. Optionally, replace the Import objec...
Definition: Tpetra_CrsMatrix_def.hpp:3901
Tpetra::CrsMatrix::import_type
Import< LocalOrdinal, GlobalOrdinal, Node > import_type
The Import specialization suitable for this CrsMatrix specialization.
Definition: Tpetra_CrsMatrix_decl.hpp:438
Tpetra::CrsMatrix::getLocalValuesHost
local_matrix_host_type::values_type getLocalValuesHost(Access::OverwriteAllStruct s)
Get the Kokkos local values on host, overwrite all.
Definition: Tpetra_CrsMatrix_decl.hpp:3319
Tpetra::CrsMatrix::getCrsGraph
Teuchos::RCP< const crs_graph_type > getCrsGraph() const
This matrix&#39;s graph, as a CrsGraph.
Definition: Tpetra_CrsMatrix_def.hpp:949
Tpetra::DistObject< char, LocalOrdinal, GlobalOrdinal, Node >::unpackAndCombine
virtual void unpackAndCombine(const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &importLIDs, Kokkos::DualView< packet_type *, buffer_device_type > imports, Kokkos::DualView< size_t *, buffer_device_type > numPacketsPerLID, const size_t constantNumPackets, const CombineMode combineMode)
Perform any unpacking and combining after communication.
Tpetra::CrsMatrix::getGlobalMaxNumRowEntries
size_t getGlobalMaxNumRowEntries() const override
Maximum number of entries in any row of the matrix, over all processes in the matrix&#39;s communicator...
Definition: Tpetra_CrsMatrix_def.hpp:890
Tpetra::CrsMatrix::applyNonTranspose
void applyNonTranspose(const MV &X_in, MV &Y_in, Scalar alpha, Scalar beta) const
Special case of apply() for mode == Teuchos::NO_TRANS.
Definition: Tpetra_CrsMatrix_def.hpp:4678
Tpetra::CrsMatrix::convert
Teuchos::RCP< CrsMatrix< T, LocalOrdinal, GlobalOrdinal, Node > > convert() const
Return another CrsMatrix with the same entries, but converted to a different Scalar type T...
Definition: Tpetra_CrsMatrix_def.hpp:5134
Tpetra::CrsMatrix::scalar_type
Scalar scalar_type
The type of each entry in the matrix.
Definition: Tpetra_CrsMatrix_decl.hpp:416
Tpetra::RowInfo
Allocation information for a locally owned row in a CrsGraph or CrsMatrix.
Definition: Tpetra_CrsGraph_decl.hpp:78
Tpetra::CrsMatrix::swap
void swap(CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &matrix)
Swaps the data from *this with the data and maps from crsMatrix.
Definition: Tpetra_CrsMatrix_def.hpp:767
Tpetra::CrsMatrix::fillLocalMatrix
void fillLocalMatrix(const Teuchos::RCP< Teuchos::ParameterList > &params)
Fill data into the local matrix.
Definition: Tpetra_CrsMatrix_def.hpp:1518
Tpetra::CrsMatrix::transformGlobalValues
LocalOrdinal transformGlobalValues(const GlobalOrdinal gblRow, const Kokkos::View< const GlobalOrdinal *, InputMemorySpace, Kokkos::MemoryUnmanaged > &inputInds, const Kokkos::View< const impl_scalar_type *, InputMemorySpace, Kokkos::MemoryUnmanaged > &inputVals, BinaryFunction f, const bool atomic=useAtomicUpdatesByDefault)
Transform CrsMatrix entries in place, using global indices to select the entries in the row to transf...
Definition: Tpetra_CrsMatrix_decl.hpp:1769
Tpetra::CrsMatrix::globalAssemble
void globalAssemble()
Communicate nonlocal contributions to other processes.
Definition: Tpetra_CrsMatrix_def.hpp:4025
Tpetra::CrsMatrix::getLocalDiagCopy
void getLocalDiagCopy(Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const override
Get a constant, nonpersisting view of a row of this matrix, using local row and column indices...
Definition: Tpetra_CrsMatrix_def.hpp:3534
Tpetra::CrsMatrix::local_matrix_device_type
KokkosSparse::CrsMatrix< impl_scalar_type, local_ordinal_type, device_type, void, typename local_graph_device_type::size_type > local_matrix_device_type
The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI pro...
Definition: Tpetra_CrsMatrix_decl.hpp:477
Tpetra::CrsMatrix::sumIntoLocalValuesImpl
virtual LocalOrdinal sumIntoLocalValuesImpl(impl_scalar_type rowVals[], const crs_graph_type &graph, const RowInfo &rowInfo, const LocalOrdinal inds[], const impl_scalar_type newVals[], const LocalOrdinal numElts, const bool atomic=useAtomicUpdatesByDefault)
Implementation detail of sumIntoLocalValues.
Definition: Tpetra_CrsMatrix_def.hpp:2916
Tpetra::CrsMatrix::getLocalValuesHost
local_matrix_host_type::values_type::const_type getLocalValuesHost(Access::ReadOnlyStruct s) const
Get the Kokkos local values on host, read only.
Definition: Tpetra_CrsMatrix_decl.hpp:3305
Tpetra::CrsMatrix::isFillActive
bool isFillActive() const
Whether the matrix is not fill complete.
Definition: Tpetra_CrsMatrix_def.hpp:797
Tpetra::RowMatrix::impl_scalar_type
typename Kokkos::ArithTraits< Scalar >::val_type impl_scalar_type
The type used internally in place of Scalar.
Definition: Tpetra_RowMatrix_decl.hpp:79
Tpetra::CrsMatrix::importMV_
Teuchos::RCP< MV > importMV_
Column Map MultiVector used in apply().
Definition: Tpetra_CrsMatrix_decl.hpp:3817
Tpetra::CrsMatrix::isStaticGraph
bool isStaticGraph() const
Indicates that the graph is static, so that new entries cannot be added to this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:1008
Tpetra::global_size_t
size_t global_size_t
Global size_t object.
Definition: Tpetra_ConfigDefs.hpp:71
Tpetra::CrsMatrix::hasTransposeApply
bool hasTransposeApply() const override
Whether apply() allows applying the transpose or conjugate transpose.
Definition: Tpetra_CrsMatrix_def.hpp:1015
Tpetra::CrsMatrix::getLocalMaxNumRowEntries
size_t getLocalMaxNumRowEntries() const override
Maximum number of entries in any row of the matrix, on this process.
Definition: Tpetra_CrsMatrix_def.hpp:897
Tpetra::CrsMatrix::exportAndFillComplete
void exportAndFillComplete(Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &destMatrix, const export_type &exporter, const Teuchos::RCP< const map_type > &domainMap=Teuchos::null, const Teuchos::RCP< const map_type > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null) const
Export from this to the given destination matrix, and make the result fill complete.
Definition: Tpetra_CrsMatrix_def.hpp:9150
Tpetra::CrsMatrix::getValuesViewDevice
values_dualv_type::t_dev::const_type getValuesViewDevice(const RowInfo &rowinfo) const
Get a const Device view of the locally owned values row myRow, such that rowinfo = getRowInfo(myRow)...
Definition: Tpetra_CrsMatrix_def.hpp:3097
Tpetra::CrsMatrix::isFillComplete
bool isFillComplete() const override
Whether the matrix is fill complete.
Definition: Tpetra_CrsMatrix_def.hpp:790
Tpetra::CrsMatrix::getComm
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const override
The communicator over which the matrix is distributed.
Definition: Tpetra_CrsMatrix_def.hpp:783
Tpetra::CrsMatrix::importAndFillComplete
void importAndFillComplete(Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &destMatrix, const import_type &importer, const Teuchos::RCP< const map_type > &domainMap, const Teuchos::RCP< const map_type > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null) const
Import from this to the given destination matrix, and make the result fill complete.
Definition: Tpetra_CrsMatrix_def.hpp:9125
Tpetra::Operator
Abstract interface for operators (e.g., matrices and preconditioners).
Definition: Tpetra_Operator.hpp:55
Tpetra::CrsMatrix::getLocalMatrixDevice
TPETRA_DETAILS_ALWAYS_INLINE local_matrix_device_type getLocalMatrixDevice() const
The local sparse matrix.
Definition: Tpetra_CrsMatrix_def.hpp:985
Tpetra::CrsMatrix::getLocalValuesDevice
local_matrix_device_type::values_type getLocalValuesDevice(Access::ReadWriteStruct s)
Get the Kokkos local values on device, read write.
Definition: Tpetra_CrsMatrix_decl.hpp:3333
Tpetra::CrsMatrix::getIndexBase
GlobalOrdinal getIndexBase() const override
The index base for global indices for this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:904
Tpetra::Export
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Definition: Tpetra_Export_decl.hpp:85
Tpetra::DistObject< char, LocalOrdinal, GlobalOrdinal, Node >::packAndPrepare
virtual void packAndPrepare(const SrcDistObject &source, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &exportLIDs, Kokkos::DualView< packet_type *, buffer_device_type > &exports, Kokkos::DualView< size_t *, buffer_device_type > numPacketsPerLID, size_t &constantNumPackets)
Pack data and metadata for communication (sends).
Tpetra::createCrsMatrix
Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > createCrsMatrix(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const size_t maxNumEntriesPerRow=0, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Create an empty CrsMatrix given a row map and a single integer upper bound on the number of stored en...
Definition: Tpetra_CrsMatrix_decl.hpp:4108
Tpetra::CrsMatrix::node_type
Node node_type
This class&#39; Kokkos Node type.
Definition: Tpetra_CrsMatrix_decl.hpp:432
Tpetra::CrsMatrix::getColumnMapMultiVector
Teuchos::RCP< MV > getColumnMapMultiVector(const MV &X_domainMap, const bool force=false) const
Create a (or fetch a cached) column Map MultiVector.
Definition: Tpetra_CrsMatrix_def.hpp:7279
Tpetra::Details::CrsPadding
Keep track of how much more space a CrsGraph or CrsMatrix needs, when the graph or matrix is the targ...
Definition: Tpetra_Details_CrsPadding.hpp:28
Tpetra::CrsMatrix::describe
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const override
Print this object with the given verbosity level to the given output stream.
Definition: Tpetra_CrsMatrix_def.hpp:5228
Tpetra::CrsMatrix::getGraph
Teuchos::RCP< const RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const override
This matrix&#39;s graph, as a RowGraph.
Definition: Tpetra_CrsMatrix_def.hpp:939
Tpetra::CombineMode
CombineMode
Rule for combining data in an Import or Export.
Definition: Tpetra_CombineMode.hpp:65
Tpetra::ADD
Sum new values.
Definition: Tpetra_CombineMode.hpp:66
Tpetra::CrsMatrix::getLocalRowPtrsHost
row_ptrs_host_view_type getLocalRowPtrsHost() const
Get a host view of the CRS packed row pointers.
Definition: Tpetra_CrsMatrix_decl.hpp:1880
Tpetra::CrsMatrix::buffer_device_type
DistObject< Scalar, LocalOrdinal, GlobalOrdinal, Node >::buffer_device_type buffer_device_type
Kokkos::Device specialization for communication buffers.
Definition: Tpetra_CrsMatrix_decl.hpp:2949
Tpetra::CrsMatrix::unpackAndCombine
void unpackAndCombine(const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &importLIDs, Kokkos::DualView< char *, buffer_device_type > imports, Kokkos::DualView< size_t *, buffer_device_type > numPacketsPerLID, const size_t constantNumPackets, const CombineMode CM) override
Unpack the imported column indices and values, and combine into matrix.
Definition: Tpetra_CrsMatrix_def.hpp:6875
Tpetra::CrsMatrix::haveGlobalConstants
bool haveGlobalConstants() const
Returns true if globalConstants have been computed; false otherwise.
Definition: Tpetra_CrsMatrix_def.hpp:4287
Tpetra::Details::Spaces::User
A class can inherit from this if it wants to use Tpetra managed spaces.
Definition: Tpetra_Details_ExecutionSpacesUser.hpp:34
Tpetra::CrsMatrix::isGloballyIndexed
bool isGloballyIndexed() const override
Whether the matrix is globally indexed on the calling process.
Definition: Tpetra_CrsMatrix_def.hpp:818
Tpetra_CrsMatrix_fwd.hpp
Forward declaration of Tpetra::CrsMatrix.
Tpetra::CrsMatrix::sumIntoGlobalValues
LocalOrdinal sumIntoGlobalValues(const GlobalOrdinal globalRow, const Teuchos::ArrayView< const GlobalOrdinal > &cols, const Teuchos::ArrayView< const Scalar > &vals, const bool atomic=useAtomicUpdatesByDefault)
Sum into one or more sparse matrix entries, using global indices.
Definition: Tpetra_CrsMatrix_def.hpp:2562
Tpetra::CrsMatrix::fillComplete_
bool fillComplete_
Whether the matrix is fill complete.
Definition: Tpetra_CrsMatrix_decl.hpp:4022
Tpetra::CrsMatrix::add
virtual Teuchos::RCP< RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > add(const Scalar &alpha, const RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params) const override
Implementation of RowMatrix::add: return alpha*A + beta*this.
Definition: Tpetra_CrsMatrix_def.hpp:7405
Tpetra::CrsMatrix::replaceGlobalValues
local_ordinal_type replaceGlobalValues(const global_ordinal_type globalRow, const Kokkos::View< const global_ordinal_type *, Kokkos::AnonymousSpace > &inputInds, const Kokkos::View< const impl_scalar_type *, Kokkos::AnonymousSpace > &inputVals)
Replace one or more entries&#39; values, using global indices.
Definition: Tpetra_CrsMatrix_def.hpp:2453
Tpetra::CrsMatrix::sumIntoGlobalValuesImpl
virtual LocalOrdinal sumIntoGlobalValuesImpl(impl_scalar_type rowVals[], const crs_graph_type &graph, const RowInfo &rowInfo, const GlobalOrdinal inds[], const impl_scalar_type newVals[], const LocalOrdinal numElts, const bool atomic=useAtomicUpdatesByDefault)
Implementation detail of sumIntoGlobalValues.
Definition: Tpetra_CrsMatrix_def.hpp:2478
Tpetra::SrcDistObject
Abstract base class for objects that can be the source of an Import or Export operation.
Definition: Tpetra_SrcDistObject.hpp:57
Tpetra::CrsMatrix::sumIntoLocalValues
local_ordinal_type sumIntoLocalValues(const local_ordinal_type localRow, const Kokkos::View< const local_ordinal_type *, Kokkos::AnonymousSpace > &inputInds, const Kokkos::View< const impl_scalar_type *, Kokkos::AnonymousSpace > &inputVals, const bool atomic=useAtomicUpdatesByDefault)
Sum into one or more sparse matrix entries, using local row and column indices.
Definition: Tpetra_CrsMatrix_def.hpp:3018
Tpetra::CrsMatrix::device_type
typename Node::device_type device_type
The Kokkos device type.
Definition: Tpetra_CrsMatrix_decl.hpp:422
Tpetra::CrsMatrix::getNumEntriesInLocalRow
size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const override
Number of entries in the sparse matrix in the given local row, on the calling (MPI) process...
Definition: Tpetra_CrsMatrix_def.hpp:883
Tpetra::CrsMatrix::getRowMapMultiVector
Teuchos::RCP< MV > getRowMapMultiVector(const MV &Y_rangeMap, const bool force=false) const
Create a (or fetch a cached) row Map MultiVector.
Definition: Tpetra_CrsMatrix_def.hpp:7336
Tpetra::CrsMatrix::description
std::string description() const override
A one-line description of this object.
Definition: Tpetra_CrsMatrix_def.hpp:5202
Tpetra::CrsMatrix::getLocalDiagOffsets
void getLocalDiagOffsets(Teuchos::ArrayRCP< size_t > &offsets) const
Get offsets of the diagonal entries in the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:3492
Tpetra::CrsMatrix::apply
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 override
Compute a sparse matrix-MultiVector multiply.
Definition: Tpetra_CrsMatrix_def.hpp:5105
Tpetra::CrsMatrix::getLocalNumEntries
size_t getLocalNumEntries() const override
The local number of entries in this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:839
Tpetra::CrsMatrix::fillComplete
void fillComplete(const Teuchos::RCP< const map_type > &domainMap, const Teuchos::RCP< const map_type > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Tell the matrix that you are done changing its structure or values, and that you are ready to do comp...
Definition: Tpetra_CrsMatrix_def.hpp:4320
Tpetra::CrsMatrix::insertGlobalValues
void insertGlobalValues(const GlobalOrdinal globalRow, const Teuchos::ArrayView< const GlobalOrdinal > &cols, const Teuchos::ArrayView< const Scalar > &vals)
Insert one or more entries into the matrix, using global column indices.
Definition: Tpetra_CrsMatrix_def.hpp:1943
Tpetra::CrsMatrix::replaceLocalValuesImpl
virtual LocalOrdinal replaceLocalValuesImpl(impl_scalar_type rowVals[], const crs_graph_type &graph, const RowInfo &rowInfo, const LocalOrdinal inds[], const impl_scalar_type newVals[], const LocalOrdinal numElts)
Implementation detail of replaceLocalValues.
Definition: Tpetra_CrsMatrix_def.hpp:2247
Tpetra::CrsMatrix::getValuesViewDeviceNonConst
values_dualv_type::t_dev getValuesViewDeviceNonConst(const RowInfo &rowinfo)
Get a non-const Device view of the locally owned values row myRow, such that rowinfo = getRowInfo(myR...
Definition: Tpetra_CrsMatrix_def.hpp:3111
Tpetra::CrsMatrix::removeEmptyProcessesInPlace
virtual void removeEmptyProcessesInPlace(const Teuchos::RCP< const map_type > &newMap) override
Remove processes owning zero rows from the Maps and their communicator.
Definition: Tpetra_CrsMatrix_def.hpp:7382
Tpetra::CrsMatrix::checkSizes
virtual bool checkSizes(const SrcDistObject &source) override
Compare the source and target (this) objects for compatibility.
Definition: Tpetra_CrsMatrix_def.hpp:5464
Tpetra::CrsMatrix::transformLocalValues
LocalOrdinal transformLocalValues(const LocalOrdinal lclRow, const typename UnmanagedView< LocalIndicesViewType >::type &inputInds, const typename UnmanagedView< ImplScalarViewType >::type &inputVals, BinaryFunction f, const bool atomic=useAtomicUpdatesByDefault)
Transform CrsMatrix entries in place, using local indices to select the entries in the row to transfo...
Definition: Tpetra_CrsMatrix_decl.hpp:1679
Tpetra::CrsMatrix::getBlockSize
virtual LocalOrdinal getBlockSize() const override
The number of degrees of freedom per mesh point.
Definition: Tpetra_CrsMatrix_decl.hpp:2395
Tpetra::CrsGraph
A distributed graph accessed by rows (adjacency lists) and stored sparsely.
Definition: Tpetra_CrsGraph_decl.hpp:190
Tpetra::CrsMatrix::impl_scalar_type
typename row_matrix_type::impl_scalar_type impl_scalar_type
The type used internally in place of Scalar.
Definition: Tpetra_CrsMatrix_decl.hpp:455
Tpetra::Map
A parallel distribution of indices over processes.
Definition: Tpetra_Map_decl.hpp:198
Tpetra::CrsMatrix::getLocalRowCopy
void getLocalRowCopy(LocalOrdinal LocalRow, nonconst_local_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const override
Fill given arrays with a deep copy of the locally owned entries of the matrix in a given row...
Definition: Tpetra_CrsMatrix_def.hpp:3125
Tpetra::CrsMatrix::getDomainMap
Teuchos::RCP< const map_type > getDomainMap() const override
The domain Map of this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:925
Tpetra::CrsMatrix::getLocalValuesHost
local_matrix_host_type::values_type getLocalValuesHost(Access::ReadWriteStruct s)
Get the Kokkos local values on host, read write.
Definition: Tpetra_CrsMatrix_decl.hpp:3312
Tpetra::CrsMatrix::insertLocalValues
void insertLocalValues(const LocalOrdinal localRow, const Teuchos::ArrayView< const LocalOrdinal > &cols, const Teuchos::ArrayView< const Scalar > &vals, const CombineMode CM=ADD)
Insert one or more entries into the matrix, using local column indices.
Definition: Tpetra_CrsMatrix_def.hpp:1711
Tpetra::CrsMatrix::storageStatus_
Details::EStorageStatus storageStatus_
Status of the matrix&#39;s storage, when not in a fill-complete state.
Definition: Tpetra_CrsMatrix_decl.hpp:4018
Tpetra::RowMatrix
A read-only, row-oriented interface to a sparse matrix.
Definition: Tpetra_RowMatrix_decl.hpp:53
Tpetra::CrsMatrix::getLocalIndicesDevice
local_inds_device_view_type getLocalIndicesDevice() const
Get a device_view of the CRS packed column indicies.
Definition: Tpetra_CrsMatrix_decl.hpp:1892
Tpetra::CrsMatrix::rightScale
void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x) override
Scale the matrix on the right with the given Vector.
Definition: Tpetra_CrsMatrix_def.hpp:3738
Tpetra::CrsMatrix::replaceDomainMap
void replaceDomainMap(const Teuchos::RCP< const map_type > &newDomainMap)
Replace the current domain Map with the given objects.
Definition: Tpetra_CrsMatrix_def.hpp:3937
Tpetra::CrsMatrix::getLocalRowView
void getLocalRowView(LocalOrdinal LocalRow, local_inds_host_view_type &indices, values_host_view_type &values) const override
Get a constant view of a row of this matrix, using local row and column indices.
Definition: Tpetra_CrsMatrix_def.hpp:3226
Tpetra::CrsMatrix::getValuesViewHost
values_dualv_type::t_host::const_type getValuesViewHost(const RowInfo &rowinfo) const
Get a const Host view of the locally owned values row myRow, such that rowinfo = getRowInfo(myRow).
Definition: Tpetra_CrsMatrix_def.hpp:3069
Tpetra::Vector
A distributed dense vector.
Definition: Tpetra_Vector_decl.hpp:44
Tpetra::importAndFillCompleteCrsMatrix
Teuchos::RCP< CrsMatrixType > importAndFillCompleteCrsMatrix(const Teuchos::RCP< const CrsMatrixType > &sourceMatrix, const Import< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > &importer, const Teuchos::RCP< const Map< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< typename CrsMatrixType::local_ordinal_type, typename CrsMatrixType::global_ordinal_type, typename CrsMatrixType::node_type > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Nonmember CrsMatrix constructor that fuses Import and fillComplete().
Definition: Tpetra_CrsMatrix_decl.hpp:4121
Tpetra::CrsMatrix::applyTranspose
void applyTranspose(const MV &X_in, MV &Y_in, const Teuchos::ETransp mode, Scalar alpha, Scalar beta) const
Special case of apply() for mode != Teuchos::NO_TRANS.
Definition: Tpetra_CrsMatrix_def.hpp:4845
Tpetra::CrsMatrix::allocateValues
void allocateValues(ELocalGlobal lg, GraphAllocationStatus gas, const bool verbose)
Allocate values (and optionally indices) using the Node.
Definition: Tpetra_CrsMatrix_def.hpp:1029
Tpetra::CrsMatrix::expertStaticFillComplete
void expertStaticFillComplete(const Teuchos::RCP< const map_type > &domainMap, const Teuchos::RCP< const map_type > &rangeMap, const Teuchos::RCP< const import_type > &importer=Teuchos::null, const Teuchos::RCP< const export_type > &exporter=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Perform a fillComplete on a matrix that already has data.
Definition: Tpetra_CrsMatrix_def.hpp:4519
Tpetra::CrsMatrix::getNumEntriesInGlobalRow
size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const override
Number of entries in the sparse matrix in the given global row, on the calling (MPI) process...
Definition: Tpetra_CrsMatrix_def.hpp:876
Tpetra::Details::residual
void residual(const Operator< SC, LO, GO, NO > &A, const MultiVector< SC, LO, GO, NO > &X, const MultiVector< SC, LO, GO, NO > &B, MultiVector< SC, LO, GO, NO > &R)
Computes R = B - A * X.
Definition: Tpetra_Details_residual.hpp:522
Tpetra::CrsMatrix::getLocalValuesDevice
local_matrix_device_type::values_type::const_type getLocalValuesDevice(Access::ReadOnlyStruct s) const
Get the Kokkos local values on device, read only.
Definition: Tpetra_CrsMatrix_decl.hpp:3326
Tpetra::CrsMatrix::setAllValues
void setAllValues(const typename local_graph_device_type::row_map_type &ptr, const typename local_graph_device_type::entries_type::non_const_type &ind, const typename local_matrix_device_type::values_type &val)
Set the local matrix using three (compressed sparse row) arrays.
Definition: Tpetra_CrsMatrix_def.hpp:3387
Tpetra::CrsMatrix::isLocallyIndexed
bool isLocallyIndexed() const override
Whether the matrix is locally indexed on the calling process.
Definition: Tpetra_CrsMatrix_def.hpp:811
Tpetra::CrsMatrix::getColMap
Teuchos::RCP< const map_type > getColMap() const override
The Map that describes the column distribution in this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:918
Tpetra::CrsMatrix::replaceLocalValues
local_ordinal_type replaceLocalValues(const local_ordinal_type localRow, const Kokkos::View< const local_ordinal_type *, Kokkos::AnonymousSpace > &inputInds, const Kokkos::View< const impl_scalar_type *, Kokkos::AnonymousSpace > &inputVals)
Replace one or more entries&#39; values, using local row and column indices.
Definition: Tpetra_CrsMatrix_def.hpp:2337
Tpetra::CrsMatrix::batchedApply
friend void batchedApply(const MatrixArray &Matrices, const typename std::remove_pointer< typename MultiVectorArray::value_type >::type &X, MultiVectorArray &Y, typename std::remove_pointer< typename MatrixArray::value_type >::type::scalar_type alpha, typename std::remove_pointer< typename MatrixArray::value_type >::type::scalar_type beta, Teuchos::RCP< Teuchos::ParameterList > params)
Does multiply matrix apply() calls with a single X vector.
Definition: Tpetra_Apply_Helpers.hpp:44
Tpetra::CrsMatrix::replaceRangeMap
void replaceRangeMap(const Teuchos::RCP< const map_type > &newRangeMap)
Replace the current range Map with the given objects.
Definition: Tpetra_CrsMatrix_def.hpp:3968
Tpetra::DistObject
Base class for distributed Tpetra objects that support data redistribution.
Definition: Tpetra_DistObject_decl.hpp:285
Tpetra::CrsGraph::local_graph_host_type
typename local_graph_device_type::HostMirror local_graph_host_type
The type of the part of the sparse graph on each MPI process.
Definition: Tpetra_CrsGraph_decl.hpp:233
Tpetra::removeCrsMatrixZeros
void removeCrsMatrixZeros(CrsMatrixType &matrix, typename Teuchos::ScalarTraits< typename CrsMatrixType::scalar_type >::magnitudeType const &threshold=Teuchos::ScalarTraits< typename CrsMatrixType::scalar_type >::magnitude(Teuchos::ScalarTraits< typename CrsMatrixType::scalar_type >::zero()))
Remove zero entries from a matrix.
Definition: Tpetra_CrsMatrix_decl.hpp:4209
Tpetra::CrsMatrix::local_ordinal_type
LocalOrdinal local_ordinal_type
The type of each local index in the matrix.
Definition: Tpetra_CrsMatrix_decl.hpp:418
Tpetra::Details::EStorageStatus
EStorageStatus
Status of the graph&#39;s or matrix&#39;s storage, when not in a fill-complete state.
Definition: Tpetra_CrsGraph_decl.hpp:121
Tpetra::CrsMatrix::getFrobeniusNorm
mag_type getFrobeniusNorm() const override
Compute and return the Frobenius norm of the matrix.
Definition: Tpetra_CrsMatrix_def.hpp:3831
Tpetra::CrsMatrix::local_graph_device_type
typename crs_graph_type::local_graph_device_type local_graph_device_type
The part of the sparse matrix&#39;s graph on each MPI process.
Definition: Tpetra_CrsMatrix_decl.hpp:467
Tpetra::CrsMatrix::localApply
void localApply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, const Teuchos::ETransp mode=Teuchos::NO_TRANS, const Scalar &alpha=Teuchos::ScalarTraits< Scalar >::one(), const Scalar &beta=Teuchos::ScalarTraits< Scalar >::zero()) const
Compute the local part of a sparse matrix-(Multi)Vector multiply.
Definition: Tpetra_CrsMatrix_def.hpp:4980
TpetraExt_MatrixMatrix_fwd.hpp
Forward declaration of some Tpetra Matrix Matrix objects.
Tpetra::CrsMatrix::isStorageOptimized
bool isStorageOptimized() const
Returns true if storage has been optimized.
Definition: Tpetra_CrsMatrix_def.hpp:804
Tpetra::CrsMatrix::copyAndPermute
virtual void copyAndPermute(const SrcDistObject &source, const size_t numSameIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteToLIDs, const Kokkos::DualView< const local_ordinal_type *, buffer_device_type > &permuteFromLIDs, const CombineMode CM) override
Definition: Tpetra_CrsMatrix_def.hpp:6022
Tpetra::CrsMatrix::getValuesViewHostNonConst
values_dualv_type::t_host getValuesViewHostNonConst(const RowInfo &rowinfo)
Get a non-const Host view of the locally owned values row myRow, such that rowinfo = getRowInfo(myRow...
Definition: Tpetra_CrsMatrix_def.hpp:3083
Tpetra::CrsMatrix::export_type
Export< LocalOrdinal, GlobalOrdinal, Node > export_type
The Export specialization suitable for this CrsMatrix specialization.
Definition: Tpetra_CrsMatrix_decl.hpp:441
Tpetra::CrsMatrix::exportMV_
Teuchos::RCP< MV > exportMV_
Row Map MultiVector used in apply().
Definition: Tpetra_CrsMatrix_decl.hpp:3831
Tpetra::CrsMatrix::getLocalNumRows
size_t getLocalNumRows() const override
The number of matrix rows owned by the calling process.
Definition: Tpetra_CrsMatrix_def.hpp:860
Tpetra::CrsMatrix::getRowMap
Teuchos::RCP< const map_type > getRowMap() const override
The Map that describes the row distribution in this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:911
Tpetra::CrsMatrix::getGlobalNumEntries
global_size_t getGlobalNumEntries() const override
The global number of entries in this matrix.
Definition: Tpetra_CrsMatrix_def.hpp:832
Generated on Mon Sep 15 2025 09:20:50 for Tpetra parallel linear algebra by   doxygen 1.8.5