Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_OverlappingRowGraph_decl.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP
44 #define IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP
45 
46 #include <Ifpack2_ConfigDefs.hpp>
47 #include <Tpetra_RowGraph.hpp>
48 #include <Tpetra_Import_decl.hpp>
49 #include <Tpetra_Export_decl.hpp>
50 
51 namespace Ifpack2 {
52 namespace Details {
53 
64 template<class GraphType>
66  virtual public Tpetra::RowGraph<typename GraphType::local_ordinal_type,
67  typename GraphType::global_ordinal_type,
68  typename GraphType::node_type> {
69 public:
71 
72  typedef typename GraphType::local_ordinal_type local_ordinal_type;
73  typedef typename GraphType::global_ordinal_type global_ordinal_type;
74  typedef typename GraphType::node_type node_type;
75 
76  typedef Tpetra::Export<local_ordinal_type, global_ordinal_type, node_type> export_type;
77  typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> import_type;
78  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
79  typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;
81 
83 
103  OverlappingRowGraph (const Teuchos::RCP<const row_graph_type>& nonoverlappingGraph,
104  const Teuchos::RCP<const row_graph_type>& overlappingGraph,
105  const Teuchos::RCP<const map_type>& rowMap,
106  const Teuchos::RCP<const map_type>& colMap,
107  const Tpetra::global_size_t numGlobalRows,
108  const Tpetra::global_size_t numGlobalCols,
109  const Tpetra::global_size_t numGlobalNonzeros,
110  const size_t maxNumEntries,
111  const Teuchos::RCP<const import_type>& nonoverlappingImporter,
112  const Teuchos::RCP<const import_type>& overlappingImporter);
114  virtual ~OverlappingRowGraph ();
115 
117 
119 
122 
124  virtual Teuchos::RCP<node_type> getNode () const;
125 
127  virtual Teuchos::RCP<const map_type> getRowMap () const;
128 
130  virtual Teuchos::RCP<const map_type> getColMap () const;
131 
137 
142  virtual Teuchos::RCP<const map_type> getRangeMap () const;
143 
146 
149 
151  virtual global_size_t getGlobalNumRows () const;
152 
154  virtual global_size_t getGlobalNumCols () const;
155 
157  virtual size_t getNodeNumRows () const;
158 
164  virtual size_t getNodeNumCols () const;
165 
167  virtual global_ordinal_type getIndexBase () const;
168 
170  virtual global_size_t getGlobalNumEntries () const;
171 
173  virtual size_t getNodeNumEntries () const;
174 
184  virtual size_t getNumEntriesInGlobalRow (global_ordinal_type globalRow) const;
185 
195  virtual size_t getNumEntriesInLocalRow (local_ordinal_type localRow) const;
196 
198  virtual global_size_t getGlobalNumDiags () const;
199 
201  virtual size_t getNodeNumDiags () const;
202 
204  virtual size_t getGlobalMaxNumRowEntries () const;
205 
207  virtual size_t getNodeMaxNumRowEntries() const;
208 
210  virtual bool hasColMap() const;
211 
213  virtual bool isLowerTriangular() const;
214 
216  virtual bool isUpperTriangular() const;
217 
219  virtual bool isLocallyIndexed () const;
220 
222  virtual bool isGloballyIndexed () const;
223 
225  virtual bool isFillComplete() const;
226 
228 
230 
244  virtual void
245  getGlobalRowCopy (global_ordinal_type globalRow,
247  size_t& numIndices) const;
248 
266  virtual void
267  getLocalRowCopy (local_ordinal_type localRow,
269  size_t& numIndices) const;
271 private:
273 
274  Teuchos::RCP<const row_graph_type> nonoverlappingGraph_;
275  Teuchos::RCP<const row_graph_type> overlappingGraph_;
278  const Tpetra::global_size_t numGlobalRows_;
279  const Tpetra::global_size_t numGlobalCols_;
280  const Tpetra::global_size_t numGlobalNonzeros_;
281  const size_t maxNumEntries_;
282  Teuchos::RCP<const import_type> nonoverlappingImporter_;
283  Teuchos::RCP<const import_type> overlappingImporter_;
285 };
286 
287 } // namespace Details
288 } // namespace Ifpack2
289 
290 #endif // IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP
virtual size_t getNodeNumCols() const
The number of columns owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:170
virtual bool isGloballyIndexed() const
Whether this graph is globally indexed.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:285
virtual size_t getNodeNumEntries() const
The number of entries in this graph owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:192
virtual bool isLowerTriangular() const
Whether this graph is lower triangular.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:264
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)
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:56
virtual bool isLocallyIndexed() const
Whether this graph is locally indexed.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:278
virtual size_t getNodeNumRows() const
The number of rows owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:162
virtual global_ordinal_type getIndexBase() const
The index base for global indices for this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:178
virtual void getLocalRowCopy(local_ordinal_type localRow, const Teuchos::ArrayView< local_ordinal_type > &indices, size_t &numIndices) const
Copy out a list of local column indices in the given local row that are owned by the calling process...
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:321
virtual Teuchos::RCP< node_type > getNode() const
The graph&#39;s Node instance.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:93
virtual Teuchos::RCP< const map_type > getRangeMap() const
The Map that describes the range of this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:125
virtual Teuchos::RCP< const import_type > getImporter() const
Import object (from domain Map to column Map).
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:133
virtual bool hasColMap() const
Whether this graph has a column Map.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:257
Ifpack2 implementation details.
virtual global_size_t getGlobalNumDiags() const
The global number of diagonal entries.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:229
virtual bool isFillComplete() const
true if fillComplete() has been called, else false.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:292
virtual Teuchos::RCP< const map_type > getRowMap() const
The Map that describes the distribution of rows over processes.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:101
virtual size_t getNodeNumDiags() const
The number of diagonal entries owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:236
virtual void getGlobalRowCopy(global_ordinal_type globalRow, const Teuchos::ArrayView< global_ordinal_type > &indices, size_t &numIndices) const
Copy out a list of column indices in the given global row that are owned by the calling process...
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:301
virtual size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const
The number of entries in the given local row that are owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:216
virtual Teuchos::RCP< const map_type > getColMap() const
The Map that describes the distribution of columns over processes.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:109
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
The communicator over which the graph is distributed.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:85
Sparse graph (Tpetra::RowGraph subclass) with ghost rows.
Definition: Ifpack2_Details_OverlappingRowGraph_decl.hpp:65
virtual global_size_t getGlobalNumEntries() const
The global number of entries in this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:185
virtual ~OverlappingRowGraph()
Destructor.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:80
virtual Teuchos::RCP< const export_type > getExporter() const
Export object (from row Map to range Map).
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:141
virtual global_size_t getGlobalNumCols() const
The global number of columns in this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:155
virtual Teuchos::RCP< const map_type > getDomainMap() const
The Map that describes the domain of this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:117
virtual global_size_t getGlobalNumRows() const
The global number of rows in this graph.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:148
virtual size_t getNumEntriesInGlobalRow(global_ordinal_type globalRow) const
The number of entries in the given global row that are owned by the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:202
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
virtual size_t getGlobalMaxNumRowEntries() const
The maximum number of entries in any row on any process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:243
virtual bool isUpperTriangular() const
Whether this graph is upper triangular.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:271
virtual size_t getNodeMaxNumRowEntries() const
The maximum number of entries in any row on the calling process.
Definition: Ifpack2_Details_OverlappingRowGraph_def.hpp:250