Support surface-based VecGeom 2.x navigator

.github/workflows/build-spack.yml

@@ -24,26 +24,11 @@ jobs:
       matrix:
         geometry: ["vecgeom"]
         special: [null]
-        geant: ["10.5", "10.6", "10.7", "11.0", "11.1", "11.2"]
+        geant: ["11.0"]
         include:
-          - geometry: "orange"
-            special: "minimal"
-            geant: null
-          - geometry: "orange"
-            special: "float"
-            geant: "11.0"
-          - geometry: "orange"
-            special: "asanlite"
-            geant: null
           - geometry: "vecgeom"
-            special: "clhep"
-            geant: "11.0"
-          - geometry: "geant4"
-            special: null
+            special: "vgsurf"
             geant: "11.0"
-          - geometry: "orange"
-            special: "clang-tidy"
-            geant: "11.2"
     env:
       CCACHE_DIR: "${{github.workspace}}/.ccache"
       CCACHE_MAXSIZE: "100Mi"
@@ -69,17 +54,19 @@ jobs:
         with:
           ref: ${{env.SPACK_REF}}
           buildcache: true
-          color: true  
+          color: true
           path: spack-src
       - name: Initialize spack environment
         run: |
           # TODO: https://github.com/spack/spack/pull/43136
           curl -LfsS https://github.com/spack/spack/pull/43136.patch | git -C spack-src apply -
           cp scripts/ci/spack.yaml .
-          if [ "${{matrix.geometry}}" == "vecgeom" ]; then
+          if [ "${{matrix.geometry}}" == "vecgeom" ] && [ "${{matrix.special}}" != "vgsurf" ]; then
             spack -e . add vecgeom
           fi
-          if [ "${{matrix.special}}" != "minimal" ] && [  "${{matrix.special}}" != "asanlite" ] ; then
+          if   [ "${{matrix.special}}" != "minimal" ] \
+            && [ "${{matrix.special}}" != "asanlite" ] \
+            && [ "${{matrix.special}}" != "vgsurf" ] ; then
             spack -e . add root
           fi
           if [ "${{matrix.geant}}" != "" ]; then
@@ -114,8 +101,8 @@ jobs:
           echo "${SPACK_VIEW}/bin" >> $GITHUB_PATH
           echo "CMAKE_PREFIX_PATH=${SPACK_VIEW}:${CMAKE_PREFIX_PATH}" >> $GITHUB_ENV
           spack env activate . --sh > "${SPACK_VIEW}/rc"
-      - name: Cache ccache
-        uses: actions/cache@v4
+      - name: Restore ccache
+        uses: actions/cache/restore@v4
         with:
           path: ${{env.CCACHE_DIR}}
           key: ccache-${{env.CMAKE_PRESET}}-${{matrix.geant}}-${{github.run_id}}
@@ -125,6 +112,33 @@ jobs:
       - name: Zero ccache stats
         run: |
           ccache -z
+      - name: Install VecGeom surface
+        if: ${{matrix.geometry == 'vecgeom' && matrix.special == 'vgsurf'}}
+        run: |
+          . ${SPACK_VIEW}/rc
+          git clone -b surface_model --depth=368 \
+            https://gitlab.cern.ch/VecGeom/VecGeom.git vecgeom
+          cd vecgeom
+          mkdir build
+          cd build
+          export VECGEOM_PREFIX_PATH=$GITHUB_WORKSPACE/vecgeom/install
+          cmake \
+            -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
+            -DCMAKE_CXX_STANDARD:STRING=17 \
+            -DVECGEOM_BACKEND:STRING=Scalar -DVECGEOM_VECTOR:STRING=empty \
+            -DVECGEOM_BUILTIN_VECCORE:BOOL=ON \
+            -DVECGEOM_NO_SPECIALIZATION:BOOL=ON \
+            -DVECGEOM_USE_SURF:BOOL=ON -DVECGEOM_USE_NAVTUPLE:BOOL=OFF -DVECGEOM_USE_NAVINDEX:BOOL=ON \
+            -DBUILD_SHARED_LIBS:BOOL=ON \
+            -DVECGEOM_GDML:BOOL=ON -DVECGEOM_ENABLE_CUDA:BOOL=OFF -DVECGEOM_GEANT4:BOOL=OFF -DVECGEOM_ROOT:BOOL=OFF \
+            -DBUILD_TESTING:BOOL=OFF \
+            -DCMAKE_INSTALL_PREFIX:STRING=$VECGEOM_PREFIX_PATH \
+            -G Ninja \
+            ..
+          ninja install
+          echo "CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}:${VECGEOM_PREFIX_PATH}" >> $GITHUB_ENV
+          echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${VECGEOM_PREFIX_PATH}/lib" >> $GITHUB_ENV
       - name: Configure Celeritas
         env:
           CLANG_TIDY: "clang-tidy-15"
