IFPACK  Development
 All Classes Namespaces Files Functions Variables Enumerations Friends Pages
Numbering_dh.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 NUMBERING_DH_H
44 #define NUMBERING_DH_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 
53 /* code and algorithms in this class adopted from Edmond Chow's
54  ParaSails
55 */
56 
57 
58 #include "euclid_common.h"
59 
60 #ifdef __cplusplus
61 extern "C"
62 {
63 #endif
64 
66  {
67  int size; /* max number of indices that can be stored;
68  (length of idx_ext[])
69  */
70  int first; /* global number of 1st local index (row) */
71  int m; /* number of local indices (number of local rows in mat) */
72  int *idx_ext; /* sorted list of external indices */
73  int *idx_extLo; /* sorted list of external indices that are < first */
74  int *idx_extHi; /* sorted list of external indices that are >= first+m */
75  int num_ext; /* number of external (non-local) indices = num_extLo+num_extHi */
76  int num_extLo; /* number of external indices < first */
77  int num_extHi; /* number of external indices >= first+num_loc */
78  Hash_i_dh global_to_local;
79 
80  bool debug;
81  };
82 
83  extern void Numbering_dhCreate (Numbering_dh * numb);
84  extern void Numbering_dhDestroy (Numbering_dh numb);
85 
86  /* must be called before calling Numbering_dhGlobalToLocal() or
87  Numbering_dhLocalToGlobal().
88  */
89  extern void Numbering_dhSetup (Numbering_dh numb, Mat_dh mat);
90 
91 
92  /* input: global_in[len], which contains global row numbers.
93  output: local_out[len], containing corresponding local numbers.
94  note: global_in[] and local_out[] may be identical.
95  */
96  extern void Numbering_dhGlobalToLocal (Numbering_dh numb, int len,
97  int *global_in, int *local_out);
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 #endif
Definition: Mat_dh.h:68