Warning, /acts/docs/groups/detector_descr/magnetic_field.md is written in an unsupported language. File is not indexed.
0001 @defgroup magnetic_field Magnetic Field
0002 @ingroup detector_descr
0003 @ingroup propagation
0004 @brief A description of magnetic field configurations for algorithms.
0005
0006 The magnetic field component of ACTS provides functionality to describe
0007 arbitrary magnetic field configurations in an experiment. It is implemented in
0008 a generic way and can be extended to connect to an experiment specific upstream
0009 source of field data.
0010
0011 Algorithms which need magnetic field information (e.g.
0012 @ref Acts::AtlasStepper, @ref Acts::EigenStepper) accept the magnetic
0013 field as an explicit argument.
0014
0015 - The documentation of @ref Acts::MagneticFieldProvider provides a good overview
0016 of the design and patterns associated with the magnetic field component.
0017 - The potentially event-context dependent configuration of the magnetic field
0018 is documented in @ref Acts::MagneticFieldContext.
0019
0020 **Classes of field providers in the library:**
0021
0022 - Analytical magnetic fields like @ref Acts::SolenoidBField that calculate
0023 their respective field values on the fly.
0024 - *Special* magnetic fields like @ref Acts::ConstantBField or @ref Acts::NullBField
0025 - The main @ref Acts::InterpolatedBFieldMap that is most commonly used by experiments
0026 to provide magnetic field maps from discrete data.
