Acts::NullBField Exception Reference

Null bfield which returns 0 always. More...

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

Inheritance diagram for Acts::NullBField:

Collaboration diagram for Acts::NullBField:

Classes
struct	Cache

Public Member Functions
	NullBField ()=default
	Default constructor.
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

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

Detailed Description

Null bfield which returns 0 always.

Definition at line 18 of file NullBField.hpp.

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

Constructor & Destructor Documentation

Acts::NullBField::NullBField ( )

default

Default constructor.

Member Function Documentation

Result<Vector3> Acts::NullBField::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 32 of file NullBField.hpp.

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

References m_BField.

Result<Vector3> Acts::NullBField::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 45 of file NullBField.hpp.

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

References m_BField.

bool Acts::NullBField::isInside ( const Vector3 &  position ) 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 66 of file NullBField.hpp.

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

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

inlineoverride

Definition at line 55 of file NullBField.hpp.

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

Member Data Documentation

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

private

magnetic field vector

Definition at line 73 of file NullBField.hpp.

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

Referenced by getField(), and getFieldGradient().

---

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

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