Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/digits_hits/scorer/src/G4PSTrackLength.cc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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 // G4PSTrackLength
 29 #include "G4PSTrackLength.hh"
 30 #include "G4SystemOfUnits.hh"
 31 #include "G4UnitsTable.hh"
 32 ////////////////////////////////////////////////////////////////////////////////
 33 // (Description)
 34 //   This is a primitive scorer class for scoring sum of track length.
 35 //
 36 //
 37 // Created: 2007-02-02  Tsukasa ASO, Akinori Kimura.
 38 //          2010-07-22  Introduce Unit specification.
 39 //          2011-09-09  Modify comment in PrintAll().
 40 //
 41 ///////////////////////////////////////////////////////////////////////////////
 42 
 43 G4PSTrackLength::G4PSTrackLength(const G4String& name, G4int depth)
 44   : G4PSTrackLength(name, "mm", depth)
 45 {}
 46 
 47 G4PSTrackLength::G4PSTrackLength(const G4String& name, const G4String& unit,
 48                                  G4int depth)
 49   : G4VPrimitiveScorer(name, depth)
 50   , HCID(-1)
 51   , EvtMap(nullptr)
 52   , weighted(false)
 53   , multiplyKinE(false)
 54   , divideByVelocity(false)
 55 {
 56   DefineUnitAndCategory();
 57   SetUnit(unit);
 58 }
 59 
 60 void G4PSTrackLength::MultiplyKineticEnergy(G4bool flg)
 61 {
 62   multiplyKinE = flg;
 63   // Default unit is set according to flags.
 64   SetUnit("");
 65 }
 66 
 67 void G4PSTrackLength::DivideByVelocity(G4bool flg)
 68 {
 69   divideByVelocity = flg;
 70   // Default unit is set according to flags.
 71   SetUnit("");
 72 }
 73 
 74 G4bool G4PSTrackLength::ProcessHits(G4Step* aStep, G4TouchableHistory*)
 75 {
 76   G4double trklength = aStep->GetStepLength();
 77   if(trklength == 0.)
 78     return false;
 79   if(weighted)
 80     trklength *= aStep->GetPreStepPoint()->GetWeight();
 81   if(multiplyKinE)
 82     trklength *= aStep->GetPreStepPoint()->GetKineticEnergy();
 83   if(divideByVelocity)
 84     trklength /= aStep->GetPreStepPoint()->GetVelocity();
 85   G4int index = GetIndex(aStep);
 86   EvtMap->add(index, trklength);
 87   return true;
 88 }
 89 
 90 void G4PSTrackLength::Initialize(G4HCofThisEvent* HCE)
 91 {
 92   EvtMap = new G4THitsMap<G4double>(detector->GetName(), GetName());
 93   if(HCID < 0)
 94   {
 95     HCID = GetCollectionID(0);
 96   }
 97   HCE->AddHitsCollection(HCID, (G4VHitsCollection*) EvtMap);
 98 }
 99 
100 void G4PSTrackLength::clear() { EvtMap->clear(); }
101 
102 void G4PSTrackLength::PrintAll()
103 {
104   G4cout << " MultiFunctionalDet  " << detector->GetName() << G4endl;
105   G4cout << " PrimitiveScorer " << GetName() << G4endl;
106   G4cout << " Number of entries " << EvtMap->entries() << G4endl;
107   for(const auto& [copy, length] : *(EvtMap->GetMap()))
108   {
109     G4cout << "  copy no.: " << copy;
110     if(multiplyKinE)
111     {
112       if(divideByVelocity)
113         G4cout << " EnergyFlux: ";
114       else
115         G4cout << " EnergyFlow: ";
116     }
117     else
118     {
119       if(divideByVelocity)
120         G4cout << " Time: ";
121       else
122         G4cout << " Length: ";
123     }
124     G4cout << *(length) / GetUnitValue() << " [" << GetUnit() << "]";
125     G4cout << G4endl;
126   }
127 }
128 
129 void G4PSTrackLength::SetUnit(const G4String& unit)
130 {
131   if(multiplyKinE)
132   {
133     if(divideByVelocity)
134     {
135       if(unit.empty())
136       {
137         CheckAndSetUnit("MeV_second", "EnergyFlux");
138       }
139       else
140       {
141         CheckAndSetUnit(unit, "EnergyFlux");
142       }
143     }
144     else
145     {
146       if(unit.empty())
147       {
148         CheckAndSetUnit("MeV_mm", "EnergyFlow");
149       }
150       else
151       {
152         CheckAndSetUnit(unit, "EnergyFlow");
153       }
154     }
155   }
156   else
157   {
158     if(divideByVelocity)
159     {
160       if(unit.empty())
161       {
162         CheckAndSetUnit("second", "Time");
163       }
164       else
165       {
166         CheckAndSetUnit(unit, "Time");
167       }
168     }
169     else
170     {
171       if(unit.empty())
172       {
173         CheckAndSetUnit("mm", "Length");
174       }
175       else
176       {
177         CheckAndSetUnit(unit, "Length");
178       }
179     }
180   }
181 }
182 
183 void G4PSTrackLength::DefineUnitAndCategory()
184 {
185   // EnergyFlux
186   new G4UnitDefinition("eV_second", "eV_s", "EnergyFlux", (eV * second));
187   new G4UnitDefinition("keV_second", "keV_s", "EnergyFlux", (keV * second));
188   new G4UnitDefinition("MeV_second", "MeV_s", "EnergyFlux", (MeV * second));
189   new G4UnitDefinition("eV_millisecond", "eV_ms", "EnergyFlux", (eV * ms));
190   new G4UnitDefinition("keV_millisecond", "keV_ms", "EnergyFlux", (keV * ms));
191   new G4UnitDefinition("MeV_millisecond", "MeV_ms", "EnergyFlux", (MeV * ms));
192   // EnergyFlow
193   new G4UnitDefinition("eV_millimeter", "eV_mm", "EnergyFlow", (eV * mm));
194   new G4UnitDefinition("keV_millimeter", "keV_mm", "EnergyFlow", (keV * mm));
195   new G4UnitDefinition("MeV_millimeter", "MeV_mm", "EnergyFlow", (MeV * mm));
196   new G4UnitDefinition("eV_centimeter", "eV_cm", "EnergyFlow", (eV * cm));
197   new G4UnitDefinition("keV_centimeter", "keV_cm", "EnergyFlow", (keV * cm));
198   new G4UnitDefinition("MeV_centimeter", "MeV_cm", "EnergyFlow", (MeV * cm));
199   new G4UnitDefinition("eV_meter", "eV_m", "EnergyFlow", (eV * m));
200   new G4UnitDefinition("keV_meter", "keV_m", "EnergyFlow", (keV * m));
201   new G4UnitDefinition("MeV_meter", "MeV_m", "EnergyFlow", (MeV * m));
202 }
203