| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 // G4SPSRandomGenerator
27 //
28 // Class Description:
29 //
30 // Special random number generator used by G4G
31 // biasing applied at the lowest level for all
32 // This is a shared class between threads.
33 // Only one thread should use the set-methods
34 // Note that this is exactly what is achieved
35 // If you use the set methods to set defaults
36 // application take care that only one thread
37 // In addition take care of calling these meth
38 // Do not use the setters during the event loo
39
40 // Author: Fan Lei, QinetiQ ltd.
41 // Customer: ESA/ESTEC
42 // History:
43 // - 05/02/2004, Fan Lei - Created.
44 // Based on the G4GeneralParticleSource cl
45 // - 06/06/2014, Andrea Dotti
46 // Added a mutex to protect access to shar
47 // Getters and Setters are mutex'd but not
48 // because it is assumed these are called
49 // during which the status of this class i
50 // -------------------------------------------
51 #ifndef G4SPSRandomGenerator_hh
52 #define G4SPSRandomGenerator_hh 1
53
54 #include "G4PhysicsFreeVector.hh"
55 #include "G4DataInterpolation.hh"
56 #include "G4ThreeVector.hh"
57 #include "G4Threading.hh"
58 #include "G4Cache.hh"
59
60 class G4SPSRandomGenerator
61 {
62 public:
63
64 G4SPSRandomGenerator();
65 // Constructor: initializes variables
66
67 ~G4SPSRandomGenerator();
68 // Destructor
69
70 // Biasing Methods
71
72 void SetXBias(const G4ThreeVector&);
73 // Allows the user to re-distribute the
74 // numbers used to generate x co-ordinat
75
76 void SetYBias(const G4ThreeVector&);
77 // Allows the user to re-distribute the
78 // numbers used to generate y co-ordinat
79
80 void SetZBias(const G4ThreeVector&);
81 // Allows the user to re-distribute the
82 // numbers used to generate z co-ordinat
83
84 void SetThetaBias(const G4ThreeVector&);
85 // Allows the user to re-distribute the
86 // numbers used to generate values of th
87
88 void SetPhiBias(const G4ThreeVector&);
89 // Allows the user to re-distribute the
90 // numbers used to generate values of ph
91
92 void SetEnergyBias(const G4ThreeVector&);
93 // Allows the user to re-distribute the ra
94 // numbers used to generate the energies
95
96 void SetPosThetaBias(const G4ThreeVector&)
97 // Allows the user to re-distribute the
98 // numbers used to generate values of th
99
100 void SetPosPhiBias(const G4ThreeVector&);
101 // Allows the user to re-distribute the
102 // numbers used to generate values of ph
103
104 G4double GenRandX();
105 // Generates the random number for x, wi
106
107 G4double GenRandY();
108 // Generates the random number for y, wi
109
110 G4double GenRandZ();
111 // Generates the random number for z, wi
112
113 G4double GenRandTheta();
114 // Generates the random number for theta
115
116 G4double GenRandPhi();
117 // Generates the random number for phi,
118
119 G4double GenRandEnergy();
120 // Generates the random number for energ
121
122 G4double GenRandPosTheta();
123 // Generates the random number for theta
124 // for position distribution
125
126 G4double GenRandPosPhi();
127 // Generates the random number for phi,
128 // for position distribution
129
130 void SetIntensityWeight(G4double weight);
131
132 G4double GetBiasWeight() const ;
133 // Returns the weight change after biasi
134
135 // method to re-set the histograms
136 void ReSetHist(const G4String&);
137 // Resets the histogram for user defined
138
139 void SetVerbosity(G4int a);
140 // Sets the verbosity level
141
142 private:
143
144 // Encapsulate in a struct to guarantee th
145 // initial state is set via constructor
146 //
147 struct a_check
148 {
149 G4bool val;
150 a_check() { val = false; }
151 };
152
153 // See .cc for an explanation of this in m
154 //
155 G4Cache<a_check> local_IPDFXBias;
156 G4bool XBias, IPDFXBias;
157 G4PhysicsFreeVector XBiasH;
158 G4PhysicsFreeVector IPDFXBiasH;
159 G4Cache<a_check> local_IPDFYBias;
160 G4bool YBias, IPDFYBias;
161 G4PhysicsFreeVector YBiasH;
162 G4PhysicsFreeVector IPDFYBiasH;
163 G4Cache<a_check> local_IPDFZBias;
164 G4bool ZBias, IPDFZBias;
165 G4PhysicsFreeVector ZBiasH;
166 G4PhysicsFreeVector IPDFZBiasH;
167 G4Cache<a_check> local_IPDFThetaBias;
168 G4bool ThetaBias, IPDFThetaBias;
169 G4PhysicsFreeVector ThetaBiasH;
170 G4PhysicsFreeVector IPDFThetaBiasH;
171 G4Cache<a_check> local_IPDFPhiBias;
172 G4bool PhiBias, IPDFPhiBias;
173 G4PhysicsFreeVector PhiBiasH;
174 G4PhysicsFreeVector IPDFPhiBiasH;
175 G4Cache<a_check> local_IPDFEnergyBias;
176 G4bool EnergyBias, IPDFEnergyBias;
177 G4PhysicsFreeVector EnergyBiasH;
178 G4PhysicsFreeVector IPDFEnergyBiasH;
179 G4Cache<a_check> local_IPDFPosThetaBias;
180 G4bool PosThetaBias, IPDFPosThetaBias;
181 G4PhysicsFreeVector PosThetaBiasH;
182 G4PhysicsFreeVector IPDFPosThetaBiasH;
183 G4Cache<a_check> local_IPDFPosPhiBias;
184 G4bool PosPhiBias, IPDFPosPhiBias;
185 G4PhysicsFreeVector PosPhiBiasH;
186 G4PhysicsFreeVector IPDFPosPhiBiasH;
187
188 struct bweights_t
189 {
190 G4double w[9];
191 bweights_t();
192 G4double& operator[] (const int i);
193 };
194 G4Cache<bweights_t> bweights;
195 // record x,y,z,theta,phi,energy,posThet
196
197 G4int verbosityLevel;
198 // Verbosity
199
200 G4Mutex mutex;
201 // Protect shared resources
202 };
203
204 #endif
205