Implement Celeritas-DD4hep integration plugin

CMakeLists.txt

@@ -42,6 +42,7 @@ celeritas_optional_package(PNG "Enable PNG output with libpng")
 celeritas_optional_package(Python "Use Python to generate and preprocess")
 celeritas_optional_package(ROOT "Enable ROOT I/O")
 celeritas_optional_package(VecGeom "Use VecGeom geometry")
+celeritas_optional_package(DD4hep "Enable DD4hep integration")
 option(CELERITAS_USE_Perfetto "Perfetto tracing library" OFF)
 
 # Components
@@ -353,6 +354,14 @@ if(CELERITAS_USE_Geant4 AND BUILD_TESTING AND NOT DEFINED CELER_G4ENV)
   celeritas_set_celer_g4env()
 endif()
 
+if(CELERITAS_USE_DD4hep)
+  if(NOT DD4hep_FOUND)
+    find_package(DD4hep 1.18 REQUIRED COMPONENTS DDCore DDG4)
+    include(${DD4hep_DIR}/cmake/DD4hep.cmake)
+    include(${DD4hep_DIR}/cmake/DD4hepBuild.cmake)
+  endif()
+endif()
+
 if(CELERITAS_USE_HepMC3)
   if(NOT HepMC3_FOUND)
     find_package(HepMC3 REQUIRED)

CMakePresets.json

@@ -28,7 +28,8 @@
         "CELERITAS_USE_MPI":     {"type": "BOOL", "value": "ON"},
         "CELERITAS_USE_PNG":     {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_ROOT":    {"type": "BOOL", "value": "ON"},
-        "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "ON"}
+        "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "ON"},
+        "CELERITAS_USE_DD4hep":  {"type": "BOOL", "value": "OFF"},
       }
     },
     {
@@ -47,6 +48,7 @@
         "CELERITAS_USE_PNG":     {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_ROOT":    {"type": "BOOL", "value": "OFF"},
         "CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "OFF"},
+        "CELERITAS_USE_DD4hep":  {"type": "BOOL", "value": "OFF"},
         "CMAKE_INSTALL_PREFIX": "${sourceDir}/install-${presetName}"
       }
     },

cmake/CeleritasConfig.cmake.in

@@ -164,6 +164,10 @@ if(CELERITAS_USE_VecGeom)
   endif()
 endif()
 
+if(CELERITAS_USE_DD4hep)
+  find_dependency(DD4hep REQUIRED)
+endif()
+
 cmake_policy(POP)
 
 #-----------------------------------------------------------------------------#

src/CMakeLists.txt

@@ -161,6 +161,9 @@ add_subdirectory(celeritas)
 if(CELERITAS_USE_Geant4)
   add_subdirectory(accel)
 endif()
+if(CELERITAS_USE_DD4hep)
+  add_subdirectory(ddceler)
+endif()
 
 # Add alias as a bridge library: see cmake/CeleritasConfig.cmake.in
 # TODO: move to a separate library for just high level interfaces

src/ddceler/CMakeLists.txt

@@ -0,0 +1,9 @@
+dd4hep_add_plugin(DDcelerTMI
+    SOURCES DDcelerTMI.cc
+    USES    DD4hep::DDG4 Celeritas::accel Celeritas::celeritas Celeritas::corecel
+    )
+dd4hep_add_plugin(DDcelerRunAction
+    SOURCES DDcelerRunAction.cc
+    USES    DD4hep::DDG4 DD4hep::DDCore Celeritas::accel Celeritas::celeritas Celeritas::corecel
+    )
+install(TARGETS DDcelerTMI DDcelerRunAction LIBRARY DESTINATION lib)

src/ddceler/DDcelerRunAction.cc

@@ -0,0 +1,40 @@
+//------------------------------- -*- C++ -*- -------------------------------//
+// Copyright Celeritas contributors: see top-level COPYRIGHT file for details
+// SPDX-License-Identifier: (Apache-2.0 OR MIT)
+//---------------------------------------------------------------------------//
+//! \file ddceler/DDcelerTMI.cc
+//---------------------------------------------------------------------------//
+#include "DDcelerRunAction.hh"
+
+#include <CeleritasG4.hh>
+#include <DDG4/Factories.h>
+#include <QGSP_BERT.hh>
+
+using TMI = celeritas::TrackingManagerIntegration;
+
+namespace dd4hep
+{
+namespace sim
+{
+
+//---------------------------------------------------------------------------//
+
+void DDcelerRunAction::begin(G4Run const* run)
+{
+    this->info("Begin of run");
+    TMI::Instance().BeginOfRunAction(run);
+}
+
+//---------------------------------------------------------------------------//
+
+void DDcelerRunAction::end(G4Run const* run)
+{
+    this->info("End of run");
+    TMI::Instance().EndOfRunAction(run);
+}
+//---------------------------------------------------------------------------//
+
+}  // namespace sim
+}  // namespace dd4hep
+
+DECLARE_GEANT4ACTION(DDcelerRunAction)

