| 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 26 // G4TemplateRNGHelper
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // Helper class for RNG Engine seeds. 30 // Helper class for RNG Engine seeds.
31 // Used in MT builds to guarantee event reprod 31 // Used in MT builds to guarantee event reproducibility.
32 // The function of this class is to return a R 32 // The function of this class is to return a RNG Engine seed given its index.
33 // It is a simple templated container that all 33 // It is a simple templated container that allows to add seeds (AddOneSeed)
34 // and retrieve a seed (GetSeed) by index. 34 // and retrieve a seed (GetSeed) by index.
35 // 35 //
36 // The normal use is with G4RNGHelper where ea 36 // The normal use is with G4RNGHelper where each element of the container
37 // represents a seed. To enforce strong-reprod 37 // represents a seed. To enforce strong-reproducibility the variant with
38 // the RNG Engine status file names is availab 38 // the RNG Engine status file names is available.
39 39
40 // Author: A.Dotti (SLAC), 5 July 2013 40 // Author: A.Dotti (SLAC), 5 July 2013
41 // ------------------------------------------- 41 // --------------------------------------------------------------------
42 #ifndef G4TemplateRNGHelper_hh 42 #ifndef G4TemplateRNGHelper_hh
43 #define G4TemplateRNGHelper_hh 1 43 #define G4TemplateRNGHelper_hh 1
44 44
45 #include "globals.hh" <<
46 <<
47 #include <queue> 45 #include <queue>
48 #include <vector> 46 #include <vector>
49 47
50 template<class T> << 48 #include "globals.hh"
>> 49
>> 50 template <class T>
51 class G4TemplateRNGHelper 51 class G4TemplateRNGHelper
52 { 52 {
53 public: 53 public:
54 using SeedsQueue = std::vector<T>; <<
55 using SeedsQueueSize_type = typename Seeds <<
56 54
57 public: <<
58 // The container is modeled as a (shared) 55 // The container is modeled as a (shared) singleton
59 static G4TemplateRNGHelper<T>* GetInstance 56 static G4TemplateRNGHelper<T>* GetInstance();
60 static G4TemplateRNGHelper<T>* GetInstance 57 static G4TemplateRNGHelper<T>* GetInstanceIfExist();
>> 58 using SeedsQueue = std::vector<T>;
>> 59 using SeedsQueueSize_type = typename SeedsQueue::size_type;
>> 60
61 virtual ~G4TemplateRNGHelper(); 61 virtual ~G4TemplateRNGHelper();
62 62
63 // Returns seed given id 63 // Returns seed given id
64 virtual const T GetSeed(const G4int& sdId) 64 virtual const T GetSeed(const G4int& sdId)
65 { 65 {
66 G4int seedId = sdId - 2 * offset; 66 G4int seedId = sdId - 2 * offset;
67 if (seedId < static_cast<G4int>(seeds.si << 67 if(seedId < static_cast<G4int>(seeds.size()))
>> 68 {
68 T& seed = seeds[seedId]; 69 T& seed = seeds[seedId];
69 return seed; 70 return seed;
70 } 71 }
71 G4ExceptionDescription msg; 72 G4ExceptionDescription msg;
72 msg << "No seed number " << seedId << "( 73 msg << "No seed number " << seedId << "(" << seeds.size() << " available)\n"
73 << " Original seed number " << sdId 74 << " Original seed number " << sdId << " filled so far " << offset;
74 G4Exception("G4RNGHelper::GetSeed", "Run 75 G4Exception("G4RNGHelper::GetSeed", "Run0115", FatalException, msg);
75 return T(); 76 return T();
76 } 77 }
77 78
78 // Adds one seed to the collection 79 // Adds one seed to the collection
79 void AddOneSeed(const T& seed) { seeds.pus 80 void AddOneSeed(const T& seed) { seeds.push_back(seed); }
80 81
81 // Fills N primary seed pairs 82 // Fills N primary seed pairs
82 void Fill(G4double* dbl, G4int nev, G4int 83 void Fill(G4double* dbl, G4int nev, G4int nev_tot, G4int nrpe)
83 { 84 {
84 seeds.clear(); 85 seeds.clear();
85 for (G4int i = 0; i < nrpe * nev; ++i) { << 86 for(G4int i = 0; i < nrpe * nev; ++i)
>> 87 {
86 seeds.push_back((G4long)(100000000L * 88 seeds.push_back((G4long)(100000000L * dbl[i]));
87 } 89 }
88 offset = 0; << 90 offset = 0;
89 nev_filled = nev; << 91 nev_filled = nev;
90 nev_total = nev_tot; << 92 nev_total = nev_tot;
91 nRandParEvent = nrpe; 93 nRandParEvent = nrpe;
92 } 94 }
93 95
94 void Refill(G4double* dbl, G4int nev) 96 void Refill(G4double* dbl, G4int nev)
95 { 97 {
96 if (nev == 0) return; << 98 if(nev == 0)
>> 99 return;
97 seeds.clear(); 100 seeds.clear();
98 for (G4int i = 0; i < nRandParEvent * ne << 101 for(G4int i = 0; i < nRandParEvent * nev; ++i)
>> 102 {
99 seeds.push_back((G4long)(100000000L * 103 seeds.push_back((G4long)(100000000L * dbl[i]));
100 } 104 }
101 offset += nev_filled; 105 offset += nev_filled;
102 nev_filled = nev; 106 nev_filled = nev;
103 } 107 }
104 108
105 // Number of available seeds 109 // Number of available seeds
106 const SeedsQueueSize_type GetNumberSeeds() 110 const SeedsQueueSize_type GetNumberSeeds() const { return seeds.size(); }
107 111
108 // Empty the seeds container 112 // Empty the seeds container
109 virtual void Clear() { seeds.clear(); } 113 virtual void Clear() { seeds.clear(); }
110 114
111 protected: 115 protected:
>> 116
112 SeedsQueue seeds; 117 SeedsQueue seeds;
113 // Note: following numbers are number of e 118 // Note: following numbers are number of events.
114 // seeds are generated for nRandParE 119 // seeds are generated for nRandParEvent times n_event
115 G4int offset = 0; 120 G4int offset = 0;
116 G4int nev_filled = 0; 121 G4int nev_filled = 0;
117 G4int nev_total = 0; 122 G4int nev_total = 0;
118 G4int nRandParEvent = 0; 123 G4int nRandParEvent = 0;
119 124
120 private: 125 private:
121 G4TemplateRNGHelper() = default; << 126
>> 127 G4TemplateRNGHelper() {}
122 128
123 private: 129 private:
>> 130
124 static G4TemplateRNGHelper<T>* instance; 131 static G4TemplateRNGHelper<T>* instance;
125 }; 132 };
126 133
127 using G4RNGHelper = G4TemplateRNGHelper<G4long 134 using G4RNGHelper = G4TemplateRNGHelper<G4long>;
128 using G4StringRNGHelper = G4TemplateRNGHelper< 135 using G4StringRNGHelper = G4TemplateRNGHelper<G4String>;
129 using G4SeedsQueue = std::queue<G4long>; 136 using G4SeedsQueue = std::queue<G4long>;
130 137
131 #endif 138 #endif
132 139