gphysics
Loading...
Searching...
No Matches
gphysics_options.cc
Go to the documentation of this file.
1// gphysics
2#include "gphysicsConventions.h"
3#include "gphysics_options.h"
4
5// geant4 version
6#include "G4Version.hh"
7
8// namespace to define options
9namespace gphysics {
10
11using std::string;
12
13// Non-Doxygen implementation note:
14// Full semantics are documented in gphysics_options.h. Here we assemble the help text and register options.
15GOptions defineOptions() {
16
17 GOptions goptions(GPHYSICS_LOGGER);
18
19 string physicsListHelp = "Geant4 Version " + string(G4VERSION_TAG);
20
21 // The help text below includes a curated list of physics lists and constructors.
22 // TODO: this should be done automatically by querying Geant4 registries at runtime.
23 physicsListHelp += " Physics List: it contains a Geant4 physics module, optional e.m. replacement, and optional physics constructors\n";
24 // below is the output of ./formatPhysList.py -gemc
25 // this should be done more automatically in the future
26 physicsListHelp += string(goptions::HELPFILLSPACE) + "The available geant4 modules are:\n\n";
27 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_BERT\n";
28 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_BERT_ATL\n";
29 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_BERT_HP\n";
30 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_BERT_TRV\n";
31 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_INCLXX\n";
32 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFP_INCLXX_HP\n";
33 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTFQGSP_BERT\n";
34 physicsListHelp += string(goptions::HELPFILLSPACE) + " - FTF_BIC\n";
35 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4GenericPhysicsList\n";
36 physicsListHelp += string(goptions::HELPFILLSPACE) + " - LBE\n";
37 physicsListHelp += string(goptions::HELPFILLSPACE) + " - NuBeam\n";
38 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QBBC\n";
39 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_BERT\n";
40 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_BERT_HP\n";
41 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_BIC\n";
42 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_BIC_AllHP\n";
43 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_BIC_HP\n";
44 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_FTFP_BERT\n";
45 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_INCLXX\n";
46 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGSP_INCLXX_HP\n";
47 physicsListHelp += string(goptions::HELPFILLSPACE) + " - QGS_BIC\n";
48 physicsListHelp += string(goptions::HELPFILLSPACE) + " - Shielding\n";
49 physicsListHelp += string(goptions::HELPFILLSPACE) + " - ShieldingLEND\n";
50 physicsListHelp += string(goptions::HELPFILLSPACE) + " - ShieldingM\n";
51 physicsListHelp +=
52 "\n" + string(goptions::HELPFILLSPACE) +
53 "The default e.m. physics can be replaced by appending one of these string to the module above:\n\n";
54 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _EM0 to use G4EmStandardPhysics\n";
55 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _EMV to use G4EmStandardPhysics_option1\n";
56 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _EMX to use G4EmStandardPhysics_option2\n";
57 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _EMY to use G4EmStandardPhysics_option3\n";
58 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _EMZ to use G4EmStandardPhysics_option4\n";
59 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _GS to use G4EmStandardPhysicsGS\n";
60 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _LE to use G4EmLowEPPhysics\n";
61 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _LIV to use G4EmLivermorePhysics\n";
62 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _PEN to use G4EmPenelopePhysics\n";
63 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _SS to use G4EmStandardPhysicsSS\n";
64 physicsListHelp += string(goptions::HELPFILLSPACE) + " - _WVI to use G4EmStandardPhysicsWVI\n";
65 physicsListHelp +=
66 "\n" + string(goptions::HELPFILLSPACE) +
67 "For example, FTFP_BERT_LIV would replace the default e.m. physics with the Livermore model \n\n";
68 physicsListHelp +=
69 "\n" + string(goptions::HELPFILLSPACE) +
70 "Additional physics can be loaded by adding its constructor name to the list using the + sign\n";
71 physicsListHelp += "\n" + string(goptions::HELPFILLSPACE) +
72 "For example: FTFP_BERT + G4OpticalPhysics. The available constructors are: \n\n";
73 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4ChargeExchangePhysics\n";
74 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4DecayPhysics\n";
75 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAChemistry\n";
76 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAChemistry_option1\n";
77 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAChemistry_option2\n";
78 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAChemistry_option3\n";
79 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics\n";
80 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option1\n";
81 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option2\n";
82 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option3\n";
83 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option4\n";
84 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option5\n";
85 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option6\n";
86 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option7\n";
87 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_option8\n";
88 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_stationary\n";
89 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_stationary_option2\n";
90 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_stationary_option4\n";
91 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmDNAPhysics_stationary_option6\n";
92 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmExtraPhysics\n";
93 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmLivermorePhysics\n";
94 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmLivermorePolarizedPhysics\n";
95 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmLowEPPhysics\n";
96 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmPenelopePhysics\n";
97 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysics\n";
98 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysicsGS\n";
99 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysicsSS\n";
100 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysicsWVI\n";
101 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysics_option1\n";
102 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysics_option2\n";
103 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysics_option3\n";
104 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4EmStandardPhysics_option4\n";
105 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4FastSimulationPhysics\n";
106 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4GenericBiasingPhysics\n";
107 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronDElasticPhysics\n";
108 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronElasticPhysics\n";
109 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronElasticPhysicsHP\n";
110 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronElasticPhysicsLEND\n";
111 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronElasticPhysicsPHP\n";
112 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronElasticPhysicsXS\n";
113 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronHElasticPhysics\n";
114 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronInelasticQBBC\n";
115 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTFP_BERT\n";
116 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTFP_BERT_ATL\n";
117 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTFP_BERT_HP\n";
118 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTFP_BERT_TRV\n";
119 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTFQGSP_BERT\n";
120 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsFTF_BIC\n";
121 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsINCLXX\n";
122 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsNuBeam\n";
123 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_BERT\n";
124 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_BERT_HP\n";
125 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_BIC\n";
126 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_BIC_AllHP\n";
127 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_BIC_HP\n";
128 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGSP_FTFP_BERT\n";
129 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsQGS_BIC\n";
130 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsShielding\n";
131 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4HadronPhysicsShieldingLEND\n";
132 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4ImportanceBiasing\n";
133 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonBinaryCascadePhysics\n";
134 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonElasticPhysics\n";
135 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonINCLXXPhysics\n";
136 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonPhysics\n";
137 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonPhysicsPHP\n";
138 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonPhysicsXS\n";
139 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4IonQMDPhysics\n";
140 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4MuonicAtomDecayPhysics\n";
141 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4NeutronCrossSectionXS\n";
142 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4NeutronTrackingCut\n";
143 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4OpticalPhysics\n";
144 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4ParallelWorldPhysics\n";
145 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4RadioactiveDecayPhysics\n";
146 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4SpinDecayPhysics\n";
147 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4StepLimiterPhysics\n";
148 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4StoppingPhysics\n";
149 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4StoppingPhysicsFritiofWithBinaryCascade\n";
150 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4UnknownDecayPhysics\n";
151 physicsListHelp += string(goptions::HELPFILLSPACE) + " - G4WeightWindowBiasing\n";
152 physicsListHelp += "\n" + string(goptions::HELPFILLSPACE) + "Command-line examples:\n";
153 physicsListHelp += string(goptions::HELPFILLSPACE) + " -phys_list=FTFP_BERT\n";
154 physicsListHelp += string(goptions::HELPFILLSPACE) + " -phys_list=\"FTFP_BERT_EMZ + G4OpticalPhysics\"\n";
155 goptions.defineOption(GVariable("phys_list", gphysics::DEFAULTPHYSICSLIST, "Select Physics List"),
156 physicsListHelp);
157 goptions.defineOption(GVariable("production_cut", std::nullopt, "Production range cut in millimeters"),
158 "Global secondary-production range cut for gamma, e-, e+, and proton.\n"
159 "By default, retain the selected physics list's production cuts.\n"
160 "This is a range cut, not a tracking-energy threshold.");
161
162 goptions.defineSwitch("showPhysics", "Log Geant4 Physics Available Modules that can be used with the \"phys_list\" option and exit");
163
164 return goptions;
165}
166
167}
gphysics_options.h
GPHYSICS_LOGGER
constexpr const char * GPHYSICS_LOGGER
Definition gphysics_options.h:6
gphysics::DEFAULTPHYSICSLIST
constexpr char DEFAULTPHYSICSLIST[]
Default value for the phys_list option.
Definition gphysicsConventions.h:13
gphysics::defineOptions
GOptions defineOptions()
Defines the user-facing options for the gphysics module.
Definition gphysics_options.cc:15
goptions::HELPFILLSPACE
constexpr char HELPFILLSPACE[]