Update benchmark example (apt-sim#314)

Author: JuanGonzalezCaminero

examples/Example1/macros/example1_ttbar.mac.in

@@ -25,7 +25,7 @@
 ## Total number of GPU track slots (not per thread)
 /adept/setMillionsOfTrackSlots 8
 /adept/setMillionsOfHitSlots 1
-# /adept/setCUDAStackLimit 4096
+# /adept/setCUDAStackLimit 8192
 
 # If true, particles are transported on the GPU across the whole geometry, GPU regions are ignored
 /adept/setTrackInAllRegions true

examples/IntegrationBenchmark/CMakeLists.txt

@@ -1,6 +1,8 @@
 # SPDX-FileCopyrightText: 2023 CERN
 # SPDX-License-Identifier: Apache-2.0
 
+SET(CMAKE_EXE_LINKER_FLAGS "-Wl,--disable-new-dtags")
+
 if(NOT TARGET G4HepEm::g4HepEm)
   message(STATUS "Disabling integrationBenchmark (needs G4HepEm)")
   return()
@@ -67,3 +69,6 @@ target_link_libraries(integrationBenchmark
 configure_file("macros/integrationbenchmark.mac.in" "${CMAKE_BINARY_DIR}/integrationbenchmark.mac")
 
 # Tests
+add_test(NAME integrationBenchmark
+  COMMAND $<TARGET_FILE:integrationBenchmark> -m ${PROJECT_BINARY_DIR}/example1_large_stack.mac
+)

examples/IntegrationBenchmark/include/DetectorConstruction.hh

@@ -5,7 +5,6 @@
 #define DETECTORCONSTRUCTION_H
 
 #include "G4VUserDetectorConstruction.hh"
-#include "G4SystemOfUnits.hh"
 #include "G4Material.hh"
 #include "G4ThreeVector.hh"
 
@@ -31,7 +30,7 @@ class DetectorMessenger;
 
 class DetectorConstruction : public G4VUserDetectorConstruction {
 public:
-  DetectorConstruction();
+  DetectorConstruction(bool allSensitive = false);
   virtual ~DetectorConstruction();
 
   virtual G4VPhysicalVolume *Construct() final;
@@ -58,6 +57,7 @@ private:
   G4ThreeVector fMagFieldVector;
 
   G4GDMLParser fParser;
+  bool fAllSensitive;
 };
 
 #endif /* DETECTORCONSTRUCTION_H */

examples/IntegrationBenchmark/include/EventAction.hh

@@ -31,6 +31,8 @@
 #include "G4UserEventAction.hh"
 #include "G4Timer.hh"
 
+#include "RunAction.hh"
+
 class DetectorConstruction;
 class EventActionMessenger;
 
@@ -45,7 +47,7 @@ class EventActionMessenger;
 
 class EventAction : public G4UserEventAction {
 public:
-  EventAction();
+  EventAction(RunAction *aRunAction);
   virtual ~EventAction();
 
   /// Timer is started
@@ -69,6 +71,7 @@ private:
   G4Timer fTimer;
   /// Messenger for this
   EventActionMessenger *fMessenger{nullptr};
+  RunAction *fRunAction{nullptr};
 };
 
 #endif /* EVENTACTION_HH */

examples/IntegrationBenchmark/include/Run.hh

@@ -6,6 +6,8 @@
 
 #include "G4Run.hh"
 
+#include "RunAction.hh"
+
 #define TAG_TYPE int
 
 template <class TTag>
@@ -17,20 +19,16 @@ class TestManager;
 class Run : public G4Run {
 
 public:
-  Run();
+  Run(RunAction *aRunAction);
   ~Run();
 
   /** @brief Merge the results of the worker threads */
   void Merge(const G4Run *run) override;
 
   TestManager<TAG_TYPE> *GetTestManager() const { return fTestManager; }
-  void SetDoBenchmark(bool aDoBenchmark) { fDoBenchmark = aDoBenchmark; }
-  bool GetDoBenchmark() { return fDoBenchmark; }
-  void SetDoValidation(bool aDoValidation) { fDoValidation = aDoValidation; }
-  bool GetDoValidation() { return fDoValidation; }
 
   /** @brief Compute and display collected metrics */
-  void EndOfRunSummary(G4String aOutputDirectory, G4String aOutputFilename);
+  void EndOfRunSummary(G4String aOutputDirectory, G4String aOutputFilenam);
 
   /**
    * @brief Enum defining the timers that we can use for benchmarking
@@ -66,8 +64,7 @@ public:
 
 private:
   TestManager<TAG_TYPE> *fTestManager;
-  bool fDoBenchmark;
-  bool fDoValidation;
+  RunAction *fRunAction;
 };
 
 #endif

examples/IntegrationBenchmark/include/RunAction.hh

@@ -58,6 +58,11 @@ public:
 
   G4Run *GenerateRun() override;
 
+  bool &GetDoBenchmark(){return fDoBenchmark;};
+  bool &GetDoValidation(){return fDoValidation;};
+  const G4String &GetOutputDirectory(){return fOutputDirectory;};
+  const G4String &GetOutputFilename(){return fOutputFilename;};
+
 private:
   /// Pointer to detector construction to retrieve the detector dimensions to
   /// setup the histograms

examples/IntegrationBenchmark/include/SensitiveDetector.hh

@@ -32,7 +32,6 @@
 #include <set>
 #include "SimpleHit.hh"
 
-#include "G4VFastSimSensitiveDetector.hh"
 #include "G4VSensitiveDetector.hh"
 #include <set>
 
@@ -43,13 +42,6 @@ class G4TouchableHistory;
  * @brief Sensitive detector.
  *
  * Describes how to store the energy deposited within the detector.
- * It derives from two classes: G4VSensitiveDetector and
- * G4VFastSimSensitiveDetector. Addition of G4VFastSimSensitiveDetector is
- * necessary in order to handle the energy deposits from the fast simulation.
- *
- * Two ProcessHits() methods are introduced to handle energy deposited from full
- * (detailed) simulation, and from fast simulation. The common part is handled
- * by RetrieveAdnSetupHit() method.
  *
  */
 class G4VPhysicalVolume;

examples/IntegrationBenchmark/include/SimpleHit.hh

@@ -84,11 +84,14 @@ public:
   inline void SetType(G4int aType) { fType = aType; }
   /// Get type (0 = full sim, 1 = fast sim)
   inline G4int GetType() const { return fType; }
-
   /// Set PhysicalVolumeName
   inline void SetPhysicalVolumeName(G4String aPhysicalVolumeName) { fPhysicalVolumeName = aPhysicalVolumeName; }
   /// Get PhysicalVolumeName
   inline G4String GetPhysicalVolumeName() const { return fPhysicalVolumeName; }
+  /// Set PhysicalVolumeId
+  inline void SetPhysicalVolumeId(G4int aPhysicalVolumeId) { fPhysicalVolumeId = aPhysicalVolumeId; }
+  /// Get PhysicalVolumeId
+  inline G4int GetPhysicalVolumeId() const { return fPhysicalVolumeId; }
 
 public:
   /// Energy deposit
@@ -101,6 +104,7 @@ public:
   G4int fType = -1;
   /// These hits will be associated to PhysicalVolumes
   G4String fPhysicalVolumeName = "";
+  G4int fPhysicalVolumeId = -1;
 };
 
 typedef G4THitsCollection<SimpleHit> SimpleHitsCollection;

examples/IntegrationBenchmark/include/SteppingAction.hh

@@ -15,15 +15,13 @@ class TrackingAction;
 class SteppingAction : public G4UserSteppingAction {
 
 public:
-  SteppingAction(TrackingAction *aTrackingAction, bool aDoBenchmark);
+  SteppingAction();
   ~SteppingAction() override;
   void UserSteppingAction(const G4Step *step) override;
   void SetNumSteps(int aNumSteps) { fNumSteps = aNumSteps; }
 
 private:
-  TrackingAction *fTrackingAction;
   int fNumSteps{0};
-  bool fDoBenchmark{false};
 };
 
 #endif

examples/IntegrationBenchmark/include/TrackingAction.hh

@@ -24,7 +24,6 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-/// \file electromagnetic/TestEm1/include/TrackingAction.hh
 /// \brief Definition of the TrackingAction class
 //
 //
@@ -51,21 +50,9 @@ public:
   virtual void PreUserTrackingAction(const G4Track *);
   virtual void PostUserTrackingAction(const G4Track *);
 
-  void setInsideEcal(bool insideEcal) { fInsideEcal = insideEcal; }
-  bool getInsideEcal() { return fInsideEcal; }
-
-  inline G4Region *getGPURegion() { return fGPURegion; }
-  inline G4Region *getCurrentRegion() { return fCurrentRegion; }
-  inline void setCurrentRegion(G4Region *aCurrentRegion) { fCurrentRegion = aCurrentRegion; }
-  inline G4VPhysicalVolume *getCurrentVolume() { return fCurrentVolume; }
-  inline void setCurrentVolume(G4VPhysicalVolume *aCurrentVolume) { fCurrentVolume = aCurrentVolume; }
   inline void setSteppingAction(SteppingAction *aSteppingAction) { fSteppingAction = aSteppingAction; }
 
 private:
-  bool fInsideEcal;
-  G4Region *fCurrentRegion;
-  G4VPhysicalVolume *fCurrentVolume;
-  G4Region *fGPURegion;
   SteppingAction *fSteppingAction;
 };
 

examples/IntegrationBenchmark/integrationBenchmark.cpp

@@ -16,8 +16,6 @@
 #include "G4UIExecutive.hh"
 #include <sstream>
 
-#include <AdePT/integration/AdePTTrackingManager.hh>
-
 int main(int argc, char **argv)
 {
   // Macro name from arguments
@@ -28,6 +26,8 @@ int main(int argc, char **argv)
   bool doValidation         = false;
   G4bool useInteractiveMode = true;
   G4bool useAdePT           = true;
+  G4bool allSensitive = false; // If set, ignores the sensitive detector flags in the GDML and marks all volumes as
+                               // sensitive. Useful for validation of geometries with no SD info
   G4String helpMsg("Usage: " + G4String(argv[0]) +
                    " [option(s)] \n No additional arguments triggers an interactive mode "
                    "executing vis.mac macro. \n Options:\n\t-h\t\tdisplay this help "
@@ -50,9 +50,11 @@ int main(int argc, char **argv)
     } else if (argument == "--do_benchmark") {
       doBenchmark = true;
     } else if (argument == "--do_validation") {
-      doValidation = true;    
-    } else if (argument == "--no_AdePT") {
+      doValidation = true;
+    } else if (argument == "--noadept") {
       useAdePT = false;
+    } else if (argument == "--allsensitive") {
+      allSensitive = true;
     } else {
       G4Exception("main", "Unknown argument", FatalErrorInArgument,
                   ("Unknown argument passed to " + G4String(argv[0]) + " : " + argument + "\n" + helpMsg).c_str());
@@ -65,44 +67,42 @@ int main(int argc, char **argv)
         "The options --do_benchmark and --do_validation are mutually exclusive! --do_benchmark will be ignored");
   }
   if (!doBenchmark && !doValidation) {
-    G4Exception(
-        "main()", "Notification", JustWarning,
-        "Testing is enabled but no option has been selected, data will not be collected for this run.\n"
-        "Available options are:\n"
-        "--do_benchmark\n"
-        "--do_validation");
+    G4Exception("main()", "Notification", JustWarning,
+                "Testing is enabled but no option has been selected, data will not be collected for this run.\n"
+                "Available options are:\n"
+                "--do_benchmark\n"
+                "--do_validation");
   }
 
   // Initialization of default Run manager
   auto *runManager = G4RunManagerFactory::CreateRunManager(G4RunManagerType::Default);
-  //auto *runManager = G4RunManagerFactory::CreateRunManager(G4RunManagerType::Serial);
+  // auto *runManager = G4RunManagerFactory::CreateRunManager(G4RunManagerType::Serial);
 
   // Detector geometry:
-  auto detector = new DetectorConstruction();
+  auto detector = new DetectorConstruction(allSensitive);
   runManager->SetUserInitialization(detector);
 
- // Physics list
- //
- G4VUserPhysicsList *physicsList;
+  // Physics list
+  //
+  G4VUserPhysicsList *physicsList;
 
- if(useAdePT){
-  physicsList = new FTFP_BERT_AdePT();
- }
- else{
-  physicsList = new FTFP_BERT_HepEm();
- }
+  if (useAdePT) {
+    physicsList = new FTFP_BERT_AdePT();
+  } else {
+    physicsList = new FTFP_BERT_HepEm();
+  }
 
- runManager->SetUserInitialization(physicsList);
+  runManager->SetUserInitialization(physicsList);
 
- // reduce verbosity of physics lists
- G4EmParameters::Instance()->SetVerbose(0);
- G4HadronicProcessStore::Instance()->SetVerbose(0);
+  // reduce verbosity of physics lists
+  G4EmParameters::Instance()->SetVerbose(0);
+  G4HadronicProcessStore::Instance()->SetVerbose(0);
 
   //-------------------------------
   // UserAction classes
   //-------------------------------
   runManager->SetUserInitialization(
-    new ActionInitialisation(outputDirectory, outputFilename, doBenchmark, doValidation));
+      new ActionInitialisation(outputDirectory, outputFilename, doBenchmark, doValidation));
 
   G4UImanager *UImanager = G4UImanager::GetUIpointer();
   G4String command       = "/control/execute ";

