| 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 ////////////////////////////////////////////// <<
27 // Class: G4AdjointCSManager <<
28 // Author: L. Desorgher <<
29 // Organisation: SpaceIT GmbH <<
30 // 26 //
31 // Class is responsible for the management of << 27 /////////////////////////////////////////////////////////////////////////////////
32 // matrices, and for the computation of the to << 28 // Class: G4AdjointCSManager
33 // sections. Total adjoint and forward cross s << 29 // Author: L. Desorgher
34 // weight of a particle after a tracking step << 30 // Organisation: SpaceIT GmbH
35 // reverse reaction. It is also used to sample << 31 // Contract: ESA contract 21435/08/NL/AT
36 // given adjoint cross section matrix. << 32 // Customer: ESA/ESTEC
>> 33 /////////////////////////////////////////////////////////////////////////////////
>> 34 //
>> 35 // CHANGE HISTORY
>> 36 // --------------
>> 37 // ChangeHistory:
>> 38 // 1st April 2007 creation by L. Desorgher
>> 39 //
>> 40 // September-October 2009. Implementation of the mode where the adjoint cross sections are scaled such that the total used adjoint cross sections is in
>> 41 // most of the cases equal to the total forward cross section. L.Desorgher
>> 42 //
>> 43 //-------------------------------------------------------------
>> 44 // Documentation:
>> 45 // Is responsible for the management of all adjoint cross sections matrices, and for the computation of the total forward and adjoint cross sections.
>> 46 // Total adjoint and forward cross sections are needed to correct the weight of a particle after a tracking step or after the occurrence of a reverse reaction.
>> 47 // It is also used to sample an adjoint secondary from a given adjoint cross section matrix.
37 // 48 //
38 ////////////////////////////////////////////// <<
39 <<
40 #ifndef G4AdjointCSManager_h 49 #ifndef G4AdjointCSManager_h
41 #define G4AdjointCSManager_h 1 50 #define G4AdjointCSManager_h 1
42 51
43 #include "globals.hh" << 52 #include"globals.hh"
44 #include "G4AdjointCSMatrix.hh" << 53 #include<vector>
>> 54 #include"G4AdjointCSMatrix.hh"
45 #include "G4ThreadLocalSingleton.hh" 55 #include "G4ThreadLocalSingleton.hh"
46 56
47 #include <vector> << 57 class G4VEmAdjointModel;
48 <<
49 class G4Element; <<
50 class G4Material; <<
51 class G4MaterialCutsCouple; 58 class G4MaterialCutsCouple;
>> 59 class G4Material;
52 class G4ParticleDefinition; 60 class G4ParticleDefinition;
53 class G4PhysicsTable; << 61 class G4Element;
54 class G4VEmProcess; 62 class G4VEmProcess;
55 class G4VEmAdjointModel; <<
56 class G4VEnergyLossProcess; 63 class G4VEnergyLossProcess;
>> 64 class G4PhysicsTable;
57 65
>> 66 ////////////////////////////////////////////////////////////////////////////////
>> 67 //
58 class G4AdjointCSManager 68 class G4AdjointCSManager
59 { 69 {
60 friend class G4ThreadLocalSingleton<G4Adjoin <<
61 <<
62 public: <<
63 ~G4AdjointCSManager(); <<
64 static G4AdjointCSManager* GetAdjointCSManag <<
65 <<
66 G4int GetNbProcesses(); <<
67 <<
68 // Registration of the different models and <<
69 <<
70 std::size_t RegisterEmAdjointModel(G4VEmAdjo <<
71 <<
72 void RegisterEmProcess(G4VEmProcess* aProces <<
73 G4ParticleDefinition* <<
74 <<
75 void RegisterEnergyLossProcess(G4VEnergyLoss <<
76 G4ParticleDef <<
77 <<
78 void RegisterAdjointParticle(G4ParticleDefin <<
79 <<
80 // Building of the CS Matrices and Total For <<
81 void BuildCrossSectionMatrices(); <<
82 <<
83 void BuildTotalSigmaTables(); <<
84 <<
85 // Get TotalCrossSections form Total Lambda <<
86 // correction and scaling of the <<
87 G4double GetTotalAdjointCS(G4ParticleDefinit <<
88 const G4MaterialC <<
89 <<
90 G4double GetTotalForwardCS(G4ParticleDefinit <<
91 const G4MaterialC <<
92 <<
93 G4double GetAdjointSigma(G4double Ekin_nuc, <<
94 G4bool is_scat_proj <<
95 const G4MaterialCut <<
96 <<
97 void GetEminForTotalCS(G4ParticleDefinition* <<
98 const G4MaterialCutsC <<
99 G4double& emin_adj, G <<
100 <<
101 void GetMaxFwdTotalCS(G4ParticleDefinition* <<
102 const G4MaterialCutsCo <<
103 G4double& e_sigma_max, <<
104 <<
105 void GetMaxAdjTotalCS(G4ParticleDefinition* <<
106 const G4MaterialCutsCo <<
107 G4double& e_sigma_max, <<
108 70
109 // CrossSection Correction 1 or FwdCS/AdjCS << 71 friend class G4ThreadLocalSingleton<G4AdjointCSManager>;
110 // forward_CS_is_used and forward_CS_mode << 72
111 G4double GetCrossSectionCorrection(G4Particl << 73 public:
112 G4double << 74 ~G4AdjointCSManager();
113 const G4M << 75 static G4AdjointCSManager* GetAdjointCSManager();
114 G4bool& f << 76
115 << 77 public:
116 // Cross section mode << 78 G4int GetNbProcesses();
117 inline void SetFwdCrossSectionMode(G4bool aB << 79
118 << 80 //Registration of the different models and processes
119 // Weight correction << 81
120 G4double GetContinuousWeightCorrection(G4Par << 82 size_t RegisterEmAdjointModel(G4VEmAdjointModel*);
121 G4dou << 83
122 G4dou << 84 void RegisterEmProcess(G4VEmProcess* aProcess, G4ParticleDefinition* aPartDef);
123 const << 85
124 G4dou << 86 void RegisterEnergyLossProcess(G4VEnergyLossProcess* aProcess, G4ParticleDefinition* aPartDef);
125 << 87
126 G4double GetPostStepWeightCorrection(); << 88 void RegisterAdjointParticle(G4ParticleDefinition* aPartDef);
127 << 89
128 // called by the adjoint model to get the CS << 90 //Building of the CS Matrices and Total Forward and Adjoint LambdaTables
129 G4double ComputeAdjointCS(G4Material* aMater << 91 //----------------------------------------------------------------------
130 G4double PrimEnerg << 92
131 G4bool isScatProjT << 93 void BuildCrossSectionMatrices();
132 std::vector<G4doub << 94 void BuildTotalSigmaTables();
133 << 95
134 // called by the adjoint model to sample sec << 96
135 G4Element* SampleElementFromCSMatrices(G4Mat << 97 //Get TotalCrossSections form Total Lambda Tables, Needed for Weight correction and scaling of the
136 G4VEm << 98 //-------------------------------------------------
137 G4dou << 99 G4double GetTotalAdjointCS(G4ParticleDefinition* aPartDef, G4double Ekin,
138 G4boo << 100 const G4MaterialCutsCouple* aCouple);
139 << 101 G4double GetTotalForwardCS(G4ParticleDefinition* aPartDef, G4double Ekin,
140 // Total Adjoint CS is computed at initialis << 102 const G4MaterialCutsCouple* aCouple);
141 G4double ComputeTotalAdjointCS(const G4Mater << 103
142 G4ParticleDef << 104 G4double GetAdjointSigma(G4double Ekin_nuc, size_t index_model,G4bool is_scat_proj_to_proj,
143 G4double Prim << 105 const G4MaterialCutsCouple* aCouple);
144 << 106
145 G4ParticleDefinition* GetAdjointParticleEqui << 107 void GetEminForTotalCS(G4ParticleDefinition* aPartDef,
146 G4ParticleDefinition* theFwdPartDef); << 108 const G4MaterialCutsCouple* aCouple, G4double& emin_adj, G4double& emin_fwd);
147 << 109 void GetMaxFwdTotalCS(G4ParticleDefinition* aPartDef,
148 G4ParticleDefinition* GetForwardParticleEqui << 110 const G4MaterialCutsCouple* aCouple, G4double& e_sigma_max, G4double& sigma_max);
149 G4ParticleDefinition* theAdjPartDef); << 111 void GetMaxAdjTotalCS(G4ParticleDefinition* aPartDef,
150 << 112 const G4MaterialCutsCouple* aCouple, G4double& e_sigma_max, G4double& sigma_max);
151 // inline << 113
152 inline void SetIon(G4ParticleDefinition* adj << 114
153 { << 115
154 fAdjIon = adjIon; << 116 //CrossSection Correction 1 or FwdCS/AdjCS following the G4boolean value of forward_CS_is_used and forward_CS_mode
155 fFwdIon = fwdIon; << 117 //-------------------------------------------------
156 } << 118 G4double GetCrossSectionCorrection(G4ParticleDefinition* aPartDef,G4double PreStepEkin,const G4MaterialCutsCouple* aCouple, G4bool& fwd_is_used, G4double& fwd_TotCS);
157 << 119
158 private: << 120
159 G4AdjointCSManager(); << 121 //Cross section mode
160 << 122 //------------------
161 void DefineCurrentMaterial(const G4MaterialC << 123 inline void SetFwdCrossSectionMode(G4bool aBool){forward_CS_mode=aBool;}
162 << 124
163 void DefineCurrentParticle(const G4ParticleD << 125
164 << 126 //Weight correction
165 G4double ComputeAdjointCS(G4double aPrimEner << 127 //------------------
166 G4AdjointCSMatrix* << 128
167 G4double Tcut); << 129 G4double GetContinuousWeightCorrection(G4ParticleDefinition* aPartDef, G4double PreStepEkin,G4double AfterStepEkin,
168 << 130 const G4MaterialCutsCouple* aCouple, G4double step_length);
169 std::vector<G4AdjointCSMatrix*> BuildCrossSe << 131 G4double GetPostStepWeightCorrection();
170 G4VEmAdjointModel* aModel, G4int Z, G4int << 132
171 << 133
172 std::vector<G4AdjointCSMatrix*> BuildCrossSe << 134
173 G4VEmAdjointModel* aModel, G4Material* aMa << 135
174 << 136 //Method Called by the adjoint model to get there CS, if not precised otherwise
175 static constexpr G4double fTmin = 0.1 * CLHE << 137 //-------------------------------
176 static constexpr G4double fTmax = 100. * CLH << 138
177 // fNbins chosen to avoid error << 139 G4double ComputeAdjointCS(G4Material* aMaterial,
178 // in the CS value close to CS jump. (For ex << 140 G4VEmAdjointModel* aModel,
179 static constexpr G4int fNbins = 320; << 141 G4double PrimEnergy,
180 << 142 G4double Tcut,
181 static G4ThreadLocal G4AdjointCSManager* fIn << 143 G4bool IsScatProjToProjCase,
182 << 144 std::vector<G4double>&
183 // only one ion can be considered by simulat << 145 AdjointCS_for_each_element);
184 G4ParticleDefinition* fAdjIon = nullptr; << 146
185 G4ParticleDefinition* fFwdIon = nullptr; << 147 //Method Called by the adjoint model to sample the secondary energy form the CS matrix
186 << 148 //--------------------------------------------------------------------------------
187 G4MaterialCutsCouple* fCurrentCouple = nullp << 149 G4Element* SampleElementFromCSMatrices(G4Material* aMaterial,
188 G4Material* fCurrentMaterial = nullp << 150 G4VEmAdjointModel* aModel,
189 << 151 G4double PrimEnergy,
190 // x dim is for G4VAdjointEM*, y dim is for << 152 G4double Tcut,
191 std::vector<std::vector<G4AdjointCSMatrix*>> << 153 G4bool IsScatProjToProjCase);
192 fAdjointCSMatricesForScatProjToProj; << 154
193 << 155
194 std::vector<std::vector<G4AdjointCSMatrix*>> << 156 //Total Adjoint CS is computed at initialisation phase
195 << 157 //-----------------------------------------------------
196 std::vector<G4VEmAdjointModel*> fAdjointMode << 158 G4double ComputeTotalAdjointCS(const G4MaterialCutsCouple* aMatCutCouple,G4ParticleDefinition* aPart,G4double PrimEnergy);
197 << 159
198 std::vector<std::size_t> fIndexOfAdjointEMMo << 160
199 std::vector<G4bool> fIsScatProjToProj; << 161
200 std::vector<std::vector<G4double>> fLastAdjo << 162
201 << 163 G4ParticleDefinition* GetAdjointParticleEquivalent(G4ParticleDefinition* theFwdPartDef);
202 // total adjoint and total forward cross sec << 164 G4ParticleDefinition* GetForwardParticleEquivalent(G4ParticleDefinition* theAdjPartDef);
203 // and in function of adjoint particle type << 165
204 std::vector<G4PhysicsTable*> fTotalFwdSigmaT << 166 //inline
205 std::vector<G4PhysicsTable*> fTotalAdjSigmaT << 167 inline void SetTmin(G4double aVal){Tmin=aVal;}
206 << 168 inline void SetTmax(G4double aVal){Tmax=aVal;}
207 // Sigma table for each G4VAdjointEMModel << 169 inline void SetNbins(G4int aInt){nbins=aInt;}
208 std::vector<G4PhysicsTable*> fSigmaTableForA << 170 inline void SetIon(G4ParticleDefinition* adjIon,
209 std::vector<G4PhysicsTable*> fSigmaTableForA << 171 G4ParticleDefinition* fwdIon) {theAdjIon=adjIon; theFwdIon =fwdIon;}
210 << 172
211 std::vector<std::vector<G4double>> fEminForF << 173
212 std::vector<std::vector<G4double>> fEminForA << 174 private:
213 std::vector<std::vector<G4double>> fEkinofFw << 175 static G4ThreadLocal G4AdjointCSManager* theInstance;
214 std::vector<std::vector<G4double>> fEkinofAd << 176 std::vector< std::vector<G4AdjointCSMatrix*> > theAdjointCSMatricesForScatProjToProj; //x dim is for G4VAdjointEM*, y dim is for elements
215 << 177 std::vector< std::vector<G4AdjointCSMatrix*> > theAdjointCSMatricesForProdToProj;
216 // list of forward G4VEmProcess and of G4VEn << 178 std::vector< G4VEmAdjointModel*> listOfAdjointEMModel;
217 // adjoint particle << 179
218 std::vector<std::vector<G4VEmProcess*>*> fFo << 180 std::vector<G4AdjointCSMatrix*>
219 std::vector<std::vector<G4VEnergyLossProcess << 181 BuildCrossSectionsMatricesForAGivenModelAndElement(G4VEmAdjointModel* aModel,
220 << 182 G4int Z,
221 // list of adjoint particles considered << 183 G4int A,
222 std::vector<G4ParticleDefinition*> fAdjointP << 184 G4int nbin_pro_decade);
223 << 185
224 G4double fMassRatio = 1.; // i << 186 std::vector<G4AdjointCSMatrix*>
225 G4double fLastCSCorrectionFactor = 1.; << 187 BuildCrossSectionsMatricesForAGivenModelAndMaterial(G4VEmAdjointModel* aModel,
226 << 188 G4Material* aMaterial,
227 G4ParticleDefinition* fCurrentParticleDef = << 189 G4int nbin_pro_decade);
228 std::size_t fCurrentParticleIndex = 0; << 190
229 std::size_t fCurrentMatIndex = 0; << 191
>> 192 G4Material* lastMaterial;
>> 193 G4double lastPrimaryEnergy;
>> 194 G4double lastTcut;
>> 195 std::vector< size_t> listOfIndexOfAdjointEMModelInAction;
>> 196 std::vector< G4bool> listOfIsScatProjToProjCase;
>> 197 std::vector< std::vector<G4double> > lastAdjointCSVsModelsAndElements;
>> 198 G4bool CrossSectionMatrixesAreBuilt;
>> 199 size_t currentParticleIndex;
>> 200 G4ParticleDefinition* currentParticleDef;
>> 201
>> 202 //total adjoint and total forward cross section table in function of material and in function of adjoint particle type
>> 203 //--------------------------------------------------------------------------------------------------------------------
>> 204 std::vector<G4PhysicsTable*> theTotalForwardSigmaTableVector;
>> 205 std::vector<G4PhysicsTable*> theTotalAdjointSigmaTableVector;
>> 206 std::vector< std::vector<G4double> > EminForFwdSigmaTables;
>> 207 std::vector< std::vector<G4double> > EminForAdjSigmaTables;
>> 208 std::vector< std::vector<G4double> > EkinofFwdSigmaMax;
>> 209 std::vector< std::vector<G4double> > EkinofAdjSigmaMax;
>> 210 G4bool TotalSigmaTableAreBuilt;
>> 211
>> 212 //Sigma tavle for each G4VAdjointEMModel
>> 213 std::vector<G4PhysicsTable*> listSigmaTableForAdjointModelScatProjToProj;
>> 214 std::vector<G4PhysicsTable*> listSigmaTableForAdjointModelProdToProj;
>> 215
>> 216 //list of forward G4VEMLossProcess and of G4VEMProcess for the different adjoint particle
>> 217 //--------------------------------------------------------------
>> 218 std::vector< std::vector<G4VEmProcess*>* > listOfForwardEmProcess;
>> 219 std::vector< std::vector<G4VEnergyLossProcess*>* > listOfForwardEnergyLossProcess;
>> 220
>> 221 //list of adjoint particles considered
>> 222 //--------------------------------------------------------------
>> 223 std::vector< G4ParticleDefinition*> theListOfAdjointParticlesInAction;
>> 224
>> 225 G4double Tmin,Tmax;
>> 226 G4int nbins;
>> 227
>> 228 //Current material
>> 229 //----------------
>> 230 G4MaterialCutsCouple* currentCouple;
>> 231 G4Material* currentMaterial;
>> 232 size_t currentMatIndex;
>> 233
>> 234 G4int verbose;
>> 235
>> 236 //Two CS mode are possible :forward_CS_mode = false the Adjoint CS are used as it is implying a AlongStep Weight Correction.
>> 237 // :forward_CS_mode = true the Adjoint CS are scaled to have the total adjoint CS eual to the fwd one implying a PostStep Weight Correction.
>> 238 // For energy range where the total FwdCS or the total adjoint CS are null, the scaling is not possble and
>> 239 // forward_CS_is_used is set to false
>> 240 //--------------------------------------------
>> 241 G4bool forward_CS_is_used;
>> 242 G4bool forward_CS_mode;
>> 243
>> 244 //Adj and Fwd CS values for re-use
>> 245 //------------------------
>> 246
>> 247 G4double PreadjCS,PostadjCS;
>> 248 G4double PrefwdCS,PostfwdCS;
>> 249 G4double LastEkinForCS;
>> 250 G4double LastCSCorrectionFactor;
>> 251 G4ParticleDefinition* lastPartDefForCS;
>> 252
>> 253 //Ion
>> 254 //----------------
>> 255 G4ParticleDefinition* theAdjIon; //at the moment Only one ion can be considered by simulation
>> 256 G4ParticleDefinition* theFwdIon;
>> 257 G4double massRatio;
>> 258
>> 259 private:
>> 260 G4AdjointCSManager();
>> 261 void DefineCurrentMaterial(const G4MaterialCutsCouple* couple);
>> 262 void DefineCurrentParticle(const G4ParticleDefinition* aPartDef);
>> 263 G4double ComputeAdjointCS(G4double aPrimEnergy, G4AdjointCSMatrix* anAdjointCSMatrix, G4double Tcut);
>> 264 size_t eindex;
230 265
231 G4bool fCSMatricesBuilt = false; <<
232 G4bool fSigmaTableBuilt = false; <<
233 G4bool fForwardCSUsed = true; <<
234 G4bool fForwardCSMode = true; <<
235 // Two CS mode are possible: <<
236 // 1) fForwardCSMode = false, the Adjoint CS <<
237 // an AlongStep Weight Correction. <<
238 // 2) fForwardCSMode = true, the Adjoint CS <<
239 // adjoint CS equal to the fwd one implyi <<
240 // For energies where the total Fwd CS or th <<
241 // the scaling is not possible and fForwardC <<
242 }; 266 };
243 #endif 267 #endif
244 268