traccc/bfield/construct_const_bfield.hpp

0001 /** TRACCC library, part of the ACTS project (R&D line)
0002  *
0003  * (c) 2025 CERN for the benefit of the ACTS project
0004  *
0005  * Mozilla Public License Version 2.0
0006  */
0007
0008 #pragma once
0009
0010 // Local include(s).
0011 #include "traccc/bfield/magnetic_field.hpp"
0012 #include "traccc/definitions/primitives.hpp"
0013
0014 namespace traccc {
0015
0016 /// Construct a constant magnetic field object
0017 ///
0018 /// @tparam scalar_t The scalar type to construct the field with
0019 ///
0020 /// @param x The X component of the constant field
0021 /// @param y The Y component of the constant field
0022 /// @param z The Z component of the constant field
0023 ///
0024 template <typename scalar_t>
0025 magnetic_field construct_const_bfield(scalar_t x, scalar_t y, scalar_t z);
0026
0027 /// Construct a constant magnetic field object
0028 ///
0029 /// @param v The 3-vector describing the constant field
0030 ///
0031 magnetic_field construct_const_bfield(const vector3& v);
0032
0033 }  // namespace traccc
0034
0035 // Include the implementation.
0036 #include "traccc/bfield/impl/construct_const_bfield.ipp"