Acts::NullBField Exception Reference

Null bfield which returns 0 always. More...

#include <acts/blob/master/Core/include/Acts/MagneticField/NullBField.hpp>

Collaboration diagram for Acts::NullBField:

Classes
struct	Cache

Public Member Functions
	NullBField ()=default
	Default constructor.
Vector3D	getField (const Vector3D &) const
	retrieve magnetic field value
Vector3D	getField (const Vector3D &, Cache &) const
	retrieve magnetic field value
Vector3D	getFieldGradient (const Vector3D &, ActsMatrixD< 3, 3 > &) const
	retrieve magnetic field value & its gradient
Vector3D	getFieldGradient (const Vector3D &, ActsMatrixD< 3, 3 > &, Cache &) const
	retrieve magnetic field value & its gradient
bool	isInside (const Vector3D &) const
	check whether given 3D position is inside look-up domain

Private Attributes
const Vector3D	m_BField = Vector3D::Zero()
	magnetic field vector

Detailed Description

Null bfield which returns 0 always.

Definition at line 17 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 17 of file NullBField.hpp

Constructor & Destructor Documentation

Acts::NullBField::NullBField ( )

default

Default constructor.

Member Function Documentation

Vector3D Acts::NullBField::getField ( const Vector3D &  ) const

inline

retrieve magnetic field value

Parameters

[in]

position

global position

Returns

magnetic field vector

Note

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

Definition at line 34 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 34 of file NullBField.hpp

References m_BField.

Vector3D Acts::NullBField::getField ( const Vector3D &  , Cache &    ) const

inline

retrieve magnetic field value

Parameters

[in]	position	global position
[in]	cache	Cache object (is ignored)

Returns

magnetic field vector

Note

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

Definition at line 44 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 44 of file NullBField.hpp

References m_BField.

Vector3D Acts::NullBField::getFieldGradient ( const Vector3D &  , ActsMatrixD< 3, 3 > &    ) const

inline

retrieve magnetic field value & its gradient

Parameters

[in]	position	global position
[out]	derivative	gradient of magnetic field vector as (3x3) matrix

Returns

magnetic field vector

Note

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

currently the derivative is not calculated

Definition at line 58 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 58 of file NullBField.hpp

References m_BField.

Vector3D Acts::NullBField::getFieldGradient ( const Vector3D &  , ActsMatrixD< 3, 3 > &  , Cache &    ) const

inline

retrieve magnetic field value & its gradient

Parameters

[in]	position	global position
[out]	derivative	gradient of magnetic field vector as (3x3) matrix
[in]	cache	Cache object (is ignored)

Returns

magnetic field vector

Note

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

currently the derivative is not calculated

Definition at line 74 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 74 of file NullBField.hpp

References m_BField.

bool Acts::NullBField::isInside ( const Vector3D &  ) const

inline

check whether given 3D position is inside look-up domain

Parameters

[in]

position

global 3D position

Returns

true if position is inside the defined look-up grid, otherwise false

Note

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

Definition at line 86 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 86 of file NullBField.hpp

Member Data Documentation

const Vector3D Acts::NullBField::m_BField = Vector3D::Zero()

private

magnetic field vector

Definition at line 90 of file NullBField.hpp.

View newest version in sPHENIX GitHub at line 90 of file NullBField.hpp

Referenced by getField(), and getFieldGradient().

---

The documentation for this exception was generated from the following file:

• acts/blob/master/Core/include/Acts/MagneticField/NullBField.hpp