openPMD-api
ParallelHDF5IOHandler.hpp
1 /* Copyright 2017-2021 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "openPMD/IO/AbstractIOHandler.hpp"
24 #include "openPMD/config.hpp"
25 
26 #include <nlohmann/json.hpp>
27 
28 #include <future>
29 #include <memory>
30 #include <string>
31 
32 namespace openPMD
33 {
34 class ParallelHDF5IOHandlerImpl;
35 
37 {
38 public:
39 #if openPMD_HAVE_MPI
41  std::string path, Access, MPI_Comm, nlohmann::json config);
42 #else
43  ParallelHDF5IOHandler(std::string path, Access, nlohmann::json config);
44 #endif
45  ~ParallelHDF5IOHandler() override;
46 
47  std::string backendName() const override
48  {
49  return "MPI_HDF5";
50  }
51 
52  std::future<void> flush(internal::FlushParams const &) override;
53 
54 private:
55  std::unique_ptr<ParallelHDF5IOHandlerImpl> m_impl;
56 }; // ParallelHDF5IOHandler
57 } // namespace openPMD
Access
File access mode to use during IO.
Definition: Access.hpp:27
std::string backendName() const override
The currently used backend.
Definition: ParallelHDF5IOHandler.hpp:47
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:122
Public definitions of openPMD-api.
Definition: Date.cpp:28
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:103
std::future< void > flush(internal::FlushParams const &) override
Process operations in queue according to FIFO.
Definition: ParallelHDF5IOHandler.cpp:57
Definition: ParallelHDF5IOHandler.hpp:36