src/ddceler/DDcelerRunAction.hh

@@ -0,0 +1,64 @@
+//------------------------------- -*- C++ -*- -------------------------------//
+// Copyright Celeritas contributors: see top-level COPYRIGHT file for details
+// SPDX-License-Identifier: (Apache-2.0 OR MIT)
+//---------------------------------------------------------------------------//
+//! \file ddceler/DDcelerTMI.hh
+//---------------------------------------------------------------------------//
+#pragma once
+
+#include <DD4hep/InstanceCount.h>
+#include <DDG4/Geant4Action.h>
+#include <DDG4/Geant4RunAction.h>
+
+using Geant4Context = dd4hep::sim::Geant4Context;
+using Geant4Action = dd4hep::sim::Geant4Action;
+using Geant4RunAction = dd4hep::sim::Geant4RunAction;
+
+namespace dd4hep
+{
+namespace sim
+{
+//---------------------------------------------------------------------------//
+/*!
+ * DDG4 action plugin for Celeritas tracking manager integration (TMI).
+ */
+class DDcelerRunAction : public Geant4RunAction
+{
+  protected:
+    // Define standard assignments and constructors
+    DDG4_DEFINE_ACTION_CONSTRUCTORS(DDcelerRunAction);
+
+  public:
+    // Standard constructor
+    inline DDcelerRunAction(Geant4Context* ctxt, std::string const& nam);
+
+    // Default destructor
+    ~DDcelerRunAction();
+
+    // Make options for Celeritas tracking manager
+    void begin(G4Run const* run) override;
+    void end(G4Run const* run) override;
+};
+
+//---------------------------------------------------------------------------//
+// INLINE DEFINITIONS
+//---------------------------------------------------------------------------//
+/*!
+ * Standard constructor
+ */
+DDcelerRunAction::DDcelerRunAction(Geant4Context* ctxt, std::string const& nam)
+    : Geant4RunAction(ctxt, nam)
+{
+    InstanceCount::increment(this);
+    this->info("Constructed Geant4RunAction");
+}
+
+DDcelerRunAction::~DDcelerRunAction()
+{
+    this->info("Destructing Geant4RunAction");
+    InstanceCount::decrement(this);
+}
+
+//---------------------------------------------------------------------------//
+}  // namespace sim
+}  // namespace dd4hep

src/ddceler/DDcelerTMI.cc

@@ -0,0 +1,71 @@
+//------------------------------- -*- C++ -*- -------------------------------//
+// Copyright Celeritas contributors: see top-level COPYRIGHT file for details
+// SPDX-License-Identifier: (Apache-2.0 OR MIT)
+//---------------------------------------------------------------------------//
+//! \file ddceler/DDcelerTMI.cc
+//---------------------------------------------------------------------------//
+#include "DDcelerTMI.hh"
+
+#include <DDG4/Factories.h>
+#include <QGSP_BERT.hh>
+
+#include "celeritas/field/FieldDriverOptions.hh"
+#include "celeritas/inp/Field.hh"
+
+using TMI = celeritas::TrackingManagerIntegration;
+
+namespace dd4hep
+{
+namespace sim
+{
+//---------------------------------------------------------------------------//
+celeritas::SetupOptions DDcelerTMI::makeOptions()
+{
+    celeritas::SetupOptions opts;
+
+    // NOTE: these numbers are appropriate for CPU execution and can be set
+    // through the UI using `/celer/`
+    opts.max_num_tracks = 2024;
+    opts.initializer_capacity = 2024 * 128;
+    // Celeritas does not support EmStandard MSC physics above 200 MeV
+    opts.ignore_processes = {"CoulombScat"};
+
+    // Use a placeholder non-zero uniform magnetic field
+    auto make_field_input = []() {
+        celeritas::inp::UniformField input;
+
+        input.strength = {0, 3, 0};
+        constexpr auto celer_mm = celeritas::units::millimeter;
+        input.driver_options.minimum_step = 1e-6 * celer_mm;
+        input.driver_options.delta_chord = 0.025 * celer_mm;
+        input.driver_options.delta_intersection = 1e-5 * celer_mm;
+        return input;
+    };
+    opts.make_along_step = celeritas::UniformAlongStepFactory(make_field_input);
+
+    // Save diagnostic file to a unique name
+    opts.output_file = "trackingmanager-offload.out.json";
+    return opts;
+}
+//---------------------------------------------------------------------------//
+
+void DDcelerTMI::constructPhysics(G4VModularPhysicsList* physics)
+{
+    this->info(
+        "Using FTFP_BERT physics list with Celeritas tracking for "
+        "e-/e+/gamma.");
+
+    // Register Celeritas tracking manager
+    auto& tmi = TMI::Instance();
+    physics->RegisterPhysics(new celeritas::TrackingManagerConstructor(&tmi));
+
+    // Configure Celeritas options
+    tmi.SetOptions(makeOptions());
+
+    this->info("Celeritas TrackingManager registered.");
+}
+//---------------------------------------------------------------------------//
+}  // namespace sim
+}  // namespace dd4hep
+
+DECLARE_GEANT4ACTION(DDcelerTMI)

