Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-09-18 08:32:10

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