OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
TrackRun.h
Go to the documentation of this file.
1//
2// Class TrackRun
3// The RUN command.
4//
5// Copyright (c) 200x - 2023, 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 OPAL_TrackRun_HH
19#define OPAL_TrackRun_HH
20
22
23#include <array>
24#include <memory>
25#include <string>
26#include <string_view>
27#include <vector>
28
29class Beam;
30class OpalData;
31class DataSink;
32class Distribution;
33class FieldSolver;
34class H5PartWrapper;
35class Inform;
37class Tracker;
38
39class TrackRun: public Action {
40
41public:
43 TrackRun();
44
45 virtual ~TrackRun();
46
48 virtual TrackRun* clone(const std::string& name);
49
51 virtual void execute();
52
53 using Action::print;
54 Inform& print(Inform& os) const;
55
56 static std::shared_ptr<Tracker> getTracker();
57
65 static void releaseTracker();
66
67private:
68 enum class RunMethod: unsigned short {
69 NONE,
72 THICK
73 };
74
75 static inline constexpr std::array<std::pair<RunMethod, std::string_view>, 5> runMethodMap {{
76 {TrackRun::RunMethod::PARALLELT, "PARALLEL-T"},
77 {TrackRun::RunMethod::CYCLOTRONT, "CYCLOTRON-T"},
79 }};
80
81 // Not implemented.
83 void operator=(const TrackRun&);
84
85 // Clone constructor.
86 TrackRun(const std::string& name, TrackRun* parent);
87
88 void setRunMethod();
89 std::string getRunMethodName() const;
90
91 void setupTTracker();
93 void setupThickTracker();
94 void setupFieldsolver();
95
96 void initPhaseSpaceSink();
97
98 void initDataSink(const int& numBunch = 1);
99
100 void setBoundaryGeometry();
101
102 double setDistributionParallelT(Beam* beam);
103
104 /* itsTracker_m is a static object; this enables access to the last executed
105 * tracker object without excessive gymnastics, e.g. for access to the
106 * field maps in PyField
107 */
108 static std::shared_ptr<Tracker> itsTracker_m;
109
111 std::vector<Distribution*> distrs_m;
112
114
116
118
120
122
123 static const std::string defaultDistribution;
124
126
127 // macromass and charge for simulation particles
130};
131
132inline Inform& operator<<(Inform& os, const TrackRun& b) {
133 return b.print(os);
134}
135
136#endif // OPAL_TrackRun_HH
Inform & operator<<(Inform &os, const TrackRun &b)
Definition TrackRun.h:132
const std::string name
The base class for all OPAL actions.
Definition Action.h:30
virtual void print(std::ostream &) const
Print the object.
Definition Object.cpp:161
The global OPAL structure.
Definition OpalData.h:49
Definition Beam.h:31
RunMethod method_m
Definition TrackRun.h:125
static void releaseTracker()
Definition TrackRun.cpp:63
DataSink * dataSink_m
Definition TrackRun.h:115
H5PartWrapper * phaseSpaceSink_m
Definition TrackRun.h:117
virtual void execute()
Execute the command.
Definition TrackRun.cpp:160
void setupTTracker()
Definition TrackRun.cpp:331
std::vector< Distribution * > distrs_m
Definition TrackRun.h:111
bool isFollowupTrack_m
Definition TrackRun.h:121
void setRunMethod()
Definition TrackRun.cpp:243
virtual ~TrackRun()
Definition TrackRun.cpp:152
static std::shared_ptr< Tracker > itsTracker_m
Definition TrackRun.h:108
FieldSolver * fieldSolver_m
Definition TrackRun.h:113
void operator=(const TrackRun &)
void initDataSink(const int &numBunch=1)
Definition TrackRun.cpp:598
TrackRun(const TrackRun &)
TrackRun()
Exemplar constructor.
Definition TrackRun.cpp:87
double macromass_m
Definition TrackRun.h:128
virtual TrackRun * clone(const std::string &name)
Make clone.
Definition TrackRun.cpp:156
static const std::string defaultDistribution
Definition TrackRun.h:123
double setDistributionParallelT(Beam *beam)
Definition TrackRun.cpp:625
std::string getRunMethodName() const
Definition TrackRun.cpp:252
void initPhaseSpaceSink()
Definition TrackRun.cpp:562
void setBoundaryGeometry()
Definition TrackRun.cpp:612
Distribution * dist_m
Definition TrackRun.h:110
void setupFieldsolver()
Definition TrackRun.cpp:529
void setupCyclotronTracker()
Definition TrackRun.cpp:415
double macrocharge_m
Definition TrackRun.h:129
static constexpr std::array< std::pair< RunMethod, std::string_view >, 5 > runMethodMap
Definition TrackRun.h:75
OpalData * opalData_m
Definition TrackRun.h:119
Inform & print(Inform &os) const
Definition TrackRun.cpp:696
void setupThickTracker()
Definition TrackRun.cpp:256
static std::shared_ptr< Tracker > getTracker()
Definition TrackRun.cpp:720