src/ddceler/DDcelerTMI.hh

@@ -0,0 +1,58 @@
+//------------------------------- -*- C++ -*- -------------------------------//
+// Copyright Celeritas contributors: see top-level COPYRIGHT file for details
+// SPDX-License-Identifier: (Apache-2.0 OR MIT)
+//---------------------------------------------------------------------------//
+//! \file ddceler/DDcelerTMI.hh
+//---------------------------------------------------------------------------//
+#pragma once
+
+#include <CeleritasG4.hh>
+#include <DDG4/Geant4Action.h>
+#include <DDG4/Geant4PhysicsList.h>
+
+using Geant4Context = dd4hep::sim::Geant4Context;
+using Geant4Action = dd4hep::sim::Geant4Action;
+using Geant4PhysicsList = dd4hep::sim::Geant4PhysicsList;
+
+namespace dd4hep
+{
+namespace sim
+{
+//---------------------------------------------------------------------------//
+/*!
+ * DDG4 action plugin for Celeritas tracking manager integration (TMI).
+ */
+class DDcelerTMI : public Geant4PhysicsList
+{
+  protected:
+    // Define standard assignments and constructors
+    DDG4_DEFINE_ACTION_CONSTRUCTORS(DDcelerTMI);
+
+  public:
+    // Standard constructor
+    inline DDcelerTMI(Geant4Context* ctxt, std::string const& nam);
+
+    // Default destructor
+    virtual ~DDcelerTMI() = default;
+
+    // Make options for Celeritas tracking manager
+    celeritas::SetupOptions makeOptions();
+
+    // constructPhysics callback
+    virtual void constructPhysics(G4VModularPhysicsList* physics) override;
+};
+
+//---------------------------------------------------------------------------//
+// INLINE DEFINITIONS
+//---------------------------------------------------------------------------//
+/*!
+ * Standard constructor
+ */
+DDcelerTMI::DDcelerTMI(Geant4Context* ctxt, std::string const& nam)
+    : Geant4PhysicsList(ctxt, nam)
+{
+}
+
+//---------------------------------------------------------------------------//
+}  // namespace sim
+}  // namespace dd4hep

src/ddceler/steeringFile.py

@@ -0,0 +1,41 @@
+"""
+
+Minimal proof of concept for DDG4 steering file to run Geant4 with celeritas integration.
+
+// Build celeritas-DDG4 plugins and set library path
+cmake -DCELERITAS_USE_DD4hep=ON -DCMAKE_INSTALL_PREFIX=install -S . -B build
+cmake --build build -j 8
+cmake --install build
+export LD_LIBRARY_PATH=$PWD/install/lib:${LD_LIBRARY_PATH}
+
+// Download and install the Open Data Detector For Testing.
+git clone https://gitlab.cern.ch/acts/OpenDataDetector
+cd OpenDataDetector
+cmake -DCMAKE_INSTALL_PREFIX=install -S . -B build
+cmake --build build -j 8
+cmake --install build
+source install/bin/this_odd.sh
+
+// Run simulation with celeritas integration
+CELER_LOG=debug CELER_LOG_LOCAL=debug ddsim --action.run DDcelerRunAction \
+--compactFile=$PWD/install/share/OpenDataDetector/xml/OpenDataDetector.xml \
+--steering steeringFile.py -N 10 -G
+
+"""
+
+import DDG4
+
+# Create DDG4 kernel
+kernel  = DDG4.Kernel()
+
+# Print detector information
+DDG4.importConstants(kernel.detectorDescription(), debug=False)
+geant4 = DDG4.Geant4(kernel)
+geant4.registerInterruptHandler()
+geant4.printDetectors()
+
+# Set up custom physics list for celeritas integration
+phys = geant4.setupPhysics('FTFP_BERT')
+ph = DDG4.PhysicsList(kernel, str('DDcelerTMI'))
+phys.adopt(ph)
+phys.dump()