Acts::ToroidField Class Reference

Toroid magnetic field implementation. More...

#include <Acts/MagneticField/ToroidField.hpp>

Inheritance diagram for Acts::ToroidField:

Collaboration diagram for Acts::ToroidField:

Classes
struct	BarrelConfig
	Configuration for barrel toroid coils. More...
struct	Cache
	Cache for magnetic field provider. More...
struct	Config
	Full configuration for the toroid field. More...
struct	EctConfig
	Configuration for end-cap toroid (ECT) coils. More...
struct	LayoutConfig
	Configuration for coil layout and discretization. More...

Public Member Functions
	ToroidField ()
	Construct with default configuration.
	ToroidField (Config cfg)
	Construct with custom configuration.
const Config &	config () const
	Get the configuration.
Result< Vector3 >	getField (const Vector3 &position, MagneticFieldProvider::Cache &cache) const override
	Retrieve magnetic field value at a given location.
MagneticFieldProvider::Cache	makeCache (const MagneticFieldContext &mctx) const override
	Make an opaque cache for the magnetic field.

Additional Inherited Members
Public Types inherited from Acts::MagneticFieldProvider
using	Cache = Acts::AnyBase<sizeof(char) * 512>
	Opaque cache type that can store arbitrary implementation specific cache data.

Detailed Description

Toroid magnetic field implementation.

This class implements a toroid magnetic field configuration similar to those used in ATLAS and other detector systems. It uses Biot-Savart calculations with discrete current-carrying wire segments to compute the field at any position.

Constructor & Destructor Documentation

ToroidField()

Acts::ToroidField::ToroidField ( Config cfg )

explicit

Construct with custom configuration.

Parameters

cfg	Configuration parameters

Member Function Documentation

config()

const Config & Acts::ToroidField::config

(

)

const

Get the configuration.

Returns

Configuration struct reference

getField()

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

overridevirtual

Retrieve magnetic field value at a given location.

Requires an instance of Acts::MagneticFieldProvider::Cache created through makeCache.

Parameters

[in]	position	global 3D position for the lookup
[in,out]	cache	Field provider specific cache object

Returns

magnetic field vector at given position

Implements Acts::MagneticFieldProvider.

makeCache()

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

overridevirtual

Make an opaque cache for the magnetic field.

Instructs the specific implementation to generate a Acts::MagneticFieldProvider::Cache instance for magnetic field lookup.

Parameters

mctx	The magnetic field context to generate cache for

Returns

Cache The opaque cache object

Implements Acts::MagneticFieldProvider.