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