Add arbitrary bfield types (defined in a dedicated header) to the detector with comprehensive

testing both for host and device. Since the covfie field types for host and device are a bit different,
the detector and the detector_view had to be templated on the field/backend type, so that in
the detector view and buffer classes the correct covfie constructors are called, which move
the data to device. Because this needs a special interface for now, the detector has its own versions
of the get_data and get_buffer functions. To make sure the detector with all the data it contains
now is not copied, the copy constructor and copy-assignment operator were deleted and
some downsteam adjustments for this were made in the io and simulation packages.

In order to manage the multiplicity of test cases (const bfield/inhomogeneous bfield) the stepper and
propagation unittests were adapted and new ones for the inhomogeneous bfield were added
(note: these can't compare against a helix anymore, since the tracks are no longer helical!).
The device propagation unittests involved a huge amount of duplicate code between the CUDA and
SYCL implementations which was moved into a common propagator test header (mostly the CPU code and
the comparison of the results between host and device). The sycl code that could not be unified
contains the sycl queue wrapper.

The toy detector has a new config struct now, which makes it easier to build different bfield types.
In many cases, the default values of this config are used and new values only set explicitely where
they diverge from the default.

The file handle saw some fixes, too. Mainly for the counting of open files and the correct handling of
empty file names.

A generic bfield reader has been added with a concrete reader implementation for covfie, which can now be
used to read the bfield files into the detector along the detray json data files.

The covfie version was bumped to 0.8.0

In order to make the CI pass, the ODD bfield file was uploaded to the traccc data repository and is
downloaded with the same script in detray now as is used in traccc

Co-authored-by: Stephen Nicholas Swatman <stephen.nicholas.swatman@cern.ch>
Co-authored-by: Guilherme Almeida <g.almeida@cern.ch>

Author: 3 people

.github/workflows/builds.yml

@@ -70,10 +70,18 @@ jobs:
       run:
         shell: bash
 
+    # Set the path to the test data files
+    env:
+      DETRAY_DATA_DIRECTORY: ${{ github.workspace }}/data/
+      DETRAY_BFIELD_FILE: ${{ github.workspace }}/data/odd-bfield_v0_8_0.cvf
+
     # The build/test steps to execute.
     steps:
     # Use a standard checkout of the code.
     - uses: actions/checkout@v2
+    # Get the data files for the tests
+    - name: Download data files
+      run: data/detray_data_get_files.sh
     # Run the CMake configuration.
     - name: Configure
       run: |
@@ -137,4 +145,3 @@ jobs:
       run: |
         source ${GITHUB_WORKSPACE}/.github/ci_setup.sh ${{ matrix.PLATFORM.NAME }}
         cmake --build build
-

.gitlab-ci.yml

@@ -8,7 +8,7 @@ build_cuda:
   stage: build
   image: ghcr.io/acts-project/ubuntu2004_cuda:v30
   artifacts:
-    paths: 
+    paths:
       - build
   script:
       - git clone $CLONE_URL src
@@ -26,12 +26,18 @@ build_cuda:
 
 
 test_cuda:
+  variables:
+    DETRAY_DATA_DIRECTORY: src/data/
+    DETRAY_BFIELD_FILE: $CI_PROJECT_DIR/src/data/odd-bfield_v0_8_0.cvf
   stage: test
   tags: [docker-gpu-nvidia]
   image: ghcr.io/acts-project/ubuntu2004_cuda:v30
-  needs: 
+  needs:
     - build_cuda
   script:
+    - git clone $CLONE_URL src
+    - git -C src checkout $HEAD_SHA
+    - src/data/detray_data_get_files.sh
     - cd build
     - nvidia-smi
     - ctest --output-on-failure -R ".*cuda.*"
@@ -43,7 +49,7 @@ build_sycl:
   stage: build
   image: "ghcr.io/acts-project/ubuntu2004_oneapi:v30"
   artifacts:
-    paths: 
+    paths:
       - build
   script:
       - git clone $CLONE_URL src
@@ -66,7 +72,7 @@ test_sycl:
   stage: test
   tags: [docker-gpu-nvidia]
   image: "ghcr.io/acts-project/ubuntu2004_oneapi:v30"
-  needs: 
+  needs:
     - build_sycl
   script:
     - git clone $CLONE_URL src
@@ -75,4 +81,4 @@ test_sycl:
     - cd build
     - nvidia-smi
     - ctest --output-on-failure -R ".*sycl.*"
-    - find bin -type f -name "*sycl" -not -name "*text*" -exec {} \;
+    - find bin -type f -name "*sycl" -not -name "*text*" -exec {} \;

core/include/detray/core/detector.hpp

@@ -11,6 +11,7 @@
 #include "detray/core/detail/container_buffers.hpp"
 #include "detray/core/detail/container_views.hpp"
 #include "detray/core/detector_metadata.hpp"
+#include "detray/definitions/bfield_backends.hpp"
 #include "detray/definitions/containers.hpp"
 #include "detray/definitions/qualifiers.hpp"
 #include "detray/geometry/detail/volume_descriptor.hpp"
@@ -22,9 +23,6 @@
 // Vecmem include(s)
 #include <vecmem/memory/memory_resource.hpp>
 
-// Covfie include(s)
-#include <covfie/core/field.hpp>
-
 // System include(s)
 #include <algorithm>
 #include <map>
@@ -34,8 +32,7 @@
 namespace detray {
 
 /// @brief Forward declaration of a detector view type
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
+template <typename device_bfield_bknd_t, typename metadata, typename bfield_t>
 struct detector_view;
 
 /// @brief The detector definition.
@@ -49,7 +46,7 @@ struct detector_view;
 /// @tparam container_t type collection of the underlying containers
 /// @tparam source_link the surface source link
 template <typename metadata_t = default_metadata,
-          template <typename> class bfield_t = covfie::field,
+          typename bfield_t = covfie::field<bfield::const_bknd_t>,
           typename container_t = host_container_types>
 class detector {
 
@@ -58,8 +55,6 @@ class detector {
         detector<metadata_t, bfield_t, container_t>>;
 
     public:
-    using metadata = metadata_t;
-
     /// Algebra types
     /// @TODO: scalar as a template parameter
     using scalar_type = scalar;
@@ -68,9 +63,9 @@ class detector {
     using vector3 = __plugin::vector3<scalar_type>;
     using point2 = __plugin::point2<scalar_type>;
 
-    using bfield_backend_type = typename metadata::bfield_backend_t;
+    using metadata = metadata_t;
 
-    using bfield_type = bfield_t<bfield_backend_type>;
+    using bfield_type = bfield_t;
 
     /// Raw container types
     template <typename T, std::size_t N>
@@ -133,18 +128,22 @@ class detector {
     using volume_finder =
         typename metadata::template volume_finder<container_t>;
 
+    // TODO: Remove
+    template <typename device_bfield_t>
     using detector_view_type =
-        detector_view<metadata, covfie::field, host_container_types>;
+        detector_view<device_bfield_t, metadata, bfield_t>;
 
+    // TODO: rename back to 'view_type' etc, once covfie is wrapped in the
+    // container view/buffer formalism
     /// Detector view types
-    using view_type = dmulti_view<
+    using view_t = dmulti_view<
         dvector_view<volume_type>, typename transform_container::view_type,
         typename mask_container::view_type,
         typename material_container::view_type,
         typename surface_container::view_type, dvector_view<surface_type>,
         typename volume_finder::view_type>;
 
-    using const_view_type =
+    using const_view_t =
         dmulti_view<dvector_view<const volume_type>,
                     typename transform_container::const_view_type,
                     typename mask_container::const_view_type,
@@ -154,19 +153,25 @@ class detector {
                     typename volume_finder::const_view_type>;
 
     /// Detector buffer types
-    using buffer_type = dmulti_buffer<
+    using buffer_t = dmulti_buffer<
         dvector_buffer<volume_type>, typename transform_container::buffer_type,
         typename mask_container::buffer_type,
         typename material_container::buffer_type,
         typename surface_container::buffer_type, dvector_buffer<surface_type>,
         typename volume_finder::buffer_type>;
 
     detector() = delete;
+    // The detector holds a lot of data and should never be copied
+    detector(const detector &) = delete;
+    detector &operator=(const detector &) = delete;
+    detector(detector &&) = default;
 
     /// Allowed costructor
+    /// @{
+    /// Default construction
     /// @param resource memory resource for the allocation of members
     DETRAY_HOST
-    detector(vecmem::memory_resource &resource, bfield_type &&field)
+    explicit detector(vecmem::memory_resource &resource)
         : _volumes(&resource),
           _transforms(resource),
           _masks(resource),
@@ -175,12 +180,12 @@ class detector {
           _surface_lookup(&resource),
           _volume_finder(resource),
           _resource(&resource),
-          _bfield(field) {}
+          _bfield() {}
 
-    /// Constructor with simplified constant-zero B-field
-    /// @param resource memory resource for the allocation of members
+    /// @param resource memory resource for the allocation of members and
+    /// externally provided magnetic field @param field
     DETRAY_HOST
-    explicit detector(vecmem::memory_resource &resource)
+    detector(vecmem::memory_resource &resource, bfield_type &&field)
         : _volumes(&resource),
           _transforms(resource),
           _masks(resource),
@@ -189,8 +194,7 @@ class detector {
           _surface_lookup(&resource),
           _volume_finder(resource),
           _resource(&resource),
-          _bfield(typename bfield_type::backend_t::configuration_t{0.f, 0.f,
-                                                                   0.f}) {}
+          _bfield(std::move(field)) {}
 
     /// Constructor with detector_data
     template <typename detector_data_type,
@@ -208,6 +212,7 @@ class detector {
           _volume_finder(
               detray::detail::get<6>(det_data._detector_data.m_view)),
           _bfield(det_data._bfield_view) {}
+    /// @}
 
     /// Add a new volume and retrieve a reference to it.
     ///
@@ -537,6 +542,12 @@ class detector {
         return *std::max_element(n_candidates.begin(), n_candidates.end());
     }
 
+    /// @brief Add a bfield to the detector
+    DETRAY_HOST
+    void set_bfield(bfield_type &&field) {
+        _bfield = std::forward<bfield_type>(field);
+    }
+
     DETRAY_HOST_DEVICE
     inline const bfield_type &get_bfield() const { return _bfield; }
 
@@ -612,12 +623,14 @@ class detector {
     bfield_type _bfield;
 };
 
-/// @brief A static inplementation of detector data for device
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
+/// @brief The detector data buffer
+///
+/// Contains the buffers for all detector components plus the covfie device
+/// field type, which is being copied to device when this type gets constructed
+template <typename device_bfield_bknd_t, typename metadata_t, typename bfield_t>
 struct detector_buffer {
 
-    using detector_type = detector<metadata, bfield_t, container_t>;
+    using detector_type = detector<metadata_t, bfield_t, host_container_types>;
 
     /// Automatic buffer creation with the given parameters
     detector_buffer(detector_type &det, vecmem::memory_resource &mr,
@@ -639,11 +652,11 @@ struct detector_buffer {
                                               cpy_type, buff_type),
                            detray::get_buffer(det.volume_search_grid(), mr, cpy,
                                               cpy_type, buff_type)),
-          _bfield_view(det.get_bfield()) {}
+          _bfield(det.get_bfield()) {}
 
     /// Buffers were created manually
     detector_buffer(
-        detector<metadata, bfield_t, container_t> &det,
+        const detector_type &det,
         detail::get_buffer_t<typename detector_type::volume_container>
             &&vol_buffer,
         typename detector_type::transform_container::buffer_type &&trf_buffer,
@@ -657,41 +670,22 @@ struct detector_buffer {
                            std::move(msk_buffer), std::move(mat_buffer),
                            std::move(sf_buffer), std::move(sf_lkp_buffer),
                            std::move(vgrd_buffer)),
-          _bfield_view(det.get_bfield()) {}
+          _bfield(det.get_bfield()) {}
 
     /// Buffers for the vecemem types
-    typename detector_type::buffer_type _detector_buffer;
-    /// Covfie field
-    typename detector_type::bfield_type::view_t _bfield_view;
+    typename detector_type::buffer_t _detector_buffer;
+    /// Covfie device field
+    covfie::field<device_bfield_bknd_t> _bfield;
 };
 
-// Deduction guide to construct a detector buffer type more conveniently
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
-detector_buffer(
-    detector<metadata, bfield_t, container_t> &,
-    detail::get_buffer_t<typename detector<metadata, bfield_t,
-                                           container_t>::volume_container> &&,
-    typename detector<metadata, bfield_t,
-                      container_t>::transform_container::buffer_type &&,
-    typename detector<metadata, bfield_t,
-                      container_t>::mask_container::buffer_type &&,
-    typename detector<metadata, bfield_t,
-                      container_t>::material_container::buffer_type &&,
-    typename detector<metadata, bfield_t,
-                      container_t>::surface_container::buffer_type &&,
-    typename detector<metadata, bfield_t, container_t>::surface_lookup_container
-        &&,
-    typename detector<metadata, bfield_t,
-                      container_t>::volume_finder::buffer_type &&)
-    -> detector_buffer<metadata, bfield_t, container_t>;
-
-/// @brief A static inplementation of detector data for device
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
+/// @brief The detector view
+///
+/// Contains the views for all detector components, including the device view
+/// of the bfield
+template <typename device_bfield_bknd_t, typename metadata_t, typename bfield_t>
 struct detector_view {
 
-    using detector_type = detector<metadata, bfield_t, container_t>;
+    using detector_type = detector<metadata_t, bfield_t, host_container_types>;
 
     detector_view(detector_type &det)
         : _detector_data(detray::get_data(det.volumes()),
@@ -703,49 +697,48 @@ struct detector_view {
                          detray::get_data(det.volume_search_grid())),
           _bfield_view(det.get_bfield()) {}
 
-    detector_view(detector_buffer<metadata, bfield_t, container_t> &det_buff)
+    detector_view(
+        detector_buffer<device_bfield_bknd_t, metadata_t, bfield_t> &det_buff)
         : _detector_data(detray::get_data(det_buff._detector_buffer)),
-          _bfield_view(det_buff._bfield_view) {}
+          _bfield_view(det_buff._bfield) {}
 
     /// Views for the vecmem types
-    typename detector_type::view_type _detector_data;
+    typename detector_type::view_t _detector_data;
     /// Covfie field view
-    typename detector_type::bfield_type::view_t _bfield_view;
+    covfie::field_view<device_bfield_bknd_t> _bfield_view;
 };
 
-/// Stand-alone function that @returns the detector data for transfer to
+/// Stand-alone function that @returns the detector view for transfer to
 /// device.
 ///
 /// @param detector the detector to be tranferred
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
-inline detector_view<metadata, bfield_t, container_t> get_data(
-    detector<metadata, bfield_t, container_t> &det) {
+template <typename device_bfield_bknd_t, typename metadata_t, typename bfield_t>
+inline detector_view<device_bfield_bknd_t, metadata_t, bfield_t> get_data(
+    detector<metadata_t, bfield_t, host_container_types> &det) {
     return {det};
 }
 
-/// Stand-alone function that @returns the detector data for transfer to
+/// Stand-alone function that @returns the detector buffer for transfer to
 /// device.
 ///
-/// @param detector the detector to be tranferred
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
-inline detector_buffer<metadata, bfield_t, container_t> get_buffer(
-    detector<metadata, bfield_t, container_t> &det, vecmem::memory_resource &mr,
-    vecmem::copy &cpy, detray::copy cpy_type = detray::copy::sync,
+/// @param detector the detector to be transferred
+template <typename device_bfield_bknd_t, typename metadata_t, typename bfield_t>
+inline detector_buffer<device_bfield_bknd_t, metadata_t, bfield_t> get_buffer(
+    detector<metadata_t, bfield_t, host_container_types> &det,
+    vecmem::memory_resource &mr, vecmem::copy &cpy,
+    detray::copy cpy_type = detray::copy::sync,
     vecmem::data::buffer_type buff_type =
         vecmem::data::buffer_type::fixed_size) {
     return {det, mr, cpy, cpy_type, buff_type};
 }
 
-/// Stand-alone function that @returns the detector data for transfer to
+/// Stand-alone function that @returns the detector view for transfer to
 /// device.
 ///
-/// @param detector the detector to be tranferred
-template <typename metadata, template <typename> class bfield_t,
-          typename container_t>
-inline detector_view<metadata, bfield_t, container_t> get_data(
-    detector_buffer<metadata, bfield_t, container_t> &det_buff) {
+/// @param detector the detector to be transferred
+template <typename device_bfield_bknd_t, typename metadata_t, typename bfield_t>
+inline detector_view<device_bfield_bknd_t, metadata_t, bfield_t> get_data(
+    detector_buffer<device_bfield_bknd_t, metadata_t, bfield_t> &det_buff) {
     return {det_buff};
 }