| 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 // $Id$
35 //
36 /// \file PrimaryKiller.hh
37 /// \brief Definition of the PrimaryKiller class
38
39 #ifndef CHEM6_PrimaryKiller_h
40 #define CHEM6_PrimaryKiller_h 1
41
42 #include <G4THitsMap.hh>
43 #include <G4UImessenger.hh>
44 #include <G4VPrimitiveScorer.hh>
45
46 class G4UIcmdWithADoubleAndUnit;
47 class G4UIcmdWith3VectorAndUnit;
48
49 /** \file PrimaryKiller.hh*/
50
51 // Description:
52 // Kill the primary particle:
53 // - either after a given energy loss
54 // - or after the primary particle has reached a given energy
55
56 class PrimaryKiller : public G4VPrimitiveScorer, public G4UImessenger
57 {
58 private:
59 double fELoss; // cumulated energy loss by the primary
60
61 double fELossRange_Min; // fELoss from which the primary is killed
62 double fELossRange_Max; // fELoss from which the event is aborted
63 double fKineticE_Min; // kinetic energy below which the primary is killed
64 G4ThreeVector fPhantomSize;
65
66 G4UIcmdWithADoubleAndUnit* fpELossUI;
67 G4UIcmdWithADoubleAndUnit* fpAbortEventIfELossUpperThan;
68 G4UIcmdWithADoubleAndUnit* fpMinKineticE;
69 G4UIcmdWith3VectorAndUnit* fpSizeUI;
70
71 public:
72 PrimaryKiller(G4String name, G4int depth = 0);
73
74 virtual ~PrimaryKiller();
75
76 /** Set energy under which the particle should be
77 killed*/
78 inline void SetEnergyThreshold(double energy) { fKineticE_Min = energy; }
79
80 /** Set the energy loss from which the primary is
81 killed*/
82 inline void SetMinLossEnergyLimit(double energy) { fELossRange_Min = energy; }
83
84 /** Set the energy loss from which the event is
85 aborted*/
86 inline void SetMaxLossEnergyLimit(double energy) { fELossRange_Max = energy; }
87
88 /** Method related to G4UImessenger
89 used to control energy cuts through macro file
90 */
91 virtual void SetNewValue(G4UIcommand* command, G4String newValue);
92
93 protected:
94 virtual G4bool ProcessHits(G4Step*, G4TouchableHistory*);
95
96 public:
97 virtual void Initialize(G4HCofThisEvent*);
98 virtual void EndOfEvent(G4HCofThisEvent*);
99 virtual void DrawAll();
100 virtual void PrintAll();
101 };
102 #endif
103