| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // This example is provided by the Geant4-DNA collaboration
27 // Any report or published results obtained using the Geant4-DNA software
28 // shall cite the following Geant4-DNA collaboration publication:
29 // Med. Phys. 37 (2010) 4692-4708
30 // J. Comput. Phys. 274 (2014) 841-882
31 // The Geant4-DNA web site is available at http://geant4-dna.org
32 //
33 //
34
35 #ifndef CHEM4_PrimaryKiller_h
36 #define CHEM4_PrimaryKiller_h 1
37
38 #include <G4THitsMap.hh>
39 #include <G4UImessenger.hh>
40 #include <G4VPrimitiveScorer.hh>
41
42 class G4UIcmdWithADoubleAndUnit;
43
44 /** \file PrimaryKiller.hh*/
45
46 // Description:
47 // Kill the primary particle:
48 // - either after a given energy loss
49 // - or after the primary particle has reached a given energy
50
51 class PrimaryKiller : public G4VPrimitiveScorer, public G4UImessenger
52 {
53 private:
54 double fELoss; // cumulated energy loss by the primary
55
56 double fELossRange_Min; // fELoss from which the primary is killed
57 double fELossRange_Max; // fELoss from which the event is aborted
58 double fKineticE_Min; // kinetic energy below which the primary is killed
59
60 G4UIcmdWithADoubleAndUnit* fpELossUI;
61 G4UIcmdWithADoubleAndUnit* fpAbortEventIfELossUpperThan;
62 G4UIcmdWithADoubleAndUnit* fpMinKineticE;
63
64 public:
65 PrimaryKiller(G4String name, G4int depth = 0);
66
67 virtual ~PrimaryKiller();
68
69 /** Set energy under which the particle should be
70 killed*/
71 inline void SetEnergyThreshold(double energy) { fKineticE_Min = energy; }
72
73 /** Set the energy loss from which the primary is
74 killed*/
75 inline void SetMinLossEnergyLimit(double energy) { fELossRange_Min = energy; }
76
77 /** Set the energy loss from which the event is
78 aborted*/
79 inline void SetMaxLossEnergyLimit(double energy) { fELossRange_Max = energy; }
80
81 /** Method related to G4UImessenger
82 used to control energy cuts through macro file
83 */
84 virtual void SetNewValue(G4UIcommand* command, G4String newValue);
85
86 protected:
87 virtual G4bool ProcessHits(G4Step*, G4TouchableHistory*);
88
89 public:
90 virtual void Initialize(G4HCofThisEvent*);
91 virtual void EndOfEvent(G4HCofThisEvent*);
92 virtual void Clear();
93 virtual void DrawAll();
94 virtual void PrintAll();
95 };
96 #endif
97