| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 //
27 // -------------------------------------------
28 //
29 // GEANT4 Class header file
30 //
31 //
32 // File name: G4VAtomDeexcitation
33 //
34 // Author: Alfonso Mantero & Vladimir I
35 //
36 // Creation date: 30.06.2009
37 //
38 // Modifications:
39 // 15 Mar 2011 ALF stripped G4AtomicShellEn
40 //
41 // Class Description:
42 //
43 // Abstract interface to energy loss models
44
45 // -------------------------------------------
46 //
47
48 #ifndef G4VAtomDeexcitation_h
49 #define G4VAtomDeexcitation_h 1
50
51 #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>
59
60 class G4ParticleDefinition;
61 class G4DynamicParticle;
62 class G4MaterialCutsCouple;
63
64 class G4VAtomDeexcitation {
65 public:
66
67 explicit G4VAtomDeexcitation(const G4String&
68
69 virtual ~G4VAtomDeexcitation();
70
71 //========== initialization ==========
72
73 // Overall initialisation before new run
74 void InitialiseAtomicDeexcitation();
75
76 // Initialisation of deexcitation at the beg
77 virtual void InitialiseForNewRun() = 0;
78
79 // Initialisation for a concrete atom
80 // May be called at run time
81 virtual void InitialiseForExtraAtom(G4int Z)
82
83 void SetDeexcitationActiveRegion(const G4Str
84 G4bool valD
85 G4bool valA
86 G4bool valP
87
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
114 //========== Run time methods ==========
115
116 // Check if deexcitation is active for a giv
117 inline G4bool CheckDeexcitationActiveRegion(
118 inline G4bool CheckAugerActiveRegion(G4int c
119
120 // Get atomic shell by shell index, used by
121 // (for example, photoelectric), when shell
122 virtual
123 const G4AtomicShell* GetAtomicShell(G4int Z,
124 G4Atomic
125
126 // generation of deexcitation for given atom
127 // and material cut couple, which defines cu
128 void GenerateParticles(std::vector<G4Dynamic
129 const G4AtomicShell*,
130 G4int Z, G4int couple
131
132 // generation of deexcitation for given atom
133 virtual void GenerateParticles(std::vector<G
134 const G4Atomi
135 G4int Z, G4do
136
137 // access or compute PIXE cross section
138 virtual G4double
139 GetShellIonisationCrossSectionPerAtom(const
140 G4int
141 G4Atom
142 G4doub
143 const
144
145 // access or compute PIXE cross section
146 virtual G4double
147 ComputeShellIonisationCrossSectionPerAtom(
148 const
149 G4int
150 G4Atom
151 G4doub
152 const
153
154 // Sampling of PIXE for ionisation processes
155 void AlongStepDeexcitation(std::vector<G4Tra
156 const G4Step& ste
157 G4double& eLoss,
158 G4int coupleIndex
159
160 // copy constructor and hide assignment oper
161 G4VAtomDeexcitation(G4VAtomDeexcitation &) =
162 G4VAtomDeexcitation & operator=(const G4VAto
163
164 private:
165
166 const G4ParticleDefinition* gamma;
167 const G4ProductionCutsTable* theCoupleTable
168
169 G4int nCouples = 0;
170 G4int verbose = 1;
171
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 };
197
198 inline void G4VAtomDeexcitation::SetFluo(G4boo
199 {
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 {
262 return (idx < nCouples) ? activeDeexcitation
263 }
264
265 inline G4bool
266 G4VAtomDeexcitation::CheckAugerActiveRegion(G4
267 {
268 return (idx < nCouples) ? activeAugerMedia[i
269 }
270
271 #endif
272
273