@@ -142,8 +156,18 @@ jobs:
         continue-on-error: ${{matrix.special == 'clang-tidy'}}
         run: |
           ninja -v -k0
+      - name: Save ccache
+        if: ${{always() && steps.build.outcome == 'success'}}
+        uses: actions/cache/save@v4
+        with:
+          path: ${{env.CCACHE_DIR}}
+          key: ccache-${{env.CMAKE_PRESET}}-${{matrix.geant}}-${{github.run_id}}
       - name: Regenerate ROOT test data
-        if: ${{matrix.geant == '11.0'}}
+        if: ${{
+          matrix.geant == '11.0'
+          && matrix.special != 'minimal'
+          && matrix.special != 'vgsurf'
+         }}
         working-directory: build
         run: |
           ninja -v -k0 update-root-test-data
@@ -183,7 +207,7 @@ jobs:
         # TODO: ASAN requires flags downstream
         if: >-
           ${{
-            (matrix.special != 'asanlite')
+            matrix.special != 'asanlite'
           }}
         run: |
           . ${SPACK_VIEW}/rc
@@ -205,7 +229,7 @@ jobs:
           ./bin/celer-sim --version
       - name: Build examples
         # TODO: ASAN requires flags downstream
-        env: 
+        env:
           CELER_DISABLE_ACCEL_EXAMPLES: >-
             ${{
               (   (matrix.special == 'minimal')

.github/workflows/pull_request.yml

@@ -32,38 +32,7 @@ jobs:
       with:
         name: event-file
         path: ${{github.event_path}}
-  build-fast:
-    uses: ./.github/workflows/build-fast.yml
-  build-ultralite:
-    uses: ./.github/workflows/build-ultralite.yml
-  doc:
-    uses: ./.github/workflows/doc.yml
-  all-prechecks:
-    needs: [build-fast, build-ultralite, doc]
-    runs-on: ubuntu-latest
-    steps:
-    - name: Success
-      run: "true"
-  build-docker:
-    # Since docker builds aren't cached and are large, don't run on draft
-    if: ${{github.event.pull_request.draft == false}}
-    needs: [all-prechecks]
-    uses: ./.github/workflows/build-docker.yml
   build-spack:
-    needs: [all-prechecks]
     uses: ./.github/workflows/build-spack.yml
 
-  # Specifying a dependent job allows us to select a single "requires" check in the project GitHub settings
-  all:
-    if: ${{always()}}
-    needs:
-    - build-docker
-    - build-spack
-    runs-on: ubuntu-latest
-    steps:
-    - name: Decide whether the needed jobs succeeded or failed
-      uses: re-actors/alls-green@release/v1
-      with:
-        jobs: ${{toJSON(needs)}}
-
 # vim: set nowrap tw=100:

scripts/cmake-presets/ci-ubuntu-github.json

@@ -103,6 +103,14 @@
       "cacheVariables": {
       }
     },
+    {
+      "name": "reldeb-vecgeom-vgsurf",
+      "description": "Build with release, assertions, VecGeom",
+      "inherits": ["reldeb-vecgeom"],
+      "cacheVariables": {
+        "CELERITAS_USE_ROOT": {"type": "BOOL", "value": "OFF"}
+      }
+    },
     {
       "name": "ndebug-vecgeom",
       "description": "Build release with vecgeom for testing *only* demos",

src/celeritas/field/FieldPropagator.hh

@@ -190,6 +190,8 @@ FieldPropagator<DriverT, GTV>::operator()(real_type step) -> result_type
         }
         auto linear_step
             = geo_.find_next_step(chord.length + this->delta_intersection());
+        CELER_ASSERT(linear_step.distance
+                     <= chord.length + this->delta_intersection());
 
         // Scale the effective substep length to travel by the fraction along
         // the chord to the boundary. This value can be slightly larger than 1
@@ -268,6 +270,13 @@ FieldPropagator<DriverT, GTV>::operator()(real_type step) -> result_type
             // The straight-line intercept is too far from substep's end state.
             // Decrease the allowed substep (curved path distance) by the
             // fraction along the chord, and retry the driver step.
+            if (CELER_UNLIKELY(update_length > chord.length))
+            {
+                // We should be converging to the endpoint, but if the
+                // navigator is misbehaving then it could get into an infinite
+                // loop if the update length increases.
+                --remaining_substeps;
+            }
             remaining = update_length;
         }
     } while (remaining > this->minimum_substep() && remaining_substeps > 0);

