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