HDF.h

Go to the documentation of this file.

// This file contains helper functions and interfaces for reading/writing HDF5
#ifndef included_AMP_HDF5_h
#define included_AMP_HDF5_h
 
#include "AMP/AMP_TPLs.h"
#include "AMP/utils/AMP_MPI.h"
#include "AMP/utils/ArraySize.h"
 
#include <cstddef>
#include <cstring>
#include <memory>
#include <string>
#include <tuple>
#include <vector>
 
 
// Include the headers and define some basic types
#ifdef AMP_USE_HDF5
    // Using HDF5
    #include "hdf5.h"
#else
// Not using HDF5
typedef int64_t hid_t;
typedef size_t hsize_t;
#endif
 
 
namespace AMP::IO {
 
 
enum class Compression : uint8_t { None, GZIP, SZIP };
 
 
bool HDF5enabled();
 
 
hid_t openHDF5( const std::string &filename,
                const char *mode,
                Compression compress = Compression::None );
 
 
void closeHDF5( hid_t fid, bool printLeaks = false );
 
 
Compression defaultCompression( hid_t fid );
 
 
hid_t createChunk( AMP::ArraySize dims, Compression compress, size_t objSize = 0 );
 
 
template<class T>
void writeHDF5( hid_t fid, const std::string &name, const T &data );
 
 
template<class T>
void readHDF5( hid_t fid, const std::string &name, T &data );
 
 
template<class T>
std::unique_ptr<T> readHDF5( hid_t fid, const std::string &name, AMP_MPI comm = AMP_COMM_SELF );
 
 
void writeHDF5( hid_t fid, const std::string &name, size_t N_bytes, const void *data );
 
 
void readHDF5( hid_t fid, const std::string &name, size_t N_bytes, void *data );
 
 
bool H5Gexists( hid_t fid, const std::string &name );
 
 
bool H5Dexists( hid_t fid, const std::string &name );
 
 
hid_t createGroup( hid_t fid, const std::string &name );
 
 
hid_t openGroup( hid_t fid, const std::string &name, bool create = false );
 
 
void closeGroup( hid_t fid );
 
void closeDataset( hid_t fid );
 
void closeDatatype( hid_t fid );
 
void closeDataspace( hid_t fid );
 
 
hid_t getHDF5datatype( hid_t fid, const std::string &name );
 
 
template<class T>
hid_t getHDF5datatype();
 
 
std::tuple<std::vector<hid_t>,
           std::vector<hid_t>,
           std::vector<hid_t>,
           std::vector<hid_t>,
           std::vector<hid_t>>
openObjects( hid_t fid );
 
 
} // namespace AMP::IO
 
#endif