include/Geant4/G4DNAPTBAugerModel.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 // Authors: S. Meylan and C. Villagrasa (IRSN, France)
0027 // Models come from
0028 // M. Bug et al, Rad. Phys and Chem. 130, 459-479 (2017)
0029 //
0030 //
0031 // -------------------------------------------------------------------
0032 //
0033 // Geant4 Header G4DNAPTBAugerModel
0034 //
0035 // -------------------------------------------------------------------
0036 //
0037 // Class description:
0038 // Implementation of atomic deexcitation
0039 //
0040 // -------------------------------------------------------------------
0041
0042 #ifndef G4DNAPTBAugerModel_h
0043 #define G4DNAPTBAugerModel_h 1
0044
0045 #include "G4VAtomDeexcitation.hh"
0046 #include "G4AtomicShell.hh"
0047 #include "globals.hh"
0048 #include "G4DynamicParticle.hh"
0049 #include <vector>
0050
0051 class G4AtomicTransitionManager;
0052 class G4VhShellCrossSection;
0053 class G4EmCorrections;
0054 class G4Material;
0055
0056 /*!
0057  * \brief The G4DNAPTBAugerModel class
0058  * Implement the PTB Auger model
0059  */
0060 class G4DNAPTBAugerModel
0061 {
0062 public:
0063
0064    /*!
0065    * \brief G4DNAPTBAugerModel
0066    * Constructor
0067    * \param modelName
0068    */
0069   G4DNAPTBAugerModel(const G4String &modelName);
0070
0071   /*!
0072    * \brief ~G4DNAPTBAugerModel
0073    * Destructor
0074    */
0075   virtual ~G4DNAPTBAugerModel();
0076
0077   G4DNAPTBAugerModel(G4DNAPTBAugerModel &) = delete;  // prevent copy-construction
0078   G4DNAPTBAugerModel & operator=(const G4DNAPTBAugerModel &right) = delete;  // prevent assignement
0079
0080   /*!
0081    * \brief Initialise
0082    * Set the verbose value
0083    */
0084   virtual void Initialise();
0085
0086   /*!
0087    * \brief SetCutForAugerElectrons
0088    * Set the cut for the auger electrons production
0089    * \param cut
0090    */
0091   void SetCutForAugerElectrons(G4double cut);
0092
0093   /*!
0094    * \brief ComputeAugerEffect
0095    * Main method to be called by the ionisation model.
0096    * \param fvect
0097    * \param materialNameIni
0098    * \param bindingEnergy
0099    */
0100   void ComputeAugerEffect(std::vector<G4DynamicParticle *> *fvect, const G4String& materialNameIni, G4double bindingEnergy);
0101
0102 private:
0103
0104   const G4String modelName; ///< name of the auger model
0105
0106   G4int verboseLevel;
0107   G4double minElectronEnergy;
0108
0109   /*!
0110    * \brief GenerateAugerWithRandomDirection
0111    * Generates the auger particle
0112    * \param fvect
0113    * \param kineticEnergy
0114    */
0115   void GenerateAugerWithRandomDirection(std::vector<G4DynamicParticle*>* fvect, G4double kineticEnergy);
0116
0117   /*!
0118    * \brief CalculAugerEnergyFor
0119    * \param atomId
0120    * \return the auger particle energy
0121    */
0122   G4double CalculAugerEnergyFor(G4int atomId);
0123
0124   /*!
0125    * \brief DetermineIonisedAtom
0126    * \param atomId
0127    * \param materialName
0128    * \param bindingEnergy
0129    * \return the id of the chosen ionised atom
0130    */
0131   G4int DetermineIonisedAtom(G4int atomId, const G4String &materialName, G4double bindingEnergy);
0132
0133
0134 };
0135
0136 #endif
0137
0138
0139
0140