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

#include <acts/blob/sPHENIX/Examples/Detectors/MagneticField/include/ActsExamples/Plugins/BField/ScalableBField.hpp>

Classes
struct	Cache

Public Member Functions
	ScalableBField (Acts::Vector3D B)
	construct constant magnetic field from field vector

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

Acts::Vector3D	getField (const Acts::Vector3D &) const
	retrieve magnetic field value

Acts::Vector3D	getField (const Acts::Vector3D &, Cache &cache) const
	retrieve magnetic field value

Acts::Vector3D	getFieldGradient (const Acts::Vector3D &, Acts::ActsMatrixD< 3, 3 > &) const
	retrieve magnetic field value & its gradient

Acts::Vector3D	getFieldGradient (const Acts::Vector3D &, Acts::ActsMatrixD< 3, 3 > &, Cache &cache) const
	retrieve magnetic field value & its gradient

bool	isInside (const Acts::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 Acts::Vector3D &B)
	update magnetic field vector

Private Attributes
Acts::Vector3D	m_BField
	magnetic field vector

Detailed Description

returns a given constant field value at every point

This class is based on the constant magnetic field class but allows a event based context

Definition at line 29 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 29 of file ScalableBField.hpp

Constructor & Destructor Documentation

ActsExamples::BField::ScalableBField::ScalableBField ( Acts::Vector3D B )

inlineexplicit

construct constant magnetic field from field vector

Parameters

[in] B magnetic field vector in global coordinate system

Definition at line 43 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 43 of file ScalableBField.hpp

ActsExamples::BField::ScalableBField::ScalableBField	(	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 50 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 50 of file ScalableBField.hpp

Member Function Documentation

Acts::Vector3D ActsExamples::BField::ScalableBField::getField ( const Acts::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 60 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 60 of file ScalableBField.hpp

References m_BField.

Acts::Vector3D ActsExamples::BField::ScalableBField::getField	(	const Acts::Vector3D &	,
		Cache &	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 72 of file ScalableBField.hpp.

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

References m_BField, and ActsExamples::BField::ScalableBField::Cache::scalor.

Acts::Vector3D ActsExamples::BField::ScalableBField::getFieldGradient	(	const Acts::Vector3D &	,
		Acts::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 88 of file ScalableBField.hpp.

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

References m_BField.

Acts::Vector3D ActsExamples::BField::ScalableBField::getFieldGradient	(	const Acts::Vector3D &	,
		Acts::ActsMatrixD< 3, 3 > &	,
		Cache &	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 106 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 106 of file ScalableBField.hpp

References m_BField, and ActsExamples::BField::ScalableBField::Cache::scalor.

bool ActsExamples::BField::ScalableBField::isInside ( const Acts::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 118 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 118 of file ScalableBField.hpp

void ActsExamples::BField::ScalableBField::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 125 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 125 of file ScalableBField.hpp

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

void ActsExamples::BField::ScalableBField::setField ( const Acts::Vector3D & B )

inline

update magnetic field vector

Parameters

[in] B magnetic field vector in global coordinate system

Definition at line 130 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 130 of file ScalableBField.hpp

References m_BField.

Member Data Documentation

Acts::Vector3D ActsExamples::BField::ScalableBField::m_BField

private

magnetic field vector

Definition at line 134 of file ScalableBField.hpp.

View newest version in sPHENIX GitHub at line 134 of file ScalableBField.hpp

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

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

acts/blob/sPHENIX/Examples/Detectors/MagneticField/include/ActsExamples/Plugins/BField/ScalableBField.hpp

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation