Class MagneticFieldProvider¶
Defined in File MagneticFieldProvider.hpp
Inheritance Relationships¶
Derived Types¶
public Acts::ConstantBField(Class ConstantBField)public Acts::InterpolatedBFieldMap< Mapper_t >(Template Class InterpolatedBFieldMap)public Acts::NullBField(Class NullBField)public Acts::SharedBField< BField >(Template Class SharedBField)public Acts::SolenoidBField(Class SolenoidBField)
Class Documentation¶
-
class
Acts::MagneticFieldProvider¶ Base class for all magnetic field providers.
Subclassed by Acts::ConstantBField, Acts::InterpolatedBFieldMap< Mapper_t >, Acts::NullBField, Acts::SharedBField< BField >, Acts::SolenoidBField
Public Types
-
using
Cache= detail::SmallObjectCache¶
Public Functions
-
Vector3
getField(const Vector3 &position, Cache &cache) const = 0¶ retrieve magnetic field value
- Return
magnetic field vector at given position
- Parameters
[in] position: global 3D position
-
Vector3
getField(const Vector3 &position) const = 0¶ retrieve magnetic field value
- Return
magnetic field vector at given position
- Parameters
[in] position: global 3D position[inout] cache: Cache object. Contains field cell used for interpolation
-
Vector3
getFieldGradient(const Vector3 &position, ActsMatrix<3, 3> &derivative) const = 0¶ retrieve magnetic field value & its gradient
- Return
magnetic field vector
- Parameters
[in] position: global 3D position[out] derivative: gradient of magnetic field vector as (3x3) matrix
-
Vector3
getFieldGradient(const Vector3 &position, ActsMatrix<3, 3> &derivative, Cache &cache) const = 0¶ retrieve magnetic field value & its gradient
- Return
magnetic field vector
- Parameters
[in] position: global 3D position[out] derivative: gradient of magnetic field vector as (3x3) matrix[inout] cache: Cache object. Contains field cell used for
-
Cache
makeCache(const MagneticFieldContext &mctx) const = 0¶ Make an opaque cache for the magnetic field.
- Return
Cache The opaque cache object
- Parameters
mctx: The magnetic field context to generate cache for
-
using