IFPACK  Development
 All Classes Namespaces Files Functions Variables Enumerations Friends Pages
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 #include "Ifpack_ConfigDefs.h"
46 #include "Ifpack_Graph.h"
47 #include "Epetra_CrsGraph.h"
48 #include "Teuchos_RefCountPtr.hpp"
49 
50 class Epetra_Comm;
51 class Epetra_CrsGraph;
52 
54 
63 
64 public:
65 
67  Ifpack_Graph_Epetra_CrsGraph(const Teuchos::RefCountPtr<const Epetra_CrsGraph>& CrsGraph);
68 
71 
73  int NumMyRows() const
74  {
75  return(NumMyRows_);
76  }
77 
79  int NumMyCols() const
80  {
81  return(NumMyCols_);
82  }
83 
84 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
85  int NumGlobalRows() const
87  {
88  if(CrsGraph_->RowMap().GlobalIndicesInt())
89  return (int) (NumGlobalRows_);
90  else
91  throw "Ifpack_Graph_Epetra_CrsGraph::NumGlobalRows: GlobalIndices not int.";
92  }
93 #endif
94  long long NumGlobalRows64() const
95  {
96  return(NumGlobalRows_);
97  }
98 
99 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
100  int NumGlobalCols() const
102  {
103  if(CrsGraph_->ColMap().GlobalIndicesInt())
104  return (int) (NumGlobalCols_);
105  else
106  throw "Ifpack_Graph_Epetra_CrsGraph::NumGlobalCols: GlobalIndices not int.";
107  }
108 #endif
109  long long NumGlobalCols64() const
110  {
111  return(NumGlobalCols_);
112  }
113 
115  int MaxMyNumEntries() const
116  {
117  return(MaxNumIndices_);
118  }
119 
121  int NumMyNonzeros() const;
122 
124  bool Filled() const;
125 
126 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
127  int GRID(int) const;
129 #endif
130  long long GRID64(int) const;
131 
132 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
133  int GCID(int) const;
135 #endif
136  long long GCID64(int) const;
137 
138 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
139  int LRID(int) const;
141 
143  int LCID(int) const;
144 #endif
145 
146 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
147  int LRID(long long) const;
149 
151  int LCID(long long) const;
152 #endif
153 
155  int ExtractMyRowCopy(int GlobalRow, int LenOfIndices,
156  int &NumIndices, int *Indices) const;
157 
159  const Epetra_Comm& Comm() const;
160 
162  virtual std::ostream& Print(std::ostream& os) const;
163 
164 private:
165 
167  int NumMyRows_;
169  int NumMyCols_;
171  long long NumGlobalRows_;
173  long long NumGlobalCols_;
175  int MaxNumIndices_;
177  Teuchos::RefCountPtr<const Epetra_CrsGraph> CrsGraph_;
178 };
179 
180 #endif
virtual ~Ifpack_Graph_Epetra_CrsGraph()
Destructor.
int GRID(int) const
Returns the global row ID of input local row.
const Epetra_Comm & Comm() const
Returns the communicator object of the graph.
int MaxMyNumEntries() const
Returns the maximun number of entries for row.
long long GCID64(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 NumMyCols() const
Returns the number of local columns.
virtual std::ostream & Print(std::ostream &os) const
Prints basic information about the graph object.
int NumGlobalRows() const
Returns the number of global rows.
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 ExtractMyRowCopy(int GlobalRow, int LenOfIndices, int &NumIndices, int *Indices) const
Extracts a copy of input local row.
int NumMyRows() const
Returns the number of local rows.
int LCID(int) const
Returns the local column ID of input global column.
Ifpack_Graph: a pure virtual class that defines graphs for IFPACK.
Definition: Ifpack_Graph.h:61
int NumMyNonzeros() const
Returns the number of local nonzero entries.
int GCID(int) const
Returns the global column ID of input local column.
Ifpack_Graph_Epetra_CrsGraph(const Teuchos::RefCountPtr< const Epetra_CrsGraph > &CrsGraph)
Constructor.
int NumGlobalCols() const
Returns the number of global columns.