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