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