include/Geant4/G4AugerTransition.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 // Class description:
0036 // Low Energy Electromagnetic Physics
0037 // This Class stores all the information of auger effect relative
0038 // to one main vacancy in a atom, like possible auger emission with
0039 // relative probabilites, originating shell's Ids, probabilities of
0040 // transition and auger electron energies.
0041 // -------------------------------------------------------------------
0042
0043 #ifndef G4AugerTransition_h
0044 #define G4AugerTransition_h 1
0045
0046 #include "G4DataVector.hh"
0047 #include "globals.hh"
0048 #include <vector>
0049 #include <map>
0050
0051 class G4AugerTransition {
0052
0053 public:
0054
0055   explicit G4AugerTransition(G4int finalShell, std::vector<G4int> transIds,
0056                  const std::map<G4int, std::vector<G4int>, std::less<G4int> >* idMap,
0057                  const std::map<G4int, G4DataVector, std::less<G4int> >* energyMap,
0058                  const std::map<G4int, G4DataVector, std::less<G4int> >* probabilityMap);
0059
0060   ~G4AugerTransition();
0061
0062   /// All the data stored and provided by this class are relative to a
0063   /// given vacancy, whose identity is provided by the FinalShellId() method,
0064   /// in an atom of a given material
0065
0066   /// Returns the ids of the shells from wich an auger electron culd came from, given the shell
0067   /// from wich the transition electron comes from.
0068   const std::vector<G4int>* AugerOriginatingShellIds(G4int startShellId) const;
0069
0070   /// Returns the ids of the shells from wich an electron cuuld fill the vacancy in finalShellId
0071   const std::vector<G4int>* TransitionOriginatingShellIds() const;
0072
0073   /// Returns the energiess of the possible auger electrons, given th shell
0074   /// from wich the transition electron comes from.
0075   const G4DataVector* AugerTransitionEnergies(G4int startShellId) const;
0076
0077   /// Returns the emission probabilities of the auger electrons, given th shell
0078   /// from wich the transition electron comes from.
0079   const G4DataVector* AugerTransitionProbabilities(G4int startShellId) const;
0080
0081   /// returns the id of the shell in wich the transition electron arrives
0082   G4int FinalShellId() const;
0083
0084   /// Returns the id of the shell from wich come the auger electron , given the shell
0085   /// from wich the transition electron comes from and the index number.
0086   G4int AugerOriginatingShellId(G4int index, G4int startShellId) const;
0087
0088   /// Returns the energy of the auger electron, given the shell
0089   /// from wich the transition electron comes from and the index number.
0090   G4double AugerTransitionEnergy(G4int index, G4int startShellId) const;
0091
0092   /// Returns the probability of the auger emission, given the shell
0093   /// from wich the transition electron comes from and the index number.
0094   G4double AugerTransitionProbability(G4int index, G4int startShellId) const;
0095
0096   /// Returns the id of the shell form wich the transition electron come from
0097   G4int TransitionOriginatingShellId(G4int index) const;
0098
0099
0100 private:
0101   std::map<G4int,std::vector<G4int>,std::less<G4int> >  augerOriginatingShellIdsMap;
0102   std::map<G4int,G4DataVector,std::less<G4int> >  augerTransitionEnergiesMap;
0103   std::map<G4int,G4DataVector,std::less<G4int> >  augerTransitionProbabilitiesMap;
0104   std::vector<G4int> transitionOriginatingShellIds;
0105
0106   G4int finalShellId;
0107
0108 };
0109
0110 #endif
0111
0112