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