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 
49 /* this file is automatically generated - do not edit (see script/interfaces.py) */
50 
52 
53 #include <Teuchos_Describable.hpp>
54 #include <Kokkos_DefaultNode.hpp>
55 #include "Xpetra_ConfigDefs.hpp"
56 #include "Xpetra_DistObject.hpp"
57 #include "Xpetra_Exceptions.hpp"
58 
59 #include "Xpetra_Map.hpp"
60 
62 
63 namespace Xpetra {
64 
65  struct RowInfo {
66  size_t localRow;
67  size_t allocSize;
68  size_t numEntries;
69  size_t offset1D;
70  };
71 
72  enum ELocalGlobal {
75  };
76 
77  template <class LocalOrdinal = Map<>::local_ordinal_type,
78  class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type,
79  class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
80  class CrsGraph
81  : /*public RowGraph<>,*/ public DistObject<GlobalOrdinal,LocalOrdinal,GlobalOrdinal,Node>
82  {
83  public:
84  typedef LocalOrdinal local_ordinal_type;
85  typedef GlobalOrdinal global_ordinal_type;
86  typedef Node node_type;
87 
89 
90 
92  virtual ~CrsGraph() { }
93 
95 
97 
98 
100  virtual void insertGlobalIndices(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices)= 0;
101 
103  virtual void insertLocalIndices(const LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices)= 0;
104 
106  virtual void removeLocalIndices(LocalOrdinal localRow)= 0;
107 
109 
111 
112 
114  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;
115 
117  virtual void fillComplete(const RCP< ParameterList > &params=null)= 0;
118 
120 
122 
123 
125  virtual RCP< const Comm< int > > getComm() const = 0;
126 
128  virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const = 0;
129 
131  virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const = 0;
132 
134  virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const = 0;
135 
137  virtual RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const = 0;
138 
140  virtual RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > getImporter() const = 0;
141 
143  virtual RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > getExporter() const = 0;
144 
146  virtual global_size_t getGlobalNumRows() const = 0;
147 
149  virtual global_size_t getGlobalNumCols() const = 0;
150 
152  virtual size_t getNodeNumRows() const = 0;
153 
155  virtual size_t getNodeNumCols() const = 0;
156 
158  virtual GlobalOrdinal getIndexBase() const = 0;
159 
161  virtual global_size_t getGlobalNumEntries() const = 0;
162 
164  virtual size_t getNodeNumEntries() const = 0;
165 
167  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
168 
170  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
171 
173  virtual size_t getNumAllocatedEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
174 
176  virtual size_t getNumAllocatedEntriesInLocalRow(LocalOrdinal localRow) const = 0;
177 
179  virtual global_size_t getGlobalNumDiags() const = 0;
180 
182  virtual size_t getNodeNumDiags() const = 0;
183 
185  virtual size_t getGlobalMaxNumRowEntries() const = 0;
186 
188  virtual size_t getNodeMaxNumRowEntries() const = 0;
189 
191  virtual bool hasColMap() const = 0;
192 
194  virtual bool isLowerTriangular() const = 0;
195 
197  virtual bool isUpperTriangular() const = 0;
198 
200  virtual bool isLocallyIndexed() const = 0;
201 
203  virtual bool isGloballyIndexed() const = 0;
204 
206  virtual bool isFillComplete() const = 0;
207 
209  virtual bool isStorageOptimized() const = 0;
210 
212  virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &Indices) const = 0;
213 
215  virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices) const = 0;
216 
218 
220 
221 
223  virtual std::string description() const = 0;
224 
226  virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const = 0;
227 
229 
230  }; // CrsGraph class
231 
232 } // Xpetra namespace
233 
234 #define XPETRA_CRSGRAPH_SHORT
235 #endif // XPETRA_CRSGRAPH_HPP
GlobalOrdinal global_ordinal_type
Definition: Xpetra_Map.hpp:86
Xpetra namespace
LocalOrdinal local_ordinal_type
virtual ~CrsGraph()
Destructor.
GlobalOrdinal global_ordinal_type
size_t global_size_t
Global size_t object.
static const EVerbosityLevel verbLevel_default