| 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 <<
40 // Author: A.Dotti (SLAC), 5 July 2013 <<
41 // ------------------------------------------- <<
42 #ifndef G4TemplateRNGHelper_hh <<
43 #define G4TemplateRNGHelper_hh 1 <<
44 37
45 #include "globals.hh" << 38 #ifndef G4RNGHELPER_HH
>> 39 #define G4RNGHELPER_HH
46 40
47 #include <queue> << 41 #include "G4Types.hh"
48 #include <vector> 42 #include <vector>
>> 43 #include <queue>
>> 44 #include "globals.hh"
49 45
50 template<class T> << 46 template <class T>
51 class G4TemplateRNGHelper 47 class G4TemplateRNGHelper
52 { 48 {
53 public: 49 public:
54 using SeedsQueue = std::vector<T>; <<
55 using SeedsQueueSize_type = typename Seeds <<
56 <<
57 public: <<
58 // The container is modeled as a (shared) 50 // The container is modeled as a (shared) singleton
59 static G4TemplateRNGHelper<T>* GetInstance 51 static G4TemplateRNGHelper<T>* GetInstance();
60 static G4TemplateRNGHelper<T>* GetInstance << 52 typedef std::vector<T> SeedsQueue;
61 virtual ~G4TemplateRNGHelper(); << 53 typedef typename SeedsQueue::size_type SeedsQueueSize_type;
62 << 54
63 // Returns seed given id << 55 virtual ~G4TemplateRNGHelper()
64 virtual const T GetSeed(const G4int& sdId) <<
65 { 56 {
66 G4int seedId = sdId - 2 * offset; << 57 Clear();
67 if (seedId < static_cast<G4int>(seeds.si << 58 instance = 0;
68 T& seed = seeds[seedId]; << 59 }
69 return seed; << 60
>> 61 //Returns seed given id
>> 62 virtual const T GetSeed(const G4int& sdId )
>> 63 {
>> 64 G4int seedId = sdId - 2*offset;
>> 65 if ( seedId < static_cast<G4int>(seeds.size()) )
>> 66 {
>> 67 T& seed = seeds[seedId];
>> 68 return seed;
70 } 69 }
71 G4ExceptionDescription msg; 70 G4ExceptionDescription msg;
72 msg << "No seed number " << seedId << "( << 71 msg << "No seed number "<<seedId<<"("<<seeds.size()<<" available)\n"
73 << " Original seed number " << sdId << 72 << " Original seed number "<<sdId<<" filled so far "<<offset;
74 G4Exception("G4RNGHelper::GetSeed", "Run << 73 G4Exception("G4RNGHelper::GetSeed","Run0115", FatalException,msg);
75 return T(); 74 return T();
76 } 75 }
>> 76
>> 77 //Adds one seed to the collection
>> 78 void AddOneSeed( const T& seed ) { seeds.push_back(seed); }
77 79
78 // Adds one seed to the collection << 80 //Fills N primary seed pairs
79 void AddOneSeed(const T& seed) { seeds.pus << 81 void Fill(G4double* dbl,G4int nev,G4int nev_tot,G4int nrpe)
80 <<
81 // Fills N primary seed pairs <<
82 void Fill(G4double* dbl, G4int nev, G4int <<
83 { 82 {
84 seeds.clear(); 83 seeds.clear();
85 for (G4int i = 0; i < nrpe * nev; ++i) { << 84 for(G4int i=0;i<nrpe*nev;i++)
86 seeds.push_back((G4long)(100000000L * << 85 { seeds.push_back((G4long)(100000000L*dbl[i])); }
87 } <<
88 offset = 0; 86 offset = 0;
89 nev_filled = nev; 87 nev_filled = nev;
90 nev_total = nev_tot; 88 nev_total = nev_tot;
91 nRandParEvent = nrpe; 89 nRandParEvent = nrpe;
92 } 90 }
93 91
94 void Refill(G4double* dbl, G4int nev) 92 void Refill(G4double* dbl, G4int nev)
95 { 93 {
96 if (nev == 0) return; << 94 if(nev==0) return;
97 seeds.clear(); 95 seeds.clear();
98 for (G4int i = 0; i < nRandParEvent * ne << 96 for(G4int i=0;i<nRandParEvent*nev;i++)
99 seeds.push_back((G4long)(100000000L * << 97 { seeds.push_back((G4long)(100000000L*dbl[i])); }
100 } <<
101 offset += nev_filled; 98 offset += nev_filled;
102 nev_filled = nev; 99 nev_filled = nev;
103 } 100 }
104 << 101
105 // Number of available seeds << 102 //Number of available seeds
106 const SeedsQueueSize_type GetNumberSeeds() 103 const SeedsQueueSize_type GetNumberSeeds() const { return seeds.size(); }
107 << 104
108 // Empty the seeds container << 105 //Empty the seeds container
109 virtual void Clear() { seeds.clear(); } 106 virtual void Clear() { seeds.clear(); }
110 107
111 protected: 108 protected:
112 SeedsQueue seeds; 109 SeedsQueue seeds;
113 // Note: following numbers are number of e 110 // Note: following numbers are number of events.
114 // seeds are generated for nRandParE 111 // seeds are generated for nRandParEvent times n_event
115 G4int offset = 0; << 112 G4int offset;
116 G4int nev_filled = 0; << 113 G4int nev_filled;
117 G4int nev_total = 0; << 114 G4int nev_total;
118 G4int nRandParEvent = 0; << 115 G4int nRandParEvent;
119 116
120 private: 117 private:
121 G4TemplateRNGHelper() = default; << 118 G4TemplateRNGHelper()
>> 119 {
>> 120 offset=0;
>> 121 nev_filled=0;
>> 122 nev_total=0;
>> 123 nRandParEvent=0;
>> 124 }
122 125
123 private: 126 private:
124 static G4TemplateRNGHelper<T>* instance; 127 static G4TemplateRNGHelper<T>* instance;
125 }; 128 };
126 129
127 using G4RNGHelper = G4TemplateRNGHelper<G4long << 130 typedef G4TemplateRNGHelper<G4long> G4RNGHelper;
128 using G4StringRNGHelper = G4TemplateRNGHelper< << 131 typedef G4TemplateRNGHelper<G4String> G4StringRNGHelper;
129 using G4SeedsQueue = std::queue<G4long>; << 132 typedef std::queue<G4long> G4SeedsQueue;
130 133
131 #endif 134 #endif
132 135