Class ConstantBField¶
Defined in File ConstantBField.hpp
Nested Relationships¶
Nested Types¶
Inheritance Relationships¶
Base Type¶
public Acts::MagneticFieldProvider
(Class MagneticFieldProvider)
Class Documentation¶
-
class
Acts
::
ConstantBField
: public Acts::MagneticFieldProvider¶ This class implements a simple constant magnetic field.
The magnetic field value has to be set at creation time, but can be updated later on.
Public Functions
-
ConstantBField
(Vector3 B)¶ Construct constant magnetic field from field vector.
- Parameters
[in] B
: magnetic field vector in global coordinate system
-
ConstantBField
(double Bx = 0., double By = 0., double Bz = 0.)¶ construct constant magnetic field from components
- Parameters
[in] Bx
: magnetic field component in global x-direction[in] By
: magnetic field component in global y-direction[in] Bz
: magnetic field component in global z-direction
-
Vector3
getField
(const Vector3&) const override¶ - Note
The
position
is ignored and only kept as argument to provide a consistent interface with other magnetic field services.
-
Vector3
getField
(const Vector3&, MagneticFieldProvider::Cache&) const override¶ - Note
The
position
is ignored and only kept as argument to provide a consistent interface with other magnetic field services.
-
Vector3
getFieldGradient
(const Vector3&, ActsMatrix<3, 3>&) const override¶ - Note
The
position
is ignored and only kept as argument to provide a consistent interface with other magnetic field services.- Note
currently the derivative is not calculated
-
Vector3
getFieldGradient
(const Vector3&, ActsMatrix<3, 3>&, MagneticFieldProvider::Cache&) const override¶ - Note
The
position
is ignored and only kept as argument to provide a consistent interface with other magnetic field services.- Note
currently the derivative is not calculated
-
bool
isInside
(const Vector3&) const¶ check whether given 3D position is inside look-up domain
- Return
true
if position is inside the defined look-up grid, otherwisefalse
- Note
The method will always return true for the constant B-Field
- Parameters
[in] position
: global 3D position
-
Acts::MagneticFieldProvider::Cache
makeCache
(const Acts::MagneticFieldContext &mctx) const override¶
-
void
setField
(double Bx, double By, double Bz)¶ update magnetic field vector from components
- Parameters
[in] Bx
: magnetic field component in global x-direction[in] By
: magnetic field component in global y-direction[in] Bz
: magnetic field component in global z-direction
-
struct
Cache
¶ Public Functions
-
Cache
(const MagneticFieldContext&)¶ constructor with context
-
-