Ifpack2_Details_OverlappingRowGraph_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_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP
#define IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP

#include <Ifpack2_ConfigDefs.hpp>
#include "Ifpack2_Details_RowGraph.hpp"
#include <Tpetra_Import_decl.hpp>
#include <Tpetra_Export_decl.hpp>

namespace Ifpack2 {
namespace Details {

template <class GraphType>
class OverlappingRowGraph : virtual public Ifpack2::Details::RowGraph<GraphType> {
 public:

  typedef typename GraphType::local_ordinal_type local_ordinal_type;
  typedef typename GraphType::global_ordinal_type global_ordinal_type;
  typedef typename GraphType::node_type node_type;
  typedef typename GraphType::local_inds_host_view_type local_inds_host_view_type;
  typedef typename GraphType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
  typedef typename GraphType::global_inds_host_view_type global_inds_host_view_type;
  typedef typename GraphType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;

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



  OverlappingRowGraph(const Teuchos::RCP<const row_graph_type>& nonoverlappingGraph,
                      const Teuchos::RCP<const row_graph_type>& overlappingGraph,
                      const Teuchos::RCP<const map_type>& rowMap,
                      const Teuchos::RCP<const map_type>& colMap,
                      const Tpetra::global_size_t numGlobalRows,
                      const Tpetra::global_size_t numGlobalCols,
                      const Tpetra::global_size_t numGlobalNonzeros,
                      const size_t maxNumEntries,
                      const Teuchos::RCP<const import_type>& nonoverlappingImporter,
                      const Teuchos::RCP<const import_type>& overlappingImporter);
  virtual ~OverlappingRowGraph();



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

  virtual Teuchos::RCP<const map_type> getRowMap() const;

  virtual Teuchos::RCP<const map_type> getColMap() const;

  virtual Teuchos::RCP<const map_type> getDomainMap() const;

  virtual Teuchos::RCP<const map_type> getRangeMap() const;

  virtual Teuchos::RCP<const import_type> getImporter() const;

  virtual Teuchos::RCP<const export_type> getExporter() 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 bool hasColMap() const;

  virtual bool isLocallyIndexed() const;

  virtual bool isGloballyIndexed() const;

  virtual bool isFillComplete() const;



  virtual void
  getGlobalRowCopy(global_ordinal_type globalRow,
                   nonconst_global_inds_host_view_type& gblColInds,
                   size_t& numIndices) const;

  virtual void
  getLocalRowCopy(local_ordinal_type localRow,
                  nonconst_local_inds_host_view_type& gblColInds,
                  size_t& numIndices) const;

  virtual void
  getLocalRowView(const local_ordinal_type lclRow,
                  local_inds_host_view_type& lclColInds) const;

  virtual void
  getGlobalRowView(const global_ordinal_type gblRow,
                   global_inds_host_view_type& gblColInds) const;

 private:

  Teuchos::RCP<const row_graph_type> nonoverlappingGraph_;
  Teuchos::RCP<const row_graph_type> overlappingGraph_;
  Teuchos::RCP<const map_type> rowMap_;
  Teuchos::RCP<const map_type> colMap_;
  const Tpetra::global_size_t numGlobalRows_;
  const Tpetra::global_size_t numGlobalCols_;
  const Tpetra::global_size_t numGlobalNonzeros_;
  const size_t maxNumEntries_;
  Teuchos::RCP<const import_type> nonoverlappingImporter_;
  Teuchos::RCP<const import_type> overlappingImporter_;
};

}  // namespace Details
}  // namespace Ifpack2

#endif  // IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP