| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4TemplateRNGHelper <<
27 // <<
28 // Class description: <<
29 // 26 //
30 // Helper class for RNG Engine seeds. 27 // Helper class for RNG Engine seeds.
31 // Used in MT builds to guarantee event reprod << 28 // Used in MT builds to guarantee reproducibility.
32 // The function of this class is to return a R << 29 // The function of this class is to return a RNG Engine seed
33 // It is a simple templated container that all << 30 // given its index. It is a simple templated container that
34 // and retrieve a seed (GetSeed) by index. << 31 // Allows to add seeds (AddOneSeed) and retrieve a seed (GetSeed)
>> 32 // by index.
35 // 33 //
36 // The normal use is with G4RNGHelper where ea << 34 // The normal use is with G4RNGHelper where each element of th econtainer
37 // represents a seed. To enforce strong-reprod 35 // represents a seed. To enforce strong-reproducibility the variant with
38 // the RNG Engine status file names is availab << 36 // the RNG Engine status file names is avilable
39 37
40 // Author: A.Dotti (SLAC), 5 July 2013 << 38 #ifndef G4RNGHELPER_HH
41 // ------------------------------------------- << 39 #define G4RNGHELPER_HH
42 #ifndef G4TemplateRNGHelper_hh <<
43 #define G4TemplateRNGHelper_hh 1 <<
44 40
45 #include "globals.hh" 41 #include "globals.hh"
46 <<
47 #include <queue> 42 #include <queue>
48 #include <vector> 43 #include <vector>
49 44
50 template<class T> << 45 template <class T>
51 class G4TemplateRNGHelper 46 class G4TemplateRNGHelper
52 { 47 {
53 public: << 48 public:
54 using SeedsQueue = std::vector<T>; << 49 // The container is modeled as a (shared) singleton
55 using SeedsQueueSize_type = typename Seeds << 50 static G4TemplateRNGHelper<T>* GetInstance();
56 << 51 static G4TemplateRNGHelper<T>* GetInstanceIfExist();
57 public: << 52 typedef std::vector<T> SeedsQueue;
58 // The container is modeled as a (shared) << 53 typedef typename SeedsQueue::size_type SeedsQueueSize_type;
59 static G4TemplateRNGHelper<T>* GetInstance << 54
60 static G4TemplateRNGHelper<T>* GetInstance << 55 virtual ~G4TemplateRNGHelper();
61 virtual ~G4TemplateRNGHelper(); << 56
62 << 57 // Returns seed given id
63 // Returns seed given id << 58 virtual const T GetSeed(const G4int& sdId)
64 virtual const T GetSeed(const G4int& sdId) << 59 {
>> 60 G4int seedId = sdId - 2 * offset;
>> 61 if(seedId < static_cast<G4int>(seeds.size()))
65 { 62 {
66 G4int seedId = sdId - 2 * offset; << 63 T& seed = seeds[seedId];
67 if (seedId < static_cast<G4int>(seeds.si << 64 return seed;
68 T& seed = seeds[seedId]; <<
69 return seed; <<
70 } <<
71 G4ExceptionDescription msg; <<
72 msg << "No seed number " << seedId << "( <<
73 << " Original seed number " << sdId <<
74 G4Exception("G4RNGHelper::GetSeed", "Run <<
75 return T(); <<
76 } 65 }
77 << 66 G4ExceptionDescription msg;
78 // Adds one seed to the collection << 67 msg << "No seed number " << seedId << "(" << seeds.size() << " available)\n"
79 void AddOneSeed(const T& seed) { seeds.pus << 68 << " Original seed number " << sdId << " filled so far " << offset;
80 << 69 G4Exception("G4RNGHelper::GetSeed", "Run0115", FatalException, msg);
81 // Fills N primary seed pairs << 70 return T();
82 void Fill(G4double* dbl, G4int nev, G4int << 71 }
>> 72
>> 73 // Adds one seed to the collection
>> 74 void AddOneSeed(const T& seed) { seeds.push_back(seed); }
>> 75
>> 76 // Fills N primary seed pairs
>> 77 void Fill(G4double* dbl, G4int nev, G4int nev_tot, G4int nrpe)
>> 78 {
>> 79 seeds.clear();
>> 80 for(G4int i = 0; i < nrpe * nev; i++)
83 { 81 {
84 seeds.clear(); << 82 seeds.push_back((G4long)(100000000L * dbl[i]));
85 for (G4int i = 0; i < nrpe * nev; ++i) { <<
86 seeds.push_back((G4long)(100000000L * <<
87 } <<
88 offset = 0; <<
89 nev_filled = nev; <<
90 nev_total = nev_tot; <<
91 nRandParEvent = nrpe; <<
92 } 83 }
93 << 84 offset = 0;
94 void Refill(G4double* dbl, G4int nev) << 85 nev_filled = nev;
>> 86 nev_total = nev_tot;
>> 87 nRandParEvent = nrpe;
>> 88 }
>> 89
>> 90 void Refill(G4double* dbl, G4int nev)
>> 91 {
>> 92 if(nev == 0)
>> 93 return;
>> 94 seeds.clear();
>> 95 for(G4int i = 0; i < nRandParEvent * nev; i++)
95 { 96 {
96 if (nev == 0) return; << 97 seeds.push_back((G4long)(100000000L * dbl[i]));
97 seeds.clear(); <<
98 for (G4int i = 0; i < nRandParEvent * ne <<
99 seeds.push_back((G4long)(100000000L * <<
100 } <<
101 offset += nev_filled; <<
102 nev_filled = nev; <<
103 } 98 }
>> 99 offset += nev_filled;
>> 100 nev_filled = nev;
>> 101 }
>> 102
>> 103 // Number of available seeds
>> 104 const SeedsQueueSize_type GetNumberSeeds() const { return seeds.size(); }
>> 105
>> 106 // Empty the seeds container
>> 107 virtual void Clear() { seeds.clear(); }
>> 108
>> 109 protected:
>> 110 SeedsQueue seeds;
>> 111 // Note: following numbers are number of events.
>> 112 // seeds are generated for nRandParEvent times n_event
>> 113 G4int offset;
>> 114 G4int nev_filled;
>> 115 G4int nev_total;
>> 116 G4int nRandParEvent;
>> 117
>> 118 private:
>> 119 G4TemplateRNGHelper()
>> 120 {
>> 121 offset = 0;
>> 122 nev_filled = 0;
>> 123 nev_total = 0;
>> 124 nRandParEvent = 0;
>> 125 }
104 126
105 // Number of available seeds << 127 private:
106 const SeedsQueueSize_type GetNumberSeeds() << 128 static G4TemplateRNGHelper<T>* instance;
107 <<
108 // Empty the seeds container <<
109 virtual void Clear() { seeds.clear(); } <<
110 <<
111 protected: <<
112 SeedsQueue seeds; <<
113 // Note: following numbers are number of e <<
114 // seeds are generated for nRandParE <<
115 G4int offset = 0; <<
116 G4int nev_filled = 0; <<
117 G4int nev_total = 0; <<
118 G4int nRandParEvent = 0; <<
119 <<
120 private: <<
121 G4TemplateRNGHelper() = default; <<
122 <<
123 private: <<
124 static G4TemplateRNGHelper<T>* instance; <<
125 }; 129 };
126 130
127 using G4RNGHelper = G4TemplateRNGHelper<G4long << 131 typedef G4TemplateRNGHelper<G4long> G4RNGHelper;
128 using G4StringRNGHelper = G4TemplateRNGHelper< << 132 typedef G4TemplateRNGHelper<G4String> G4StringRNGHelper;
129 using G4SeedsQueue = std::queue<G4long>; << 133 typedef std::queue<G4long> G4SeedsQueue;
130 134
131 #endif 135 #endif
132 136