IFPACK Development
Loading...
Searching...
No Matches
Ifpack_Graph_Epetra_RowMatrix.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_GRAPH_EPETRA_ROWMATRIX_H
44#define IFPACK_GRAPH_EPETRA_ROWMATRIX_H
45
46#if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
47#ifdef __GNUC__
48#warning "The Ifpack package is deprecated"
49#endif
50#endif
51
52#include "Ifpack_ConfigDefs.h"
53#include "Ifpack_Graph.h"
54#include "Epetra_RowMatrix.h"
55#include "Epetra_Map.h"
56#include "Teuchos_RefCountPtr.hpp"
57
58class Epetra_Comm;
60
62
73
74public:
75
77 Ifpack_Graph_Epetra_RowMatrix(const Teuchos::RefCountPtr<const Epetra_RowMatrix>& RowMatrix);
78
81
83 int NumMyRows() const
84 {
85 return(NumMyRows_);
86 }
87
89 int NumMyCols() const
90 {
91 return(NumMyCols_);
92 }
93
94#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
96 int NumGlobalRows() const
97 {
98 if(RowMatrix_->RowMatrixRowMap().GlobalIndicesInt())
99 return (int) (NumGlobalRows_);
100 else
101 throw "Ifpack_Graph_Epetra_RowMatrix::NumGlobalRows: GlobalIndices not int.";
102 }
103#endif
104 long long NumGlobalRows64() const
105 {
106 return(NumGlobalRows_);
107 }
108
109#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
111 int NumGlobalCols() const
112 {
113 if(RowMatrix_->RowMatrixColMap().GlobalIndicesInt())
114 return (int) (NumGlobalCols_);
115 else
116 throw "Ifpack_Graph_Epetra_RowMatrix::NumGlobalCols: GlobalIndices not int.";
117 }
118#endif
119 long long NumGlobalCols64() const
120 {
121 return(NumGlobalCols_);
122 }
123
125 int MaxMyNumEntries() const
126 {
127 return(MaxNumIndices_);
128 }
129
131 int NumMyNonzeros() const;
132
134 bool Filled() const;
135
136#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
138 int GRID(int) const;
139#endif
140 long long GRID64(int) const;
141
142#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
144 int GCID(int) const;
145#endif
146 long long GCID64(int) const;
147
148#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
150 int LRID(int) const;
151
153 int LCID(int) const;
154#endif
155
156#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
158 int LRID(long long) const;
159
161 int LCID(long long) const;
162#endif
163
165 int ExtractMyRowCopy(int GlobalRow, int LenOfIndices,
166 int &NumIndices, int *Indices) const;
167
169 const Epetra_Comm& Comm() const;
170
172 std::ostream& Print(std::ostream& os) const;
173
174private:
175
177 int NumMyRows_;
179 int NumMyCols_;
181 long long NumGlobalRows_;
183 long long NumGlobalCols_;
185 int MaxNumIndices_;
187 Teuchos::RefCountPtr<const Epetra_RowMatrix> RowMatrix_;
189 mutable std::vector<double> Values_;
190};
191
192#endif
Ifpack_Graph_Epetra_RowMatrix: a class to define Ifpack_Graph as a light-weight conversion of Epetra_...
int GCID(int) const
Returns the global column ID of input local column.
int NumGlobalRows() const
Returns the number of global rows.
int LCID(int) const
Returns the local column ID of input global column.
int NumMyCols() const
Returns the number of local columns.
const Epetra_Comm & Comm() const
Returns the communicator object of the graph.
int GRID(int) const
Returns the global row ID of input local row.
int ExtractMyRowCopy(int GlobalRow, int LenOfIndices, int &NumIndices, int *Indices) const
Extracts a copy of input local row.
int NumGlobalCols() const
Returns the number of global columns.
bool Filled() const
Returns true is graph is filled.
long long GCID64(int) const
Returns the global column ID of input local column.
int NumMyNonzeros() const
Returns the number of local nonzero entries.
int LRID(int) const
Returns the local row ID of input global row.
int MaxMyNumEntries() const
Returns the maximun number of entries for row.
int NumMyRows() const
Returns the number of local rows.
std::ostream & Print(std::ostream &os) const
Prints basic information abobut the graph object.
Ifpack_Graph: a pure virtual class that defines graphs for IFPACK.