Layer/src/TrackingAction.cc

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /// \file TrackingAction.cc
0027 /// \brief Implementation of the TrackingAction class
0028
0029 #include "TrackingAction.hh"
0030
0031 #include "Run.hh"
0032
0033 #include "G4IonTable.hh"
0034 #include "G4ParticleDefinition.hh"
0035 #include "G4ParticleTypes.hh"
0036 #include "G4Step.hh"
0037 #include "G4StepPoint.hh"
0038 #include "G4SystemOfUnits.hh"
0039 #include "G4Track.hh"
0040
0041 const std::array<G4String, TrackingAction::fkNumberScoringVolumes>
0042   TrackingAction::fkArrayScoringVolumeNames = {"layer"};
0043
0044 const std::array<G4String, TrackingAction::fkNumberKinematicRegions>
0045   TrackingAction::fkArrayKinematicRegionNames = {"", "below 20 MeV", "above 20 MeV"};
0046
0047 const std::array<G4String, TrackingAction::fkNumberParticleTypes>
0048   TrackingAction::fkArrayParticleTypeNames = {"all",      "electron",   "gamma",      "muon",
0049                                               "neutrino", "pion",       "neutron",    "proton",
0050                                               "ion",      "otherMeson", "otherBaryon"};
0051
0052 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0053
0054 G4int TrackingAction::GetIndex(const G4int iScoringVolume, const G4int iKinematicRegion,
0055                                const G4int iParticleType)
0056 {
0057   G4int index = -1;
0058   if (iScoringVolume >= 0 && iScoringVolume < fkNumberScoringVolumes && iKinematicRegion >= 0
0059       && iKinematicRegion < fkNumberKinematicRegions && iParticleType >= 0
0060       && iParticleType < fkNumberParticleTypes)
0061   {
0062     index = iScoringVolume * fkNumberKinematicRegions * fkNumberParticleTypes
0063             + iKinematicRegion * fkNumberParticleTypes + iParticleType;
0064   }
0065   return index;
0066 }
0067
0068 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0069
0070 TrackingAction::TrackingAction() : G4UserTrackingAction()
0071 {
0072   Initialize();
0073 }
0074
0075 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0076
0077 void TrackingAction::Initialize()
0078 {
0079   // Initialization needed at the beginning of each Run
0080   fArrayMultiplicities.fill(0);
0081   fArraySumKineticEnergies.fill(0.0);
0082 }
0083
0084 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0085
0086 void TrackingAction::PreUserTrackingAction(const G4Track* aTrack)
0087 {
0088   // This method is called not only once when a particle is created,
0089   // but also each time it is resumed, in the case the track gets suspended,
0090   // as it happens in the case of neutrons with _HP Physics Lists.
0091   // To be sure that we collect information about a track one and only once,
0092   // we require that the current step be the first one.
0093   if (aTrack == nullptr || aTrack->GetCurrentStepNumber() != 0 || aTrack->GetDefinition() == nullptr
0094       || aTrack->GetLogicalVolumeAtVertex() == nullptr
0095       || aTrack->GetLogicalVolumeAtVertex()->GetName() != "logicLayer")
0096     return;
0097   G4int iScoringVolume = 0;
0098   // Three kinematical regions:  [0] : any value ;  [1] : below 20 MeV ;  [2] : above 20 MeV
0099   G4int iKinematicRegion = aTrack->GetKineticEnergy() < 20.0 ? 1 : 2;
0100   G4int absPdg = std::abs(aTrack->GetDefinition()->GetPDGEncoding());
0101   G4int iParticleType = -1;
0102   if (absPdg == 11)
0103     iParticleType = 1;  // electron (and positron)
0104   else if (absPdg == 22)
0105     iParticleType = 2;  // gamma
0106   else if (absPdg == 13)
0107     iParticleType = 3;  // muons (mu- and mu+)
0108   else if (absPdg == 12 || absPdg == 14 || absPdg == 16)
0109     iParticleType = 4;
0110   // neutrinos (and anti-neutrinos), all flavors
0111   else if (absPdg == 111 || absPdg == 211)
0112     iParticleType = 5;  // (charged) pions
0113   else if (absPdg == 2112)
0114     iParticleType = 6;  // neutron (and anti-neutron)
0115   else if (absPdg == 2212)
0116     iParticleType = 7;  // proton  (and anti-proton)
0117   else if (G4IonTable::IsIon(aTrack->GetDefinition())
0118            || G4IonTable::IsAntiIon(aTrack->GetDefinition()))
0119     iParticleType = 8;
0120   // ions (and anti-ions)
0121   else if (absPdg < 1000)
0122     iParticleType = 9;  // other mesons (e.g. kaons)
0123   // (Note: this works in most cases, but not always!)
0124   else if (absPdg > 1000)
0125     iParticleType = 10;  // other baryons (e.g. hyperons,
0126                          // anti-hyperons, etc.)
0127   // Consider the specific case : scoring volume, kinematic region and particle type
0128   G4int index = GetIndex(iScoringVolume, iKinematicRegion, iParticleType);
0129   ++fArrayMultiplicities[index];
0130   fArraySumKineticEnergies[index] += aTrack->GetKineticEnergy();
0131   // Consider the "all" particle case, with the same scoring volume and kinematic region
0132   index = GetIndex(iScoringVolume, iKinematicRegion, 0);
0133   ++fArrayMultiplicities[index];
0134   fArraySumKineticEnergies[index] += aTrack->GetKineticEnergy();
0135   // Consider the "any" kinematic region case, with the same scoring volume and particle type
0136   index = GetIndex(iScoringVolume, 0, iParticleType);
0137   ++fArrayMultiplicities[index];
0138   fArraySumKineticEnergies[index] += aTrack->GetKineticEnergy();
0139   // Consider the "any" kinematic region and "all" particle, with the same scoring volume
0140   index = GetIndex(iScoringVolume, 0, 0);
0141   ++fArrayMultiplicities[index];
0142   fArraySumKineticEnergies[index] += aTrack->GetKineticEnergy();
0143   if (fRunPtr) {
0144     fRunPtr->SetTrackingArray1(fArrayMultiplicities);
0145     fRunPtr->SetTrackingArray2(fArraySumKineticEnergies);
0146   }
0147 }
0148
0149 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0150
0151 void TrackingAction::PostUserTrackingAction(const G4Track* /* aTrack  */) {}
0152
0153 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......