Class NullBField

Nested Relationships

Class Documentation

class Acts::NullBField

Null bfield which returns 0 always.

Public Functions

NullBField() = default

Default constructor.

Vector3 getField(const Vector3&) const

retrieve magnetic field value

Return

magnetic field vector

Note

The position is ignored and only kept as argument to provide a consistent interface with other magnetic field services.

Parameters

  • [in] position: global position

Vector3 getField(const Vector3&, Cache&) const

retrieve magnetic field value

Return

magnetic field vector

Note

The position is ignored and only kept as argument to provide a consistent interface with other magnetic field services.

Parameters

  • [in] position: global position

  • [in] cache: Cache object (is ignored)

Vector3 getFieldGradient(const Vector3&, ActsMatrix<3, 3>&) const

retrieve magnetic field value & its gradient

Return

magnetic field vector

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

Parameters

  • [in] position: global position

  • [out] derivative: gradient of magnetic field vector as (3x3) matrix

Vector3 getFieldGradient(const Vector3&, ActsMatrix<3, 3>&, Cache&) const

retrieve magnetic field value & its gradient

Return

magnetic field vector

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

Parameters

  • [in] position: global position

  • [out] derivative: gradient of magnetic field vector as (3x3) matrix

  • [in] cache: Cache object (is ignored)

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, otherwise false

Note

The method will always return true for the null B-Field

Parameters

  • [in] position: global 3D position

struct Cache

Public Functions

Cache(std::reference_wrapper<const MagneticFieldContext>)

constructor with context