| 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 // 26 //
27 // 27 //
28 // Authors: Elena Guardincerri (Elena.Guardinc 28 // Authors: Elena Guardincerri (Elena.Guardincerri@ge.infn.it)
29 // Alfonso Mantero (Alfonso.Mantero@g 29 // Alfonso Mantero (Alfonso.Mantero@ge.infn.it)
30 // 30 //
31 // History: 31 // History:
32 // ----------- 32 // -----------
33 // 33 //
34 // 16 Sept 2001 EG Modified according to a d 34 // 16 Sept 2001 EG Modified according to a design iteration in the
35 // LowEnergy category 35 // LowEnergy category
36 // 36 //
37 // ------------------------------------------- 37 // -------------------------------------------------------------------
38 38
39 // Class description: 39 // Class description:
40 // Low Energy Electromagnetic Physics: create 40 // Low Energy Electromagnetic Physics: create or fills and manages G4AtomicShell,
41 // G4FluoTransition, G4AugerTransition objects 41 // G4FluoTransition, G4AugerTransition objects.
>> 42 // Further documentation available from http://www.ge.infn.it/geant4/lowE
>> 43
42 // ------------------------------------------- 44 // -------------------------------------------------------------------
43 45
44 #ifndef G4AtomicTransitionManager_h 46 #ifndef G4AtomicTransitionManager_h
45 #define G4AtomicTransitionManager_h 1 47 #define G4AtomicTransitionManager_h 1
46 48
47 #include "G4ShellData.hh" 49 #include "G4ShellData.hh"
48 #include "G4FluoTransition.hh" 50 #include "G4FluoTransition.hh"
49 #include "G4AugerTransition.hh" 51 #include "G4AugerTransition.hh"
50 #include "G4AtomicShell.hh" 52 #include "G4AtomicShell.hh"
51 #include <vector> 53 #include <vector>
52 #include "globals.hh" 54 #include "globals.hh"
53 55
54 class G4AugerData; 56 class G4AugerData;
55 57
56 // This class is a singleton 58 // This class is a singleton
57 class G4AtomicTransitionManager { 59 class G4AtomicTransitionManager {
58 60
59 public: 61 public:
60 /// The only way to get an instance of this << 62
61 /// function Instance() << 63 // The only way to get an instance of this class is to call the
>> 64 // function Instance()
62 static G4AtomicTransitionManager* Instance() 65 static G4AtomicTransitionManager* Instance();
63 66
64 /// needs to be called once from other code << 67 // needs to be called once from other code before start of run
65 void Initialise(); 68 void Initialise();
66 69
67 /// Z is the atomic number of the element, s << 70 // Z is the atomic number of the element, shellIndex is the
68 /// index (in EADL) of the shell << 71 // index (in EADL) of the shell
69 G4AtomicShell* Shell(G4int Z, size_t shellIn 72 G4AtomicShell* Shell(G4int Z, size_t shellIndex) const;
70 73
71 /// Z is the atomic number of the element, s << 74 // Z is the atomic number of the element, shellIndex is the
72 /// index (in EADL) of the final shell for t << 75 // index (in EADL) of the final shell for the transition
73 /// This function gives, upon Z and the Inde << 76 // This function gives, upon Z and the Index of the initial shell where
74 /// the vacancy is, the radiative transition << 77 // the vacancy is, the radiative transition that can happen (originating
75 /// shell, energy, probability) << 78 // shell, energy, probability)
76 const G4FluoTransition* ReachableShell(G4int 79 const G4FluoTransition* ReachableShell(G4int Z, size_t shellIndex) const;
77 80
78 /// This function gives, upon Z and the Inde << 81 // This function gives, upon Z and the Index of the initial shell where
79 /// the vacancy is, the NON-radiative transi << 82 // the vacancy is, the NON-radiative transition that can happen with
80 /// originating shell for the transition, an << 83 // originating shell for the transition, and the data for the possible
81 /// auger electrons emitted (originating vac << 84 // auger electrons emitted (originating vacancy, energy amnd probability)
>> 85
82 const G4AugerTransition* ReachableAugerShell 86 const G4AugerTransition* ReachableAugerShell(G4int Z, G4int shellIndex) const;
83 87
84 /// This function returns the number of shel << 88 // This function returns the number of shells of the element
85 /// whose atomic number is Z << 89 // whose atomic number is Z
86 G4int NumberOfShells(G4int Z) const; 90 G4int NumberOfShells(G4int Z) const;
87 91
88 /// This function returns the number of thos << 92 // This function returns the number of those shells of the element
89 /// whose atomic number is Z which are reach << 93 // whose atomic number is Z which are reachable through a radiative
90 /// transition << 94 // transition
91 G4int NumberOfReachableShells(G4int Z) const 95 G4int NumberOfReachableShells(G4int Z) const;
92 96
93 /// This function returns the number of poss << 97 // This function returns the number of possible NON-radiative transitions
94 /// for the atom with atomic number Z i.e. t << 98 // for the atom with atomic number Z i.e. the number of shell in wich
95 /// a vacancy can be filled by a NON-radiati << 99 // a vacancy can be filled by a NON-radiative transition
>> 100
96 G4int NumberOfReachableAugerShells(G4int Z) 101 G4int NumberOfReachableAugerShells(G4int Z) const;
97 102
98 /// Gives the sum of the probabilities of ra << 103 // Gives the sum of the probabilities of radiative transition towards the
99 /// shell whose index is shellIndex << 104 // shell whose index is shellIndex
100 G4double 105 G4double
101 TotalRadiativeTransitionProbability(G4int Z, 106 TotalRadiativeTransitionProbability(G4int Z, size_t shellIndex) const;
102 107
103 /// Gives the sum of the probabilities of no << 108 // Gives the sum of the probabilities of non radiative transition from the
104 /// shell whose index is shellIndex << 109 // shell whose index is shellIndex
105 G4double 110 G4double
106 TotalNonRadiativeTransitionProbability(G4int 111 TotalNonRadiativeTransitionProbability(G4int Z, size_t shellIndex) const;
107 112
108 /// Verbosity control << 113 // Verbosity control
109 void SetVerboseLevel(G4int vl) {verboseLevel 114 void SetVerboseLevel(G4int vl) {verboseLevel = vl;};
110 G4int GetVerboseLevel(){return verboseLevel; 115 G4int GetVerboseLevel(){return verboseLevel;};
111 116
112 private: 117 private:
113 explicit G4AtomicTransitionManager(); << 118
>> 119 G4AtomicTransitionManager();
114 120
115 ~G4AtomicTransitionManager(); 121 ~G4AtomicTransitionManager();
116 122
117 // Hide copy constructor and assignment oper 123 // Hide copy constructor and assignment operator
118 G4AtomicTransitionManager& operator=(const G 124 G4AtomicTransitionManager& operator=(const G4AtomicTransitionManager& right);
119 G4AtomicTransitionManager(const G4AtomicTran 125 G4AtomicTransitionManager(const G4AtomicTransitionManager&);
120 126
121 static G4AtomicTransitionManager* instance; 127 static G4AtomicTransitionManager* instance;
122 // since Augereffect data r stored as a tabl << 128
123 // here a pointer to an element of that clas <<
124 G4AugerData* augerData; <<
125 <<
126 // the first element of the map is the atomi 129 // the first element of the map is the atomic number Z.
127 // the second element is a vector of G4Atomi 130 // the second element is a vector of G4AtomicShell*.
128 std::map<G4int,std::vector<G4AtomicShell*>,s 131 std::map<G4int,std::vector<G4AtomicShell*>,std::less<G4int> > shellTable;
129 132
130 // the first element of the map is the atomi 133 // the first element of the map is the atomic number Z.
131 // the second element is a vector of G4Atomi 134 // the second element is a vector of G4AtomicTransition*.
132 std::map<G4int,std::vector<G4FluoTransition* 135 std::map<G4int,std::vector<G4FluoTransition*>,std::less<G4int> > transitionTable;
133 136
>> 137 // since Augereffect data r stored as a table in G4AugerData, we have
>> 138 // here a pointer to an element of that class itself.
>> 139 G4AugerData* augerData;
>> 140
134 // Minimum and maximum Z in EADL table conta 141 // Minimum and maximum Z in EADL table containing identities and binding
135 // energies of shells 142 // energies of shells
136 G4int zMin = 1; << 143 G4int zMin;
137 G4int zMax = 104; << 144 G4int zMax;
138 145
139 // Minimum and maximum Z in EADL table conta 146 // Minimum and maximum Z in EADL table containing identities, transition
140 // energies and transition probabilities of 147 // energies and transition probabilities of shells
141 G4int infTableLimit = 6; << 148 G4int infTableLimit;
142 G4int supTableLimit = 104; << 149 G4int supTableLimit;
>> 150
>> 151 G4bool isInitialized;
>> 152
143 G4int verboseLevel; 153 G4int verboseLevel;
144 G4bool isInitialized; <<
145 }; 154 };
146 155
147 #endif 156 #endif
148 157