Tpetra_RowGraph_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_ROWGRAPH_DECL_HPP
#define TPETRA_ROWGRAPH_DECL_HPP

#include "Tpetra_RowGraph_fwd.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_Import.hpp"
#include "Tpetra_Export.hpp"
#include "Tpetra_Packable.hpp"
#include "Teuchos_Describable.hpp"

namespace Tpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class RowGraph : virtual public Teuchos::Describable,
                 public Packable<GlobalOrdinal, LocalOrdinal> {
 public:

  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_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 ~RowGraph(){};



  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 Map<LocalOrdinal, GlobalOrdinal, Node> >
  getDomainMap() const = 0;

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

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

  virtual Teuchos::RCP<const Export<LocalOrdinal, GlobalOrdinal, Node> >
  getExporter() 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 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 void
  getGlobalRowCopy(const GlobalOrdinal gblRow,
                   nonconst_global_inds_host_view_type& gblColInds,
                   size_t& numColInds) const = 0;

  virtual void
  getLocalRowCopy(const LocalOrdinal lclRow,
                  nonconst_local_inds_host_view_type& lclColInds,
                  size_t& numColInds) const = 0;

  virtual bool supportsRowViews() const {
    return false;
  }

  virtual void
  getLocalRowView(const LocalOrdinal lclRow,
                  local_inds_host_view_type& lclColInds) const = 0;

  virtual void
  getGlobalRowView(const GlobalOrdinal gblRow,
                   global_inds_host_view_type& gblColInds) const = 0;



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

#endif  // TPETRA_ROWGRAPH_DECL_HPP