IFPACK Development
Loading...
Searching...
No Matches
Ifpack_Graph_Epetra_CrsGraph.h
1/*@HEADER
2// ***********************************************************************
3//
4// Ifpack: Object-Oriented Algebraic Preconditioner Package
5// Copyright (2002) 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 IFPACK_EPETRA_CRSGRAPH_H
44#define IFPACK_EPETRA_CRSGRAPH_H
45
46#if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
47#ifdef __GNUC__
48#warning "The Ifpack package is deprecated"
49#endif
50#endif
51#include "Ifpack_ConfigDefs.h"
52#include "Ifpack_Graph.h"
53#include "Epetra_CrsGraph.h"
54#include "Teuchos_RefCountPtr.hpp"
55
56class Epetra_Comm;
57class Epetra_CrsGraph;
58
60
69
70public:
71
73 Ifpack_Graph_Epetra_CrsGraph(const Teuchos::RefCountPtr<const Epetra_CrsGraph>& CrsGraph);
74
77
79 int NumMyRows() const
80 {
81 return(NumMyRows_);
82 }
83
85 int NumMyCols() const
86 {
87 return(NumMyCols_);
88 }
89
90#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
92 int NumGlobalRows() const
93 {
94 if(CrsGraph_->RowMap().GlobalIndicesInt())
95 return (int) (NumGlobalRows_);
96 else
97 throw "Ifpack_Graph_Epetra_CrsGraph::NumGlobalRows: GlobalIndices not int.";
98 }
99#endif
100 long long NumGlobalRows64() const
101 {
102 return(NumGlobalRows_);
103 }
104
105#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
107 int NumGlobalCols() const
108 {
109 if(CrsGraph_->ColMap().GlobalIndicesInt())
110 return (int) (NumGlobalCols_);
111 else
112 throw "Ifpack_Graph_Epetra_CrsGraph::NumGlobalCols: GlobalIndices not int.";
113 }
114#endif
115 long long NumGlobalCols64() const
116 {
117 return(NumGlobalCols_);
118 }
119
121 int MaxMyNumEntries() const
122 {
123 return(MaxNumIndices_);
124 }
125
127 int NumMyNonzeros() const;
128
130 bool Filled() const;
131
132#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
134 int GRID(int) const;
135#endif
136 long long GRID64(int) const;
137
138#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
140 int GCID(int) const;
141#endif
142 long long GCID64(int) const;
143
144#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
146 int LRID(int) const;
147
149 int LCID(int) const;
150#endif
151
152#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
154 int LRID(long long) const;
155
157 int LCID(long long) const;
158#endif
159
161 int ExtractMyRowCopy(int GlobalRow, int LenOfIndices,
162 int &NumIndices, int *Indices) const;
163
165 const Epetra_Comm& Comm() const;
166
168 virtual std::ostream& Print(std::ostream& os) const;
169
170private:
171
173 int NumMyRows_;
175 int NumMyCols_;
177 long long NumGlobalRows_;
179 long long NumGlobalCols_;
181 int MaxNumIndices_;
183 Teuchos::RefCountPtr<const Epetra_CrsGraph> CrsGraph_;
184};
185
186#endif
Ifpack_Graph_Epetra_CrsGraph: a class to define Ifpack_Graph as a light-weight conversion of Epetra_C...
bool Filled() const
Returns true is graph is filled.
int GCID(int) const
Returns the global column ID of input local column.
int LRID(int) const
Returns the local row ID of input global row.
int NumGlobalRows() const
Returns the number of global rows.
int NumMyNonzeros() const
Returns the number of local nonzero entries.
int MaxMyNumEntries() const
Returns the maximun number of entries for row.
int LCID(int) const
Returns the local column ID of input global column.
const Epetra_Comm & Comm() const
Returns the communicator object of the graph.
int ExtractMyRowCopy(int GlobalRow, int LenOfIndices, int &NumIndices, int *Indices) const
Extracts a copy of input local row.
int NumMyCols() const
Returns the number of local columns.
int NumMyRows() const
Returns the number of local rows.
virtual std::ostream & Print(std::ostream &os) const
Prints basic information about the graph object.
int GRID(int) const
Returns the global row ID of input local row.
int NumGlobalCols() const
Returns the number of global columns.
long long GCID64(int) const
Returns the global column ID of input local column.
Ifpack_Graph: a pure virtual class that defines graphs for IFPACK.