returns a given constant field value at every point More...

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

Classes
struct	Cache

Public Member Functions
	ConstantBField (Vector3D B)
	construct constant magnetic field from field vector

	ConstantBField (double Bx=0., double By=0., double Bz=0.)
	construct constant magnetic field from components

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

void	setField (double Bx, double By, double Bz)
	update magnetic field vector from components

void	setField (const Vector3D &B)
	update magnetic field vector

Private Attributes
Vector3D	m_BField
	magnetic field vector

Detailed Description

returns a given constant field value at every point

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.

Definition at line 21 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 21 of file ConstantBField.hpp

Constructor & Destructor Documentation

Acts::ConstantBField::ConstantBField ( Vector3D B )

inlineexplicit

construct constant magnetic field from field vector

Parameters

[in] B magnetic field vector in global coordinate system

Definition at line 31 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 31 of file ConstantBField.hpp

Acts::ConstantBField::ConstantBField	(	double	Bx = `0.`,
		double	By = `0.`,
		double	Bz = `0.`
	)

inline

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

Definition at line 38 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 38 of file ConstantBField.hpp

Member Function Documentation

Vector3D Acts::ConstantBField::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 48 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 48 of file ConstantBField.hpp

References m_BField.

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), and Acts::Test::BOOST_DATA_TEST_CASE().

Here is the caller graph for this function:

Vector3D Acts::ConstantBField::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 58 of file ConstantBField.hpp.

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

References m_BField.

Vector3D Acts::ConstantBField::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 72 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 72 of file ConstantBField.hpp

References m_BField.

Vector3D Acts::ConstantBField::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 88 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 88 of file ConstantBField.hpp

References m_BField.

bool Acts::ConstantBField::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 constant B-Field

Definition at line 100 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 100 of file ConstantBField.hpp

void Acts::ConstantBField::setField	(	double	Bx,
		double	By,
		double	Bz
	)

inline

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

Definition at line 107 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 107 of file ConstantBField.hpp

References Acts::IntegrationTest::Bz, and m_BField.

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), and Acts::Test::BOOST_DATA_TEST_CASE().

Here is the caller graph for this function:

void Acts::ConstantBField::setField ( const Vector3D & B )

inline

update magnetic field vector

Parameters

[in] B magnetic field vector in global coordinate system

Definition at line 112 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 112 of file ConstantBField.hpp

References B(), and m_BField.

Here is the call graph for this function:

Member Data Documentation

Vector3D Acts::ConstantBField::m_BField

private

magnetic field vector

Definition at line 116 of file ConstantBField.hpp.

View newest version in sPHENIX GitHub at line 116 of file ConstantBField.hpp

Referenced by getField(), getFieldGradient(), and setField().

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

acts/blob/master/Core/include/Acts/MagneticField/ConstantBField.hpp

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation