Xpetra_TpetraCrsGraph_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef XPETRA_TPETRACRSGRAPH_DECL_HPP
#define XPETRA_TPETRACRSGRAPH_DECL_HPP

/* this file is automatically generated - do not edit (see script/tpetra.py) */

#include "Xpetra_TpetraConfigDefs.hpp"
#include "Xpetra_Exceptions.hpp"

#include "Tpetra_CrsGraph.hpp"

#include "Xpetra_CrsGraph.hpp"
#include "Xpetra_TpetraMap_decl.hpp"
#include "Xpetra_TpetraImport_decl.hpp"
#include "Xpetra_TpetraExport_decl.hpp"
#include "Xpetra_Utils.hpp"

namespace Xpetra {

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class TpetraCrsGraph
  : public CrsGraph<LocalOrdinal, GlobalOrdinal, Node> {
#undef XPETRA_TPETRACRSGRAPH_SHORT
#include "Xpetra_UseShortNamesOrdinal.hpp"
  // The following typedef is used by the XPETRA_DYNAMIC_CAST() macro.
  typedef TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> TpetraCrsGraphClass;
  typedef TpetraImport<LocalOrdinal, GlobalOrdinal, Node> TpetraImportClass;
  typedef TpetraExport<LocalOrdinal, GlobalOrdinal, Node> TpetraExportClass;
  typedef Map map_type;

  using local_graph_type        = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_type;
  using local_graph_device_type = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_device_type;
  using local_graph_host_type   = typename Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node>::local_graph_host_type;

 public:


  TpetraCrsGraph(const RCP<const Map>& rowMap, size_t maxNumEntriesPerRow, const RCP<ParameterList>& params = null);

  TpetraCrsGraph(const RCP<const Map>& rowMap, const ArrayRCP<const size_t>& NumEntriesPerRowToAlloc, const RCP<ParameterList>& params = null);

  TpetraCrsGraph(const RCP<const Map>& rowMap, const RCP<const Map>& colMap, size_t maxNumEntriesPerRow, const RCP<ParameterList>& params = null);

  TpetraCrsGraph(const RCP<const Map>& rowMap, const RCP<const Map>& colMap, const ArrayRCP<const size_t>& NumEntriesPerRowToAlloc, const RCP<ParameterList>& params = null);

  // Constructor for fused import
  TpetraCrsGraph(const RCP<const CrsGraph>& sourceGraph,
                 const Import& importer,
                 const RCP<const Map>& domainMap           = Teuchos::null,
                 const RCP<const Map>& rangeMap            = Teuchos::null,
                 const RCP<Teuchos::ParameterList>& params = Teuchos::null);

  TpetraCrsGraph(const Teuchos::RCP<const Map>& rowMap,
                 const Teuchos::RCP<const Map>& colMap,
                 const typename local_graph_type::row_map_type& rowPointers,
                 const typename local_graph_type::entries_type::non_const_type& columnIndices,
                 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);

  TpetraCrsGraph(const local_graph_type& lclGraph,
                 const Teuchos::RCP<const map_type>& rowMap,
                 const Teuchos::RCP<const map_type>& colMap,
                 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);

  TpetraCrsGraph(const Teuchos::RCP<const Map>& rowMap,
                 const Teuchos::RCP<const Map>& colMap,
                 const local_graph_type& lclGraph,
                 const Teuchos::RCP<Teuchos::ParameterList>& params);

  TpetraCrsGraph(const Teuchos::RCP<const Map>& rowMap,
                 const Teuchos::RCP<const Map>& colMap,
                 const Teuchos::ArrayRCP<size_t>& rowPointers,
                 const Teuchos::ArrayRCP<LocalOrdinal>& columnIndices,
                 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);

  virtual ~TpetraCrsGraph();



  void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView<const GlobalOrdinal>& indices);

  void insertLocalIndices(const LocalOrdinal localRow, const ArrayView<const LocalOrdinal>& indices);

  void removeLocalIndices(LocalOrdinal localRow);

  void allocateAllIndices(size_t numNonZeros, ArrayRCP<size_t>& rowptr, ArrayRCP<LocalOrdinal>& colind);

  void setAllIndices(const ArrayRCP<size_t>& rowptr, const ArrayRCP<LocalOrdinal>& colind);

