openPMD-api
PatchRecord.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/backend/BaseRecord.hpp"
24 #include "openPMD/backend/PatchRecordComponent.hpp"
25 
26 #include <string>
27 #include <unordered_map>
28 
29 namespace openPMD
30 {
31 class PatchRecord : public BaseRecord<PatchRecordComponent>
32 {
33  friend class Container<PatchRecord>;
34  friend class ParticleSpecies;
35  friend class ParticlePatches;
36 
37 public:
38  PatchRecord &setUnitDimension(std::map<UnitDimension, double> const &);
39  ~PatchRecord() override = default;
40 
41 private:
42  PatchRecord() = default;
43 
44  void
45  flush_impl(std::string const &, internal::FlushParams const &) override;
46  void read() override;
47 }; // PatchRecord
48 } // namespace openPMD
Definition: ParticlePatches.hpp:31
Definition: PatchRecord.hpp:31
Public definitions of openPMD-api.
Definition: BaseRecord.hpp:58
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:84
Definition: ParticleSpecies.hpp:33
Map-like container that enforces openPMD requirements and handles IO.
Definition: Container.hpp:131