Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_RowGraph.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Xpetra: A linear algebra interface package
4//
5// Copyright 2012 NTESS and the Xpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef XPETRA_ROWGRAPH_HPP
11#define XPETRA_ROWGRAPH_HPP
12
13/* this file is automatically generated - do not edit (see script/interfaces.py) */
14
15#include <Teuchos_Describable.hpp>
16#include <Tpetra_KokkosCompat_DefaultNode.hpp>
17#include "Xpetra_ConfigDefs.hpp"
18#include "Xpetra_Map.hpp"
19#include "Xpetra_Import.hpp"
20#include "Xpetra_Export.hpp"
21
22namespace Xpetra {
23
24template <class LocalOrdinal,
25 class GlobalOrdinal,
26 class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
28 : virtual public Teuchos::Describable {
29 public:
30 typedef LocalOrdinal local_ordinal_type;
31 typedef GlobalOrdinal global_ordinal_type;
32 typedef Node node_type;
33
35
36
38 virtual ~RowGraph() {}
39
41
43
44
47
50
53
56
59
62
65
67 virtual global_size_t getGlobalNumRows() const = 0;
68
70 virtual global_size_t getGlobalNumCols() const = 0;
71
73 virtual size_t getLocalNumRows() const = 0;
74
76 virtual size_t getLocalNumCols() const = 0;
77
79 virtual GlobalOrdinal getIndexBase() const = 0;
80
83
85 virtual size_t getNodeNumEntries() const = 0;
86
88 virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
89
91 virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
92
94 virtual size_t getGlobalMaxNumRowEntries() const = 0;
95
97 virtual size_t getLocalMaxNumRowEntries() const = 0;
98
100 virtual bool hasColMap() const = 0;
101
103 virtual bool isLocallyIndexed() const = 0;
104
106 virtual bool isGloballyIndexed() const = 0;
107
109 virtual bool isFillComplete() const = 0;
110
112
114
115
117 virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const Teuchos::ArrayView<GlobalOrdinal> &Indices, size_t &NumIndices) const = 0;
118
120 virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView<LocalOrdinal> &Indices, size_t &NumIndices) const = 0;
121
123
124}; // RowGraph class
125
126} // namespace Xpetra
127
128#define XPETRA_ROWGRAPH_SHORT
129#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.
size_t global_size_t
Global size_t object.