OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
LossDataSink.h
Go to the documentation of this file.
1//
2// Class LossDataSink
3// This class writes file attributes to describe phase space of loss files
4//
5// Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
6// All rights reserved
7//
8// This file is part of OPAL.
9//
10// OPAL is free software: you can redistribute it and/or modify
11// it under the terms of the GNU General Public License as published by
12// the Free Software Foundation, either version 3 of the License, or
13// (at your option) any later version.
14//
15// You should have received a copy of the GNU General Public License
16// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
17//
18#ifndef LOSSDATASINK_H_
19#define LOSSDATASINK_H_
20
23#include "Algorithms/Vektor.h"
24
25#include <h5core/h5_types.h>
26
27#include <cstddef>
28#include <fstream>
29#include <functional>
30#include <optional>
31#include <set>
32#include <string>
33#include <utility>
34#include <vector>
35
62
63namespace std {
64 template<>
65 struct less<SetStatistics> {
66 bool operator() (const SetStatistics& x, const SetStatistics& y) const {
67 return x.spos_m < y.spos_m;
68 }
69 };
70}
71enum class CollectionType: unsigned short {
72 SPATIAL = 0,
74};
75
76/*
77 - In the destructor we do ALL the file handling
78 - h5hut_mode_m defines h5hut or ASCII
79 */
81
82public:
83 LossDataSink() = default;
84
85 LossDataSink(const std::string& outfn, bool hdf5Save, CollectionType = CollectionType::TEMPORAL);
86
87 LossDataSink(const LossDataSink& rsh);
88 ~LossDataSink() noexcept(false);
89
90 bool inH5Mode() { return h5hut_mode_m;}
91
93 bool save(unsigned int numSets = 1, OpalData::OpenMode openMode = OpalData::OpenMode::UNDEFINED);
94
95 void addReferenceParticle(const Vector_t& x,
96 const Vector_t& p,
97 double time,
98 double spos,
99 long long globalTrackStep);
100
101 void addParticle(const OpalParticle&, const std::optional<std::pair<int, short int>>& turnBunchNumPair = std::nullopt);
102
103 std::size_t size() const;
104
105 std::set<SetStatistics> computeStatistics(unsigned int numSets);
106
107private:
108 void openASCII() {
109 if (Ippl::myNode() == 0) {
110 os_m.open(fileName_m.c_str(), std::ios::out);
111 }
112 }
113 void openH5(h5_int32_t mode = H5_O_WRONLY);
114
115 void appendASCII() {
116 if (Ippl::myNode() == 0) {
117 os_m.open(fileName_m.c_str(), std::ios::app);
118 }
119 }
120
121 void writeHeaderASCII();
122 void writeHeaderH5();
123
124 void saveASCII();
125 void saveH5(unsigned int setIdx);
126
127 void closeASCII() {
128 if (Ippl::myNode() == 0) {
129 os_m.close();
130 }
131 }
132
133 bool hasNoParticlesToDump() const;
134 bool hasTurnInformations() const;
135
136 void reportOnError(h5_int64_t rc, const char* file, int line);
137
138 void splitSets(unsigned int numSets);
139 SetStatistics computeSetStatistics(unsigned int setIdx);
140
141 std::string fileName_m;
142
143 // write either in ASCII or H5hut format
145
146 // used to write out data in ASCII mode
147 std::ofstream os_m;
148
150 h5_file_t H5file_m;
151
152 // filename without extension
153 std::string outputName_m;
154
156 h5_int64_t H5call_m;
157
158 std::vector<OpalParticle> particles_m;
159 std::vector<std::size_t> bunchNumber_m;
160 std::vector<std::size_t> turnNumber_m;
161
162 std::vector<Vector_t> RefPartR_m;
163 std::vector<Vector_t> RefPartP_m;
164 std::vector<h5_int64_t> globalTrackStep_m;
165 std::vector<double> refTime_m;
166 std::vector<double> spos_m;
167
168 std::vector<unsigned long> startSet_m;
169
171};
172
173inline
174std::size_t LossDataSink::size() const {
175 return particles_m.size();
176}
177
178inline
179std::set<SetStatistics> LossDataSink::computeStatistics(unsigned int numStatistics) {
180 std::set<SetStatistics> stats;
181
182 splitSets(numStatistics);
183
184 for (unsigned int i = 0; i < numStatistics; ++ i) {
185 auto setStats = computeSetStatistics(i);
186 if (setStats.nTotal_m > 0) {
187 stats.insert(setStats);
188 }
189 }
190
191 return stats;
192}
193
194#endif
CollectionType
OpenMode
Enum for writing to files.
Definition OpalData.h:64
Vector_t eps_norm_m
Vector_t rmax_m
Vector_t RefPartP_m
std::string outputName_m
Vector_t prms_m
Vector_t pmean_m
Vector_t psqsum_m
Vector_t rmean_m
unsigned long nTotal_m
Vector_t rsqsum_m
Vector_t eps2_m
Vector_t normEmit_m
Vector_t rrms_m
Vector_t fac_m
Vector_t RefPartR_m
Vector_t rpsum_m
Vector_t rmin_m
Vector_t rprms_m
bool save(unsigned int numSets=1, OpalData::OpenMode openMode=OpalData::OpenMode::UNDEFINED)
Returns whether the file was written; false (on all ranks) if there was nothing to save.
std::vector< Vector_t > RefPartR_m
void addReferenceParticle(const Vector_t &x, const Vector_t &p, double time, double spos, long long globalTrackStep)
std::vector< std::size_t > bunchNumber_m
h5_file_t H5file_m
used to write out data in H5hut mode
~LossDataSink() noexcept(false)
std::vector< std::size_t > turnNumber_m
std::vector< double > refTime_m
std::set< SetStatistics > computeStatistics(unsigned int numSets)
CollectionType collectionType_m
std::string outputName_m
void writeHeaderASCII()
std::ofstream os_m
std::vector< Vector_t > RefPartP_m
bool inH5Mode()
h5_int64_t H5call_m
Current record, or time step, of H5 file.
void reportOnError(h5_int64_t rc, const char *file, int line)
void addParticle(const OpalParticle &, const std::optional< std::pair< int, short int > > &turnBunchNumPair=std::nullopt)
std::string fileName_m
std::size_t size() const
std::vector< double > spos_m
void openH5(h5_int32_t mode=H5_O_WRONLY)
SetStatistics computeSetStatistics(unsigned int setIdx)
void splitSets(unsigned int numSets)
std::vector< OpalParticle > particles_m
bool hasTurnInformations() const
void appendASCII()
void saveH5(unsigned int setIdx)
std::vector< h5_int64_t > globalTrackStep_m
LossDataSink()=default
void closeASCII()
bool hasNoParticlesToDump() const
std::vector< unsigned long > startSet_m
static int myNode()
Definition IpplInfo.cpp:710