Acts::ConstantBField Exception Reference

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

Inheritance diagram for Acts::ConstantBField:

Collaboration diagram for Acts::ConstantBField:

Classes
struct	Cache

Public Member Functions
	ConstantBField (Vector3 B)
Vector3	getField () const
	Get the B field at a position.
Result< Vector3 >	getField (const Vector3 &position, MagneticFieldProvider::Cache &cache) const override
Result< Vector3 >	getFieldGradient (const Vector3 &position, ActsMatrix< 3, 3 > &derivative, MagneticFieldProvider::Cache &cache) const override
Acts::MagneticFieldProvider::Cache	makeCache (const Acts::MagneticFieldContext &mctx) const override
bool	isInside (const Vector3 &position) const
	check whether given 3D position is inside look-up domain
void	setField (const Vector3 &B)
	update magnetic field vector

Private Attributes
Vector3	m_BField
	magnetic field vector

Detailed Description

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 ( Vector3  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

Member Function Documentation

Vector3 Acts::ConstantBField::getField ( ) const

inline

Get the B field at a position.

Definition at line 34 of file ConstantBField.hpp.

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

References m_BField.

Referenced by Acts::Test::BOOST_DATA_TEST_CASE().

Here is the caller graph for this function:

Result<Vector3> Acts::ConstantBField::getField ( const Vector3 &  position, MagneticFieldProvider::Cache &  cache  ) const

inlineoverride

Note

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

Definition at line 40 of file ConstantBField.hpp.

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

References m_BField.

Result<Vector3> Acts::ConstantBField::getFieldGradient ( const Vector3 &  position, ActsMatrix< 3, 3 > &  derivative, MagneticFieldProvider::Cache &  cache  ) const

inlineoverride

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 53 of file ConstantBField.hpp.

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

References m_BField.

bool Acts::ConstantBField::isInside ( const Vector3 &  position ) const

inline

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

Parameters

[in]

position

global 3D position

Returns

Always true for constant magnetic field

Definition at line 72 of file ConstantBField.hpp.

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

Acts::MagneticFieldProvider::Cache Acts::ConstantBField::makeCache ( const Acts::MagneticFieldContext &  mctx ) const

inlineoverride

Definition at line 63 of file ConstantBField.hpp.

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

Referenced by Acts::Test::BOOST_DATA_TEST_CASE().

Here is the caller graph for this function:

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

inline

update magnetic field vector

Parameters

[in]

B

magnetic field vector in global coordinate system

Definition at line 80 of file ConstantBField.hpp.

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

References m_BField.

Referenced by Acts::Test::BOOST_DATA_TEST_CASE().

Here is the caller graph for this function:

Member Data Documentation

Vector3 Acts::ConstantBField::m_BField

private

magnetic field vector

Definition at line 84 of file ConstantBField.hpp.

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

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

---

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

• acts/blob/sPHENIX/Core/include/Acts/MagneticField/ConstantBField.hpp