Loading...
Searching...
No Matches
HDF5Serializer.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_SERIALIZER_HPP
#define HDF5_SERIALIZER_HPP
#include <opm/common/utility/Serializer.hpp>
#include <opm/simulators/utils/HDF5File.hpp>
#include <opm/simulators/utils/ParallelCommunication.hpp>
#include <opm/simulators/utils/SerializationPackers.hpp>
#include <cstddef>
#include <limits>
#include <string>
namespace Opm {
class HDF5Serializer : public Serializer<Serialization::MemPacker> {
public:
HDF5Serializer(const std::string& fileName,
HDF5File::OpenMode mode,
Parallel::Communication comm)
: Serializer<Serialization::MemPacker>(m_packer_priv)
, m_h5file(fileName, mode, comm)
{}
template<class T>
void write(T& data,
const std::string& group,
const std::string& dset,
HDF5File::DataSetMode mode = HDF5File::DataSetMode::PROCESS_SPLIT)
{
try {
this->pack(data);
} catch (...) {
m_packSize = std::numeric_limits<std::size_t>::max();
throw;
}
m_h5file.write(group, dset, m_buffer, mode);
}
void writeHeader(const std::string& simulator_name,
const std::string& module_version,
const std::string& time_stamp,
const std::string& case_name,
const std::string& params,
int num_procs);
template<class T>
void read(T& data,
const std::string& group,
const std::string& dset,
HDF5File::DataSetMode mode = HDF5File::DataSetMode::PROCESS_SPLIT)
{
m_h5file.read(group, dset, m_buffer, mode);
this->unpack(data);
}
int lastReportStep() const;
std::vector<int> reportSteps() const;
private:
const Serialization::MemPacker m_packer_priv{};
HDF5File m_h5file;
};
}
#endif // HDF5_SERIALIZER_HPP
Opm::HDF5File::OpenMode
OpenMode
Enumeration of file opening modes.
Definition HDF5File.hpp:37
Opm::HDF5File::DataSetMode
DataSetMode
Enumeration of dataset modes.
Definition HDF5File.hpp:44
Opm::HDF5File::DataSetMode::PROCESS_SPLIT
@ PROCESS_SPLIT
One separate data set for each parallel process.
Definition HDF5File.hpp:46
Opm::HDF5Serializer::lastReportStep
int lastReportStep() const
Returns the last report step stored in file.
Definition HDF5Serializer.cpp:46
Opm::HDF5Serializer::reportSteps
std::vector< int > reportSteps() const
Returns a list of report steps stored in restart file.
Definition HDF5Serializer.cpp:58
Opm::HDF5Serializer::read
void read(T &data, const std::string &group, const std::string &dset, HDF5File::DataSetMode mode=HDF5File::DataSetMode::PROCESS_SPLIT)
Read data and deserialize from restart file.
Definition HDF5Serializer.hpp:89
Opm::HDF5Serializer::writeHeader
void writeHeader(const std::string &simulator_name, const std::string &module_version, const std::string &time_stamp, const std::string &case_name, const std::string &params, int num_procs)
Writes a header to the file.
Definition HDF5Serializer.cpp:29
Opm::HDF5Serializer::write
void write(T &data, const std::string &group, const std::string &dset, HDF5File::DataSetMode mode=HDF5File::DataSetMode::PROCESS_SPLIT)
Serialize and write data to restart file.
Definition HDF5Serializer.hpp:53
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43