chem5/include/PrimaryKiller.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 // This example is provided by the Geant4-DNA collaboration
0027 // Any report or published results obtained using the Geant4-DNA software
0028 // shall cite the following Geant4-DNA collaboration publication:
0029 // Med. Phys. 37 (2010) 4692-4708
0030 // J. Comput. Phys. 274 (2014) 841-882
0031 // The Geant4-DNA web site is available at http://geant4-dna.org
0032 //
0033 //
0034
0035 #ifndef CHEM5_PrimaryKiller_h
0036 #define CHEM5_PrimaryKiller_h 1
0037
0038 #include <G4THitsMap.hh>
0039 #include <G4UImessenger.hh>
0040 #include <G4VPrimitiveScorer.hh>
0041
0042 class G4UIcmdWithADoubleAndUnit;
0043
0044 /** \file PrimaryKiller.hh*/
0045
0046 // Description:
0047 //   Kill the primary particle:
0048 //   - either after a given energy loss
0049 //   - or after the primary particle has reached a given energy
0050
0051 class PrimaryKiller : public G4VPrimitiveScorer, public G4UImessenger
0052 {
0053   private:
0054     double fELoss;  // cumulated energy loss by the primary
0055
0056     double fELossRange_Min;  // fELoss from which the primary is killed
0057     double fELossRange_Max;  // fELoss from which the event is aborted
0058     double fKineticE_Min;  // kinetic energy below which the primary is killed
0059
0060     G4UIcmdWithADoubleAndUnit* fpELossUI;
0061     G4UIcmdWithADoubleAndUnit* fpAbortEventIfELossUpperThan;
0062     G4UIcmdWithADoubleAndUnit* fpMinKineticE;
0063
0064   public:
0065     PrimaryKiller(G4String name, G4int depth = 0);
0066
0067     virtual ~PrimaryKiller();
0068
0069     /** Set energy under which the particle should be
0070      killed*/
0071     inline void SetEnergyThreshold(double energy) { fKineticE_Min = energy; }
0072
0073     /** Set the energy loss from which the primary is
0074      killed*/
0075     inline void SetMinLossEnergyLimit(double energy) { fELossRange_Min = energy; }
0076
0077     /** Set the energy loss from which the event is
0078      aborted*/
0079     inline void SetMaxLossEnergyLimit(double energy) { fELossRange_Max = energy; }
0080
0081     /** Method related to G4UImessenger
0082         used to control energy cuts through macro file
0083      */
0084     virtual void SetNewValue(G4UIcommand* command, G4String newValue);
0085
0086   protected:
0087     virtual G4bool ProcessHits(G4Step*, G4TouchableHistory*);
0088
0089   public:
0090     virtual void Initialize(G4HCofThisEvent*);
0091     virtual void EndOfEvent(G4HCofThisEvent*);
0092     virtual void Clear();
0093     virtual void DrawAll();
0094     virtual void PrintAll();
0095 };
0096 #endif