| 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 //
27 //
28 // G4PSCellFlux
29 #include "G4PSCellFlux.hh"
30
31 #include "G4SystemOfUnits.hh"
32 #include "G4Track.hh"
33 #include "G4VSolid.hh"
34 #include "G4VPhysicalVolume.hh"
35 #include "G4VPVParameterisation.hh"
36 #include "G4UnitsTable.hh"
37 #include "G4VScoreHistFiller.hh"
38
39 ///////////////////////////////////////////////////////////////////////////////
40 // (Description)
41 // This is a primitive scorer class for scoring cell flux.
42 // The Cell Flux is defined by a sum of track length divided
43 // by the geometry volume, where all of the tracks in the geometry
44 // are taken into account.
45 //
46 // If you want to score only tracks passing through the geometry volume,
47 // please use G4PSPassageCellFlux.
48 //
49 //
50 // Created: 2005-11-14 Tsukasa ASO, Akinori Kimura.
51 // 2010-07-22 Introduce Unit specification.
52 // 2010-07-22 Add weighted option
53 // 2020-10-06 Use G4VPrimitivePlotter and fill 1-D histo of kinetic energy (x)
54 // vs. cell flux * track weight (y) (Makoto Asai)
55 //
56 ///////////////////////////////////////////////////////////////////////////////
57
58 G4PSCellFlux::G4PSCellFlux(const G4String& name, G4int depth)
59 : G4PSCellFlux(name, "percm2", depth)
60 {}
61
62 G4PSCellFlux::G4PSCellFlux(const G4String& name, const G4String& unit, G4int depth)
63 : G4VPrimitivePlotter(name, depth)
64 , HCID(-1)
65 , EvtMap(nullptr)
66 , weighted(true)
67 {
68 DefineUnitAndCategory();
69 SetUnit(unit);
70 }
71
72 G4bool G4PSCellFlux::ProcessHits(G4Step* aStep, G4TouchableHistory*)
73 {
74 G4double stepLength = aStep->GetStepLength();
75 if(stepLength == 0.)
76 return false;
77
78 G4int idx = ((G4TouchableHistory*) (aStep->GetPreStepPoint()->GetTouchable()))
79 ->GetReplicaNumber(indexDepth);
80 G4double cubicVolume = ComputeVolume(aStep, idx);
81
82 G4double CellFlux = stepLength / cubicVolume;
83 if(weighted)
84 CellFlux *= aStep->GetPreStepPoint()->GetWeight();
85 G4int index = GetIndex(aStep);
86 EvtMap->add(index, CellFlux);
87
88 if(!hitIDMap.empty() && hitIDMap.find(index) != hitIDMap.end())
89 {
90 auto filler = G4VScoreHistFiller::Instance();
91 if(filler == nullptr)
92 {
93 G4Exception(
94 "G4PSCellFlux::ProcessHits", "SCORER0123", JustWarning,
95 "G4TScoreHistFiller is not instantiated!! Histogram is not filled.");
96 }
97 else
98 {
99 filler->FillH1(hitIDMap[index],
100 aStep->GetPreStepPoint()->GetKineticEnergy(), CellFlux);
101 }
102 }
103
104 return true;
105 }
106
107 void G4PSCellFlux::Initialize(G4HCofThisEvent* HCE)
108 {
109 EvtMap = new G4THitsMap<G4double>(detector->GetName(), GetName());
110 if(HCID < 0)
111 HCID = GetCollectionID(0);
112 HCE->AddHitsCollection(HCID, EvtMap);
113 }
114
115 void G4PSCellFlux::clear() { EvtMap->clear(); }
116
117 void G4PSCellFlux::PrintAll()
118 {
119 G4cout << " MultiFunctionalDet " << detector->GetName() << G4endl;
120 G4cout << " PrimitiveScorer " << GetName() << G4endl;
121 G4cout << " Number of entries " << EvtMap->entries() << G4endl;
122 for(const auto& [copy, flux]: *(EvtMap->GetMap()))
123 {
124 G4cout << " copy no.: " << copy
125 << " cell flux : " << *(flux) / GetUnitValue() << " ["
126 << GetUnit() << "]" << G4endl;
127 }
128 }
129
130 void G4PSCellFlux::SetUnit(const G4String& unit)
131 {
132 CheckAndSetUnit(unit, "Per Unit Surface");
133 }
134
135 void G4PSCellFlux::DefineUnitAndCategory()
136 {
137 // Per Unit Surface
138 new G4UnitDefinition("percentimeter2", "percm2", "Per Unit Surface",
139 (1. / cm2));
140 new G4UnitDefinition("permillimeter2", "permm2", "Per Unit Surface",
141 (1. / mm2));
142 new G4UnitDefinition("permeter2", "perm2", "Per Unit Surface", (1. / m2));
143 }
144
145 G4double G4PSCellFlux::ComputeVolume(G4Step* aStep, G4int idx)
146 {
147 G4VSolid* solid = ComputeSolid(aStep, idx);
148 assert(solid);
149 return solid->GetCubicVolume();
150 }
151