19#include "BDSExecOptions.hh"
29#include "BDSColourFromMaterial.hh"
30#include "BDSColours.hh"
31#include "BDSMaterials.hh"
32#include "BDSOutputLoader.hh"
33#include "BDSUtilities.hh"
35#include "parser/beam.h"
36#include "parser/getEnv.h"
37#include "parser/options.h"
55 G4cout << __METHOD_NAME__ <<
"BDSIMPATH set to: " <<
options.
bdsimPath << G4endl;
60 G4cout << __METHOD_NAME__ <<
"Recreation mode. Loading options from recreate file:\n\""
77 static struct option LongOptions[] = {{
"help" , 0, 0, 0 },
78 {
"reference", 0, 0, 0},
79 {
"citation", 0, 0, 0},
80 {
"version", 0, 0, 0 },
81 {
"versionGit", 0, 0, 0 },
82 {
"verbose", 0, 0, 0 },
83 {
"verbose_step", 0, 0, 0 },
84 {
"verboseSteppingBDSIM", 0, 0, 0 },
85 {
"verbose_event", 0, 0, 0 },
86 {
"verboseEventBDSIM", 0, 0, 0 },
87 {
"verbose_event_num", 1, 0, 0 },
88 {
"verboseEventNumber", 1, 0, 0 },
89 {
"verboseEventStart", 1, 0, 0 },
90 {
"verboseEventContinueFor", 1, 0, 0 },
91 {
"verbose_G4run", 1, 0, 0 },
92 {
"verboseRunLevel", 1, 0, 0},
93 {
"verbose_G4event", 1, 0, 0 },
94 {
"verboseEventLevel", 1, 0, 0},
95 {
"verbose_G4tracking", 1, 0, 0 },
96 {
"verboseTrackingLevel", 1, 0, 0 },
97 {
"verbose_G4stepping", 1, 0, 0 },
98 {
"verboseSteppingLevel", 1, 0, 0 },
99 {
"verboseSteppingEventStart", 1, 0, 0 },
100 {
"verboseSteppingEventContinueFor", 1, 0, 0 },
101 {
"verboseSteppingPrimaryOnly", 0, 0, 0 },
103 {
"distrFile", 1, 0, 0 },
104 {
"distrFileNLinesSkip", 1, 0, 0 },
105 {
"distrFileLoopNTimes", 1, 0, 0 },
109 {
"vis_debug", 0, 0, 0 },
110 {
"vis_mac", 1, 0, 0 },
111 {
"geant4Macro", 1, 0, 0 },
112 {
"geant4MacroFileName", 1, 0, 0 },
113 {
"geant4PhysicsMacroFileName", 1, 0, 0 },
114 {
"output", 1, 0, 0 },
115 {
"outfile", 1, 0, 0 },
116 {
"batch", 0, 0, 0 },
117 {
"colours", 0, 0, 0 },
118 {
"materials", 0, 0, 0 },
119 {
"circular", 0, 0, 0 },
121 {
"recreate", 1, 0, 0},
122 {
"startFromEvent", 1, 0, 0},
123 {
"writeSeedState", 0, 0, 0},
124 {
"seedState", 1, 0, 0},
125 {
"seedStateFileName", 1, 0, 0},
126 {
"survey", 1, 0, 0 },
127 {
"ngenerate", 1, 0, 0 },
128 {
"nGenerate", 1, 0, 0 },
129 {
"nturns", 1, 0, 0 },
130 {
"nTurns", 1, 0, 0 },
131 {
"printFractionEvents", 1, 0, 0},
132 {
"printFractionTurns", 1, 0, 0},
133 {
"printPhysicsProcesses", 0, 0, 0},
134 {
"exportGeometryTo", 1, 0, 0 },
135 {
"generatePrimariesOnly", 0, 0, 0 },
136 {
"ignoresigint", 0, 0, 0},
140 int OptionNumber = 0;
141 const char* optionName;
143 bool conversion =
true;
149 int c = getopt_long(argc, argv,
"Vv",
150 LongOptions, &OptionIndex );
159 G4cout <<
"invalid option for command " << argv[0] << G4endl << G4endl << G4endl;
167 optionName = LongOptions[OptionIndex].name;
168 if ( !strcmp(optionName ,
"help") )
173 else if ( !strcmp(optionName,
"reference") || !strcmp(optionName,
"citation") )
178 else if ( !strcmp(optionName,
"version") )
180 G4cout <<
"@BDSIM_VERSION@" << G4endl;
183 else if ( !strcmp(optionName,
"versionGit") )
185 G4cout <<
"@BDSIM_VERSION@ based on git commit SHA1: @VERSION_SHA1@" << G4endl;
188 else if ( !strcmp(optionName ,
"batch") )
190 else if ( !strcmp(optionName ,
"verbose") )
192 else if ( !strcmp(optionName ,
"verbose_step") || !strcmp(optionName ,
"verboseSteppingBDSIM"))
197 else if ( !strcmp(optionName ,
"verbose_event") || !strcmp(optionName,
"verboseEventBDSIM") )
199 else if ( !strcmp(optionName ,
"verbose_event_num") || !strcmp(optionName ,
"verboseEventNumber"))
206 else if ( !strcmp(optionName ,
"verboseEventStart") )
212 else if ( !strcmp(optionName ,
"verboseEventContinueFor") )
218 else if ( !strcmp(optionName ,
"verbose_G4run") || !strcmp(optionName ,
"verboseRunLevel") )
224 else if ( !strcmp(optionName ,
"verbose_G4event") || !strcmp(optionName ,
"verboseEventLevel") )
230 else if ( !strcmp(optionName ,
"verbose_G4tracking") || !strcmp(optionName ,
"verboseTrackingLevel") )
236 else if ( !strcmp(optionName ,
"verbose_G4stepping") || !strcmp(optionName ,
"verboseSteppingLevel"))
242 else if ( !strcmp(optionName ,
"verboseSteppingEventStart") )
248 else if ( !strcmp(optionName ,
"verboseSteppingEventContinueFor") )
254 else if ( !strcmp(optionName ,
"verboseSteppingPrimaryOnly") )
256 else if ( !strcmp(optionName ,
"output") )
258 else if ( !strcmp(optionName ,
"outfile") )
260 else if ( !strcmp(optionName ,
"survey") )
265 else if ( !strcmp(optionName ,
"file") )
267 else if ( !strcmp(optionName,
"distrFile") )
272 else if ( !strcmp(optionName,
"distrFileNLinesSkip") )
278 else if ( !strcmp(optionName,
"distrFileLoopNTimes") )
285 else if (!strcmp(optionName,
"E0") )
291 else if (!strcmp(optionName,
"P0") )
297 else if (!strcmp(optionName,
"Ek0") )
303 else if ( !strcmp(optionName,
"vis_debug") )
305 else if ( !strcmp(optionName,
"vis_mac") )
307 else if ( !strcmp(optionName,
"geant4Macro") || !strcmp(optionName,
"genat4MacroFileName") )
309 else if ( !strcmp(optionName,
"geant4PhysicsMacroFileName") )
314 else if ( !strcmp(optionName,
"colours") )
320 else if ( !strcmp(optionName,
"materials") )
325 else if ( !strcmp(optionName,
"circular") )
327 else if ( !strcmp(optionName,
"seed") )
333 else if ( !strcmp(optionName,
"recreate") )
338 else if ( !strcmp(optionName,
"startFromEvent") )
344 else if ( !strcmp(optionName,
"writeSeedState") )
346 else if ( !strcmp(optionName,
"seedState") || !strcmp(optionName,
"seedStateFileName"))
351 else if ( !strcmp(optionName,
"ngenerate") || !strcmp(optionName,
"nGenerate"))
358 else if ( !strcmp(optionName,
"nturns") || !strcmp(optionName,
"nTurns"))
364 else if ( !strcmp(optionName,
"printFractionEvents") )
370 else if ( !strcmp(optionName,
"printFractionTurns") )
376 else if ( !strcmp(optionName,
"printPhysicsProcesses") )
378 else if ( !strcmp(optionName,
"generatePrimariesOnly") )
380 else if ( !strcmp(optionName,
"ignoresigint") )
382 else if ( !strcmp(optionName,
"exportGeometryTo") )
384 std::string fn = optarg;
385 if (fn.substr(fn.find_last_of(
".") + 1) ==
"gdml")
392 G4cerr << __METHOD_NAME__ <<
"Unknown geometry format \""
393 << fn.substr(fn.find_last_of(
".") + 1) <<
"\"\n"
394 <<
"Please specify a valid filename extension - options are: \"gdml\"" << G4endl;
401 if (conversion ==
false)
404 G4cerr << __METHOD_NAME__ <<
"Conversion to number (or integer) went wrong for \""
405 << optionName <<
"\" with value: \"" << optarg <<
"\"" << G4endl;
413 G4cout <<
"WARNING unknown returned character code " << c << G4endl;
419 if (OptionNumber < argc - 1)
421 G4cout << __METHOD_NAME__ <<
"there are remaining unknown options: " << G4endl;
422 for (
int i=1; i<argc; i++)
425 if (strncmp(argv[i],
"-", 1))
426 {G4cout <<
"\"" << argv[i] <<
"\"" << G4endl;}
429 G4cout <<
"Please check your command line arguments" << G4endl;
436 G4cout<<
"Usage: bdsim [options]" << G4endl;
437 G4cout<<
"Note options are case sensitive." << G4endl;
438 G4cout<<
"bdsim --help : display this message" << G4endl;
439 G4cout<<
"Options (alphabetically):" << G4endl;
440 G4cout<<
"--file=<filename> : specify the input file " << G4endl
441 <<
"--batch : batch mode - no graphics" << G4endl
442 <<
"--reference or --citation : print the citation information then quit" << G4endl
443 <<
"--circular : assume circular machine - turn control" << G4endl
444 <<
"--colours : list available colours included in bdsim" << G4endl
445 <<
" by default" << G4endl
446 <<
"--distrFile=<filename> : file to use for bunch distribution" << G4endl
447 <<
"--distrFileNLinesSkip=N : skip N lines in the file (userfile)" << G4endl
448 <<
"--distrFileLoopNTimes=N : repeat the distribution file N times" << G4endl
449 <<
"--exportGeometryTo=<filename.extension> : export the fully constructed geometry" << G4endl
450 <<
" to a file. Only gdml extension supported." << G4endl
451 <<
"--E0=N : set E0 for the bunch for this run (GeV only)" << G4endl
452 <<
"--Ek0=N : set Ek0 for the bunch for this run (GeV only)" << G4endl
453 <<
"--geant4MacroFileName=<filename> : macro run after visualisation" << G4endl
454 <<
"--geant4PhysicsMacroFileName=<filename> : physics macro file name" << G4endl
455 <<
"--generatePrimariesOnly : generate N primary particle coordinates" << G4endl
456 <<
" without simulation then quit" << G4endl
457 <<
"--materials : list materials included in bdsim by default" << G4endl
458 <<
"--ngenerate=N : the number of primary events to simulate:" << G4endl
459 <<
" overrides ngenerate option in the input gmad file" << G4endl
460 <<
"--nturns=N : the number of turns to simulate:" << G4endl
461 <<
" overrides nturns option in the input gmad file" << G4endl
462 <<
"--output=<fmt> : output format (rootevent|none), default rootevent" << G4endl
463 <<
"--outfile=<file> : output file name. Will be appended with _N" << G4endl
464 <<
" where N = 0, 1, 2, 3... etc." << G4endl
465 <<
"--printFractionEvents=N : fraction of events to print out (default 0.1)" << G4endl
466 <<
" -1 is all, range [0-1]" << G4endl
467 <<
"--printFractionTurns=N : fraction of turns to print out (default 0.2)" << G4endl
468 <<
" -1 is all, range [0-1]" << G4endl
469 <<
"--printPhysicsProcesses : print out every particle registered and all " << G4endl
470 <<
" their processes - depends on physics list in input"<< G4endl
471 <<
"--P0=N : set P0 for the bunch for this run (GeV only)" << G4endl
472 <<
"--recreate=<file> : the rootevent file to recreate events from" << G4endl
473 <<
"--seed=N : the seed to use for the random number generator" << G4endl
474 <<
"--seedStateFileName=<file> : use this ASCII file seed state to run an event" << G4endl
475 <<
"--startFromEvent=N : event offset to start from when recreating events" << G4endl
476 <<
"--survey=<file> : print survey info to <file>" << G4endl
477 <<
"--verbose : display general parameters before run" << G4endl
478 <<
"--verboseRunLevel=N : set Geant4 verbosity at run level [0:5]" << G4endl
479 <<
"--verboseEventLevel=N : set Geant4 event manager verbosity level" << G4endl
480 <<
"--verboseEventStart=N : display tracking information from event number N" << G4endl
481 <<
"--verboseEventContinueFor=N : number of events to continue verbose event info for" << G4endl
482 <<
"--verboseTrackingLevel=N : set Geant4 verbosity about new tracks." << G4endl
483 <<
"--verboseSteppingLevel=N : set Geant4 Stepping manager verbosity level [0:5]" << G4endl
484 <<
"--verboseSteppingEventStart=N : event to start verbose stepping." << G4endl
485 <<
"--verboseSteppingEventContinueFor=N : number of events to continue verbose stepping" << G4endl
486 <<
" information for" << G4endl
487 <<
"--verboseSteppingPrimaryOnly : only print out verbose stepping for primary particle" << G4endl
488 <<
"--verboseEventBDSIM : display BDSIM information for every event " << G4endl
489 <<
"--verboseSteppingBDSIM : display BDSIM tracking information after each step"<< G4endl
490 <<
"--version : display version number" << G4endl
491 <<
"--versionGit : display version number including git commit SHA1" << G4endl
492 <<
"--vis_debug : display all volumes in visualiser" << G4endl
493 <<
"--vis_mac=<file> : file with the visualisation macro script, default" << G4endl
494 <<
" provided by BDSIM openGL (OGLSQt))" << G4endl
495 <<
"--writeSeedState : write an ASCII file seed state for each event" << G4endl;
501 G4cout<<
"BDSIM : version @BDSIM_VERSION@"<<G4endl;
502 G4cout<<
" (C) 2001-@CURRENT_YEAR@ Royal Holloway University London - GPLv3" << G4endl;
504 G4cout<<
" Reference: Computer Physics Communications, 107200 (2020)" << G4endl;
505 G4cout<<
" https://doi.org/10.1016/j.cpc.2020.107200" << G4endl;
506 G4cout<<
" https://arxiv.org/abs/1808.10745" << G4endl;
507 G4cout<<
" Website: http://www.pp.rhul.ac.uk/bdsim"<<G4endl;
513 G4cout <<
"BDSIM: An accelerator tracking code with particle-matter interactions." << G4endl;
514 G4cout <<
"L.J. Nevay et al., Computer Physics Communications, 1070200 (2020)" << G4endl;
515 G4cout <<
"https://doi.org/10.1016/j.cpc.2020.107200" << G4endl << G4endl;
516 G4cout << R
"(@article{NEVAY2020107200,)" << G4endl;
517 G4cout << R"(title = {BDSIM: An accelerator tracking code with particle–matter interactions},)" << G4endl;
518 G4cout << R"(journal = {Comput. Phys. Commun.},)" << G4endl;
519 G4cout << R"(volume = {252},)" << G4endl;
520 G4cout << R"(pages = {107200},)" << G4endl;
521 G4cout << R"(year = {2020},)" << G4endl;
522 G4cout << R"(issn = {0010-4655},)" << G4endl;
523 G4cout << R"(doi = {https://doi.org/10.1016/j.cpc.2020.107200},)" << G4endl;
524 G4cout << R"(url = {https://www.sciencedirect.com/science/article/pii/S0010465520300400},)" << G4endl;
525 G4cout << R"(author = {L.J. Nevay and S.T. Boogert and J. Snuverink and A. Abramov and L.C. Deacon and H. Garcia-Morales and H. Lefebvre and S.M. Gibson and R. Kwee-Hinzmann and W. Shields and S.D. Walker},)" << G4endl;
526 G4cout << R"(})" << G4endl;
531 for (
const auto& key :
options.KeysOfSetValues())
532 {G4cout <<
"Executable option> " << std::setw(27) << std::left << key <<
": " << std::setw(15) << std::left <<
options.get_value_string(key) << G4endl;}
533 for (
const auto& key :
beam.KeysOfSetValues())
534 {G4cout <<
"Executable option> " << std::setw(27) << std::left << key <<
": " << std::setw(15) << std::left <<
beam.get_value_string(key) << G4endl;}
541 G4String fullPath = getEnv(
"BDSIMPATH");
543 G4cout << __METHOD_NAME__ <<
"filename = " << fileName << G4endl;
545 if (fullPath.empty())
547 G4String inputFilepath =
"";
549 G4String::size_type found = fileName.rfind(
"/");
550 if (found != G4String::npos)
551 {inputFilepath = fileName.substr(0,found);}
554 if ((fileName.substr(0,1)) ==
"/")
556 fullPath = inputFilepath;
561 fullPath = curDir +
"/" + inputFilepath;
565 if (fullPath.back() !=
'/')
568 G4cout << __METHOD_NAME__ <<
"fullpath = " << fullPath << G4endl;
static BDSColourFromMaterial * Instance()
Singleton pattern.
static BDSColours * Instance()
singleton pattern
GMAD::Options options
The options instance that is populated by parsing the command line options.
GMAD::Beam beam
The beam instance that is populated by parsing some command line options.
void Print() const
Print out the commands and their set values.
void PrintCitation() const
Print academic citation information.
G4bool ignoreSIGINT
Whether to ignore Ctrl-C or not - used for ctest.
void Usage() const
Print out the available executable commands (no exit).
void PrintCopyright() const
Print out the copyright information (no exit).
void Parse(int argc, char **argv)
G4String GetPath(G4String filename)
Helper method to set the BDSIMPath correctly.
BDSExecOptions()
Private default constructor to force use of provided one.
static BDSMaterials * Instance()
Singleton pattern access.
void ListMaterials() const
output available materials
Loader of ROOT Event output for recreating events.
void Amalgamate(const Beam &optionsIn, bool override, int startFromEvent=0)
void set_value(std::string name, T value)
set methods by property name
bool batch
Flag for batch / interactive mode.
std::string inputFileName
Input filename.
std::string recreateFileName
The file path to recreate a run from.
int startFromEvent
Event to start from when recreating.
bool recreate
Whether to recreate from a file or not.
void Amalgamate(const Options &optionsIn, bool override)
void set_value(std::string name, T value)
set methods by property name
std::string GetCurrentDir()
Get the current dir the program was executed from.
G4bool IsNumber(const char *s, double &convertedNumber)
Check if character array is an integer, and returns the double by reference.
G4bool IsInteger(const char *s, int &convertedInteger)
Check if character array is an integer, and returns the integer by reference.
Parser namespace for GMAD language. Combination of Geant4 and MAD.