43#ifndef IFPACK2_OVERLAPPINGROWMATRIX_DECL_HPP
44#define IFPACK2_OVERLAPPINGROWMATRIX_DECL_HPP
46#include "Ifpack2_Details_RowMatrix.hpp"
47#include "Tpetra_CrsMatrix_decl.hpp"
48#include "Tpetra_Import_decl.hpp"
49#include "Tpetra_Map_decl.hpp"
57template<
class MatrixType>
63 typedef typename MatrixType::scalar_type scalar_type;
64 typedef typename MatrixType::local_ordinal_type local_ordinal_type;
65 typedef typename MatrixType::global_ordinal_type global_ordinal_type;
66 typedef typename MatrixType::node_type node_type;
67 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
68 typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
69 typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
70 typedef typename MatrixType::values_host_view_type values_host_view_type;
72 typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
73 typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
74 typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;
76 using row_matrix_type = Tpetra::RowMatrix<scalar_type, local_ordinal_type,
77 global_ordinal_type, node_type>;
78 using crs_matrix_type = Tpetra::CrsMatrix<scalar_type, local_ordinal_type,
79 global_ordinal_type, node_type>;
82 typedef typename MatrixType::node_type::device_type device_type;
83 typedef typename device_type::execution_space execution_space;
84 typedef typename MatrixType::local_inds_device_view_type local_inds_device_view_type;
85 typedef typename MatrixType::global_inds_device_view_type global_inds_device_view_type;
86 typedef typename MatrixType::values_device_view_type values_device_view_type;
88 static_assert(std::is_same<MatrixType, row_matrix_type>::value,
"Ifpack2::OverlappingRowMatrix: The template parameter MatrixType must be a Tpetra::RowMatrix specialization. Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore. The constructor can take either a RowMatrix or a CrsMatrix just fine.");
90 typedef typename row_matrix_type::mag_type mag_type;
107 const int overlapLevel);
117 virtual Teuchos::RCP<const Teuchos::Comm<int> >
getComm()
const;
121 virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
125 virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
131 virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
137 virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
141 virtual Teuchos::RCP<const Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> >
229 nonconst_global_inds_host_view_type &Indices,
230 nonconst_values_host_view_type &Values,
231 size_t& NumEntries)
const;
246 nonconst_local_inds_host_view_type &Indices,
247 nonconst_values_host_view_type &Values,
248 size_t& NumEntries)
const;
262 global_inds_host_view_type &indices,
263 values_host_view_type &values)
const;
277 local_inds_host_view_type & indices,
278 values_host_view_type & values)
const;
284 void getLocalDiagCopy (Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &diag)
const;
300 leftScale (
const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);
312 rightScale (
const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);
330 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &X,
331 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &Y,
332 Teuchos::ETransp mode = Teuchos::NO_TRANS,
333 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
334 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
340 importMultiVector (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &X,
341 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &OvX,
342 Tpetra::CombineMode CM = Tpetra::INSERT);
345 exportMultiVector (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &OvX,
346 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &X,
347 Tpetra::CombineMode CM = Tpetra::ADD);
349 std::string description()
const;
351 void describe(Teuchos::FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel)
const;
353 Teuchos::RCP<const crs_matrix_type> getUnderlyingMatrix()
const;
355 Teuchos::RCP<const crs_matrix_type> getExtMatrix()
const;
357 Kokkos::View<size_t*, typename OverlappingRowMatrix<MatrixType>::device_type> getExtHaloStarts()
const;
358 typename Kokkos::View<size_t*, typename OverlappingRowMatrix<MatrixType>::device_type>::HostMirror getExtHaloStartsHost()
const;
363 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
364 typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> import_type;
365 typedef Tpetra::Export<local_ordinal_type, global_ordinal_type, node_type> export_type;
366 typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;
367 typedef Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> vector_type;
370 Teuchos::RCP<const crs_matrix_type> A_;
372 Tpetra::global_size_t NumGlobalRows_;
373 Tpetra::global_size_t NumGlobalNonzeros_;
374 size_t MaxNumEntries_;
378 Teuchos::RCP<const map_type> RowMap_;
379 Teuchos::RCP<const map_type> ColMap_;
380 Teuchos::RCP<const import_type> Importer_;
383 Teuchos::RCP<crs_matrix_type> ExtMatrix_;
384 Teuchos::RCP<const map_type> ExtMap_;
385 Teuchos::RCP<const import_type> ExtImporter_;
386 Kokkos::View<size_t*, device_type> ExtHaloStarts_;
387 typename Kokkos::View<size_t*, device_type>::HostMirror ExtHaloStarts_h;
390 Teuchos::RCP<const row_graph_type> graph_;
392 mutable nonconst_local_inds_host_view_type Indices_;
394 mutable nonconst_values_host_view_type Values_;
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:67
Sparse matrix (Tpetra::RowMatrix subclass) with ghost rows.
Definition: Ifpack2_OverlappingRowMatrix_decl.hpp:59
virtual void apply(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
Computes the operator-multivector application.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:541
virtual bool hasTransposeApply() const
Whether this operator's apply() method can apply the adjoint (transpose).
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:599
virtual Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getRangeMap() const
The Map that describes the range of this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:279
virtual void getLocalRowCopy(local_ordinal_type LocalRow, nonconst_local_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const
Extract a list of entries in a specified local row of the graph. Put into storage allocated by callin...
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:428
virtual bool isLocallyIndexed() const
Whether this matrix is locally indexed.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:394
virtual size_t getNumEntriesInGlobalRow(global_ordinal_type globalRow) const
The number of entries in the given global row that are owned by the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:346
virtual void getLocalRowView(local_ordinal_type LocalRow, local_inds_host_view_type &indices, values_host_view_type &values) const
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:465
virtual void getGlobalRowCopy(global_ordinal_type GlobalRow, nonconst_global_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const
Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:417
virtual Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getColMap() const
The Map that describes the distribution of columns over processes.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:254
~OverlappingRowMatrix()=default
Destructor.
virtual size_t getGlobalMaxNumRowEntries() const
The maximum number of entries in any row on any process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:373
virtual global_size_t getGlobalNumCols() const
The global number of columns in this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:301
virtual bool isGloballyIndexed() const
Whether this matrix is globally indexed.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:401
virtual global_ordinal_type getIndexBase() const
The index base for global indices for this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:323
virtual size_t getLocalNumEntries() const
The number of entries in this matrix owned by the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:337
virtual Teuchos::RCP< const Tpetra::RowGraph< local_ordinal_type, global_ordinal_type, node_type > > getGraph() const
This matrix's graph.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:287
virtual size_t getLocalNumCols() const
The number of columns owned by the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:315
virtual size_t getLocalNumRows() const
The number of rows owned by the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:308
virtual void getGlobalRowView(global_ordinal_type GlobalRow, global_inds_host_view_type &indices, values_host_view_type &values) const
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:446
virtual size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const
The number of entries in the given local row that are owned by the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:360
virtual void rightScale(const Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:524
virtual bool hasColMap() const
Whether this matrix has a column Map.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:387
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
The communicator over which the matrix is distributed.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:235
virtual global_size_t getGlobalNumRows() const
The global number of rows in this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:294
virtual bool supportsRowViews() const
true if row views are supported, else false.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:606
virtual global_size_t getGlobalNumEntries() const
The global number of entries in this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:330
virtual Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getRowMap() const
The Map that describes the distribution of rows over processes.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:245
virtual void leftScale(const Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:515
virtual size_t getLocalMaxNumRowEntries() const
The maximum number of entries in any row on the calling process.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:380
virtual bool isFillComplete() const
true if fillComplete() has been called, else false.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:408
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:532
virtual void getLocalDiagCopy(Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &diag) const
Get a copy of the diagonal entries owned by this node, with local row indices.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:482
virtual Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getDomainMap() const
The Map that describes the domain of this matrix.
Definition: Ifpack2_OverlappingRowMatrix_def.hpp:263
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74