| 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/DoseAccumulable.hh
27 /// \brief Definition of the RadioBio::DoseAccumulable class
28
29 #ifndef RadiobiologyDoseACCUMULABLE_HH
30 #define RadiobiologyDoseACCUMULABLE_HH
31
32 #include "VRadiobiologicalAccumulable.hh"
33 #include <G4VAccumulable.hh>
34
35 #include <valarray>
36 #include <vector>
37
38 namespace RadioBio
39 {
40
41 // Forward declariation of other radiobiology classes
42 class VoxelizedSensitiveDetector;
43
44 /**
45 * @brief Accumulable of Dose-related data (that must be thread-local).
46 *
47 * It keeps the energy deposit data divided in voxels for dose calculation
48 *
49 * This is implemented as a customized G4VAccumulable with non-scalar data.
50 *
51 * @note There are two levels of merging (accumulation):
52 * 1) From more threads in one run (G4VAccumulable merging is applied)
53 * 2) (Optional) inter-run merging of data (implemented in Dose).
54 *
55 * @note std::valarray is used (instead of C arrays or std::vectors)
56 * to accumulate data for its logical simplicity.
57 */
58 class DoseAccumulable : public VRadiobiologicalAccumulable
59 {
60 public:
61 DoseAccumulable();
62 DoseAccumulable(const DoseAccumulable& other) = default;
63
64 // G4VAccumulable virtual methods to override
65 void Merge(const G4VAccumulable& rhs) override;
66 void Reset() override;
67
68 // Store information from a single step
69 void Accumulate(Hit* hit) override;
70
71 // Type alias for numerical arrays
72 using array_type = std::valarray<G4double>;
73
74 // Access to stored data (to be called on the merged data)
75 const array_type GetEnDeposit() const { return fEnDep; }
76
77 // Verbosity, shared with Dose
78 G4int GetVerboseLevel() const;
79
80 private:
81 // Apply configuration from the Dose class and prepare matrices
82 void Initialize();
83 G4bool fInitialized = false;
84
85 array_type fEnDep;
86 };
87
88 } // namespace RadioBio
89
90 #endif // DoseACCUMULABLE_HH
91