OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
DataSink.h
Go to the documentation of this file.
1//
2// Class DataSink
3// This class acts as an observer during the calculation. It generates diagnostic
4// output of the accelerated beam such as statistical beam descriptors of particle
5// positions, momenta, beam phase space (emittance) etc. These are written to file
6// at periodic time steps during the calculation.
7//
8// This class also writes the full beam phase space to an H5 file at periodic time
9// steps in the calculation (this period is different from that of the statistical
10// numbers).
11
12// Class also writes processor load balancing data to file to track parallel
13// calculation efficiency.
14//
15// Copyright (c) 2008 - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
16// All rights reserved
17//
18// This file is part of OPAL.
19//
20// OPAL is free software: you can redistribute it and/or modify
21// it under the terms of the GNU General Public License as published by
22// the Free Software Foundation, either version 3 of the License, or
23// (at your option) any later version.
24//
25// You should have received a copy of the GNU General Public License
26// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
27//
28#ifndef _OPAL_DATA_SINK_H
29#define _OPAL_DATA_SINK_H
30
31#include "Algorithms/Vektor.h"
32#include "Structure/H5Writer.h"
36
37#include <iomanip>
38#include <memory>
39#include <string>
40#include <vector>
41
42template <class T, unsigned Dim>
43class PartBunchBase;
45class H5PartWrapper;
47
48class DataSink {
49private:
51 typedef std::unique_ptr<StatWriter> statWriter_t;
52 typedef std::unique_ptr<SDDSWriter> sddsWriter_t;
53 typedef std::unique_ptr<H5Writer> h5Writer_t;
54 typedef std::unique_ptr<MultiBunchDump> mbWriter_t;
55
56public:
62 DataSink();
63 DataSink(H5PartWrapper *h5wrapper, bool restart, short numBunch);
64 DataSink(H5PartWrapper *h5wrapper, short numBunch);
65
66 void dumpH5(PartBunchBase<double, 3>* beam, Vector_t FDext[]) const;
67
68 int dumpH5(PartBunchBase<double, 3>* beam, Vector_t FDext[], double meanEnergy,
69 int refSource,
70 double refPr, double refPt, double refPz,
71 double refR, double refTheta, double refZ,
72 double azimuth, double elevation, bool local) const;
73
79 void dumpSDDS(PartBunchBase<double, 3>* beam, Vector_t FDext[],
80 const double& azimuth, const double& timeStep) const;
81
82 void dumpSDDS(PartBunchBase<double, 3>* beam, Vector_t FDext[],
83 const losses_t& losses = losses_t(), const double& azimuth = -1) const;
84
88
89 void changeH5Wrapper(H5PartWrapper* h5wrapper);
90
97 void writeGeomToVtk(BoundaryGeometry& bg, const std::string& fn);
98 //void writeGeoContourToVtk(BoundaryGeometry& bg, std::string fn);
99
107 long long int& step,
108 size_t& impact,
109 double& sey_num,
110 size_t numberOfFieldEmittedParticles,
111 bool nEmissionMode,
112 std::string fn);
113
119 MultiBunchHandler* mbhandler);
120
127
128private:
129 DataSink(const DataSink& ds) = delete;
130 DataSink &operator = (const DataSink &) = delete;
131
132 void rewindLines();
133
134 void dumpSDDS_m(PartBunchBase<double, 3>* beam, Vector_t FDext[],
135 const losses_t& losses, const double& azimuth,
136 const double& timeStep) const;
137
138 void init(bool restart = false,
139 H5PartWrapper* h5wrapper = nullptr,
140 short numBunch = 1);
141
144 std::vector<sddsWriter_t> sddsWriter_m;
145 std::vector<mbWriter_t> mbWriter_m;
146
147 static std::string convertToString(int number, int setw = 5);
148
150 unsigned int lossWrCounter_m;
151
154
155 const bool isMultiBunch_m;
156
157 void initMultiBunchDump(short numBunch);
158};
159
160
161inline
162std::string DataSink::convertToString(int number, int setw) {
163 std::stringstream ss;
164 ss << std::setw(setw) << std::setfill('0') << number;
165 return ss.str();
166}
167
168#endif // DataSink_H_
void setMultiBunchInitialPathLengh(MultiBunchHandler *mbhandler_p)
Definition DataSink.cpp:229
void dumpSDDS(PartBunchBase< double, 3 > *beam, Vector_t FDext[], const double &azimuth, const double &timeStep) const
Write the stat file (OPAL-cycl)
Definition DataSink.cpp:107
std::unique_ptr< MultiBunchDump > mbWriter_t
Definition DataSink.h:54
void writeImpactStatistics(const PartBunchBase< double, 3 > *beam, long long int &step, size_t &impact, double &sey_num, size_t numberOfFieldEmittedParticles, bool nEmissionMode, std::string fn)
Definition DataSink.cpp:166
void rewindLines()
Definition DataSink.cpp:243
std::vector< sddsWriter_t > sddsWriter_m
Definition DataSink.h:144
void writeGeomToVtk(BoundaryGeometry &bg, const std::string &fn)
Definition DataSink.cpp:159
void changeH5Wrapper(H5PartWrapper *h5wrapper)
Definition DataSink.cpp:152
const bool isMultiBunch_m
Definition DataSink.h:155
StatWriter::losses_t losses_t
Definition DataSink.h:50
void initMultiBunchDump(short numBunch)
Definition DataSink.cpp:322
void dumpSDDS_m(PartBunchBase< double, 3 > *beam, Vector_t FDext[], const losses_t &losses, const double &azimuth, const double &timeStep) const
Definition DataSink.cpp:121
DataSink & operator=(const DataSink &)=delete
void init(bool restart=false, H5PartWrapper *h5wrapper=nullptr, short numBunch=1)
Definition DataSink.cpp:280
std::unique_ptr< SDDSWriter > sddsWriter_t
Definition DataSink.h:52
static std::string convertToString(int number, int setw=5)
Definition DataSink.h:162
std::vector< mbWriter_t > mbWriter_m
Definition DataSink.h:145
void storeCavityInformation()
Write cavity information from H5 file.
Definition DataSink.cpp:145
void dumpH5(PartBunchBase< double, 3 > *beam, Vector_t FDext[]) const
Definition DataSink.cpp:87
IpplTimings::TimerRef StatMarkerTimer_m
Timer to track statistics write time.
Definition DataSink.h:153
std::unique_ptr< H5Writer > h5Writer_t
Definition DataSink.h:53
unsigned int lossWrCounter_m
needed to create index for vtk file
Definition DataSink.h:150
DataSink(const DataSink &ds)=delete
statWriter_t statWriter_m
Definition DataSink.h:143
void writeMultiBunchStatistics(PartBunchBase< double, 3 > *beam, MultiBunchHandler *mbhandler)
Definition DataSink.cpp:208
DataSink()
Default constructor.
Definition DataSink.cpp:60
h5Writer_t h5Writer_m
Definition DataSink.h:142
std::unique_ptr< StatWriter > statWriter_t
Definition DataSink.h:51
std::vector< std::pair< std::string, unsigned int > > losses_t
Definition StatWriter.h:27
Timing::TimerRef TimerRef