openPMD-api
ParallelADIOS1IOHandler.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/auxiliary/Export.hpp"
25 #include "openPMD/config.hpp"
26 
27 #include <future>
28 #include <memory>
29 #include <string>
30 #if openPMD_HAVE_ADIOS1
31 #include <queue>
32 #endif
33 
34 namespace openPMD
35 {
36 class OPENPMDAPI_EXPORT ParallelADIOS1IOHandlerImpl;
37 
38 class OPENPMDAPI_EXPORT ParallelADIOS1IOHandler : public AbstractIOHandler
39 {
40  friend class ParallelADIOS1IOHandlerImpl;
41 
42 public:
43 #if openPMD_HAVE_MPI
44  ParallelADIOS1IOHandler(std::string path, Access, MPI_Comm);
45 #else
46  ParallelADIOS1IOHandler(std::string path, Access);
47 #endif
48  ~ParallelADIOS1IOHandler() override;
49 
50  std::string backendName() const override
51  {
52  return "MPI_ADIOS1";
53  }
54 
55  std::future<void> flush(internal::FlushParams const &) override;
56 #if openPMD_HAVE_ADIOS1
57  void enqueue(IOTask const &) override;
58 #endif
59 
60 private:
61 #if openPMD_HAVE_ADIOS1
62  std::queue<IOTask> m_setup;
63 #endif
64  std::unique_ptr<ParallelADIOS1IOHandlerImpl> m_impl;
65 }; // ParallelADIOS1IOHandler
66 
67 } // namespace openPMD
Self-contained description of a single IO operation.
Definition: IOTask.hpp:615
Access
File access mode to use during IO.
Definition: Access.hpp:27
Definition: ParallelADIOS1IOHandler.hpp:38
std::string backendName() const override
The currently used backend.
Definition: ParallelADIOS1IOHandler.hpp:50
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
Definition: ParallelADIOS1IOHandlerImpl.hpp:44