All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Xpetra_CrsGraph.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Xpetra: A linear algebra interface package
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef XPETRA_CRSGRAPH_HPP
47 #define XPETRA_CRSGRAPH_HPP
48 
50 
51 #include <Teuchos_Describable.hpp>
52 #include <Kokkos_DefaultNode.hpp>
53 #include "Xpetra_ConfigDefs.hpp"
54 #include "Xpetra_DistObject.hpp"
55 #include "Xpetra_Exceptions.hpp"
56 
57 #include "Xpetra_Map.hpp"
58 
59 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
60 #ifdef HAVE_XPETRA_TPETRA
61 #include <Kokkos_StaticCrsGraph.hpp>
62 #endif
63 #endif
64 
65 namespace Xpetra {
66 
68 
69  struct RowInfo {
70  size_t localRow;
71  size_t allocSize;
72  size_t numEntries;
73  size_t offset1D;
74  };
75 
76  enum ELocalGlobal {
79  };
80 
81  template <class LocalOrdinal = Map<>::local_ordinal_type,
82  class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type,
83  class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
84  class CrsGraph
85  : /*public RowGraph<>,*/ public DistObject<GlobalOrdinal,LocalOrdinal,GlobalOrdinal,Node>
86  {
87  public:
88  typedef LocalOrdinal local_ordinal_type;
89  typedef GlobalOrdinal global_ordinal_type;
90  typedef Node node_type;
91 
93 
94 
96  virtual ~CrsGraph() { }
97 
99 
101 
102 
104  virtual void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)= 0;
105 
107  virtual void insertLocalIndices(const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)= 0;
108 
110  virtual void removeLocalIndices(LocalOrdinal localRow)= 0;
111 
113 
115 
116 
118  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;
119 
121  virtual void fillComplete(const RCP< ParameterList > &params=null)= 0;
122 
124 
126 
127 
129  virtual RCP< const Comm< int > > getComm() const = 0;
130 
133 
136 
139 
142 
145 
148 
150  virtual global_size_t getGlobalNumRows() const = 0;
151 
153  virtual global_size_t getGlobalNumCols() const = 0;
154 
156  virtual size_t getNodeNumRows() const = 0;
157 
159  virtual size_t getNodeNumCols() const = 0;
160 
162  virtual GlobalOrdinal getIndexBase() const = 0;
163 
165  virtual global_size_t getGlobalNumEntries() const = 0;
166 
168  virtual size_t getNodeNumEntries() const = 0;
169 
171  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
172 
174  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
175 
177  virtual size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
178 
180  virtual size_t getNumAllocatedEntriesInLocalRow(LocalOrdinal localRow) const = 0;
181 
183  virtual size_t getGlobalMaxNumRowEntries() const = 0;
184 
186  virtual size_t getNodeMaxNumRowEntries() const = 0;
187 
189  virtual bool hasColMap() const = 0;
190 
192  virtual bool isLocallyIndexed() const = 0;
193 
195  virtual bool isGloballyIndexed() const = 0;
196 
198  virtual bool isFillComplete() const = 0;
199 
201  virtual bool isStorageOptimized() const = 0;
202 
204  virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const = 0;
205 
207  virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const = 0;
208 
210  virtual void computeGlobalConstants() =0;
211 
213 
215 
216 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR
217 #ifdef HAVE_XPETRA_TPETRA
218  typedef typename node_type::execution_space execution_space;
219  typedef Kokkos::StaticCrsGraph<LocalOrdinal, Kokkos::LayoutLeft, execution_space> local_graph_type;
220 
228  virtual local_graph_type getLocalGraph () const = 0;
229 #else
230 #ifdef __GNUC__
231 #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."
232 #endif
233 #endif
234 #endif
235 
237 
239 
240 
242  virtual std::string description() const = 0;
243 
246 
248 
249  }; // CrsGraph class
250 
251 } // Xpetra namespace
252 
253 #define XPETRA_CRSGRAPH_SHORT
254 #endif // XPETRA_CRSGRAPH_HPP
virtual bool hasColMap() const =0
Whether the graph has a column Map.
virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const =0
Return a const, nonpersisting view of local indices in the given row.
virtual bool isStorageOptimized() const =0
Returns true if storage has been optimized.
virtual size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of allocated entries for this node in the specified global row ...
virtual RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > getExporter() const =0
Returns the exporter associated with this graph.
virtual size_t getNodeNumRows() const =0
Returns the number of graph rows owned on the calling node.
virtual RCP< const Comm< int > > getComm() const =0
Returns the communicator.
virtual void insertLocalIndices(const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)=0
Insert local indices into the graph.
virtual void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)=0
Insert global indices into the graph.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print the object with some verbosity level to an FancyOStream object.
virtual size_t getNumAllocatedEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of allocated entries on this node in the specified local row...
LocalOrdinal local_ordinal_type
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
virtual ~CrsGraph()
Destructor.
GlobalOrdinal global_ordinal_type
virtual bool isLocallyIndexed() const =0
Whether column indices are stored using local indices on the calling process.
virtual global_size_t getGlobalNumCols() const =0
Returns the number of global columns in the graph.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
Returns the Map associated with the domain of this graph.
virtual void removeLocalIndices(LocalOrdinal localRow)=0
Remove all graph indices from the specified local row.
virtual GlobalOrdinal getIndexBase() const =0
Returns the index base for global indices for this graph.
virtual global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in the graph.
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in the graph.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
Returns the Map associated with the domain of this graph.
virtual size_t getNodeNumCols() const =0
Returns the number of columns connected to the locally owned rows of this graph.
virtual bool isFillComplete() const =0
Whether fillComplete() has been called and the graph is in compute mode.
size_t global_size_t
Global size_t object.
static const EVerbosityLevel verbLevel_default
virtual size_t getNodeNumEntries() const =0
Returns the local number of entries in the graph.
virtual std::string description() const =0
Return a simple one-line description of this object.
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries on this node in the specified global row.
virtual size_t getNodeMaxNumRowEntries() const =0
Maximum number of entries in all rows owned by the calling process.
virtual size_t getGlobalMaxNumRowEntries() const =0
Maximum number of entries in all rows over all processes.
virtual void computeGlobalConstants()=0
Force the computation of global constants if we don&#39;t have them.
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
Signal that data entry is complete, specifying domain and range maps.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const =0
Returns the Map that describes the row distribution in this graph.
virtual bool isGloballyIndexed() const =0
Whether column indices are stored using global indices on the calling process.
virtual RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > getImporter() const =0
Returns the importer associated with this graph.
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const =0
Return a const, nonpersisting view of global indices in the given row.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const =0
Returns the Map that describes the column distribution in this graph.