| 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 // $Id: G4VAtomDeexcitation.hh,v 1.1.2.1 2010/04/06 09:05:17 gcosmo Exp $
>> 27 // GEANT4 tag $Name: geant4-09-03-patch-02 $
26 // 28 //
27 // ------------------------------------------- 29 // -------------------------------------------------------------------
28 // 30 //
29 // GEANT4 Class header file 31 // GEANT4 Class header file
30 // 32 //
31 // 33 //
32 // File name: G4VAtomDeexcitation 34 // File name: G4VAtomDeexcitation
33 // 35 //
34 // Author: Alfonso Mantero & Vladimir I 36 // Author: Alfonso Mantero & Vladimir Ivanchenko
35 // 37 //
36 // Creation date: 30.06.2009 38 // Creation date: 30.06.2009
37 // 39 //
38 // Modifications: 40 // Modifications:
39 // 15 Mar 2011 ALF stripped G4AtomicShellEn <<
40 // 41 //
41 // Class Description: 42 // Class Description:
42 // 43 //
43 // Abstract interface to energy loss models 44 // Abstract interface to energy loss models
44 45
45 // ------------------------------------------- 46 // -------------------------------------------------------------------
46 // 47 //
47 48
48 #ifndef G4VAtomDeexcitation_h 49 #ifndef G4VAtomDeexcitation_h
49 #define G4VAtomDeexcitation_h 1 50 #define G4VAtomDeexcitation_h 1
50 51
51 #include "globals.hh" 52 #include "globals.hh"
52 #include "G4EmParameters.hh" <<
53 #include "G4AtomicShell.hh" <<
54 #include "G4AtomicShellEnumerator.hh" <<
55 #include "G4ProductionCutsTable.hh" <<
56 #include "G4Track.hh" <<
57 #include "G4Threading.hh" <<
58 #include <vector> 53 #include <vector>
59 54
>> 55 class G4AtomicShell;
60 class G4ParticleDefinition; 56 class G4ParticleDefinition;
61 class G4DynamicParticle; 57 class G4DynamicParticle;
62 class G4MaterialCutsCouple; <<
63 58
64 class G4VAtomDeexcitation { 59 class G4VAtomDeexcitation {
65 public: <<
66 60
67 explicit G4VAtomDeexcitation(const G4String& << 61 G4VAtomDeexcitation(const G4String& pname = "");
68 62
69 virtual ~G4VAtomDeexcitation(); 63 virtual ~G4VAtomDeexcitation();
70 64
71 //========== initialization ========== 65 //========== initialization ==========
72 66
73 // Overall initialisation before new run << 67 virtual void PreparePhysicsTable(const G4ParticleDefinition&);
74 void InitialiseAtomicDeexcitation(); << 68 virtual void BuildPhysicsTable(const G4ParticleDefinition&);
75 69
76 // Initialisation of deexcitation at the beg << 70 // PIXE model name
77 virtual void InitialiseForNewRun() = 0; << 71 inline void SetPIXECrossSectionModel(const G4String&);
78 << 72 inline const G4String& PIXECrossSectionModel() const;
79 // Initialisation for a concrete atom << 73
80 // May be called at run time << 74 // Activation of deexcitation per detector region
81 virtual void InitialiseForExtraAtom(G4int Z) << 75 void SetFluorescenceActiveRegion(const G4Region* region = 0);
82 << 76 void SetAugerActiveRegion(const G4Region* region = 0);
83 void SetDeexcitationActiveRegion(const G4Str << 77 void SetPIXECrossSectionActiveRegion(const G4Region* region = 0);
84 G4bool valD << 78
85 G4bool valA << 79 void SetFluorescenceActiveRegion(const G4String& rname = "");
86 G4bool valP << 80 void SetAugerActiveRegion(const G4String& rname = "");
87 << 81 void SetPIXECrossSectionActiveRegion(const G4String& rname = "");
88 // Activation of deexcitation <<
89 inline void SetFluo(G4bool); <<
90 inline G4bool IsFluoActive() const; <<
91 <<
92 // Activation of Auger electron production <<
93 inline void SetAuger(G4bool); <<
94 inline G4bool IsAugerActive() const; <<
95 <<
96 // Activation of Auger cascade <<
97 inline void SetAugerCascade(G4bool); <<
98 inline G4bool IsAugerCascadeActive() const; <<
99 <<
100 // Activation of PIXE simulation <<
101 inline void SetPIXE(G4bool); <<
102 inline G4bool IsPIXEActive() const; <<
103 <<
104 // Deexcitation model name <<
105 inline const G4String& GetName() const; <<
106 <<
107 // Access to the list of atoms active for de <<
108 inline const std::vector<G4bool>& GetListOfA <<
109 <<
110 // Verbosity level <<
111 inline void SetVerboseLevel(G4int); <<
112 inline G4int GetVerboseLevel() const; <<
113 82
114 //========== Run time methods ========== 83 //========== Run time methods ==========
115 84
116 // Check if deexcitation is active for a giv 85 // Check if deexcitation is active for a given geometry volume
117 inline G4bool CheckDeexcitationActiveRegion( << 86 G4bool CheckFluorescenceActiveRegion(G4int coupleIndex);
118 inline G4bool CheckAugerActiveRegion(G4int c << 87
>> 88 // Check if deexcitation is active for a given geometry volume
>> 89 G4bool CheckPIXEActiveRegion(G4int coupleIndex);
119 90
120 // Get atomic shell by shell index, used by 91 // Get atomic shell by shell index, used by discrete processes
121 // (for example, photoelectric), when shell 92 // (for example, photoelectric), when shell vacancy sampled by the model
122 virtual << 93 const G4AtomicShell* GetAtomicShell(G4int Z, G4int ShellIndex);
123 const G4AtomicShell* GetAtomicShell(G4int Z, <<
124 G4Atomic <<
125 94
126 // generation of deexcitation for given atom << 95 // selection of random shell for ionisation process
127 // and material cut couple, which defines cu << 96 virtual const G4AtomicShell* SelectRandomShell(const G4DynamicParticle*,
128 void GenerateParticles(std::vector<G4Dynamic << 97 G4int Z);
129 const G4AtomicShell*, <<
130 G4int Z, G4int couple <<
131 98
132 // generation of deexcitation for given atom 99 // generation of deexcitation for given atom and shell vacancy
133 virtual void GenerateParticles(std::vector<G << 100 virtual void GenerateParticles(std::vector<G4DynamicParticle*>*,
134 const G4Atomi << 101 const G4AtomicShell*, G4int Z) = 0;
135 G4int Z, G4do <<
136 102
137 // access or compute PIXE cross section 103 // access or compute PIXE cross section
138 virtual G4double << 104 virtual G4double GetPIXECrossSection (const G4ParticleDefinition*,
139 GetShellIonisationCrossSectionPerAtom(const << 105 G4int Z, G4double kinE) = 0;
140 G4int <<
141 G4Atom <<
142 G4doub <<
143 const <<
144 106
145 // access or compute PIXE cross section << 107 // calculate PIXE cross section from the models
146 virtual G4double << 108 virtual G4double CalculatePIXECrossSection(const G4ParticleDefinition*,
147 ComputeShellIonisationCrossSectionPerAtom( << 109 G4int Z, G4double kinE) = 0;
148 const <<
149 G4int <<
150 G4Atom <<
151 G4doub <<
152 const <<
153 110
154 // Sampling of PIXE for ionisation processes 111 // Sampling of PIXE for ionisation processes
155 void AlongStepDeexcitation(std::vector<G4Tra << 112 virtual void
156 const G4Step& ste << 113 AlongStepDeexcitation(std::vector<G4DynamicParticle*>* secVect,
157 G4double& eLoss, << 114 const G4DynamicParticle* icidentParticle,
158 G4int coupleIndex << 115 const G4MaterialCutsCouple*,
>> 116 G4double trueStepLenght,
>> 117 G4double eLoss) = 0;
>> 118
159 119
160 // copy constructor and hide assignment oper <<
161 G4VAtomDeexcitation(G4VAtomDeexcitation &) = <<
162 G4VAtomDeexcitation & operator=(const G4VAto <<
163 120
164 private: 121 private:
165 122
166 const G4ParticleDefinition* gamma; << 123 // copy constructor and hide assignment operator
167 const G4ProductionCutsTable* theCoupleTable << 124 G4VAtomDeexcitation(G4VAtomDeexcitation &);
>> 125 G4VAtomDeexcitation & operator=(const G4VAtomDeexcitation &right);
168 126
169 G4int nCouples = 0; << 127 G4String namePIXE;
170 G4int verbose = 1; <<
171 128
172 G4bool isActive = false; <<
173 G4bool flagAuger = false; <<
174 G4bool flagPIXE = false; <<
175 G4bool ignoreCuts = false; <<
176 <<
177 G4bool isActiveLocked = false; <<
178 G4bool isAugerLocked = false; <<
179 G4bool isPIXELocked = false; <<
180 <<
181 std::vector<G4bool> activeZ; <<
182 std::vector<G4bool> activeDeexcitationMedi <<
183 std::vector<G4bool> activeAugerMedia; <<
184 std::vector<G4bool> activePIXEMedia; <<
185 std::vector<G4bool> deRegions; <<
186 std::vector<G4bool> AugerRegions; <<
187 std::vector<G4bool> PIXERegions; <<
188 std::vector<G4DynamicParticle*> vdyn; <<
189 std::vector<G4String> activeRegions; <<
190 <<
191 G4String name; <<
192 <<
193 #ifdef G4MULTITHREADED <<
194 static G4Mutex atomDeexcitationMutex; <<
195 #endif <<
196 }; 129 };
197 130
198 inline void G4VAtomDeexcitation::SetFluo(G4boo << 131 inline
199 { << 132 void G4VAtomDeexcitation::SetPIXECrossSectionModel(const G4String& n)
200 if(!isActiveLocked) { isActive = val; isActi <<
201 } <<
202 <<
203 inline G4bool G4VAtomDeexcitation::IsFluoActiv <<
204 { <<
205 return isActive; <<
206 } <<
207 <<
208 inline void G4VAtomDeexcitation::SetAuger(G4bo <<
209 { <<
210 if(!isAugerLocked) { flagAuger = val; isAuge <<
211 } <<
212 <<
213 inline G4bool G4VAtomDeexcitation::IsAugerActi <<
214 { <<
215 return flagAuger; <<
216 } <<
217 <<
218 inline void G4VAtomDeexcitation::SetAugerCasca <<
219 { <<
220 SetAuger(val); <<
221 } <<
222 <<
223 inline G4bool G4VAtomDeexcitation::IsAugerCasc <<
224 { <<
225 return flagAuger; <<
226 } <<
227 <<
228 inline void G4VAtomDeexcitation::SetPIXE(G4boo <<
229 { <<
230 if(!isPIXELocked) { flagPIXE = val; isPIXEL <<
231 } <<
232 <<
233 inline G4bool G4VAtomDeexcitation::IsPIXEActiv <<
234 { <<
235 return flagPIXE; <<
236 } <<
237 <<
238 inline const G4String& G4VAtomDeexcitation::Ge <<
239 { <<
240 return name; <<
241 } <<
242 <<
243 inline const std::vector<G4bool>& <<
244 G4VAtomDeexcitation::GetListOfActiveAtoms() co <<
245 { <<
246 return activeZ; <<
247 } <<
248 <<
249 inline void G4VAtomDeexcitation::SetVerboseLev <<
250 { <<
251 verbose = val; <<
252 } <<
253 <<
254 inline G4int G4VAtomDeexcitation::GetVerboseLe <<
255 { <<
256 return verbose; <<
257 } <<
258 <<
259 inline G4bool <<
260 G4VAtomDeexcitation::CheckDeexcitationActiveRe <<
261 { 133 {
262 return (idx < nCouples) ? activeDeexcitation << 134 namePIXE = n;
263 } 135 }
264 136
265 inline G4bool << 137 inline
266 G4VAtomDeexcitation::CheckAugerActiveRegion(G4 << 138 const G4String& G4VAtomDeexcitation::PIXECrossSectionModel() const
267 { 139 {
268 return (idx < nCouples) ? activeAugerMedia[i << 140 return namePIXE;
269 } 141 }
270 142
271 #endif 143 #endif
272 144
273 145