| 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 radiobiology/include/LETAccumulable.hh
27 /// \brief Definition of the RadioBio::LETAccumulable class
28
29 #ifndef RadiobiologyLETACCUMULABLE_HH
30 #define RadiobiologyLETACCUMULABLE_HH
31
32 #include "IonLet.hh"
33 #include "VRadiobiologicalAccumulable.hh"
34 #include <G4VAccumulable.hh>
35
36 #include <valarray>
37 #include <vector>
38
39 namespace RadioBio
40 {
41
42 // Forward declariation of other radiobiology classes
43 class Hit;
44 class VoxelizedSensitiveDetector;
45
46 /**
47 * @brief Accumulable of LET-related data (that must be thread-local).
48 *
49 * It keeps the sum of alpha and beta numerators/denominator, as well as energy deposits.
50 * The class is closely tied with the singLETon LET that is used both
51 * to calculate alphas and betas, and also to store results.
52 *
53 * This is implemented as a customized G4VAccumulable with non-scalar data.
54 *
55 * @note There are two levels of merging (accumulation):
56 * 1) From more threads in one run (G4VAccumulable merging is applied)
57 * 2) (Optional) inter-run merging of data (implemented in LET).
58 *
59 * @note std::valarray is used (instead of C arrays or std::vectors)
60 * to accumulate data for its logical simplicity.
61 */
62 class LETAccumulable : public VRadiobiologicalAccumulable
63 {
64 public:
65 LETAccumulable();
66 LETAccumulable(const LETAccumulable& other) = default;
67
68 // G4VAccumulable virtual methods to override
69 void Merge(const G4VAccumulable& rhs) override;
70 void Reset() override;
71
72 // Store information from a single step
73 void Accumulate(Hit* hit) override;
74
75 // Type alias for numerical arrays
76 using array_type = std::valarray<G4double>;
77
78 // Access to stored data (to be called on the merged data)
79 const array_type GetTotalLETT() const { return fTotalLETT; }
80 const array_type GetTotalLETD() const { return fTotalLETD; }
81 const array_type GetDTotalLETT() const { return fDTotalLETT; }
82 const array_type GetDTotalLETD() const { return fDTotalLETD; }
83
84 const std::vector<IonLet> GetIonLetStore() const { return fIonLetStore; }
85
86 // Verbosity, shared with LET
87 G4int GetVerboseLevel() const;
88
89 private:
90 // Apply configuration from the LET class and prepare matrices
91 void Initialize();
92 G4bool fInitialized{false};
93
94 array_type fTotalLETT = {};
95 array_type fTotalLETD = {};
96 array_type fDTotalLETT = {};
97 array_type fDTotalLETD = {};
98
99 std::vector<IonLet> fIonLetStore = {};
100 };
101
102 } // namespace RadioBio
103
104 #endif // LETACCUMULABLE_HH
105