IFPACK  Development
 All Classes Namespaces Files Functions Variables Enumerations Friends Pages
Ifpack_Graph.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_H
44 #define IFPACK_GRAPH_H
45 class Epetra_Comm;
46 
48 
59 #include "Epetra_ConfigDefs.h"
60 
61 class Ifpack_Graph {
62 
63 public:
64 
66  virtual ~Ifpack_Graph() {};
67 
69  virtual int NumMyRows() const = 0;
70 
72  virtual int NumMyCols() const = 0;
73 
74 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
75  virtual int NumGlobalRows() const = 0;
77 
79  virtual int NumGlobalCols() const = 0;
80 #endif
81 
82  virtual long long NumGlobalRows64() const = 0;
83 
84  virtual long long NumGlobalCols64() const = 0;
85 
87  virtual int MaxMyNumEntries() const = 0;
88 
90  virtual int NumMyNonzeros() const = 0;
91 
93  virtual bool Filled() const = 0;
94 
95 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
96  virtual int GRID(int) const = 0;
98 
100  virtual int GCID(int) const = 0;
101 #endif
102 
103  virtual long long GRID64(int) const = 0;
104 
106  virtual long long GCID64(int) const = 0;
107 
108 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
109  virtual int LRID(int) const = 0;
111 
113  virtual int LCID(int) const = 0;
114 #endif
115 
116 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
117  virtual int LRID(long long) const = 0;
119 
121  virtual int LCID(long long) const = 0;
122 #endif
123 
125  virtual int ExtractMyRowCopy(int MyRow, int LenOfIndices,
126  int &NumIndices, int *Indices) const = 0;
127 
129  virtual const Epetra_Comm& Comm() const = 0;
130 
132  virtual std::ostream& Print(std::ostream& os) const = 0;
133 
134 };
135 
136 inline std::ostream& operator<<(std::ostream& os, const Ifpack_Graph& obj)
137 {
138  return(obj.Print(os));
139 }
140 
141 #endif // iFPACK_GRAPH_H
virtual int ExtractMyRowCopy(int MyRow, int LenOfIndices, int &NumIndices, int *Indices) const =0
Extracts a copy of input local row.
virtual int NumMyRows() const =0
Returns the number of local rows.
virtual int GRID(int) const =0
Returns the global row ID of input local row.
virtual std::ostream & Print(std::ostream &os) const =0
Prints basic information about the graph object.
virtual int GCID(int) const =0
Returns the global column ID of input local column.
virtual int LRID(int) const =0
Returns the local row ID of input global row.
virtual int NumMyNonzeros() const =0
Returns the number of local nonzero entries.
virtual bool Filled() const =0
Returns true is graph is filled.
virtual int NumGlobalRows() const =0
Returns the number of global rows.
virtual int NumMyCols() const =0
Returns the number of local columns.
virtual const Epetra_Comm & Comm() const =0
Returns the communicator object of the graph.
virtual int NumGlobalCols() const =0
Returns the number of global columns.
virtual ~Ifpack_Graph()
Destructor.
Definition: Ifpack_Graph.h:66
virtual int MaxMyNumEntries() const =0
Returns the maximun number of entries for row.
virtual int LCID(int) const =0
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
virtual long long GCID64(int) const =0
Returns the global column ID of input local column.