HDF5File.hpp

/*
  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef HDF5_FILE_HPP
#define HDF5_FILE_HPP

#include <opm/simulators/utils/ParallelCommunication.hpp>

#include <hdf5.h>

#include <string>
#include <vector>

namespace Opm {

class HDF5File {
public:
    enum class OpenMode {
        APPEND,    
        OVERWRITE, 
        READ       
    };

    enum class DataSetMode {
        ROOT_ONLY,     
        PROCESS_SPLIT  
    };

    HDF5File(const std::string& fileName,
             OpenMode mode,
             Parallel::Communication comm);

    ~HDF5File();

    void write(const std::string& group,
               const std::string& dset,
               const std::vector<char>& buffer,
               DataSetMode mode = DataSetMode::PROCESS_SPLIT) const;

    void read(const std::string& group,
              const std::string& dset,
              std::vector<char>& buffer,
              DataSetMode mode = DataSetMode::PROCESS_SPLIT) const;

    std::vector<std::string> list(const std::string& group) const;

private:
    void writeSplit(hid_t grp,
                    const std::vector<char>& buffer,
                    const std::string& dset) const;

    void writeRootOnly(hid_t grp,
                       const std::vector<char>& buffer,
                       const std::string& group,
                       const std::string& dset) const;

    hid_t getCompression(hsize_t size) const;

    void writeDset(int rank, hid_t dataset_id,
                   hid_t dxpl, hsize_t size, const void* data) const;
    hid_t m_file = H5I_INVALID_HID; 
    Parallel::Communication comm_;
};

}

#endif