Ifpack2_OverlappingRowMatrix_decl.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef IFPACK2_OVERLAPPINGROWMATRIX_DECL_HPP
#define IFPACK2_OVERLAPPINGROWMATRIX_DECL_HPP

#include "Ifpack2_Details_RowMatrix.hpp"
#include "Tpetra_CrsMatrix_decl.hpp"  // only need the declaration here
#include "Tpetra_Import_decl.hpp"
#include "Tpetra_Map_decl.hpp"
#include <type_traits>

namespace Ifpack2 {

template <class MatrixType>
class OverlappingRowMatrix : virtual public Ifpack2::Details::RowMatrix<MatrixType> {
 public:

  typedef typename MatrixType::scalar_type scalar_type;
  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
  typedef typename MatrixType::node_type node_type;
  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
  typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
  typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
  typedef typename MatrixType::values_host_view_type values_host_view_type;

  typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
  typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
  typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;

  using row_matrix_type = Tpetra::RowMatrix<scalar_type, local_ordinal_type,
                                            global_ordinal_type, node_type>;
  using crs_matrix_type = Tpetra::CrsMatrix<scalar_type, local_ordinal_type,
                                            global_ordinal_type, node_type>;

  // device typedefs
  typedef typename MatrixType::node_type::device_type device_type;
  typedef typename device_type::execution_space execution_space;
  typedef typename MatrixType::local_inds_device_view_type local_inds_device_view_type;
  typedef typename MatrixType::global_inds_device_view_type global_inds_device_view_type;
  typedef typename MatrixType::values_device_view_type values_device_view_type;

  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.");

  typedef typename row_matrix_type::mag_type mag_type;



  OverlappingRowMatrix(const Teuchos::RCP<const row_matrix_type> &A,
                       const int overlapLevel);

  ~OverlappingRowMatrix() = default;



  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;

  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getRowMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getColMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getDomainMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getRangeMap() const;

  virtual Teuchos::RCP<const Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> >
  getGraph() const;

  virtual global_size_t getGlobalNumRows() const;

  virtual global_size_t getGlobalNumCols() const;

  virtual size_t getLocalNumRows() const;

  virtual size_t getLocalNumCols() const;

  virtual global_ordinal_type getIndexBase() const;

  virtual global_size_t getGlobalNumEntries() const;

  virtual size_t getLocalNumEntries() const;

  virtual size_t getNumEntriesInGlobalRow(global_ordinal_type globalRow) const;

  virtual size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const;

  virtual size_t getGlobalMaxNumRowEntries() const;

  virtual size_t getLocalMaxNumRowEntries() const;

  virtual local_ordinal_type getBlockSize() const;

  virtual bool hasColMap() const;

  virtual bool isLocallyIndexed() const;

  virtual bool isGloballyIndexed() const;

  virtual bool isFillComplete() const;

  virtual bool supportsRowViews() const;




  virtual void
  getGlobalRowCopy(global_ordinal_type GlobalRow,
                   nonconst_global_inds_host_view_type &Indices,
                   nonconst_values_host_view_type &Values,
                   size_t &NumEntries) const;


  virtual void
  getLocalRowCopy(local_ordinal_type LocalRow,
                  nonconst_local_inds_host_view_type &Indices,
                  nonconst_values_host_view_type &Values,
                  size_t &NumEntries) const;


  virtual void
  getGlobalRowView(global_ordinal_type GlobalRow,
                   global_inds_host_view_type &indices,
                   values_host_view_type &values) const;


  virtual void
  getLocalRowView(local_ordinal_type LocalRow,
                  local_inds_host_view_type &indices,
                  values_host_view_type &values) const;


  virtual void getLocalDiagCopy(Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &diag) const;



  virtual void
  leftScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &x);

  virtual void
  rightScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &x);


  virtual mag_type
  getFrobeniusNorm() const;


  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;

  virtual bool hasTransposeApply() const;

  virtual void
  importMultiVector(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> &OvX,
                    Tpetra::CombineMode CM = Tpetra::INSERT);

  virtual void
  exportMultiVector(const Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &OvX,
                    Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &X,
                    Tpetra::CombineMode CM = Tpetra::ADD);

  std::string description() const;

  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const;

  Teuchos::RCP<const crs_matrix_type> getUnderlyingMatrix() const;

  Teuchos::RCP<const crs_matrix_type> getExtMatrix() const;

  Kokkos::View<size_t *, typename OverlappingRowMatrix<MatrixType>::device_type> getExtHaloStarts() const;
  typename Kokkos::View<size_t *, typename OverlappingRowMatrix<MatrixType>::device_type>::HostMirror getExtHaloStartsHost() const;

  void doExtImport();

 private:
  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
  typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> import_type;
  typedef Tpetra::Export<local_ordinal_type, global_ordinal_type, node_type> export_type;
  typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;
  typedef Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> vector_type;

  Teuchos::RCP<const crs_matrix_type> A_;

  Tpetra::global_size_t NumGlobalRows_;
  Tpetra::global_size_t NumGlobalNonzeros_;
  size_t MaxNumEntries_;
  int OverlapLevel_;

  // Wrapper matrix objects
  Teuchos::RCP<const map_type> RowMap_;
  Teuchos::RCP<const map_type> ColMap_;
  Teuchos::RCP<const import_type> Importer_;

  Teuchos::RCP<crs_matrix_type> ExtMatrix_;
  Teuchos::RCP<const map_type> ExtMap_;
  Teuchos::RCP<const import_type> ExtImporter_;
  Kokkos::View<size_t *, device_type> ExtHaloStarts_;
  typename Kokkos::View<size_t *, device_type>::HostMirror ExtHaloStarts_h;

  Teuchos::RCP<const row_graph_type> graph_;
  mutable nonconst_local_inds_host_view_type Indices_;
  mutable nonconst_values_host_view_type Values_;

};  // class OverlappingRowMatrix

}  // namespace Ifpack2

#endif  // IFPACK2_OVERLAPPINGROWMATRIX_DECL_HPP