| 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 /// \file Run.hh
27 /// \brief Definition of the Run class
28 //
29 //
30
31 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
32 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
33
34 #ifndef Run_h
35 #define Run_h 1
36
37 #include "SteppingAction.hh"
38 #include "TrackingAction.hh"
39
40 #include "G4Run.hh"
41 #include "G4ThreeVector.hh"
42
43 #include <array>
44
45 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
46
47 class Run : public G4Run
48 {
49 // This class accumulates relevant quantities related to particle fluence collected during
50 // the run.
51 // ( Note: these information are provided via calls of accessor methods of this Run class
52 // made by SteppingAction::UserSteppingAction
53 // and TrackingAction::PreUserTrackingAction. )
54 // At the end of a run, the PrintInfo method is called by the run-action to print out
55 // some summary information about these quantities.
56 // In multithreaded (MT) mode, an object of this class is filled up for each working thread,
57 // and then merged (automatically by the Geant4 kernel) into another object (of this class)
58 // owned by the master class; the PrintInfo method is then called only for the latter run
59 // object.
60 // Note that, for simplicity and brevity, we avoid histograms and print-out instead some
61 // statistics (compute by ourself) at the end of the run.
62 public:
63 Run();
64 ~Run() override = default;
65
66 void RecordEvent(const G4Event* anEvent) override;
67 // This method is called automatically by the Geant4 kernel (not by the user!) at the end
68 // of each event. In the case of multithreaded mode, it is called only for the working thread
69 // that handled that event.
70
71 void Merge(const G4Run* aRun) override;
72 // This method is called automatically by the Geant4 kernel (not by the user!) only in the
73 // case of multithreaded mode and only for working threads.
74
75 void PrintInfo() const;
76 // This method is called by RunAction::EndOfRunAction : in the case of multithreaded mode,
77 // only the master thread calls it.
78
79 void SetPrimaryParticleId(const G4int inputValue) { fPrimaryParticleId = inputValue; }
80 void SetPrimaryParticleEnergy(const G4double inputValue)
81 {
82 fPrimaryParticleEnergy = inputValue;
83 }
84 void SetPrimaryParticleDirection(const G4ThreeVector& inputValue)
85 {
86 fPrimaryParticleDirection = inputValue;
87 }
88 void SetAbsorberMaterialName(const G4String& inputValue) { fAbsorberMaterialName = inputValue; }
89 void SetActiveMaterialName(const G4String& inputValue) { fActiveMaterialName = inputValue; }
90 void SetCubicVolumeScoringUpDown(const G4double inputValue)
91 {
92 fCubicVolumeScoringUpDown = inputValue;
93 }
94 void SetCubicVolumeScoringSide(const G4double inputValue)
95 {
96 fCubicVolumeScoringSide = inputValue;
97 }
98 G4int GetPrimaryParticleId() const { return fPrimaryParticleId; }
99 G4double GetPrimaryParticleEnergy() const { return fPrimaryParticleEnergy; }
100 G4ThreeVector GetPrimaryParticleDirection() const { return fPrimaryParticleDirection; }
101 G4String GetAbsorberMaterialName() const { return fAbsorberMaterialName; }
102 G4String GetActiveMaterialName() const { return fActiveMaterialName; }
103 G4double GetCubicVolumeScoringUpDown() const { return fCubicVolumeScoringUpDown; }
104 G4double GetCubicVolumeScoringSide() const { return fCubicVolumeScoringSide; }
105
106 void
107 SetSteppingArray(const std::array<G4double, SteppingAction::fkNumberCombinations>& inputArray);
108 std::array<G4double, SteppingAction::fkNumberCombinations> GetSteppingArray() const
109 {
110 return fSteppingArray;
111 }
112 // Accessor methods useful to transfer information collected by the stepping-action
113 // into this Run class
114
115 void
116 SetTrackingArray1(const std::array<G4long, TrackingAction::fkNumberCombinations>& inputArray);
117 std::array<G4long, TrackingAction::fkNumberCombinations> GetTrackingArray1() const
118 {
119 return fTrackingArray1;
120 }
121 void
122 SetTrackingArray2(const std::array<G4double, TrackingAction::fkNumberCombinations>& inputArray);
123 std::array<G4double, TrackingAction::fkNumberCombinations> GetTrackingArray2() const
124 {
125 return fTrackingArray2;
126 }
127 // Accessor methods useful to transfer information collected by the tracking-action
128 // into this Run class
129
130 private:
131 G4int fNumEvents;
132 G4int fPrimaryParticleId;
133 G4double fPrimaryParticleEnergy;
134 G4ThreeVector fPrimaryParticleDirection;
135 G4String fAbsorberMaterialName;
136 G4String fActiveMaterialName;
137 G4double fCubicVolumeScoringUpDown;
138 G4double fCubicVolumeScoringSide;
139 std::array<G4double, SteppingAction::fkNumberCombinations> fSteppingArray;
140 std::array<G4long, TrackingAction::fkNumberCombinations> fTrackingArray1;
141 std::array<G4double, TrackingAction::fkNumberCombinations> fTrackingArray2;
142 };
143
144 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
145
146 #endif
147