Geant4  10.01.p03
G4AtomicTransitionManager.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4AtomicTransitionManager.hh,v 1.2 ????
28 //
29 // Authors: Elena Guardincerri (Elena.Guardincerri@ge.infn.it)
30 // Alfonso Mantero (Alfonso.Mantero@ge.infn.it)
31 //
32 // History:
33 // -----------
34 //
35 // 16 Sept 2001 EG Modified according to a design iteration in the
36 // LowEnergy category
37 //
38 // -------------------------------------------------------------------
39 
40 // Class description:
41 // Low Energy Electromagnetic Physics: create or fills and manages G4AtomicShell,
42 // G4FluoTransition, G4AugerTransition objects.
43 // Further documentation available from http://www.ge.infn.it/geant4/lowE
44 
45 // -------------------------------------------------------------------
46 
47 #ifndef G4AtomicTransitionManager_h
48 #define G4AtomicTransitionManager_h 1
49 
50 #include "G4ShellData.hh"
51 #include "G4FluoTransition.hh"
52 #include "G4AugerTransition.hh"
53 #include "G4AtomicShell.hh"
54 #include <vector>
55 #include "globals.hh"
56 
57 class G4AugerData;
58 
59 // This class is a singleton
61 
62 public:
63 
64  // The only way to get an instance of this class is to call the
65  // function Instance()
67 
68  // needs to be called once from other code before start of run
69  void Initialise();
70 
71  // Z is the atomic number of the element, shellIndex is the
72  // index (in EADL) of the shell
73  G4AtomicShell* Shell(G4int Z, size_t shellIndex) const;
74 
75  // Z is the atomic number of the element, shellIndex is the
76  // index (in EADL) of the final shell for the transition
77  // This function gives, upon Z and the Index of the initial shell where
78  // the vacancy is, the radiative transition that can happen (originating
79  // shell, energy, probability)
80  const G4FluoTransition* ReachableShell(G4int Z, size_t shellIndex) const;
81 
82  // This function gives, upon Z and the Index of the initial shell where
83  // the vacancy is, the NON-radiative transition that can happen with
84  // originating shell for the transition, and the data for the possible
85  // auger electrons emitted (originating vacancy, energy amnd probability)
86 
87  const G4AugerTransition* ReachableAugerShell(G4int Z, G4int shellIndex) const;
88 
89  // This function returns the number of shells of the element
90  // whose atomic number is Z
91  G4int NumberOfShells(G4int Z) const;
92 
93  // This function returns the number of those shells of the element
94  // whose atomic number is Z which are reachable through a radiative
95  // transition
97 
98  // This function returns the number of possible NON-radiative transitions
99  // for the atom with atomic number Z i.e. the number of shell in wich
100  // a vacancy can be filled by a NON-radiative transition
101 
103 
104  // Gives the sum of the probabilities of radiative transition towards the
105  // shell whose index is shellIndex
106  G4double
107  TotalRadiativeTransitionProbability(G4int Z, size_t shellIndex) const;
108 
109  // Gives the sum of the probabilities of non radiative transition from the
110  // shell whose index is shellIndex
111  G4double
112  TotalNonRadiativeTransitionProbability(G4int Z, size_t shellIndex) const;
113 
114  void SetFluoDirectory(const G4String& ss);
115 
116 private:
117 
119 
121 
122  // Hide copy constructor and assignment operator
125 
127 
128  // the first element of the map is the atomic number Z.
129  // the second element is a vector of G4AtomicShell*.
130  std::map<G4int,std::vector<G4AtomicShell*>,std::less<G4int> > shellTable;
131 
132  // the first element of the map is the atomic number Z.
133  // the second element is a vector of G4AtomicTransition*.
134  std::map<G4int,std::vector<G4FluoTransition*>,std::less<G4int> > transitionTable;
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.
139 
140  // Minimum and maximum Z in EADL table containing identities and binding
141  // energies of shells
144 
145  // Minimum and maximum Z in EADL table containing identities, transition
146  // energies and transition probabilities of shells
149 
152 };
153 
154 #endif
const G4AugerTransition * ReachableAugerShell(G4int Z, G4int shellIndex) const
G4int NumberOfReachableShells(G4int Z) const
std::map< G4int, std::vector< G4FluoTransition * >, std::less< G4int > > transitionTable
void SetFluoDirectory(const G4String &ss)
std::map< G4int, std::vector< G4AtomicShell * >, std::less< G4int > > shellTable
int G4int
Definition: G4Types.hh:78
G4double TotalNonRadiativeTransitionProbability(G4int Z, size_t shellIndex) const
G4AtomicTransitionManager & operator=(const G4AtomicTransitionManager &right)
bool G4bool
Definition: G4Types.hh:79
G4int NumberOfReachableAugerShells(G4int Z) const
G4double TotalRadiativeTransitionProbability(G4int Z, size_t shellIndex) const
const G4FluoTransition * ReachableShell(G4int Z, size_t shellIndex) const
static G4AtomicTransitionManager * instance
double G4double
Definition: G4Types.hh:76
static G4AtomicTransitionManager * Instance()
G4AtomicShell * Shell(G4int Z, size_t shellIndex) const