examples/IntegrationBenchmark/macros/integrationbenchmark.mac.in

@@ -7,7 +7,7 @@
 ## Geant4 macro for modelling simplified sampling calorimeters
 ## =============================================================================
 ##
-/run/numberOfThreads 1
+/run/numberOfThreads 8
 /control/verbose 0
 /run/verbose 0
 /process/verbose 0
@@ -21,10 +21,18 @@
 /adept/setVecGeomGDML cms2018_sd.gdml
 /adept/setVerbosity 0
 ## Threshold for buffering tracks before sending to GPU
-/adept/setTransportBufferThreshold 200
+/adept/setTransportBufferThreshold 2000
 ## Total number of GPU track slots (not per thread)
-/adept/setMillionsOfTrackSlots 1
+/adept/setMillionsOfTrackSlots 8
 /adept/setMillionsOfHitSlots 1
+/adept/setCUDAStackLimit 8192
+
+# If true, particles are transported on the GPU across the whole geometry, GPU regions are ignored
+/adept/setTrackInAllRegions true
+# In order to do the GPU transport only in specific regions
+#/adept/addGPURegion EcalRegion
+#/adept/addGPURegion HcalRegion
+
 
 ## -----------------------------------------------------------------------------
 ## Optionally, set a constant magnetic filed:
@@ -41,22 +49,11 @@
 ## User-defined Event verbosity: 1 = total edep, 2 = energy deposit per placed sensitive volume
 /eventAction/verbose 2
 
-/gun/setDefault
-/gun/particle e-
-/gun/energy 10 GeV
-/gun/number 200
-/gun/position 0 0 0
-/gun/print true
-
-#If false, the following parameters are ignored
-/gun/randomizeGun true
-#Usage: /gun/addParticle type ["weight" weight] ["energy" energy unit]
-/gun/addParticle e- weight 1 energy 10 GeV
-/gun/addParticle proton weight 0 energy 10 GeV
-/gun/minPhi 0 deg
-/gun/maxPhi 360 deg
-/gun/minTheta 10 deg
-/gun/maxTheta 170 deg
+/gun/hepmc
+/generator/hepmcAscii/maxevents 256
+/generator/hepmcAscii/firstevent 0
+/generator/hepmcAscii/open ppttbar.hepmc3
+/generator/hepmcAscii/verbose 0
 
 ## -----------------------------------------------------------------------------
 ## Run the simulation with the given number of events and print list of processes
@@ -66,5 +63,5 @@
 
 # run events with parametrised simulation
 # by default all created models are active
-/run/beamOn 1
+/run/beamOn 8