physics/include/G4RDAugerTransition.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028 //
0029 // Author: Alfonso Mantero (Alfosno.Mantero@ge.infn.it)
0030 //
0031 // History:
0032 // -----------
0033 // 1 Jun 2002: first Commited to CVS
0034 // -------------------------------------------------------------------
0035
0036 // Class description:
0037 // Low Energy Electromagnetic Physics
0038 // This Class stores all the information of auger effect relative
0039 // to one main vacancy in a atom, like possible auger emission with
0040 // relative probabilites, originating shell's Ids, probabilities of
0041 // transition and auger electron energies.
0042 // Further documentation available from http://www.ge.infn.it/geant4/lowE
0043
0044 // -------------------------------------------------------------------
0045
0046 #ifndef G4RDAugerTransition_h
0047 #define G4RDAugerTransition_h 1
0048
0049 #include "G4DataVector.hh"
0050 #include "globals.hh"
0051 #include <vector>
0052 #include <map>
0053
0054 class G4RDAugerTransition {
0055
0056 public:
0057
0058   G4RDAugerTransition(G4int finalShell, std::vector<G4int> transIds,
0059             const std::map<G4int, std::vector<G4int>, std::less<G4int> >* idMap,
0060             const std::map<G4int, G4DataVector, std::less<G4int> >* energyMap,
0061             const std::map<G4int, G4DataVector, std::less<G4int> >* probabilityMap);
0062
0063   ~G4RDAugerTransition();
0064
0065 // All the data stored and provided by this class are relative to a
0066 // given vacancy, whose identity is provided by the FinalShellId() method,
0067 // in an atom of a given material
0068
0069 // Returns the ids of the shells from wich an auger electron culd came from, given the shell
0070 // from wich the transition electron comes from.
0071
0072   const std::vector<G4int>* AugerOriginatingShellIds(G4int startShellId) const;
0073
0074 // Returns the ids of the shells from wich an electron cuuld fill the vacancy in finalShellId
0075
0076   const std::vector<G4int>* TransitionOriginatingShellIds() const;
0077
0078 // Returns the energiess of the possible auger electrons, given th shell
0079 // from wich the transition electron comes from.
0080
0081   const G4DataVector* AugerTransitionEnergies(G4int startShellId) const;
0082
0083 // Returns the emission probabilities of the auger electrons, given th shell
0084 // from wich the transition electron comes from.
0085
0086   const G4DataVector* AugerTransitionProbabilities(G4int startShellId) const;
0087
0088 // returns the id of the shell in wich the transition electron arrives
0089
0090   G4int FinalShellId() const;
0091
0092 // Returns the id of the shell from wich come the auger electron , given the shell
0093 // from wich the transition electron comes from and the index number.
0094
0095   G4int AugerOriginatingShellId(G4int index, G4int startShellId) const;
0096
0097 // Returns the energy of the auger electron, given the shell
0098 // from wich the transition electron comes from and the index number.
0099
0100   G4double AugerTransitionEnergy(G4int index, G4int startShellId) const;
0101
0102 // Returns the probability of the auger emission, given the shell
0103 // from wich the transition electron comes from and the index number.
0104
0105   G4double AugerTransitionProbability(G4int index, G4int startShellId) const;
0106
0107 // Returns the id of the shell form wich the transition electron come from
0108
0109   G4int TransitionOriginatingShellId(G4int index) const;
0110
0111
0112 private:
0113
0114   G4int finalShellId;
0115   std::map<G4int,std::vector<G4int>,std::less<G4int> >  augerOriginatingShellIdsMap;
0116   std::map<G4int,G4DataVector,std::less<G4int> >  augerTransitionEnergiesMap;
0117   std::map<G4int,G4DataVector,std::less<G4int> >  augerTransitionProbabilitiesMap;
0118   std::vector<G4int> transitionOriginatingShellIds;
0119
0120 };
0121
0122 #endif
0123
0124