| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 /// \file SteppingAction.hh 26 /// \file SteppingAction.hh
27 /// \brief Definition of the SteppingAction cl 27 /// \brief Definition of the SteppingAction class
28 // 28 //
29 // << 29 //
30 30
31 //....oooOO0OOooo........oooOO0OOooo........oo 31 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
32 //....oooOO0OOooo........oooOO0OOooo........oo 32 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
33 33
34 #ifndef SteppingAction_H 34 #ifndef SteppingAction_H
35 #define SteppingAction_H 1 35 #define SteppingAction_H 1
36 36
37 #include "G4ThreeVector.hh" <<
38 #include "G4UserSteppingAction.hh" <<
39 #include "globals.hh" 37 #include "globals.hh"
40 << 38 #include "G4UserSteppingAction.hh"
>> 39 #include "G4ThreeVector.hh"
41 #include <array> 40 #include <array>
42 41
43 class Run; 42 class Run;
44 43
45 //....oooOO0OOooo........oooOO0OOooo........oo 44 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
46 45
47 class SteppingAction : public G4UserSteppingAc << 46 class SteppingAction : public G4UserSteppingAction {
48 { << 47 public:
49 public: <<
50 SteppingAction(); 48 SteppingAction();
51 ~SteppingAction() override = default; 49 ~SteppingAction() override = default;
52 << 50
53 void UserSteppingAction(const G4Step*) ove << 51 void UserSteppingAction( const G4Step* ) override;
54 // This is the main method where the step 52 // This is the main method where the step lengths of particles inside
55 // the scoring volumes are collected, and 53 // the scoring volumes are collected, and then the corresponding fluences
56 // are filled up in the Run object where t 54 // are filled up in the Run object where they are stored (and then
57 // printed out at the end of the Run). 55 // printed out at the end of the Run).
58 // (For simplicity and brevity, we avoid h 56 // (For simplicity and brevity, we avoid histograms and compute instead
59 // some statistics ourself, which will be 57 // some statistics ourself, which will be print-out at the end of the run.)
60 58
61 void Initialize(); 59 void Initialize();
62 // This method is called by RunAction::Beg 60 // This method is called by RunAction::BeginOfRunAction for the
63 // initialization of the stepping-action a 61 // initialization of the stepping-action at the beginning of each Run.
64 // This is necessary because different run 62 // This is necessary because different runs can have different primary particle
65 // types, kinetic energies, and detector c 63 // types, kinetic energies, and detector configurations.
66 64
67 void SetRunPointer(Run* inputValue = nullp << 65 void SetRunPointer( Run* inputValue = nullptr ) { fRunPtr = inputValue; }
68 // This method is called by RunAction::Beg 66 // This method is called by RunAction::BeginOfRunAction for providing to the
69 // stepping-action the pointer to the run 67 // stepping-action the pointer to the run object at the beginning of each Run.
70 // This pointer is then used to pass the i 68 // This pointer is then used to pass the information collected by the stepping-action
71 // to the run object. 69 // to the run object.
72 70
73 G4double GetCubicVolumeScoringUpDown() con 71 G4double GetCubicVolumeScoringUpDown() const { return fCubicVolumeScoringUpDown; }
74 G4double GetCubicVolumeScoringSide() const 72 G4double GetCubicVolumeScoringSide() const { return fCubicVolumeScoringSide; }
75 // The cubic-volumes of the scoring volume 73 // The cubic-volumes of the scoring volumes are needed to get the fluence from
76 // the sum of step lengths in those scorin 74 // the sum of step lengths in those scoring volumes.
77 // Notice that two of the three scoring vo 75 // Notice that two of the three scoring volumes - upstream and downstream -
78 // have the same cubic-volume, that we cal 76 // have the same cubic-volume, that we call "fCubicVolumeScoringUpDown".
79 << 77
80 static const G4int fkNumberScoringVolumes << 78 static const G4int fkNumberScoringVolumes = 3; // downstream, side, upstream
81 static const G4int fkNumberKinematicRegion 79 static const G4int fkNumberKinematicRegions = 3; // all, below 20 MeV, above 20 MeV
82 static const G4int fkNumberParticleTypes = << 80 static const G4int fkNumberParticleTypes = 11; // all, e, gamma, mu, nu, pi, n, p, ions,
83 81 // other-mesons, other-baryons
84 static const G4int fkNumberCombinations = 82 static const G4int fkNumberCombinations =
85 fkNumberScoringVolumes * fkNumberKinemat << 83 fkNumberScoringVolumes*fkNumberKinematicRegions*fkNumberParticleTypes;
86 static const std::array<G4String, fkNumber << 84 static const std::array< G4String, fkNumberScoringVolumes > fkArrayScoringVolumeNames;
87 static const std::array<G4String, fkNumber << 85 static const std::array< G4String, fkNumberKinematicRegions > fkArrayKinematicRegionNames;
88 static const std::array<G4String, fkNumber << 86 static const std::array< G4String, fkNumberParticleTypes > fkArrayParticleTypeNames;
89 static G4int GetIndex(const G4int iScoring << 87 static G4int GetIndex( const G4int iScoringVolume, const G4int iKinematicRegion,
90 const G4int iParticl << 88 const G4int iParticleType );
91 << 89
92 private: << 90 private:
93 Run* fRunPtr; // Pointer to the Run objec 91 Run* fRunPtr; // Pointer to the Run object
94 G4int fPrimaryParticleId; 92 G4int fPrimaryParticleId;
95 G4double fPrimaryParticleEnergy; 93 G4double fPrimaryParticleEnergy;
96 G4ThreeVector fPrimaryParticleDirection; 94 G4ThreeVector fPrimaryParticleDirection;
97 G4String fAbsorberMaterialName; 95 G4String fAbsorberMaterialName;
98 G4String fActiveMaterialName; 96 G4String fActiveMaterialName;
99 G4bool fIsFirstStepOfTheEvent; 97 G4bool fIsFirstStepOfTheEvent;
100 G4bool fIsFirstStepInAbsorberLayer; 98 G4bool fIsFirstStepInAbsorberLayer;
101 G4bool fIsFirstStepInActiveLayer; 99 G4bool fIsFirstStepInActiveLayer;
102 G4bool fIsFirstStepInScoringUpDown; 100 G4bool fIsFirstStepInScoringUpDown;
103 G4bool fIsFirstStepInScoringSide; 101 G4bool fIsFirstStepInScoringSide;
104 G4double fCubicVolumeScoringUpDown; 102 G4double fCubicVolumeScoringUpDown;
105 G4double fCubicVolumeScoringSide; 103 G4double fCubicVolumeScoringSide;
106 << 104
107 std::array<G4double, fkNumberCombinations> << 105 std::array< G4double, fkNumberCombinations > fArraySumStepLengths;
108 // Array to collect the sum of step length 106 // Array to collect the sum of step lengths in the scoring volumes for the whole run,
109 // according to the various cases (kinemat 107 // according to the various cases (kinematical region and particle type).
110 // Note that the fluence in a scoring volu 108 // Note that the fluence in a scoring volume is defined as sum of step lengths
111 // in that scoring volume divided by the c 109 // in that scoring volume divided by the cubic-volume of that scoring volume.
112 }; 110 };
113 111
114 //....oooOO0OOooo........oooOO0OOooo........oo 112 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
115 113
116 #endif 114 #endif
117 115