Xpetra Version of the Day
Loading...
Searching...
No Matches
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 <KokkosCompat_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_TPETRA
60#include <Kokkos_StaticCrsGraph.hpp>
61#endif
62
63namespace Xpetra {
64
66
67 struct RowInfo {
68 size_t localRow;
69 size_t allocSize;
70 size_t numEntries;
71 size_t offset1D;
72 };
73
78
79 template <class LocalOrdinal,
80 class GlobalOrdinal,
83 : /*public RowGraph<>,*/ public DistObject<GlobalOrdinal,LocalOrdinal,GlobalOrdinal,Node>
84 {
85 public:
86 typedef LocalOrdinal local_ordinal_type;
87 typedef GlobalOrdinal global_ordinal_type;
88 typedef Node node_type;
89
91 //@
92
94 virtual ~CrsGraph() { }
95
97
99
100
102 virtual void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)= 0;
103
105 virtual void insertLocalIndices(const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)= 0;
106
108 virtual void removeLocalIndices(LocalOrdinal localRow)= 0;
109
111 virtual void allocateAllIndices(size_t numNonZeros,ArrayRCP<size_t> & rowptr, ArrayRCP<LocalOrdinal> & colind)=0;
112
114 virtual void setAllIndices(const ArrayRCP<size_t> & rowptr, const ArrayRCP<LocalOrdinal> & colind)=0;
115
117 virtual void getAllIndices(ArrayRCP<const size_t>& rowptr, ArrayRCP<const LocalOrdinal>& colind) const = 0;
118
120
122
123
125 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;
126
128 virtual void fillComplete(const RCP< ParameterList > &params=null)= 0;
129
131 virtual void
132 expertStaticFillComplete (const RCP<const Map < LocalOrdinal, GlobalOrdinal, Node > >& domainMap,
133 const RCP<const Map < LocalOrdinal, GlobalOrdinal, Node > >& rangeMap,
134 const RCP<const Import< LocalOrdinal, GlobalOrdinal, Node > >& importer =null,
135 const RCP<const Export< LocalOrdinal, GlobalOrdinal, Node > >& exporter =null,
136 const RCP<Teuchos::ParameterList>& params = null)=0;
137
138
140
142
143
145 virtual RCP< const Comm< int > > getComm() const = 0;
146
149
152
155
158
161
164
166 virtual global_size_t getGlobalNumRows() const = 0;
167
169 virtual global_size_t getGlobalNumCols() const = 0;
170
172 virtual size_t getLocalNumRows() const = 0;
173
175 virtual size_t getLocalNumCols() const = 0;
176
178 virtual GlobalOrdinal getIndexBase() const = 0;
179
182
184 virtual size_t getLocalNumEntries() const = 0;
185
187 virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
188
190 virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
191
193 virtual size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
194
196 virtual size_t getNumAllocatedEntriesInLocalRow(LocalOrdinal localRow) const = 0;
197
199 virtual size_t getGlobalMaxNumRowEntries() const = 0;
200
202 virtual size_t getLocalMaxNumRowEntries() const = 0;
203
205 virtual bool hasColMap() const = 0;
206
208 virtual bool isLocallyIndexed() const = 0;
209
211 virtual bool isGloballyIndexed() const = 0;
212
214 virtual bool isFillComplete() const = 0;
215
217 virtual bool isStorageOptimized() const = 0;
218
220 virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const = 0;
221
223 virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const = 0;
224
226 virtual void computeGlobalConstants() =0;
227
229
231
232#ifdef HAVE_XPETRA_TPETRA
233 typedef typename node_type::execution_space execution_space;
234 typedef typename node_type::device_type device_type;
235 typedef Kokkos::StaticCrsGraph<LocalOrdinal, Kokkos::LayoutLeft, device_type, void, size_t> local_graph_type;
236
244 virtual typename local_graph_type::HostMirror getLocalGraphHost () const = 0;
246
247#else
248#ifdef __GNUC__
249#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."
250#endif
251#endif
252
254
256
257
259 virtual std::string description() const = 0;
260
263
265
266 }; // CrsGraph class
267
268} // Xpetra namespace
269
270#define XPETRA_CRSGRAPH_SHORT
271#endif // XPETRA_CRSGRAPH_HPP
static const EVerbosityLevel verbLevel_default
virtual void allocateAllIndices(size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< LocalOrdinal > &colind)=0
Allocates the 1D pointer arrays of the graph.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
Returns the Map associated with the domain of this graph.
virtual void getAllIndices(ArrayRCP< const size_t > &rowptr, ArrayRCP< const LocalOrdinal > &colind) const =0
Gets the 1D pointer arrays of the graph.
node_type::execution_space execution_space
virtual size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of allocated entries for this node in the specified global row .
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in the graph.
virtual local_graph_type::HostMirror getLocalGraphHost() const =0
Get the local graph.
virtual bool isGloballyIndexed() const =0
Whether column indices are stored using global indices on the calling process.
virtual void insertLocalIndices(const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)=0
Insert local indices into the graph.
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 GlobalOrdinal getIndexBase() const =0
Returns the index base for global indices for this graph.
virtual void removeLocalIndices(LocalOrdinal localRow)=0
Remove all graph indices from the specified local row.
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const =0
Return a const, nonpersisting view of global indices in the given row.
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 global_size_t getGlobalNumCols() const =0
Returns the number of global columns in the graph.
virtual global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in the graph.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const =0
Returns the Map that describes the row distribution in this graph.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
Returns the Map associated with the domain of this graph.
virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const =0
Return a const, nonpersisting view of local indices in the given row.
virtual void setAllIndices(const ArrayRCP< size_t > &rowptr, const ArrayRCP< LocalOrdinal > &colind)=0
Sets the 1D pointer arrays of the graph.
virtual size_t getLocalNumEntries() const =0
Returns the local number of entries in the graph.
virtual RCP< const Comm< int > > getComm() const =0
Returns the communicator.
virtual size_t getGlobalMaxNumRowEntries() const =0
Maximum number of entries in all rows over all processes.
virtual size_t getLocalNumCols() const =0
Returns the number of columns connected to the locally owned rows of this graph.
Kokkos::StaticCrsGraph< LocalOrdinal, Kokkos::LayoutLeft, device_type, void, size_t > local_graph_type
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries on this node in the specified global row.
virtual ~CrsGraph()
Destructor.
virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const =0
Returns the Map that describes the column distribution in this graph.
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
Expert version of fillComplete.
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 getLocalMaxNumRowEntries() const =0
Maximum number of entries in all rows owned by the calling process.
virtual bool isStorageOptimized() const =0
Returns true if storage has been optimized.
node_type::device_type device_type
virtual void computeGlobalConstants()=0
Force the computation of global constants if we don't have them.
virtual std::string description() const =0
Return a simple one-line description of this object.
virtual size_t getLocalNumRows() const =0
Returns the number of graph rows owned on the calling node.
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
virtual RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > getImporter() const =0
Returns the importer associated with this graph.
virtual bool hasColMap() const =0
Whether the graph has a column Map.
GlobalOrdinal global_ordinal_type
virtual void fillComplete(const RCP< ParameterList > &params=null)=0
Signal that data entry is complete.
virtual local_graph_type getLocalGraphDevice() const =0
virtual bool isFillComplete() const =0
Whether fillComplete() has been called and the graph is in compute mode.
virtual bool isLocallyIndexed() const =0
Whether column indices are stored using local indices on the calling process.
virtual RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > getExporter() const =0
Returns the exporter associated with this graph.
virtual void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)=0
Insert global indices into the graph.
Xpetra namespace
size_t global_size_t
Global size_t object.