BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
options.cc
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2024.
4
5This file is part of BDSIM.
6
7BDSIM is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published
9by the Free Software Foundation version 3 of the License.
10
11BDSIM is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
18*/
19#include "options.h"
20
21#include <algorithm>
22#include <iostream>
23#include <sstream>
24#include <string>
25
26using namespace GMAD;
27
28Options::Options():
30{
31 PublishMembers();
32}
33
34Options::Options(const GMAD::OptionsBase& options):
35 OptionsBase(options)
36{
37 PublishMembers();
38}
39
40double Options::get_value(std::string property_name)const{
41 double value;
42 try {
43 value = get<double>(this,property_name);
44 }
45 catch (const std::runtime_error&) {
46 try {
47 // try int and convert
48 value = (double)get<int>(this,property_name);
49 }
50 catch (const std::runtime_error&) {
51 try {
52 // try long and convert
53 value = (double)get<long>(this,property_name);
54 }
55 catch (const std::runtime_error&) {
56 std::cerr << "options.cc> Error: unknown property \"" << property_name << "\" (only works on numerical properties)" << std::endl;
57 exit(1);
58 }
59 }
60 }
61 return value;
62}
63
64std::string Options::get_value_string(std::string property_name) const
65{
66 try {
67 double value = get<double>(this, property_name);
68 std::ostringstream strs;
69 strs << value;
70 return strs.str();
71 }
72 catch (...) {
73 try {
74 int value = get<int>(this, property_name);
75 std::ostringstream strs;
76 strs << value;
77 return strs.str();
78 }
79 catch (...) {
80 try {
81 std::string value = get<std::string>(this, property_name);
82 return value;
83 }
84 catch (...) {
85 try {
86 bool value = get<bool>(this, property_name);
87 std::ostringstream strs;
88 strs << std::boolalpha << value;
89 return strs.str();
90 }
91 catch (...)
92 {std::cerr << "Error " << property_name << std::endl; exit(1);}
93 }
94 }
95 }
96}
97
98void Options::Amalgamate(const Options& optionsIn, bool override)
99{
100 if (override)
101 {
102 for (auto const& key : optionsIn.setKeys)
103 {
104 try
105 {
106 set(this, &optionsIn, key);
107 setKeys.push_back(key);
108 }
109 catch (const std::runtime_error&)
110 {
111 std::cerr << "Error: Amalgamate unknown option \"" << key << "\"" << std::endl;
112 exit(1);
113 }
114 }
115 }
116 else
117 {// don't override - ie give preference to ones set in this instance
118 for (auto const& key : optionsIn.setKeys)
119 {
120 auto const& ok = setKeys; // shortcut
121 auto result = std::find(ok.begin(), ok.end(), key);
122 if (result == ok.end())
123 {//it wasn't found so ok to copy
124 try
125 {
126 set(this, &optionsIn, key);
127 setKeys.push_back(key);
128 }
129 catch (const std::runtime_error&)
130 {
131 std::cerr << "Error: Amalgamate unknown option \"" << key << "\"" << std::endl;
132 exit(1);
133 }
134 }
135 }
136 }
137}
138
139bool Options::HasBeenSet(const std::string& name) const
140{
141 return std::find(setKeys.begin(), setKeys.end(), name) != setKeys.end();
142}
143
145{
146 // executable options first
147 publish("inputFileName", &Options::inputFileName);
148 publish("visMacroFileName", &Options::visMacroFileName);
149 publish("geant4MacroFileName", &Options::geant4MacroFileName);
150 publish("geant4PhysicsMacroFileName", &Options::geant4PhysicsMacroFileName);
151 publish("geant4PhysicsMacroFileNameFromExecOptions", &Options::geant4PhysicsMacroFileNameFromExecOptions);
152 publish("visDebug", &Options::visDebug);
153 publish("visVerbosity", &Options::visVerbosity);
154
155 publish("outfile", &Options::outputFileName);
156 publish("outputFileName", &Options::outputFileName);
157 publish("output", &Options::outputFormat);
158 publish("outputFormat", &Options::outputFormat);
159 publish("outputDoublePrecision", &Options::outputDoublePrecision);
160 publish("outputCompressionLevel",&Options::outputCompressionLevel);
161 publish("survey", &Options::survey);
162 publish("surveyFileName", &Options::surveyFileName);
163
164 publish("verbose", &Options::verbose);
165
166 publish("verboseRunLevel", &Options::verboseRunLevel);
167
168 publish("verboseEventBDSIM", &Options::verboseEventBDSIM);
169 publish("verboseEvent", &Options::verboseEventBDSIM);
170 publish("verbose_event", &Options::verboseEventBDSIM); // to be compatible with exec options
171 publish("verboseEventLevel", &Options::verboseEventLevel);
172 publish("verboseEventStart", &Options::verboseEventStart);
173 publish("verboseEventContinueFor", &Options::verboseEventContinueFor);
174
175 // alternates
176 publish("verboseEventNumber", &Options::verboseEventStart);
177 publish("verbose_event_num", &Options::verboseEventStart); // to be compatible with exec options
178
179 publish("verboseSteppingBDSIM", &Options::verboseSteppingBDSIM);
180 publish("verboseSteppingLevel", &Options::verboseSteppingLevel);
181 publish("verboseSteppingEventStart", &Options::verboseSteppingEventStart);
182 publish("verboseSteppingEventContinueFor", &Options::verboseSteppingEventContinueFor);
183 publish("verboseSteppingPrimaryOnly", &Options::verboseSteppingPrimaryOnly);
184
185 // alternates
186 publish("verboseStep", &Options::verboseSteppingBDSIM);
187
188 publish("batch", &Options::batch);
189
190 publish("verbose_G4Run", &Options::verboseRunLevel); // to be compatible with exec options
191 publish("verbose_G4run", &Options::verboseRunLevel); // to just generally be consistent!
192 publish("verboseEventLevel", &Options::verboseEventLevel);
193 publish("verbose_G4event", &Options::verboseEventLevel); // to be compatible with exec options
194 publish("verboseTrackingLevel", &Options::verboseTrackingLevel);
195 publish("verbose_G4tracking", &Options::verboseTrackingLevel); // to be compatible with exec options
196 publish("verboseSteppingLevel", &Options::verboseSteppingLevel);
197 publish("verbose_G4stepping", &Options::verboseSteppingLevel); // to be compatible with exec options
198 publish("verboseImportanceSampling", &Options::verboseImportanceSampling);
199 publish("verboseSensitivity", &Options::verboseSensitivity);
200 publish("circular", &Options::circular);
201 publish("seed", &Options::seed);
202 publish("randomEngine", &Options::randomEngine);
203 publish("recreate", &Options::recreate);
204 publish("recreateFileName", &Options::recreateFileName);
205 publish("startFromEvent", &Options::startFromEvent);
206 publish("writeSeedState", &Options::writeSeedState);
207 publish("useASCIISeedState", &Options::useASCIISeedState);
208 publish("seedStateFileName", &Options::seedStateFileName);
209 publish("ngenerate", &Options::nGenerate);
210 publish("generatePrimariesOnly", &Options::generatePrimariesOnly);
211 publish("exportGeometry", &Options::exportGeometry);
212 publish("exportType", &Options::exportType);
213 publish("exportFileName", &Options::exportFileName);
214 publish("bdsimPath", &Options::bdsimPath);
215
216 // physics
217 publish("physicsList", &Options::physicsList);
218 publish("physicsVerbose", &Options::physicsVerbose);
219 publish("physicsVerbosity", &Options::physicsVerbosity);
220 publish("physicsEnergyLimitLow", &Options::physicsEnergyLimitLow);
221 publish("physicsEnergyLimitHigh", &Options::physicsEnergyLimitHigh);
222 publish("g4PhysicsUseBDSIMRangeCuts", &Options::g4PhysicsUseBDSIMRangeCuts);
223 publish("g4PhysicsUseBDSIMCutsAndLimits", &Options::g4PhysicsUseBDSIMCutsAndLimits);
224
225 // reproducibility
226 publish("eventOffset", &Options::eventOffset);
227 publish("recreateSeedState", &Options::recreateSeedState);
228
229 publish("elossHistoBinWidth",&Options::elossHistoBinWidth);
230 publish("defaultRangeCut",&Options::defaultRangeCut);
231 publish("ffact",&Options::ffact);
232 publish("bv", &Options::ffact); // MadX naming
233
234 publish("beamlineX", &Options::beamlineX);
235 publish("beamlineY", &Options::beamlineY);
236 publish("beamlineZ", &Options::beamlineZ);
237 publish("beamlinePhi", &Options::beamlinePhi);
238 publish("beamlineTheta", &Options::beamlineTheta);
239 publish("beamlinePsi", &Options::beamlinePsi);
240 publish("beamlineAxisX", &Options::beamlineAxisX);
241 publish("beamlineAxisY", &Options::beamlineAxisY);
242 publish("beamlineAxisZ", &Options::beamlineAxisZ);
243 publish("beamlineAngle", &Options::beamlineAngle);
244 publish("beamlineAxisAngle", &Options::beamlineAxisAngle);
245 publish("beamlineS", &Options::beamlineS);
246
247 publish("checkOverlaps", &Options::checkOverlaps);
248 publish("eventNumberOffset", &Options::eventNumberOffset);
249 publish("vacuumPressure", &Options::vacuumPressure);
250 publish("xsize", &Options::xsize);
251 publish("ysize", &Options::ysize);
252
253 // options which influence the geometry
254 publish("magnetGeometryType", &Options::magnetGeometryType);
255 publish("outerMaterial", &Options::outerMaterialName);
256 publish("horizontalWidth", &Options::horizontalWidth);
257 publish("outerDiameter", &Options::horizontalWidth); // for backwards compatibility
258 publish("boxSize", &Options::horizontalWidth); // for backwards compatibility
259 publish("yokeFields", &Options::yokeFields);
260 publish("includeIronMagFields", &Options::yokeFields); // for backwards compatibility
261 publish("yokeFieldsMatchLHCGeometry", &Options::yokeFieldsMatchLHCGeometry);
262 publish("useOldMultipoleOuterFields", &Options::useOldMultipoleOuterFields);
263 publish("scalingFieldOuter", &Options::scalingFieldOuter);
264 publish("integrateKineticEnergyAlongBeamline", &Options::integrateKineticEnergyAlongBeamline);
265 publish("cavityFieldType", &Options::cavityFieldType);
266 publish("includeFringeFields", &Options::includeFringeFields);
267 publish("includeFringeFieldsCavities", &Options::includeFringeFieldsCavities);
268 publish("beampipeRadius", &Options::aper1);
269 publish("beampipeThickness", &Options::beampipeThickness);
270 publish("apertureType", &Options::apertureType);
271 publish("aper1", &Options::aper1);
272 publish("aper2", &Options::aper2);
273 publish("aper3", &Options::aper3);
274 publish("aper4", &Options::aper4);
275 publish("beampipeMaterial", &Options::beampipeMaterial);
276 publish("ignoreLocalAperture", &Options::ignoreLocalAperture);
277 publish("vacuumMaterial", &Options::vacMaterial);
278 publish("emptyMaterial", &Options::emptyMaterial);
279 publish("worldMaterial", &Options::worldMaterial);
280 publish("worldGeometryFile", &Options::worldGeometryFile);
281 publish("autoColourWorldGeometryFile", &Options::autoColourWorldGeometryFile);
282 publish("importanceWorldGeometryFile", &Options::importanceWorldGeometryFile);
283 publish("importanceVolumeMap", &Options::importanceVolumeMap);
284 publish("worldVolumeMargin", &Options::worldVolumeMargin);
285 publish("dontSplitSBends", &Options::dontSplitSBends);
286 publish("thinElementLength", &Options::thinElementLength);
287 publish("hStyle", &Options::hStyle);
288 publish("vhRatio", &Options::vhRatio);
289 publish("coilWidthFraction", &Options::coilWidthFraction);
290 publish("coilHeightFraction", &Options::coilHeightFraction);
291 publish("ignoreLocalMagnetGeometry", &Options::ignoreLocalMagnetGeometry);
292 publish("buildPoleFaceGeometry", &Options::buildPoleFaceGeometry);
293 publish("preprocessGDML", &Options::preprocessGDML);
294 publish("preprocessGDMLSchema", &Options::preprocessGDMLSchema);
295
296 // tunnel options
297 publish("buildTunnel", &Options::buildTunnel);
298 publish("buildTunnelStraight", &Options::buildTunnelStraight);
299 publish("tunnelType", &Options::tunnelType);
300 publish("tunnelThickness", &Options::tunnelThickness);
301 publish("tunnelSoilThickness", &Options::tunnelSoilThickness);
302 publish("tunnelMaterial", &Options::tunnelMaterial);
303 publish("soilMaterial", &Options::soilMaterial);
304 publish("buildTunnelFloor", &Options::buildTunnelFloor);
305 publish("tunnelFloorOffset", &Options::tunnelFloorOffset);
306 publish("tunnelAper1", &Options::tunnelAper1);
307 publish("tunnelAper2", &Options::tunnelAper2);
308 publish("tunnelRadius", &Options::tunnelAper1); // for backwards compatibility
309 publish("tunnelVisible", &Options::tunnelVisible);
310 publish("showTunnel", &Options::tunnelVisible); // for backwards compatibility
311 publish("tunnelOffsetX", &Options::tunnelOffsetX);
312 publish("tunnelOffsetY", &Options::tunnelOffsetY);
313 publish("tunnelMaxSegmentLength", &Options::tunnelMaxSegmentLength);
314
315 publish("removeTemporaryFiles", &Options::removeTemporaryFiles);
316 publish("temporaryDirectory", &Options::temporaryDirectory);
317
318 publish("samplerDiameter",&Options::samplerDiameter);
319
320 // physics processes
321 publish("turnOnOpticalAbsorption", &Options::turnOnOpticalAbsorption);
322 publish("turnOnMieScattering", &Options::turnOnMieScattering);
323 publish("turnOnRayleighScattering", &Options::turnOnRayleighScattering);
324 publish("turnOnOpticalSurface", &Options::turnOnOpticalSurface);
325 publish("scintYieldFactor", &Options::scintYieldFactor);
326 publish("maximumPhotonsPerStep", &Options::maximumPhotonsPerStep);
327 publish("maximumBetaChangePerStep", &Options::maximumBetaChangePerStep);
328 publish("maximumTracksPerEvent", &Options::maximumTracksPerEvent);
329 publish("minimumKineticEnergy", &Options::minimumKineticEnergy);
330 publish("minimumKineticEnergyTunnel", &Options::minimumKineticEnergyTunnel);
331 publish("minimumRange", &Options::minimumRange);
332 publish("particlesToExcludeFromCuts", &Options::particlesToExcludeFromCuts);
333
334 publish("prodCutPhotons", &Options::prodCutPhotons);
335 publish("prodCutElectrons", &Options::prodCutElectrons);
336 publish("prodCutPositrons", &Options::prodCutPositrons);
337 publish("prodCutProtons", &Options::prodCutProtons);
338 publish("prodCutHadrons", &Options::prodCutProtons); // backwards compatibility
339 publish("neutronTimeLimit", &Options::neutronTimeLimit);
340 publish("neutronKineticEnergyLimit", &Options::neutronKineticEnergyLimit);
341 publish("useLENDGammaNuclear", &Options::useLENDGammaNuclear);
342 publish("useElectroNuclear", &Options::useElectroNuclear);
343 publish("useMuonNuclear", &Options::useMuonNuclear);
344 publish("useGammaToMuMu", &Options::useGammaToMuMu);
345 publish("usePositronToMuMu", &Options::usePositronToMuMu);
346 publish("usePositronToHadrons", &Options::usePositronToHadrons);
347 publish("restoreFTPFDiffractionForAGreater10", &Options::restoreFTPFDiffractionForAGreater10);
348 publish("beamPipeIsInfiniteAbsorber", &Options::beamPipeIsInfiniteAbsorber);
349 publish("collimatorsAreInfiniteAbsorbers", &Options::collimatorsAreInfiniteAbsorbers);
350 publish("tunnelIsInfiniteAbsorber", &Options::tunnelIsInfiniteAbsorber);
351 publish("muonSplittingFactor", &Options::muonSplittingFactor);
352 publish("muonSplittingThresholdParentEk", &Options::muonSplittingThresholdParentEk);
353 publish("muonSplittingFactor2", &Options::muonSplittingFactor2);
354 publish("muonSplittingThresholdParentEk2", &Options::muonSplittingThresholdParentEk2);
355 publish("muonSplittingExcludeWeight1Particles", &Options::muonSplittingExcludeWeight1Particles);
356 publish("muonSplittingExclusionWeight", &Options::muonSplittingExclusionWeight);
357 publish("xrayAllSurfaceRoughness", &Options::xrayAllSurfaceRoughness);
358
359 // bias options
360 publish("scaleFactorLaser", &Options::scaleFactorLaser);
361 publish("defaultBiasVacuum", &Options::defaultBiasVacuum);
362 publish("defaultBiasMaterial", &Options::defaultBiasMaterial);
363 publish("biasForWorldVolume", &Options::biasForWorldVolume);
364 publish("biasForWorldContents",&Options::biasForWorldContents);
365 publish("biasForWorldVacuum", &Options::biasForWorldVacuum);
366 publish("worldVacuumVolumeNames",&Options::worldVacuumVolumeNames);
367
368 // options which influence tracking
369 publish("integratorSet", &Options::integratorSet);
370 publish("fieldModulator", &Options::fieldModulator);
371 publish("lengthSafety", &Options::lengthSafety);
372 publish("lengthSafetyLarge", &Options::lengthSafetyLarge);
373 publish("maximumTrackingTime", &Options::maximumTrackingTime);
374 publish("maximumStepLength", &Options::maximumStepLength);
375 publish("maximumStepSize", &Options::maximumStepLength);
376 publish("maximumTrackLength", &Options::maximumTrackLength);
377 publish("chordStepMinimum", &Options::chordStepMinimum);
378 publish("chordStepMinimumYoke", &Options::chordStepMinimumYoke);
379 publish("deltaIntersection", &Options::deltaIntersection);
380 publish("minimumEpsilonStep", &Options::minimumEpsilonStep);
381 publish("maximumEpsilonStep", &Options::maximumEpsilonStep);
382 publish("minimumEpsilonStepThin", &Options::minimumEpsilonStepThin);
383 publish("maximumEpsilonStepThin", &Options::maximumEpsilonStepThin);
384 publish("deltaOneStep", &Options::deltaOneStep);
385 publish("stopSecondaries", &Options::stopSecondaries);
386 publish("killNeutrinos", &Options::killNeutrinos);
387 publish("killedParticlesMassAddedToEloss", &Options::killedParticlesMassAddedToEloss);
388 publish("minimumRadiusOfCurvature", &Options::minimumRadiusOfCurvature);
389 publish("sampleElementsWithPoleface", &Options::sampleElementsWithPoleface);
390 publish("nominalMatrixRelativeMomCut", &Options::nominalMatrixRelativeMomCut);
391 publish("teleporterFullTransform", &Options::teleporterFullTransform);
392 publish("dEThresholdForScattering", &Options::dEThresholdForScattering);
393 publish("backupStepperMomLimit", &Options::backupStepperMomLimit);
394
395 // hit generation
396 publish("sensitiveOuter", &Options::sensitiveOuter);
397 publish("sensitiveBeamlineComponents", &Options::sensitiveOuter); // backwards compatibility
398 publish("sensitiveBeamPipe", &Options::sensitiveBeamPipe);
399 publish("sensitiveBeampipe", &Options::sensitiveBeamPipe);
400 publish("sensitiveTunnel", &Options::storeElossTunnel);
401 publish("tunnelSensitive", &Options::storeElossTunnel);// backwards compatibility
402
403 // output
404 publish("nperfile", &Options::numberOfEventsPerNtuple);
405
406 publish("storeMinimalData", &Options::storeMinimalData);
407
408 publish("storeApertureImpacts", &Options::storeApertureImpacts);
409 publish("storeApertureImpactsIons", &Options::storeApertureImpactsIons);
410 publish("storeApertureImpactsAll", &Options::storeApertureImpactsAll);
411 publish("storeApertureImpactsHistograms", &Options::storeApertureImpactsHistograms);
412 publish("apertureImpactsMinimumKE", &Options::apertureImpactsMinimumKE);
413 publish("storeCavityInfo", &Options::storeCavityInfo);
414 publish("storeCollimatorInfo", &Options::storeCollimatorInfo);
415 publish("storeCollimatorHits", &Options::storeCollimatorHits);
416 publish("storeCollimatorHitsLinks", &Options::storeCollimatorHitsLinks); // backwards compatibility
417 publish("storeCollimatorHitsLinks", &Options::storeCollimatorHitsLinks);
418 publish("storeCollimatorHitsIons", &Options::storeCollimatorHitsIons);
419 publish("storeCollimatorHitsAll", &Options::storeCollimatorHitsAll);
420 publish("collimatorHitsMinimumKE", &Options::collimatorHitsMinimumKE);
421 publish("storeEloss", &Options::storeEloss);
422 publish("storeELoss", &Options::storeEloss);
423 publish("storeElossHistograms", &Options::storeElossHistograms);
424 publish("storeELossHistograms", &Options::storeElossHistograms);
425 publish("storeElossVacuum", &Options::storeElossVacuum);
426 publish("storeELossVacuum", &Options::storeElossVacuum);
427 publish("storeElossVacuumHistograms", &Options::storeElossVacuumHistograms);
428 publish("storeELossVacuumHistograms", &Options::storeElossVacuumHistograms);
429 publish("storeElossTunnel", &Options::storeElossTunnel);
430 publish("storeELossTunnel", &Options::storeElossTunnel);
431 publish("storeElossTunnelHistograms", &Options::storeElossTunnelHistograms);
432 publish("storeELossTunnelHistograms", &Options::storeElossTunnelHistograms);
433 publish("storeElossWorld", &Options::storeElossWorld);
434 publish("storeELossWorld", &Options::storeElossWorld);
435 publish("storeElossWorldIntegral", &Options::storeElossWorldIntegral);
436 publish("storeELossWorldIntegral", &Options::storeElossWorldIntegral);
437 publish("storeElossWorldContents", &Options::storeElossWorldContents);
438 publish("storeELossWorldContents", &Options::storeElossWorldContents);
439 publish("storeElossWorldContentsIntegral",&Options::storeElossWorldContentsIntegral);
440 publish("storeELossWorldContentsIntegral",&Options::storeElossWorldContentsIntegral);
441 publish("storeElossTurn", &Options::storeElossTurn);
442 publish("storeELossTurn", &Options::storeElossTurn);
443 publish("storeElossLinks", &Options::storeElossLinks);
444 publish("storeELossLinks", &Options::storeElossLinks);
445 publish("storeElossLocal", &Options::storeElossLocal);
446 publish("storeELossLocal", &Options::storeElossLocal);
447 publish("storeElossGlobal", &Options::storeElossGlobal);
448 publish("storeELossGlobal", &Options::storeElossGlobal);
449 publish("storeElossTime", &Options::storeElossTime);
450 publish("storeELossTime", &Options::storeElossTime);
451 publish("storeElossStepLength", &Options::storeElossStepLength);
452 publish("storeELossStepLength", &Options::storeElossStepLength);
453 publish("storeElossPreStepKineticEnergy", &Options::storeElossPreStepKineticEnergy);
454 publish("storeELossPreStepKineticEnergy", &Options::storeElossPreStepKineticEnergy);
455 publish("storeElossModelID", &Options::storeElossModelID);
456 publish("storeELossModelID", &Options::storeElossModelID);
457 publish("storeElossPhysicsProcesses", &Options::storeElossPhysicsProcesses);
458 publish("storeELossPhysicsProcesses", &Options::storeElossPhysicsProcesses);
459 publish("storeParticleData", &Options::storeParticleData);
460 publish("storeGeant4Data", &Options::storeParticleData); // backwards compatibility
461 publish("storePrimaries", &Options::storePrimaries);
462 publish("storePrimaryHistograms", &Options::storePrimaryHistograms);
463 publish("writePrimaries", &Options::storePrimaries); // backwards compatibility
464
465 publish("storeTrajectory", &Options::storeTrajectory);
466 publish("storeTrajectories", &Options::storeTrajectory);
467 publish("storeTrajectoryDepth", &Options::storeTrajectoryDepth);
468 publish("storeTrajectoryStepPoints", &Options::storeTrajectoryStepPoints);
469 publish("storeTrajectoryStepPointLast", &Options::storeTrajectoryStepPointLast);
470 publish("storeTrajectoryParticle", &Options::storeTrajectoryParticle);
471 publish("storeTrajectoryParticleID", &Options::storeTrajectoryParticleID);
472 publish("storeTrajectorySecondaryParticles", &Options::storeTrajectorySecondaryParticles);
473 publish("storeTrajectoryEnergyThreshold", &Options::storeTrajectoryEnergyThreshold);
474 publish("storeTrajectorySamplerID", &Options::storeTrajectorySamplerID);
475 publish("storeTrajectoryELossSRange", &Options::storeTrajectoryELossSRange);
476
477 publish("storeTrajectoryTransportationSteps", &Options::storeTrajectoryTransportationSteps);
478 publish("trajNoTransportation", &Options::trajNoTransportation);
479 publish("storeTrajectoryKineticEnergy", &Options::storeTrajectoryKineticEnergy);
480 publish("storeTrajectoryMomentumVector", &Options::storeTrajectoryMomentumVector);
481 publish("storeTrajectoryProcesses", &Options::storeTrajectoryProcesses);
482 publish("storeTrajectoryTime", &Options::storeTrajectoryTime);
483 publish("storeTrajectoryLocal", &Options::storeTrajectoryLocal);
484 publish("storeTrajectoryLinks", &Options::storeTrajectoryLinks);
485 publish("storeTrajectoryIon", &Options::storeTrajectoryIon);
486 publish("storeTrajectoryIons", &Options::storeTrajectoryIon);
487 publish("storeTrajectoryMaterial", &Options::storeTrajectoryMaterial);
488 publish("storeTrajectoryAllVariables", &Options::storeTrajectoryAllVariables);
489 publish("trajectoryFilterLogicAND", &Options::trajectoryFilterLogicAND);
490
491 publish("storeSamplerAll", &Options::storeSamplerAll);
492 publish("storeSamplerPolarCoords", &Options::storeSamplerPolarCoords);
493 publish("storeSamplerPolarCoordinates", &Options::storeSamplerPolarCoords);
494 publish("storeSamplerCharge", &Options::storeSamplerCharge);
495 publish("storeSamplerKineticEnergy", &Options::storeSamplerKineticEnergy);
496 publish("storeSamplerMass", &Options::storeSamplerMass);
497 publish("storeSamplerRigidity", &Options::storeSamplerRigidity);
498 publish("storeSamplerIon", &Options::storeSamplerIon);
499
500 publish("trajConnect", &Options::trajConnect);
501 publish("trajectoryConnect", &Options::trajConnect);
502 publish("trajCutGTZ", &Options::trajCutGTZ);
503 publish("trajCutLTR", &Options::trajCutLTR);
504
505 publish("storeModel", &Options::storeModel);
506
507 publish("storePerEventHistos", &Options::storePerEventHistos);
508
509 publish("samplersSplitLevel", &Options::samplersSplitLevel);
510 publish("modelSplitLevel", &Options::modelSplitLevel);
511 publish("uprootCompatible", &Options::uprootCompatible);
512
513 // circular options
514 publish("nturns", &Options::nturns);
515 publish("ptcOneTurnMapFileName", &Options::ptcOneTurnMapFileName);
516
517 publish("printModuloFraction", &Options::printFractionEvents); // alternative name
518 publish("printFractionEvents", &Options::printFractionEvents);
519 publish("printFractionTurns", &Options::printFractionTurns);
520 publish("printPhysicsProcesses", &Options::printPhysicsProcesses);
521
522 // visualisation
523 publish("nSegmentsPerCircle", &Options::nSegmentsPerCircle);
524
525 // scoring map
526 publish("nbinsx", &Options::nbinsx);
527 publish("nbinsy", &Options::nbinsy);
528 publish("nbinsz", &Options::nbinsz);
529 publish("nbinse" , &Options::nbinse);
530 publish("xmin", &Options::xmin);
531 publish("xmax", &Options::xmax);
532 publish("ymin", &Options::ymin);
533 publish("ymax", &Options::ymax);
534 publish("zmin", &Options::zmin);
535 publish("zmax", &Options::zmax);
536 publish("emin", &Options::emin);
537 publish("emax", &Options::emax);
538 publish("useScoringMap", &Options::useScoringMap);
539
540 // millicharged
541 publish("enableMillicharge", &Options::enableMillicharge);
542 publish("millichargeName", &Options::millichargeName);
543 publish("millichargeMass", &Options::millichargeMass);
544 publish("millichargeCharge" , &Options::millichargeCharge);
545 publish("millichargeID", &Options::millichargeID);
546}
Basic options class independent of Geant4.
Definition optionsBase.h:36
std::string bdsimPath
std::string seedStateFileName
Seed state file path.
std::string magnetGeometryType
default magnet geometry parameters
double beamlineZ
Initial beam line transform w.r.t. the world coordinate frame.
int nGenerate
The number of primary events to simulate.
Definition optionsBase.h:94
std::string physicsList
list of physics processes
double muonSplittingThresholdParentEk2
physics parameters
double beamlineAngle
Initial beam line transform w.r.t. the world coordinate frame.
double beamlineS
Initial beam line transform w.r.t. the world coordinate frame.
bool survey
Parameter for survey.
Definition optionsBase.h:56
double minimumRange
physics parameters
std::string outputFileName
Parameter for output format.
Definition optionsBase.h:49
int muonSplittingFactor
physics parameters
double tunnelSoilThickness
tunnel geometry parameters
double minimumRadiusOfCurvature
Minimum allowed radius of curvature.
std::string outputFormat
Parameter for output format.
Definition optionsBase.h:50
int verboseSteppingEventContinueFor
Stepping level verbosity.
Definition optionsBase.h:83
bool beamlineAxisAngle
Initial beam line transform w.r.t. the world coordinate frame.
std::string exportFileName
Parameter for controlling geometry export.
int seed
The seed value for the random number generator.
Definition optionsBase.h:92
double tunnelOffsetY
tunnel geometry parameters
double tunnelFloorOffset
tunnel geometry parameters
int verboseEventContinueFor
Event level verbosity.
Definition optionsBase.h:74
bool hStyle
H Style dipoles (if not, C Style).
double xsize
for element specification
std::string particlesToExcludeFromCuts
physics parameters
double ffact
magnetic field flip (+1 default, -1: flip sign)
double tunnelMaxSegmentLength
tunnel geometry parameters
double muonSplittingThresholdParentEk
physics parameters
int verboseEventStart
Event level verbosity.
Definition optionsBase.h:73
bool useLENDGammaNuclear
physics parameters
double maximumTrackingTime
Maximum tracking time per track [s].
bool dontSplitSBends
geometry debug, don't split bends into multiple segments
std::string tunnelMaterial
tunnel geometry parameters
bool useASCIISeedState
Whether to use the seed state from an ASCII file.
Definition optionsBase.h:99
bool tunnelIsInfiniteAbsorber
physics parameters
bool verboseSteppingPrimaryOnly
Stepping level verbosity.
Definition optionsBase.h:84
int visVerbosity
Geant4 vis system verbosity.
Definition optionsBase.h:46
double muonSplittingExclusionWeight
physics parameters
bool collimatorsAreInfiniteAbsorbers
physics parameters
int verboseRunLevel
Run level verbosity.
Definition optionsBase.h:68
bool turnOnOpticalSurface
Physics processes.
double prodCutProtons
physics parameters
int nSegmentsPerCircle
Number of facets per 2pi in visualisation.
std::string soilMaterial
tunnel geometry parameters
bool preprocessGDML
geometry control
int maximumBetaChangePerStep
physics parameters
bool batch
Flag for batch / interactive mode.
Definition optionsBase.h:60
double minimumKineticEnergy
physics parameters
int eventOffset
Event number to start from when recreating from a root file.
int verboseTrackingLevel
Tracking verbosity.
Definition optionsBase.h:77
bool circular
Flag for circular machine.
Definition optionsBase.h:91
bool checkOverlaps
bdsim options
double neutronKineticEnergyLimit
physics parameters
double aper1
default beampipe parameters
double maximumTrackLength
Maximum permitted track length [m].
int verboseEventLevel
Event level verbosity.
Definition optionsBase.h:72
bool restoreFTPFDiffractionForAGreater10
physics parameters
bool turnOnOpticalAbsorption
Physics processes.
bool buildTunnelStraight
tunnel geometry parameters
std::string inputFileName
Input filename.
Definition optionsBase.h:40
long maximumTracksPerEvent
physics parameters
double backupStepperMomLimit
Fractional momentum limit for reverting to backup steppers.
double aper2
default beampipe parameters
int outputCompressionLevel
Parameter for output format.
Definition optionsBase.h:52
double beamlinePhi
Initial beam line transform w.r.t. the world coordinate frame.
double maximumStepLength
Maximum permitted step length in any volume.
std::string exportType
Parameter for controlling geometry export.
double neutronTimeLimit
physics parameters
bool recreateSeedState
Load seed state when recreating events.
std::string vacMaterial
vacuum material
bool verbose
General verbosity.
Definition optionsBase.h:65
std::string recreateFileName
The file path to recreate a run from.
Definition optionsBase.h:96
bool teleporterFullTransform
Whether to use the new Transform3D method for the teleporter.
bool buildTunnelFloor
tunnel geometry parameters
int startFromEvent
Event to start from when recreating.
Definition optionsBase.h:97
std::string emptyMaterial
material in container volumes
bool muonSplittingExcludeWeight1Particles
physics parameters
double prodCutPhotons
physics parameters
bool generatePrimariesOnly
Whether to only generate primary coordinates and quit, or not.
double defaultRangeCut
physics parameters
double beamlineAxisY
Initial beam line transform w.r.t. the world coordinate frame.
double prodCutElectrons
physics parameters
double tunnelAper1
tunnel geometry parameters
bool verboseEventBDSIM
Event level verbosity.
Definition optionsBase.h:71
int maximumPhotonsPerStep
physics parameters
std::string beampipeMaterial
default beampipe parameters
bool exportGeometry
Parameter for controlling geometry export.
int verboseSteppingLevel
Stepping level verbosity.
Definition optionsBase.h:81
double beampipeThickness
default beampipe parameters
bool turnOnRayleighScattering
Physics processes.
std::string geant4PhysicsMacroFileName
Geant4 physics macro.
Definition optionsBase.h:43
std::string visMacroFileName
Visualisation filename.
Definition optionsBase.h:41
double scintYieldFactor
physics parameters
bool beamPipeIsInfiniteAbsorber
physics parameters
double beamlineX
Initial beam line transform w.r.t. the world coordinate frame.
std::string apertureType
default beampipe parameters
bool verboseSteppingBDSIM
Stepping level verbosity.
Definition optionsBase.h:80
bool useMuonNuclear
physics parameters
bool useElectroNuclear
physics parameters
int verboseSteppingEventStart
Stepping level verbosity.
Definition optionsBase.h:82
std::string surveyFileName
Parameter for survey.
Definition optionsBase.h:57
std::vector< std::string > setKeys
A list of all the keys that have been set in this instance.
bool recreate
Whether to recreate from a file or not.
Definition optionsBase.h:95
double tunnelAper2
tunnel geometry parameters
bool turnOnMieScattering
Physics processes.
double beamlineY
Initial beam line transform w.r.t. the world coordinate frame.
double beamlineAxisX
Initial beam line transform w.r.t. the world coordinate frame.
double tunnelThickness
tunnel geometry parameters
std::string randomEngine
Name of random engine to use.
Definition optionsBase.h:93
double prodCutPositrons
physics parameters
bool buildTunnel
tunnel geometry parameters
bool outputDoublePrecision
Parameter for output format.
Definition optionsBase.h:51
bool writeSeedState
Write the seed state each event to a text file.
Definition optionsBase.h:98
bool visDebug
Flag for visualisation debug.
Definition optionsBase.h:45
bool useGammaToMuMu
physics parameters
double aper4
default beampipe parameters
double aper3
default beampipe parameters
double minimumKineticEnergyTunnel
physics parameters
double tunnelOffsetX
tunnel geometry parameters
bool usePositronToMuMu
physics parameters
std::string tunnelType
tunnel geometry parameters
double beamlineAxisZ
Initial beam line transform w.r.t. the world coordinate frame.
double beamlinePsi
Initial beam line transform w.r.t. the world coordinate frame.
std::string geant4MacroFileName
Geant4 macro to run.
Definition optionsBase.h:42
bool trajNoTransportation
kept only for backwards compatibility.
double xrayAllSurfaceRoughness
physics parameters
bool usePositronToHadrons
physics parameters
bool tunnelVisible
tunnel geometry parameters
int muonSplittingFactor2
physics parameters
double worldVolumeMargin
Padding margin for world volume size.
double nominalMatrixRelativeMomCut
Momentum threshold for nominal dipole matrix tracking.
double beamlineTheta
Initial beam line transform w.r.t. the world coordinate frame.
bool ignoreLocalAperture
default beampipe parameters
Options class.
Definition options.h:44
void Amalgamate(const Options &optionsIn, bool override)
Definition options.cc:98
void PublishMembers()
publish members so these can be looked up from parser
Definition options.cc:144
bool HasBeenSet(const std::string &name) const
Whether a parameter has been set using the set_value method or not.
Definition options.cc:139
void publish(const std::string &name, T C::*mp)
Make pointer to member from class C and type T with accessible with a name.
Definition published.h:94
void set(OptionsBase *instance, const std::string &name, double value)
Definition published.h:101
Parser namespace for GMAD language. Combination of Geant4 and MAD.