Ifpack Package Browser (Single Doxygen Collection)
Development
Toggle main menu visibility
Loading...
Searching...
No Matches
src
Ifpack_Graph_Epetra_CrsGraph.h
Go to the documentation of this file.
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
62
class
Ifpack_Graph_Epetra_CrsGraph
:
public
Ifpack_Graph
{
63
64
public
:
65
67
Ifpack_Graph_Epetra_CrsGraph
(
const
Teuchos::RefCountPtr<const Epetra_CrsGraph>& CrsGraph);
68
70
virtual
~Ifpack_Graph_Epetra_CrsGraph
() {};
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
86
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
101
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
128
int
GRID
(
int
)
const
;
129
#endif
130
long
long
GRID64
(
int
)
const
;
131
132
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
134
int
GCID
(
int
)
const
;
135
#endif
136
long
long
GCID64
(
int
)
const
;
137
138
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
140
int
LRID
(
int
)
const
;
141
143
int
LCID
(
int
)
const
;
144
#endif
145
146
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
148
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
Epetra_CrsGraph.h
Ifpack_ConfigDefs.h
Ifpack_Graph.h
Epetra_Comm
Epetra_CrsGraph
Ifpack_Graph_Epetra_CrsGraph::Filled
bool Filled() const
Returns true is graph is filled.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:68
Ifpack_Graph_Epetra_CrsGraph::GCID
int GCID(int) const
Returns the global column ID of input local column.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:81
Ifpack_Graph_Epetra_CrsGraph::LRID
int LRID(int) const
Returns the local row ID of input global row.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:100
Ifpack_Graph_Epetra_CrsGraph::Ifpack_Graph_Epetra_CrsGraph
Ifpack_Graph_Epetra_CrsGraph(const Teuchos::RefCountPtr< const Epetra_CrsGraph > &CrsGraph)
Constructor.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:51
Ifpack_Graph_Epetra_CrsGraph::NumGlobalRows
int NumGlobalRows() const
Returns the number of global rows.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:86
Ifpack_Graph_Epetra_CrsGraph::NumMyRows_
int NumMyRows_
Number of local rows.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:167
Ifpack_Graph_Epetra_CrsGraph::NumGlobalRows64
long long NumGlobalRows64() const
Definition
Ifpack_Graph_Epetra_CrsGraph.h:94
Ifpack_Graph_Epetra_CrsGraph::NumMyNonzeros
int NumMyNonzeros() const
Returns the number of local nonzero entries.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:135
Ifpack_Graph_Epetra_CrsGraph::NumMyCols_
int NumMyCols_
Number of local columns.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:169
Ifpack_Graph_Epetra_CrsGraph::MaxNumIndices_
int MaxNumIndices_
Maximum number of indices per row.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:175
Ifpack_Graph_Epetra_CrsGraph::MaxMyNumEntries
int MaxMyNumEntries() const
Returns the maximun number of entries for row.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:115
Ifpack_Graph_Epetra_CrsGraph::LCID
int LCID(int) const
Returns the local column ID of input global column.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:106
Ifpack_Graph_Epetra_CrsGraph::NumGlobalRows_
long long NumGlobalRows_
Number of global rows.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:171
Ifpack_Graph_Epetra_CrsGraph::Comm
const Epetra_Comm & Comm() const
Returns the communicator object of the graph.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:62
Ifpack_Graph_Epetra_CrsGraph::ExtractMyRowCopy
int ExtractMyRowCopy(int GlobalRow, int LenOfIndices, int &NumIndices, int *Indices) const
Extracts a copy of input local row.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:127
Ifpack_Graph_Epetra_CrsGraph::~Ifpack_Graph_Epetra_CrsGraph
virtual ~Ifpack_Graph_Epetra_CrsGraph()
Destructor.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:70
Ifpack_Graph_Epetra_CrsGraph::NumMyCols
int NumMyCols() const
Returns the number of local columns.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:79
Ifpack_Graph_Epetra_CrsGraph::GRID64
long long GRID64(int) const
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:87
Ifpack_Graph_Epetra_CrsGraph::NumMyRows
int NumMyRows() const
Returns the number of local rows.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:73
Ifpack_Graph_Epetra_CrsGraph::NumGlobalCols64
long long NumGlobalCols64() const
Definition
Ifpack_Graph_Epetra_CrsGraph.h:109
Ifpack_Graph_Epetra_CrsGraph::Print
virtual std::ostream & Print(std::ostream &os) const
Prints basic information about the graph object.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:141
Ifpack_Graph_Epetra_CrsGraph::NumGlobalCols_
long long NumGlobalCols_
Number of global columns.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:173
Ifpack_Graph_Epetra_CrsGraph::GRID
int GRID(int) const
Returns the global row ID of input local row.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:75
Ifpack_Graph_Epetra_CrsGraph::NumGlobalCols
int NumGlobalCols() const
Returns the number of global columns.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:101
Ifpack_Graph_Epetra_CrsGraph::GCID64
long long GCID64(int) const
Returns the global column ID of input local column.
Definition
Ifpack_Graph_Epetra_CrsGraph.cpp:93
Ifpack_Graph_Epetra_CrsGraph::CrsGraph_
Teuchos::RefCountPtr< const Epetra_CrsGraph > CrsGraph_
Pointer to the wrapped Epetra_CrsGraph.
Definition
Ifpack_Graph_Epetra_CrsGraph.h:177
Ifpack_Graph
Ifpack_Graph: a pure virtual class that defines graphs for IFPACK.
Definition
Ifpack_Graph.h:61
Generated by
1.17.0