src/corecel/CMakeLists.txt

@@ -118,6 +118,19 @@ foreach(_dep Geant4 VecGeom HepMC3)
 endforeach()
 list(JOIN CELERITAS_DEPENDENCY_VERSIONS "\n" CELERITAS_DEPENDENCY_VERSIONS)
 
+# Save
+if(CELERITAS_USE_VecGeom)
+  if(VecGeom_USE_SURF)
+    set(_surf_geo 1)
+  else()
+    set(_surf_geo 0)
+  endif()
+  set(CELERITAS_VECGEOM_SURFACE_DEF
+    "#define CELERITAS_VECGEOM_SURFACE ${_surf_geo}"
+  )
+else()
+  set(CELERITAS_VECGEOM_SURFACE_DEF "/* #undef CELERITAS_VECGEOM_SURFACE */")
+endif()
 #-----------------------------------------------------------------------------#
 
 celeritas_configure_file("Version.hh.in" "corecel/Version.hh" @ONLY)

src/corecel/Config.hh.in

@@ -60,3 +60,5 @@
 @CELERITAS_SINCOSPI_PREFIX_DEF@
 
 @CELERITAS_DEPENDENCY_VERSIONS@
+
+@CELERITAS_VECGEOM_SURFACE_DEF@

src/geocel/g4vg/SolidConverter.cc

@@ -177,17 +177,25 @@ auto SolidConverter::convert_impl(arg_type solid_base) -> result_type
         VGSC_TYPE_FUNC(Box              , box),
         VGSC_TYPE_FUNC(Cons             , cons),
         VGSC_TYPE_FUNC(CutTubs          , cuttubs),
+#ifndef VECGEOM_USE_SURF
         VGSC_TYPE_FUNC(Ellipsoid        , ellipsoid),
         VGSC_TYPE_FUNC(EllipticalCone   , ellipticalcone),
         VGSC_TYPE_FUNC(EllipticalTube   , ellipticaltube),
+#endif
         VGSC_TYPE_FUNC(ExtrudedSolid    , extrudedsolid),
+#ifndef VECGEOM_USE_SURF
         VGSC_TYPE_FUNC(GenericPolycone  , genericpolycone),
+#endif
         VGSC_TYPE_FUNC(GenericTrap      , generictrap),
+#ifndef VECGEOM_USE_SURF
         VGSC_TYPE_FUNC(Hype             , hype),
+#endif
         VGSC_TYPE_FUNC(IntersectionSolid, intersectionsolid),
         VGSC_TYPE_FUNC(Orb              , orb),
         VGSC_TYPE_FUNC(Para             , para),
+#ifndef VECGEOM_USE_SURF
         VGSC_TYPE_FUNC(Paraboloid       , paraboloid),
+#endif
         VGSC_TYPE_FUNC(Polycone         , polycone),
         VGSC_TYPE_FUNC(Polyhedra        , polyhedra),
         VGSC_TYPE_FUNC(ReflectedSolid   , reflectedsolid),

src/geocel/vg/VecgeomData.hh

@@ -7,9 +7,10 @@
 //---------------------------------------------------------------------------//
 #pragma once
 
+#include "corecel/Config.hh"
+
 #include "corecel/Macros.hh"
 #include "corecel/Types.hh"
-#include "corecel/cont/Array.hh"
 #include "corecel/data/Collection.hh"
 #include "corecel/data/CollectionBuilder.hh"
 #include "corecel/sys/ThreadId.hh"
@@ -73,6 +74,9 @@ struct VecgeomStateData
     // Collections
     Items<Real3> pos;
     Items<Real3> dir;
+#if CELERITAS_VECGEOM_SURFACE
+    Items<long> next_surface;
+#endif
 
     // Wrapper for NavStatePool, vector, or void*
     detail::VecgeomNavCollection<W, M> vgstate;
