hip/utils/make_magnetic_field.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2025-2026 CERN for the benefit of the ACTS project
0004  *
0005  * Mozilla Public License Version 2.0
0006  */
0007
0008 #pragma once
0009
0010 // Project include(s).
0011 #include "traccc/bfield/magnetic_field.hpp"
0012
0013 namespace traccc::hip {
0014
0015 /// Storage method for inhomogeneous magnetic fields
0016 enum class magnetic_field_storage {
0017   global_memory  ///< Store the magnetic field in global device memory
0018 };
0019
0020 /// Create a magnetic field usable on the active HIP device
0021 ///
0022 /// @param bfield The magnetic field to be copied
0023 /// @param storage The storage method to use for the magnetic field
0024 /// @return A copy of the magnetic field that can be used on the active HIP
0025 ///         device
0026 ///
0027 magnetic_field make_magnetic_field(
0028     const magnetic_field& bfield,
0029     magnetic_field_storage storage = magnetic_field_storage::global_memory);
0030
0031 }  // namespace traccc::hip