Sphere/src/SteppingAction.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 SteppingAction.cc
0027 /// \brief Implementation of the SteppingAction class
0028 //
0029 //
0030
0031 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0032 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0033
0034 #include "SteppingAction.hh"
0035
0036 #include "Run.hh"
0037
0038 #include "G4IonTable.hh"
0039 #include "G4LossTableManager.hh"
0040 #include "G4ParticleDefinition.hh"
0041 #include "G4ParticleTypes.hh"
0042 #include "G4Step.hh"
0043 #include "G4StepPoint.hh"
0044 #include "G4SystemOfUnits.hh"
0045 #include "G4TouchableHistory.hh"
0046 #include "G4Track.hh"
0047 #include "G4VPhysicalVolume.hh"
0048 #include "G4VSolid.hh"
0049 #include "G4VTouchable.hh"
0050
0051 const std::array<G4String, SteppingAction::fkNumberKinematicRegions>
0052   SteppingAction::fkArrayKinematicRegionNames = {"", "below 20 MeV", "above 20 MeV"};
0053
0054 const std::array<G4String, SteppingAction::fkNumberScoringPositions>
0055   SteppingAction::fkArrayScoringPositionNames = {"forward", "backward"};
0056
0057 const std::array<G4String, SteppingAction::fkNumberParticleTypes>
0058   SteppingAction::fkArrayParticleTypeNames = {"all",      "electron",   "gamma",      "muon",
0059                                               "neutrino", "pion",       "neutron",    "proton",
0060                                               "ion",      "otherMeson", "otherBaryon"};
0061
0062 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0063
0064 G4int SteppingAction::GetIndex(const G4int iKinematicRegion, const G4int iScoringPosition,
0065                                const G4int iParticleType)
0066 {
0067   G4int index = -1;
0068   if (iKinematicRegion >= 0 && iKinematicRegion < fkNumberKinematicRegions && iScoringPosition >= 0
0069       && iScoringPosition < fkNumberScoringPositions && iParticleType >= 0
0070       && iParticleType < fkNumberParticleTypes)
0071   {
0072     index = iKinematicRegion * fkNumberScoringPositions * fkNumberParticleTypes
0073             + iScoringPosition * fkNumberParticleTypes + iParticleType;
0074   }
0075   if (index < 0 || index >= fkNumberCombinations) {
0076     G4cerr << "SteppingAction::GetIndex : WRONG index=" << index << "  set it to 0 !" << G4endl;
0077     index = 0;
0078   }
0079   return index;
0080 }
0081
0082 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0083
0084 SteppingAction::SteppingAction() : G4UserSteppingAction()
0085 {
0086   Initialize();
0087 }
0088
0089 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0090
0091 void SteppingAction::Initialize()
0092 {
0093   // Initialization needed at the beginning of each Run
0094   fPrimaryParticleId = 0;
0095   fPrimaryParticleEnergy = 0.0;
0096   fPrimaryParticleDirection = G4ThreeVector(0.0, 0.0, 1.0);
0097   fTargetMaterialName = "";
0098   fIsFirstStepOfTheEvent = true;
0099   fIsFirstStepInTarget = true;
0100   fIsFirstStepInScoringShell = true;
0101   fCubicVolumeScoringShell = 1.0;
0102   for (G4int i = 0; i < fkNumberCombinations; ++i) {
0103     fArraySumStepLengths[i] = 0.0;
0104   }
0105   /*
0106   for ( G4int i = 0; i < fkNumberCombinations; ++i ) fArraySumStepLengths[i] = 999.9;
0107   G4cout << " fkNumberCombinations=" << fkNumberCombinations << G4endl;
0108   for ( G4int i = 0; i < fkNumberKinematicRegions; ++i ) {
0109     for ( G4int j = 0; j < fkNumberScoringPositions; ++j ) {
0110       for ( G4int k = 0; k < fkNumberParticleTypes; ++k ) {
0111         G4int index = GetIndex( i, j, k );
0112         G4cout << "(i, j, k)=(" << i << ", " << j << ", " << k << ")  ->" << index;
0113         if ( fArraySumStepLengths[ index ] < 1.0 ) G4cout << " <=== REPEATED!";
0114         else                                       fArraySumStepLengths[ index ] = 0.0;
0115         G4cout << G4endl;
0116       }
0117     }
0118   }
0119   for ( G4int i = 0; i < fkNumberCombinations; ++i ) {
0120     if ( fArraySumStepLengths[i] > 999.0 ) G4cout << " i=" << i << " NOT COVERED !" << G4endl;
0121   }
0122   */
0123 }
0124
0125 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0126
0127 void SteppingAction::UserSteppingAction(const G4Step* theStep)
0128 {
0129   // Get information on the primary particle
0130   if (fIsFirstStepOfTheEvent) {
0131     if (theStep->GetTrack()->GetParentID() == 0) {
0132       fPrimaryParticleId = theStep->GetTrack()->GetDefinition()->GetPDGEncoding();
0133       fPrimaryParticleEnergy = theStep->GetPreStepPoint()->GetKineticEnergy();
0134       fPrimaryParticleDirection = theStep->GetPreStepPoint()->GetMomentumDirection();
0135       if (fRunPtr) {
0136         fRunPtr->SetPrimaryParticleId(fPrimaryParticleId);
0137         fRunPtr->SetPrimaryParticleEnergy(fPrimaryParticleEnergy);
0138         fRunPtr->SetPrimaryParticleDirection(fPrimaryParticleDirection);
0139       }
0140       fIsFirstStepOfTheEvent = false;
0141     }
0142   }
0143   // Get information on the target material
0144   if (fIsFirstStepInTarget
0145       && theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiSphere")
0146   {
0147     fTargetMaterialName = theStep->GetPreStepPoint()->GetMaterial()->GetName();
0148     if (fRunPtr) fRunPtr->SetTargetMaterialName(fTargetMaterialName);
0149     fIsFirstStepInTarget = false;
0150   }
0151   // Get information on step lengths in the scoring shell
0152   if (theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiScoringShell") {
0153     if (fIsFirstStepInScoringShell) {
0154       fCubicVolumeScoringShell =
0155         theStep->GetTrack()->GetVolume()->GetLogicalVolume()->GetSolid()->GetCubicVolume();
0156       if (fRunPtr) fRunPtr->SetCubicVolumeScoringShell(fCubicVolumeScoringShell);
0157       fIsFirstStepInScoringShell = false;
0158     }
0159     G4double stepLength = theStep->GetTrack()->GetStepLength() * theStep->GetTrack()->GetWeight();
0160     G4int absPdg = theStep->GetTrack()->GetDefinition() == nullptr
0161                      ? 0
0162                      : std::abs(theStep->GetTrack()->GetDefinition()->GetPDGEncoding());
0163     /*
0164     G4cout << theStep->GetTrack()->GetDefinition()->GetParticleName() << "  absPdg=" << absPdg
0165            << "  Ekin[MeV]=" << theStep->GetPreStepPoint()->GetKineticEnergy()
0166            << "  r[mm]=" << theStep->GetTrack()->GetPosition().mag()
0167            << "  z[mm]=" << theStep->GetTrack()->GetPosition().z()
0168            << "  " << theStep->GetTrack()->GetVolume()->GetName()
0169            << "  " << theStep->GetTrack()->GetMaterial()->GetName()
0170            << "  L[mm]=" << stepLength << "  "
0171            << ( fPrimaryParticleDirection.dot( theStep->GetTrack()->GetPosition().unit() ) > 0.0
0172                 ? "forward" : "backward" ) << G4endl;
0173     */
0174     // Three kinematical regions:  [0] : any value ;  [1] : below 20 MeV ;  [2] : above 20 MeV
0175     G4int iKinematicRegion = theStep->GetPreStepPoint()->GetKineticEnergy() < 20.0 ? 1 : 2;
0176     // Two scoring positions:  [0] : forward hemisphere ;  [1] : backward hemisphere
0177     // (with respect to the primary particle initial direction)
0178     G4int iScoringPosition =
0179       fPrimaryParticleDirection.dot(theStep->GetTrack()->GetPosition().unit()) > 0.0 ? 0 : 1;
0180     G4int iParticleType = -1;
0181     if (absPdg == 11)
0182       iParticleType = 1;  // electron (and positron)
0183     else if (absPdg == 22)
0184       iParticleType = 2;  // gamma
0185     else if (absPdg == 13)
0186       iParticleType = 3;  // muons (mu- and mu+)
0187     else if (absPdg == 12 || absPdg == 14 || absPdg == 16)
0188       iParticleType = 4;  // neutrinos (and
0189                           // anti-neutrinos), all flavors
0190     else if (absPdg == 111 || absPdg == 211)
0191       iParticleType = 5;  // (charged) pions
0192     else if (absPdg == 2112)
0193       iParticleType = 6;  // neutron (and anti-neutron)
0194     else if (absPdg == 2212)
0195       iParticleType = 7;  // proton  (and anti-proton)
0196     else if (G4IonTable::IsIon(theStep->GetTrack()->GetDefinition()) ||  // ions (and anti-ions)
0197              G4IonTable::IsAntiIon(theStep->GetTrack()->GetDefinition()))
0198       iParticleType = 8;
0199     else if (absPdg < 1000)
0200       iParticleType = 9;  // other mesons (e.g. kaons) (Note: this works
0201                           // in most cases, but not always!)
0202     else if (absPdg > 1000)
0203       iParticleType = 10;  // other baryons (e.g. hyperons, anti-hyperons,
0204                            // etc.)
0205     // Consider the specific case : kinematic region, scoring position, and particle type
0206     G4int index = GetIndex(iKinematicRegion, iScoringPosition, iParticleType);
0207     fArraySumStepLengths[index] += stepLength;
0208     // Consider the "all" particle case, with the same kinematic region and scoring position
0209     index = GetIndex(iKinematicRegion, iScoringPosition, 0);
0210     fArraySumStepLengths[index] += stepLength;
0211     // Consider the "any" kinematic region case, with the same scoring position and particle type
0212     index = GetIndex(0, iScoringPosition, iParticleType);
0213     fArraySumStepLengths[index] += stepLength;
0214     // Consider the "any" kinematic region and "all" particle, with the same scoring position
0215     index = GetIndex(0, iScoringPosition, 0);
0216     fArraySumStepLengths[index] += stepLength;
0217     if (fRunPtr) fRunPtr->SetSteppingArray(fArraySumStepLengths);
0218   }
0219 }
0220
0221 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......