IFPACK  Development
 All Classes Namespaces Files Functions Variables Enumerations Friends Pages
io_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 /*
44  Note: this module contains functionality for reading/writing
45  Euclid's binary io format, and opening and closing files.
46  Additional io can be found in in mat_dh_private, which contains
47  private functions for reading/writing various matrix and
48  vector formats; functions in that module are called by
49  public class methods of the Mat_dh and Vec_dh classes.
50 */
51 
52 #ifndef IO_DH
53 #define IO_DH
54 
55 #if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
56 #ifdef __GNUC__
57 #warning "The Ifpack package is deprecated"
58 #endif
59 #endif
60 
61 #include "euclid_common.h"
62 
63 #ifdef __cplusplus
64 extern "C"
65 {
66 #endif
67 
68 /*--------------------------------------------------------------------------
69  * open and close files, with error checking
70  *--------------------------------------------------------------------------*/
71  extern FILE *openFile_dh (const char *filenameIN, const char *modeIN);
72  extern void closeFile_dh (FILE * fpIN);
73 
74 /*---------------------------------------------------------------------------
75  * binary io; these are called by functions in mat_dh_private
76  *---------------------------------------------------------------------------*/
77 
78  bool isSmallEndian ();
79 
80 /* seq only ?? */
81  extern void io_dh_print_ebin_mat_private (int m, int beg_row,
82  int *rp, int *cval, double *aval,
83  int *n2o, int *o2n,
84  Hash_i_dh hash, char *filename);
85 
86 /* seq only ?? */
87  extern void io_dh_read_ebin_mat_private (int *m, int **rp, int **cval,
88  double **aval, char *filename);
89 
90 /* seq only */
91  extern void io_dh_print_ebin_vec_private (int n, int beg_row, double *vals,
92  int *n2o, int *o2n,
93  Hash_i_dh hash, char *filename);
94 /* seq only */
95  extern void io_dh_read_ebin_vec_private (int *n, double **vals,
96  char *filename);
97 
98 #ifdef __cplusplus
99 }
100 #endif
101 
102 #endif