openPMD-api
ParticleSpecies.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/ParticlePatches.hpp"
24 #include "openPMD/Record.hpp"
25 #include "openPMD/backend/Attributable.hpp"
26 #include "openPMD/backend/Container.hpp"
27 
28 #include <string>
29 
30 namespace openPMD
31 {
32 
33 class ParticleSpecies : public Container<Record>
34 {
35  friend class Container<ParticleSpecies>;
36  friend class Container<Record>;
37  friend class Iteration;
38 
39 public:
40  ParticlePatches particlePatches;
41 
42 private:
43  ParticleSpecies();
44 
45  void read();
46  void flush(std::string const &, internal::FlushParams const &) override;
47 
56  bool dirtyRecursive() const;
57 };
58 
59 namespace traits
60 {
61  template <>
63  {
64  template <typename T>
65  void operator()(T &ret)
66  {
67  ret.particlePatches.linkHierarchy(ret.writable());
68 
69  auto &np = ret.particlePatches["numParticles"];
70  auto &npc = np[RecordComponent::SCALAR];
71  npc.resetDataset(Dataset(determineDatatype<uint64_t>(), {1}));
72  npc.parent() = np.parent();
73  auto &npo = ret.particlePatches["numParticlesOffset"];
74  auto &npoc = npo[RecordComponent::SCALAR];
75  npoc.resetDataset(Dataset(determineDatatype<uint64_t>(), {1}));
76  npoc.parent() = npo.parent();
77  }
78  };
79 } // namespace traits
80 } // namespace openPMD
Definition: ParticlePatches.hpp:31
Definition: Dataset.hpp:35
Container Element Creation Policy.
Definition: Attributable.hpp:47
Logical compilation of data from one snapshot (e.g.
Definition: Iteration.hpp:126
Public definitions of openPMD-api.
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