  void getAllIndices(ArrayRCP<const size_t>& rowptr, ArrayRCP<const LocalOrdinal>& colind) const;




  void fillComplete(const RCP<const Map>& domainMap, const RCP<const Map>& rangeMap, const RCP<ParameterList>& params = null);

  void fillComplete(const RCP<ParameterList>& params = null);

  void
  expertStaticFillComplete(const Teuchos::RCP<const map_type>& domainMap,
                           const Teuchos::RCP<const map_type>& rangeMap,
                           const Teuchos::RCP<const Import>& importer =
                               Teuchos::null,
                           const Teuchos::RCP<const Export>& exporter =
                               Teuchos::null,
                           const Teuchos::RCP<Teuchos::ParameterList>& params =
                               Teuchos::null);




  RCP<const Comm<int> > getComm() const;

  RCP<const Map> getRowMap() const;

  RCP<const Map> getColMap() const;

  RCP<const Map> getDomainMap() const;

  RCP<const Map> getRangeMap() const;

  RCP<const Import> getImporter() const;

  RCP<const Export> getExporter() const;

  global_size_t getGlobalNumRows() const;

  global_size_t getGlobalNumCols() const;

  size_t getLocalNumRows() const;

  size_t getLocalNumCols() const;

  GlobalOrdinal getIndexBase() const;

  global_size_t getGlobalNumEntries() const;

  size_t getLocalNumEntries() const;

  size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;

  size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;

  size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const;

  size_t getNumAllocatedEntriesInLocalRow(LocalOrdinal localRow) const;

  size_t getGlobalMaxNumRowEntries() const;

  size_t getLocalMaxNumRowEntries() const;

  bool hasColMap() const;

  bool isLocallyIndexed() const;

  bool isGloballyIndexed() const;

  bool isFillComplete() const;

  bool isStorageOptimized() const;

  void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal>& Indices) const;

  void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal>& indices) const;

#if KOKKOS_VERSION >= 40799
  typename local_graph_type::host_mirror_type getLocalGraphHost() const;
#else
  typename local_graph_type::HostMirror getLocalGraphHost() const;
#endif

  local_graph_type getLocalGraphDevice() const;

  void getLocalDiagOffsets(const Kokkos::View<size_t*, typename Node::device_type, Kokkos::MemoryUnmanaged>& offsets) const;

  void computeGlobalConstants();




  std::string description() const;

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




  ArrayRCP<const size_t> getNodeRowPtrs() const;


  //{@

  Teuchos::RCP<const Map> getMap() const;

  void doImport(const DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node>& source,
                const Import& importer, CombineMode CM);

  void doExport(const DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node>& dest,
                const Import& importer, CombineMode CM);

  void doImport(const DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node>& source,
                const Export& exporter, CombineMode CM);

  void doExport(const DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node>& dest,
                const Export& exporter, CombineMode CM);

  // @}



  TpetraCrsGraph(const Teuchos::RCP<Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >& graph);

  RCP<const Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > getTpetra_CrsGraph() const;


 private:
  RCP<Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > graph_;
};  // TpetraCrsGraph class

// TODO: move that elsewhere
template <class LocalOrdinal, class GlobalOrdinal, class Node>
RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >
toXpetra(RCP<const Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > graph) {  // TODO: return TpetraCrsGraph instead of CrsGraph
  // typedef TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> TpetraCrsGraphClass;
  // XPETRA_RCP_DYNAMIC_CAST(const TpetraCrsGraphClass, graph, tGraph, "toTpetra");
  if (graph.is_null()) {
    return Teuchos::null;
  }
  RCP<Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > tGraph =
      Teuchos::rcp_const_cast<Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >(graph);
  return rcp(new Xpetra::TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node>(tGraph));
}

template <class LocalOrdinal, class GlobalOrdinal, class Node>
RCP<const Tpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >
toTpetra(const RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >& graph) {
  typedef TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> TpetraCrsGraphClass;
  XPETRA_RCP_DYNAMIC_CAST(const TpetraCrsGraphClass, graph, tpetraCrsGraph, "toTpetra");
  return tpetraCrsGraph->getTpetra_CrsGraph();
}

}  // namespace Xpetra

#endif  // XPETRA_TPETRACRSGRAPH_DECL_HPP