Back to home page

EIC code displayed by LXR

 
 

    


Warning, file /geant4/examples/extended/hadronic/ParticleFluence/Layer/src/SteppingAction.cc was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

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::fkNumberScoringVolumes>
0047   SteppingAction::fkArrayScoringVolumeNames = {"downstream", "side", "upstream"};
0048 
0049 const std::array<G4String, SteppingAction::fkNumberKinematicRegions>
0050   SteppingAction::fkArrayKinematicRegionNames = {"", "below 20 MeV", "above 20 MeV"};
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 iScoringVolume, const G4int iKinematicRegion,
0060                                const G4int iParticleType)
0061 {
0062   G4int index = -1;
0063   if (iScoringVolume >= 0 && iScoringVolume < fkNumberScoringVolumes && iKinematicRegion >= 0
0064       && iKinematicRegion < fkNumberKinematicRegions && iParticleType >= 0
0065       && iParticleType < fkNumberParticleTypes)
0066   {
0067     index = iScoringVolume * fkNumberKinematicRegions * fkNumberParticleTypes
0068             + iKinematicRegion * 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   fIsFirstStepInScoringUpDown = true;
0096   fIsFirstStepInScoringSide = true;
0097   fCubicVolumeScoringUpDown = 1.0;
0098   fCubicVolumeScoringSide = 1.0;
0099   for (G4int i = 0; i < fkNumberCombinations; ++i) {
0100     fArraySumStepLengths[i] = 0.0;
0101   }
0102   /*
0103   for ( G4int i = 0; i < fkNumberCombinations; ++i ) fArraySumStepLengths[i] = 999.9;
0104   G4cout << " fkNumberCombinations=" << fkNumberCombinations << G4endl;
0105   for ( G4int i = 0; i < fkNumberScoringVolumes; ++i ) {
0106     for ( G4int j = 0; j < fkNumberKinematicRegions; ++j ) {
0107       for ( G4int k = 0; k < fkNumberParticleTypes; ++k ) {
0108         G4int index = GetIndex( i, j, k );
0109         G4cout << "(i, j, k)=(" << i << ", " << j << ", " << k << ")  ->" << index;
0110         if ( fArraySumStepLengths[ index ] < 1.0 ) G4cout << " <=== REPEATED!";
0111         else                                       fArraySumStepLengths[ index ] = 0.0;
0112         G4cout << G4endl;
0113       }
0114     }
0115   }
0116   for ( G4int i = 0; i < fkNumberCombinations; ++i ) {
0117     if ( fArraySumStepLengths[i] > 999.0 ) G4cout << " i=" << i << " NOT COVERED !" << G4endl;
0118   }
0119   */
0120 }
0121 
0122 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0123 
0124 void SteppingAction::UserSteppingAction(const G4Step* theStep)
0125 {
0126   // Get information on the primary particle
0127   if (fIsFirstStepOfTheEvent) {
0128     if (theStep->GetTrack()->GetParentID() == 0) {
0129       fPrimaryParticleId = theStep->GetTrack()->GetDefinition()->GetPDGEncoding();
0130       fPrimaryParticleEnergy = theStep->GetPreStepPoint()->GetKineticEnergy();
0131       fPrimaryParticleDirection = theStep->GetPreStepPoint()->GetMomentumDirection();
0132       if (fRunPtr) {
0133         fRunPtr->SetPrimaryParticleId(fPrimaryParticleId);
0134         fRunPtr->SetPrimaryParticleEnergy(fPrimaryParticleEnergy);
0135         fRunPtr->SetPrimaryParticleDirection(fPrimaryParticleDirection);
0136       }
0137       fIsFirstStepOfTheEvent = false;
0138     }
0139   }
0140   // Get information on the target material
0141   if (fIsFirstStepInTarget
0142       && theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiLayer")
0143   {
0144     fTargetMaterialName = theStep->GetPreStepPoint()->GetMaterial()->GetName();
0145     if (fRunPtr) fRunPtr->SetTargetMaterialName(fTargetMaterialName);
0146     fIsFirstStepInTarget = false;
0147   }
0148   // Get information on step lengths in the scoring volumes
0149   G4int iScoringVolume = -1;
0150   if (theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiScoringDownstream") {
0151     iScoringVolume = 0;
0152     if (fIsFirstStepInScoringUpDown) {
0153       fCubicVolumeScoringUpDown =
0154         theStep->GetTrack()->GetVolume()->GetLogicalVolume()->GetSolid()->GetCubicVolume();
0155       if (fRunPtr) fRunPtr->SetCubicVolumeScoringUpDown(fCubicVolumeScoringUpDown);
0156       fIsFirstStepInScoringUpDown = false;
0157     }
0158   }
0159   else if (theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiScoringSide") {
0160     iScoringVolume = 1;
0161     if (fIsFirstStepInScoringSide) {
0162       fCubicVolumeScoringSide =
0163         theStep->GetTrack()->GetVolume()->GetLogicalVolume()->GetSolid()->GetCubicVolume();
0164       if (fRunPtr) fRunPtr->SetCubicVolumeScoringSide(fCubicVolumeScoringSide);
0165       fIsFirstStepInScoringSide = false;
0166     }
0167   }
0168   else if (theStep->GetPreStepPoint()->GetPhysicalVolume()->GetName() == "physiScoringUpstream") {
0169     iScoringVolume = 2;
0170     if (fIsFirstStepInScoringUpDown) {
0171       fCubicVolumeScoringUpDown =
0172         theStep->GetTrack()->GetVolume()->GetLogicalVolume()->GetSolid()->GetCubicVolume();
0173       if (fRunPtr) fRunPtr->SetCubicVolumeScoringUpDown(fCubicVolumeScoringUpDown);
0174       fIsFirstStepInScoringUpDown = false;
0175     }
0176   }
0177   if (iScoringVolume >= 0) {
0178     // In the case of the upstream scoring volume, consider only particles whose direction
0179     // is opposite with respect to the primary particle (this is needed, in particular,
0180     // for avoiding to account the incoming, primary beam particle in the "upstream" fluence).
0181     if (iScoringVolume == 2
0182         && fPrimaryParticleDirection.dot(theStep->GetPreStepPoint()->GetMomentumDirection()) > 0.0)
0183     {
0184       return;
0185     }
0186     G4double stepLength = theStep->GetTrack()->GetStepLength() * theStep->GetTrack()->GetWeight();
0187     G4int absPdg = theStep->GetTrack()->GetDefinition() == nullptr
0188                      ? 0
0189                      : std::abs(theStep->GetTrack()->GetDefinition()->GetPDGEncoding());
0190     /*
0191     G4cout << std::setprecision(6)
0192            << theStep->GetTrack()->GetDefinition()->GetParticleName() << "  absPdg=" << absPdg
0193            << "  Ekin[MeV]=" << theStep->GetPreStepPoint()->GetKineticEnergy()
0194            << "  (rho,z)[mm]=(" << theStep->GetTrack()->GetPosition().perp()
0195            << "," << theStep->GetTrack()->GetPosition().z() << ")"
0196            << "  " << theStep->GetTrack()->GetVolume()->GetName()
0197            << "  " << theStep->GetTrack()->GetMaterial()->GetName()
0198            << "  L[mm]=" << stepLength << "  "
0199            << ( fPrimaryParticleDirection.dot(
0200                   theStep->GetPreStepPoint()->GetMomentumDirection() ) > 0.0
0201                 ? "forward" : "backward" )
0202            << G4endl;
0203     */
0204     // Three kinematical regions:  [0] : any value ;  [1] : below 20 MeV ;  [2] : above 20 MeV
0205     G4int iKinematicRegion = theStep->GetPreStepPoint()->GetKineticEnergy() < 20.0 ? 1 : 2;
0206     G4int iParticleType = -1;
0207     if (absPdg == 11)
0208       iParticleType = 1;  // electron (and positron)
0209     else if (absPdg == 22)
0210       iParticleType = 2;  // gamma
0211     else if (absPdg == 13)
0212       iParticleType = 3;  // muons (mu- and mu+)
0213     else if (absPdg == 12 || absPdg == 14 || absPdg == 16)
0214       iParticleType = 4;  // neutrinos
0215     //(and anti-neutrinos), all flavors
0216     else if (absPdg == 111 || absPdg == 211)
0217       iParticleType = 5;  // (charged) pions
0218     else if (absPdg == 2112)
0219       iParticleType = 6;  // neutron (and anti-neutron)
0220     else if (absPdg == 2212)
0221       iParticleType = 7;  // proton  (and anti-proton)
0222     else if (G4IonTable::IsIon(theStep->GetTrack()->GetDefinition()) ||  // ions (and anti-ions)
0223              G4IonTable::IsAntiIon(theStep->GetTrack()->GetDefinition()))
0224       iParticleType = 8;
0225     else if (absPdg < 1000)
0226       iParticleType = 9;  // other mesons (e.g. kaons) (Note: this works
0227                           //              in most cases, but not always!)
0228     else if (absPdg > 1000)
0229       iParticleType = 10;  // other baryons (e.g. hyperons, anti-hyperons,
0230                            // etc.)
0231     // Consider the specific case : scoring volume, kinematic region and particle type
0232     G4int index = GetIndex(iScoringVolume, iKinematicRegion, iParticleType);
0233     fArraySumStepLengths[index] += stepLength;
0234     // Consider the "all" particle case, with the same scoring volume and kinematic region
0235     index = GetIndex(iScoringVolume, iKinematicRegion, 0);
0236     fArraySumStepLengths[index] += stepLength;
0237     // Consider the "any" kinematic region case, with the same scoring volume and particle type
0238     index = GetIndex(iScoringVolume, 0, iParticleType);
0239     fArraySumStepLengths[index] += stepLength;
0240     // Consider the "any" kinematic region and "all" particle, with the same scoring volume
0241     index = GetIndex(iScoringVolume, 0, 0);
0242     fArraySumStepLengths[index] += stepLength;
0243     if (fRunPtr) fRunPtr->SetSteppingArray(fArraySumStepLengths);
0244   }
0245 }
0246 
0247 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......