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