Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

HDF5Portable.H

Go to the documentation of this file.
00001 /*   _______              __
00002     / ___/ /  ___  __ _  / /  ___
00003    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00004    \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 // CHOMBO Copyright (c) 2000-2004, The Regents of the University of
00007 // California, through Lawrence Berkeley National Laboratory (subject to
00008 // receipt of any required approvals from U.S. Dept. of Energy).  All
00009 // rights reserved.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are met:
00013 //
00014 // (1) Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 // (2) Redistributions in binary form must reproduce the above copyright
00017 // notice, this list of conditions and the following disclaimer in the
00018 // documentation and/or other materials provided with the distribution.
00019 // (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
00020 // Dept. of Energy nor the names of its contributors may be used to endorse
00021 // or promote products derived from this software without specific prior
00022 // written permission.
00023 //
00024 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00026 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00027 // PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00028 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00029 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00030 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 //
00036 // You are under no obligation whatsoever to provide any bug fixes,
00037 // patches, or upgrades to the features, functionality or performance of
00038 // the source code ("Enhancements") to anyone; however, if you choose to
00039 // make your Enhancements available either publicly, or directly to
00040 // Lawrence Berkeley National Laboratory, without imposing a separate
00041 // written license agreement for such Enhancements, then you hereby grant
00042 // the following license: a non-exclusive, royalty-free perpetual license
00043 // to install, use, modify, prepare derivative works, incorporate into
00044 // other computer software, distribute, and sublicense such Enhancements or
00045 // derivative works thereof, in binary and source code form.
00046 //
00047 // TRADEMARKS. Product and company names mentioned herein may be the
00048 // trademarks of their respective owners.  Any rights not expressly granted
00049 // herein are reserved.
00050 //
00051 
00052 #ifndef _HDF5PORTABLE_H_
00053 #define _HDF5PORTABLE_H_
00054 
00055 #include "Vector.H"
00056 extern "C"
00057 {
00058 #ifdef CH_USE_HDF5
00059 #include <hdf5.h>
00060 #else
00061   typedef long hid_t;
00062 #endif
00063 }
00064 
00065 #include "Box.H"
00066 #include "Interval.H"
00067 
00068 template <class T> void dataTypes(Vector<hid_t>& a_types,
00069                                   const T&       a_dummySpecializationArg);
00070 
00071 template <class T> void dataSize(const T&        a_item,
00072                                  Vector<int>&    a_sizes,
00073                                  const Box&      a_box,
00074                                  const Interval& a_comps);
00075 
00076 template <class T> void write(const T&        a_item,
00077                               Vector<void*>&  a_allocatedBuffers,
00078                               const Box&      a_box,
00079                               const Interval& a_comps);
00080 
00081 template <class T> void read(T&              a_item,
00082                              Vector<void*>&  a_allocatedBuffers,
00083                              const Box&      a_box,
00084                              const Interval& a_comps);
00085 
00086 template <class T> const char* name(const T& a_dummySpecializationArg);
00087 
00088 // These are the default template declarations for the HDF5 I/O
00089 // template functions needed by T objects for binary IO.  The default
00090 // implementations use the linearOut/linearIn/size functions of the
00091 // T template classes to provide non-portable binary IO.
00092 //
00093 // A user can add their own template specializations for
00094 // portable binary IO abilities.
00095 //
00096 // To use this header, a user includes this file first, then
00097 // decalres their template specializations, then includes the CH_HDF5.H
00098 // header file.
00099 //
00100 //   http://hdf.ncsa.uiuc.edu/HDF5/
00101 //
00102 // available datatypes in HDF5
00103 //
00104 //            Example
00105 //                                                  Corresponding C Type
00106 //            H5T_NATIVE_CHAR
00107 //                                                  char
00108 //            H5T_NATIVE_UCHAR
00109 //                                                  unsigned char
00110 //            H5T_NATIVE_SHORT
00111 //                                                  short
00112 //            H5T_NATIVE_USHORT
00113 //                                                  unsigned short
00114 //            H5T_NATIVE_INT
00115 //                                                  int
00116 //            H5T_NATIVE_UINT
00117 //                                                  unsigned
00118 //            H5T_NATIVE_LONG
00119 //                                                  long
00120 //            H5T_NATIVE_ULONG
00121 //                                                  unsigned long
00122 //            H5T_NATIVE_FLOAT
00123 //                                                  float
00124 //            H5T_NATIVE_DOUBLE
00125 //                                                  double
00126 //
00127 // and some special ones defined for Chombo:
00128 //
00129 //            H5T_NATIVE_REAL                       Real
00130 //
00131 //            box_id                                Box
00132 //
00133 //            intvext_id                            IntVect
00134 
00135 #endif

Generated on Wed Oct 5 13:52:08 2005 for Chombo&AMRSelfGravity by  doxygen 1.4.1