| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // ********************************************************************
27 //
28 // CaTS (Calorimetry and Tracking Simulation)
29 //
30 // Authors : Hans Wenzel
31 // Soon Yung Jun
32 // (Fermi National Accelerator Laboratory)
33 //
34 // History
35 // October 18th, 2021 : first implementation
36 //
37 // ********************************************************************
38 //
39 /// \file ConfigurationManager.cc
40 /// \brief Implementation of the CaTS::ConfigurationManager class
41
42 // Geant4 headers
43 #include <G4ios.hh>
44 #include "G4GenericMessenger.hh"
45 // project headers
46 #include "ConfigurationManager.hh"
47 // c++ headers
48 #include <ostream>
49 #include <string>
50 ConfigurationManager* ConfigurationManager::fginstance = nullptr;
51 std::once_flag ConfigurationManager::fginitInstanceFlag;
52
53 ConfigurationManager::ConfigurationManager() { DefineCommands(); }
54
55 ConfigurationManager::~ConfigurationManager() { delete fMessenger; }
56
57 void ConfigurationManager::Print()
58 {
59 G4cout << "--------------------------------------------------" << G4endl;
60 G4cout << "CaTS configuration: " << G4endl;
61 G4cout << "====================" << G4endl;
62 G4cout << G4endl;
63 G4cout << "fenable_verbose: " << fenable_verbose << G4endl;
64 G4cout << "fdumpgdml: " << fdumpgdml << G4endl;
65 G4cout << "fGDMLFileName: " << fGDMLFileName << G4endl;
66 #ifdef WITH_ROOT
67 G4cout << "fdoAnalysis: " << fdoAnalysis << G4endl;
68 G4cout << "fHistoFileName: " << fHistoFileName << G4endl;
69 G4cout << "fwriteHits: " << fwriteHits << G4endl;
70 G4cout << "fname: " << fname << G4endl;
71 #endif
72 G4cout << "fenable_opticks: " << fenable_opticks << G4endl;
73 G4cout << "fMaxPhotons: " << fMaxPhotons << G4endl;
74 G4cout << "--------------------------------------------------" << G4endl;
75 }
76
77 void ConfigurationManager::DefineCommands()
78 {
79 fMessenger = new G4GenericMessenger(this, "/CaTS/", "Configuring CaTS");
80 //
81 // Commands defining RootIO
82 #ifdef WITH_ROOT
83 auto& HistoFileNameCmd =
84 fMessenger->DeclareProperty("HistoFileName", fHistoFileName);
85 HistoFileNameCmd.SetGuidance("Filename for Analysis Histograms");
86 HistoFileNameCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
87 HistoFileNameCmd.SetDefaultValue("histograms.root");
88 auto& writeHitsCmd = fMessenger->DeclareProperty("writeHits", fwriteHits);
89 writeHitsCmd.SetGuidance("Write out Hits collection");
90 writeHitsCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
91 writeHitsCmd.SetDefaultValue("false");
92 auto& doAnalysisCmd = fMessenger->DeclareProperty("doAnalysis", fdoAnalysis);
93 doAnalysisCmd.SetGuidance("Do Analysis");
94 doAnalysisCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
95 doAnalysisCmd.SetDefaultValue("false");
96 auto& fnameCmd = fMessenger->DeclareProperty("fname", fname);
97 fnameCmd.SetGuidance("set fname");
98 fnameCmd.SetStates(G4State_PreInit);
99 fnameCmd.SetDefaultValue("Hits");
100 #endif
101 //
102 // Commands enabling G4Opticks and frequency calling it:
103 //
104 auto& enable_opticksCmd =
105 fMessenger->DeclareProperty("enable_opticks", fenable_opticks);
106 enable_opticksCmd.SetGuidance(
107 "use opticks for generating and tracing of optical photons");
108 enable_opticksCmd.SetDefaultValue("false");
109 enable_opticksCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
110 auto& MaxPhotonsCmd = fMessenger->DeclareProperty("MaxPhotons", fMaxPhotons);
111 MaxPhotonsCmd.SetGuidance(
112 "set number of photons to be collecetd befores invoking G4Opticks");
113 MaxPhotonsCmd.SetDefaultValue("1000000");
114 MaxPhotonsCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
115 //
116 // general command to control verbosity and writing out geometry to a gdml
117 // file:
118 //
119 fMessenger->DeclareMethod("list", &ConfigurationManager::Print)
120 .SetGuidance("Print all configuration parameters")
121 .SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
122 auto& verboseCmd = fMessenger->DeclareProperty("verbose", fenable_verbose);
123 verboseCmd.SetGuidance("Set flag for enabling verbose diagnostic printout");
124 verboseCmd.SetDefaultValue("false");
125 verboseCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
126 auto& GDMLFileNameCmd =
127 fMessenger->DeclareProperty("GDMLFileName", fGDMLFileName);
128 GDMLFileNameCmd.SetGuidance(
129 "Set Filename to dump GDML representation of Geometry");
130 GDMLFileNameCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
131 GDMLFileNameCmd.SetDefaultValue("dump.gdml_G4");
132 auto& dumpgdmlCmd = fMessenger->DeclareProperty("dumpgdml", fdumpgdml);
133 dumpgdmlCmd.SetGuidance(
134 "Set flag for enabling dumping the Geometry to a gdml file");
135 dumpgdmlCmd.SetStates(G4State_PreInit, G4State_Init, G4State_Idle);
136 dumpgdmlCmd.SetDefaultValue("false");
137 }
138