include/Geant4/G4LowECapture.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:   G4LowECapture
0030 //
0031 // Description: The process to kill low-energy particles
0032 //
0033 // Author:      V.Ivanchenko 12 May 2015
0034 //
0035 //----------------------------------------------------------------------------
0036 //
0037 // Class description:
0038 //
0039 // G4LowECapture allows to remove unwanted particles from simulation in
0040 // order to improve CPU performance. There are two parameters:
0041 //
0042 // 1) low energy threshold for kinetic energy (default 0)
0043 // 2) the vector of names of G4Region where process is active
0044 //
0045 //
0046 // If a 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 LowECapture_h
0053 #define LowECapture_h 1
0054
0055 #include "G4VDiscreteProcess.hh"
0056 #include "globals.hh"
0057
0058 class G4Region;
0059
0060 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0061
0062 class G4LowECapture : public G4VDiscreteProcess
0063 {
0064 public:
0065   explicit G4LowECapture(G4double ekinlimit = 0.0);
0066   virtual ~G4LowECapture();
0067
0068   void SetKinEnergyLimit(G4double);
0069   void AddRegion(const G4String&);
0070
0071   void BuildPhysicsTable(const G4ParticleDefinition&) override;
0072
0073   G4bool IsApplicable(const G4ParticleDefinition&) override;
0074
0075   G4double PostStepGetPhysicalInteractionLength(const G4Track& track,
0076                         G4double,
0077                         G4ForceCondition*) override;
0078   G4VParticleChange* PostStepDoIt(const G4Track&, const G4Step&) override;
0079
0080   G4LowECapture(const G4LowECapture&) = delete;
0081   G4LowECapture& operator = (const G4LowECapture &right) = delete;
0082
0083 protected:
0084   G4double GetMeanFreePath(const G4Track&, G4double,G4ForceCondition*) override;
0085
0086 private:
0087   std::vector<G4String> regionName;
0088   std::vector<const G4Region*> region;
0089   G4double kinEnergyThreshold;
0090   G4int    nRegions;
0091   G4bool   isIon;
0092 };
0093
0094 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0095
0096 #endif