Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_RowGraph.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_ROWGRAPH_HPP
47#define XPETRA_ROWGRAPH_HPP
48
49/* this file is automatically generated - do not edit (see script/interfaces.py) */
50
51#include <Teuchos_Describable.hpp>
52#include <KokkosCompat_DefaultNode.hpp>
53#include "Xpetra_ConfigDefs.hpp"
54#include "Xpetra_Map.hpp"
55#include "Xpetra_Import.hpp"
56#include "Xpetra_Export.hpp"
57
58namespace Xpetra {
59
60 template<class LocalOrdinal,
61 class GlobalOrdinal,
64 : virtual public Teuchos::Describable
65 {
66 public:
67 typedef LocalOrdinal local_ordinal_type;
68 typedef GlobalOrdinal global_ordinal_type;
69 typedef Node node_type;
70
72
73
75 virtual ~RowGraph() { }
76
78
80
81
84
85
88
91
94
97
100
103
105 virtual global_size_t getGlobalNumRows() const = 0;
106
108 virtual global_size_t getGlobalNumCols() const = 0;
109
111 virtual size_t getLocalNumRows() const = 0;
112
114 virtual size_t getLocalNumCols() const = 0;
115
117 virtual GlobalOrdinal getIndexBase() const = 0;
118
121
123 virtual size_t getNodeNumEntries() const = 0;
124
126 virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
127
129 virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
130
132 virtual size_t getGlobalMaxNumRowEntries() const = 0;
133
135 virtual size_t getLocalMaxNumRowEntries() const = 0;
136
138 virtual bool hasColMap() const = 0;
139
141 virtual bool isLocallyIndexed() const = 0;
142
144 virtual bool isGloballyIndexed() const = 0;
145
147 virtual bool isFillComplete() const = 0;
148
150
152
153
155 virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, size_t &NumIndices) const = 0;
156
158 virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, size_t &NumIndices) const = 0;
159
160
162
163 }; // RowGraph class
164
165} // Xpetra namespace
166
167#define XPETRA_ROWGRAPH_SHORT
168#endif // XPETRA_ROWGRAPH_HPP
virtual size_t getLocalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
virtual ~RowGraph()
Destructor.
virtual const Teuchos::RCP< const Teuchos::Comm< int > > getComm() const =0
Returns the communicator.
virtual bool isLocallyIndexed() const =0
If graph indices are in the local range, this function returns true. Otherwise, this function returns...
virtual global_size_t getGlobalNumCols() const =0
Returns the number of global columns in the graph.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const =0
Returns the Map that describes the row distribution in this graph.
virtual size_t getNodeNumEntries() const =0
Returns the local number of entries in the graph.
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries on this node in the specified global row.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const =0
Returns the Map that describes the column distribution in this graph.
virtual global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in the graph.
virtual bool hasColMap() const =0
Indicates whether the graph has a well-defined column map.
virtual size_t getLocalNumCols() const =0
Returns the number of columns connected to the locally owned rows of this graph.
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in the graph.
virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, size_t &NumIndices) const =0
Extract a list of entries in a specified global row of the graph. Put into pre-allocated storage.
virtual Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > getImporter() const =0
Returns the importer associated with this graph.
LocalOrdinal local_ordinal_type
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
Returns the Map associated with the domain of this graph.
virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, size_t &NumIndices) const =0
Extract a list of entries in a specified local row of the graph. Put into storage allocated by callin...
virtual size_t getLocalNumRows() const =0
Returns the number of rows owned on the calling node.
virtual size_t getGlobalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on all nodes.
GlobalOrdinal global_ordinal_type
virtual Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > getExporter() const =0
Returns the exporter associated with this graph.
virtual bool isGloballyIndexed() const =0
If graph indices are in the global range, this function returns true. Otherwise, this function return...
virtual GlobalOrdinal getIndexBase() const =0
Returns the index base for global indices for this graph.
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
virtual bool isFillComplete() const =0
Returns true if fillComplete() has been called.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
Returns the Map associated with the domain of this graph.
Xpetra namespace
size_t global_size_t
Global size_t object.