@@ -83,8 +87,11 @@ struct VecgeomStateData
     //! True if sizes are consistent and states are assigned
     explicit CELER_FUNCTION operator bool() const
     {
-        return this->size() > 0 && dir.size() == this->size() && vgstate
-               && vgnext;
+        return this->size() > 0 && dir.size() == this->size()
+#if CELERITAS_VECGEOM_SURFACE
+               && next_surface.size() == this->size()
+#endif
+               && vgstate && vgnext;
     }
 
     //! State size
@@ -100,6 +107,9 @@ struct VecgeomStateData
         CELER_EXPECT(other);
         pos = other.pos;
         dir = other.dir;
+#if CELERITAS_VECGEOM_SURFACE
+        next_surface = other.next_surface;
+#endif
         vgstate = other.vgstate;
         vgnext = other.vgnext;
         return *this;
@@ -121,6 +131,9 @@ void resize(VecgeomStateData<Ownership::value, M>* data,
 
     resize(&data->pos, size);
     resize(&data->dir, size);
+#if CELERITAS_VECGEOM_SURFACE
+    resize(&data->next_surface, size);
+#endif
     data->vgstate.resize(params.max_depth, size);
     data->vgnext.resize(params.max_depth, size);
 

src/geocel/vg/VecgeomParams.cc

@@ -11,6 +11,7 @@
 #include <vector>
 #include <VecGeom/base/Config.h>
 #include <VecGeom/base/Cuda.h>
+#include <VecGeom/base/Version.h>
 #include <VecGeom/management/ABBoxManager.h>
 #include <VecGeom/management/BVHManager.h>
 #include <VecGeom/management/GeoManager.h>
@@ -21,7 +22,7 @@
 #ifdef VECGEOM_ENABLE_CUDA
 #    include <VecGeom/management/CudaManager.h>
 #endif
-#ifdef VECGEOM_USE_SURF
+#if CELERITAS_VECGEOM_SURFACE
 #    include <VecGeom/surfaces/BrepHelper.h>
 #endif
 #ifdef VECGEOM_GDML
@@ -47,6 +48,10 @@
 #include "VecgeomData.hh"  // IWYU pragma: associated
 
 #include "detail/VecgeomCompatibility.hh"
+
+#if CELERITAS_VECGEOM_SURFACE
+#    include "VecgeomParams.surface.hh"
+#endif
 #include "detail/VecgeomSetup.hh"
 
 static_assert(std::is_same_v<celeritas::real_type, vecgeom::Precision>,
@@ -70,7 +75,7 @@ namespace
 #    define VG_CUDA_CALL(CODE) CELER_UNREACHABLE
 #endif
 
-#ifdef VECGEOM_USE_SURF
+#if CELERITAS_VECGEOM_SURFACE
 #    define VG_SURF_CALL(CODE) CODE
 #else
 #    define VG_SURF_CALL(CODE) \
@@ -107,11 +112,7 @@ int vecgeom_verbosity()
  */
 bool VecgeomParams::use_surface_tracking()
 {
-#ifdef VECGEOM_USE_SURF
-    return true;
-#else
-    return false;
-#endif
+    return CELERITAS_VECGEOM_SURFACE;
 }
 
 //---------------------------------------------------------------------------//
@@ -381,7 +382,12 @@ void VecgeomParams::build_volume_tracking()
 
     {
         ScopedTimeAndRedirect time_and_output_("vecgeom::ABBoxManager");
+#if VECGEOM_VERSION < 0x020000
         vecgeom::ABBoxManager::Instance().InitABBoxesForCompleteGeometry();
+#else
+        vecgeom::ABBoxManager<real_type>::Instance()
+            .InitABBoxesForCompleteGeometry();
+#endif
     }
 
     // Init the bounding volume hierarchy structure
@@ -618,9 +624,13 @@ void VecgeomParams::build_metadata()
         VPlacedVolume const* pv = GeoManager::Instance().GetWorld();
 
         // Calculate bounding box
+#if VECGEOM_VERSION < 0x020000
+        auto bbox_mgr = ABBoxManager::Instance();
+#else
+        auto bbox_mgr = ABBoxManager<real_type>::Instance();
+#endif
         Vector3D<real_type> lower, upper;
-        ABBoxManager::Instance().ComputeABBox(pv, &lower, &upper);
-
+        bbox_mgr.ComputeABBox(pv, &lower, &upper);
         return BBox{detail::to_array(lower), detail::to_array(upper)};
     }();
 }