Xpetra_CrsGraph.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//             Xpetra: A linear algebra interface package
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_CRSGRAPH_HPP
#define XPETRA_CRSGRAPH_HPP

#include <Teuchos_ParameterList.hpp>

#include <Teuchos_Describable.hpp>
#include <Tpetra_KokkosCompat_DefaultNode.hpp>
#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_DistObject.hpp"
#include "Xpetra_Exceptions.hpp"

#include "Xpetra_Map.hpp"

#ifdef HAVE_XPETRA_TPETRA
#include <Kokkos_StaticCrsGraph.hpp>
#endif

namespace Xpetra {

using Teuchos::ParameterList;

struct RowInfo {
  size_t localRow;
  size_t allocSize;
  size_t numEntries;
  size_t offset1D;
};

enum ELocalGlobal {
  LocalIndices,
  GlobalIndices
};

template <class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class CrsGraph
  : /*public RowGraph<>,*/ public DistObject<GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node> {
 public:
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

  //@

  virtual ~CrsGraph() {}




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

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

  virtual void removeLocalIndices(LocalOrdinal localRow) = 0;

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

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

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




  virtual void fillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap, const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap, const RCP<ParameterList> &params = null) = 0;

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

  virtual void
  expertStaticFillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap,
                           const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap,
                           const RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > &importer = null,
                           const RCP<const Export<LocalOrdinal, GlobalOrdinal, Node> > &exporter = null,
                           const RCP<Teuchos::ParameterList> &params                             = null) = 0;




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

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

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

  virtual RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getDomainMap() const = 0;

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

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

  virtual 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 getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;

  virtual size_t getNumAllocatedEntriesInLocalRow(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 bool isStorageOptimized() const = 0;

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

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

  virtual void computeGlobalConstants() = 0;



#ifdef HAVE_XPETRA_TPETRA
  typedef typename node_type::execution_space execution_space;
  typedef typename node_type::device_type device_type;
  typedef Kokkos::StaticCrsGraph<LocalOrdinal, Kokkos::LayoutLeft, device_type, void, size_t> local_graph_type;

  virtual typename local_graph_type::HostMirror getLocalGraphHost() const = 0;
  virtual local_graph_type getLocalGraphDevice() const                    = 0;

  virtual void getLocalDiagOffsets(const Kokkos::View<size_t *, device_type, Kokkos::MemoryUnmanaged> &offsets) const = 0;

#else
#ifdef __GNUC__
#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
#endif
#endif




  virtual std::string description() const = 0;

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


};  // CrsGraph class

}  // namespace Xpetra

#define XPETRA_CRSGRAPH_SHORT
#endif  // XPETRA_CRSGRAPH_HPP