wholeNuclearDNA/include/G4ElectronCapture.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 /// \file G4ElectronCapture.hh
0027 /// \brief Definition of the G4ElectronCapture class
0028
0029 //---------------------------------------------------------------------------
0030 //
0031 // ClassName:   G4ElectronCapture
0032 //
0033 // Description: The process to kill e- to save CPU
0034 //
0035 // Author:      V.Ivanchenko 31 August 2010
0036 //
0037 //----------------------------------------------------------------------------
0038 //
0039 // Class description:
0040 //
0041 // G4ElectronCapture allows to remove unwanted e- from simulation in
0042 // order to improve CPU performance. There are two parameters:
0043 //
0044 // 1) low energy threshold for e- kinetic energy (default 0)
0045 // 2) the name of G4Region where process is active
0046 //
0047 //
0048 // If an electron track is killed then energy deposition is added to the step
0049 //
0050 // This example is provided by the Geant4-DNA collaboration
0051 // Any report or published results obtained using the Geant4-DNA software
0052 // and the DNA geometry given in the Geom_DNA example
0053 // shall cite the following Geant4-DNA collaboration publications:
0054 // [1] NIM B 298 (2013) 47-54
0055 // [2] Med. Phys. 37 (2010) 4692-4708
0056 // The Geant4-DNA web site is available at http://geant4-dna.org
0057 //
0058 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0059
0060 #ifndef ElectronCapture_h
0061 #define ElectronCapture_h 1
0062
0063 #include "G4ParticleChangeForGamma.hh"
0064 #include "G4VDiscreteProcess.hh"
0065 #include "globals.hh"
0066
0067 class G4Region;
0068
0069 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0070
0071 class G4ElectronCapture : public G4VDiscreteProcess
0072 {
0073   public:
0074     G4ElectronCapture(const G4String& regName, G4double ekinlimit);
0075
0076     virtual ~G4ElectronCapture();
0077
0078     void SetKinEnergyLimit(G4double);
0079
0080     virtual void BuildPhysicsTable(const G4ParticleDefinition&);
0081
0082     virtual G4bool IsApplicable(const G4ParticleDefinition&);
0083
0084     virtual G4double PostStepGetPhysicalInteractionLength(const G4Track& track,
0085                                                           G4double previousStepSize,
0086                                                           G4ForceCondition* condition);
0087
0088     virtual G4VParticleChange* PostStepDoIt(const G4Track&, const G4Step&);
0089
0090   protected:
0091     virtual G4double GetMeanFreePath(const G4Track&, G4double, G4ForceCondition*);
0092
0093   private:
0094     // hide assignment operator as private
0095     G4ElectronCapture(const G4ElectronCapture&);
0096     G4ElectronCapture& operator=(const G4ElectronCapture& right);
0097
0098     G4double fKinEnergyThreshold;
0099     G4String fRegionName;
0100     G4Region* region;
0101     G4ParticleChangeForGamma fParticleChange;
0102 };
0103
0104 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0105
0106 #endif