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