Tpetra_RowMatrix_decl.hpp

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_ROWMATRIX_DECL_HPP
#define TPETRA_ROWMATRIX_DECL_HPP

#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_RowMatrix_fwd.hpp"
#include "Tpetra_Vector_fwd.hpp"
#include "Tpetra_Operator.hpp"
#include "Tpetra_RowGraph_fwd.hpp"
#include "Tpetra_Packable.hpp"
#include "Tpetra_SrcDistObject.hpp"
#include "Teuchos_Describable.hpp"
#if KOKKOS_VERSION >= 40799
#include "KokkosKernels_ArithTraits.hpp"
#else
#include "Kokkos_ArithTraits.hpp"
#endif

namespace Tpetra {
template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class RowMatrix : virtual public Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
                  virtual public SrcDistObject,
                  public Packable<char, LocalOrdinal> {
 public:


  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

#if KOKKOS_VERSION >= 40799
  using impl_scalar_type = typename KokkosKernels::ArithTraits<Scalar>::val_type;
#else
  using impl_scalar_type = typename Kokkos::ArithTraits<Scalar>::val_type;
#endif
#if KOKKOS_VERSION >= 40799
  using mag_type = typename KokkosKernels::ArithTraits<Scalar>::mag_type;
#else
  using mag_type         = typename Kokkos::ArithTraits<Scalar>::mag_type;
#endif

  typedef typename Kokkos::View<impl_scalar_type*, typename Node::device_type>::const_type
      values_device_view_type;
  typedef typename values_device_view_type::host_mirror_type::const_type
      values_host_view_type;
  typedef typename values_device_view_type::host_mirror_type
      nonconst_values_host_view_type;

  typedef typename Kokkos::View<LocalOrdinal*, typename Node::device_type>::const_type
      local_inds_device_view_type;
  typedef typename local_inds_device_view_type::host_mirror_type::const_type
      local_inds_host_view_type;
  typedef typename local_inds_device_view_type::host_mirror_type
      nonconst_local_inds_host_view_type;

  typedef typename Kokkos::View<GlobalOrdinal*, typename Node::device_type>::const_type
      global_inds_device_view_type;
  typedef typename global_inds_device_view_type::host_mirror_type::const_type
      global_inds_host_view_type;
  typedef typename global_inds_device_view_type::host_mirror_type
      nonconst_global_inds_host_view_type;

  typedef typename Kokkos::View<const size_t*, typename Node::device_type>::const_type
      row_ptrs_device_view_type;
  typedef typename row_ptrs_device_view_type::host_mirror_type::const_type
      row_ptrs_host_view_type;



  virtual ~RowMatrix();



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

  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const = 0;

  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getColMap() const = 0;

  virtual Teuchos::RCP<const RowGraph<LocalOrdinal, GlobalOrdinal, Node> > getGraph() const = 0;

  virtual global_size_t getGlobalNumRows() const = 0;

  virtual global_size_t getGlobalNumCols() const = 0;

  virtual size_t getLocalNumRows() const = 0;

  virtual size_t getLocalNumCols() const = 0;

  virtual GlobalOrdinal getIndexBase() const = 0;

  virtual global_size_t getGlobalNumEntries() const = 0;

  virtual size_t getLocalNumEntries() const = 0;

  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;

  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;

  virtual size_t getGlobalMaxNumRowEntries() const = 0;

  virtual local_ordinal_type getBlockSize() const = 0;

  virtual size_t getLocalMaxNumRowEntries() const = 0;

  virtual bool hasColMap() const = 0;

  virtual bool isLocallyIndexed() const = 0;

  virtual bool isGloballyIndexed() const = 0;

  virtual bool isFillComplete() const = 0;

  virtual bool supportsRowViews() const = 0;



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

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

  virtual void
  getGlobalRowView(GlobalOrdinal GlobalRow,
                   global_inds_host_view_type& indices,
                   values_host_view_type& values) const = 0;

  virtual void
  getLocalRowView(LocalOrdinal LocalRow,
                  local_inds_host_view_type& indices,
                  values_host_view_type& values) const = 0;

  virtual void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& diag) const = 0;



  virtual void leftScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x) = 0;

  virtual void rightScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x) = 0;

  virtual mag_type getFrobeniusNorm() const = 0;

  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 = Teuchos::null,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& rangeMap  = Teuchos::null,
      const Teuchos::RCP<Teuchos::ParameterList>& params                           = Teuchos::null) const;

 private:
  bool
  packRow(char* const numEntOut,
          char* const valOut,
          char* const indOut,
          const size_t numEnt,
          const LocalOrdinal lclRow) const;

  // TODO (mfh 25 Jan 2015) Could just make this "protected" and let
  // CrsMatrix use it, since it's exactly the same there.
  void
  allocatePackSpace(Teuchos::Array<char>& exports,
                    size_t& totalNumEntries,
                    const Teuchos::ArrayView<const LocalOrdinal>& exportLIDs) const;

  void
  packImpl(const Teuchos::ArrayView<const LocalOrdinal>& exportLIDs,
           Teuchos::Array<char>& exports,
           const Teuchos::ArrayView<size_t>& numPacketsPerLID,
           size_t& constantNumPackets) const;

 public:
  virtual void
  pack(const Teuchos::ArrayView<const LocalOrdinal>& exportLIDs,
       Teuchos::Array<char>& exports,
       const Teuchos::ArrayView<size_t>& numPacketsPerLID,
       size_t& constantNumPackets) const;
};  // class RowMatrix
}  // namespace Tpetra

#endif  // TPETRA_ROWMATRIX_DECL_HPP