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:
44 
45  void read();
46  void flush(std::string const &, internal::FlushParams const &) override;
47 };
48 
49 namespace traits
50 {
51  template <>
53  {
54  constexpr static bool is_noop = false;
55  template <typename T>
56  void operator()(T &ret)
57  {
58  ret.particlePatches.linkHierarchy(ret.writable());
59 
60  auto &np = ret.particlePatches["numParticles"];
61  np.resetDataset(Dataset(determineDatatype<uint64_t>(), {1}));
62  auto &npo = ret.particlePatches["numParticlesOffset"];
63  npo.resetDataset(Dataset(determineDatatype<uint64_t>(), {1}));
64  }
65  };
66 } // namespace traits
67 } // namespace openPMD
Map-like container that enforces openPMD requirements and handles IO.
Definition: Container.hpp:104
Definition: Dataset.hpp:38
Logical compilation of data from one snapshot (e.g.
Definition: Iteration.hpp:127
Definition: ParticlePatches.hpp:32
Definition: ParticleSpecies.hpp:34
Definition: Record.hpp:33
Public definitions of openPMD-api.
Definition: Date.cpp:29
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:86
Container Element Creation Policy.
Definition: Container.hpp:52