BFieldManager Class Reference

Bfield manager to obtain the magnetic field at any point. More...

#include <BFieldManager.h>

Collaboration diagram for BFieldManager:

Static Public Member Functions
static void	getField (const double *pos, double *field)
	return the magnetic field at a given position.
static ROOT::Math::XYZVector	getField (double x, double y, double z)
	return the magnetic field at a given position.
static ROOT::Math::XYZVector	getField (const ROOT::Math::XYZVector &pos)
	return the magnetic field at a given position.
static ROOT::Math::XYZVector	getFieldInTesla (const ROOT::Math::XYZVector &pos)
	return the magnetic field at a given position in Tesla.
static BFieldManager &	getInstance ()
	Return the instance of the magnetic field manager.

Private Member Functions
	BFieldManager ()=default
	Singleton: private constructor.
	BFieldManager (BFieldManager &)=delete
	Singleton: no copy constructor.
BFieldManager &	operator= (const BFieldManager &)=delete
	Singleton: no assignment operator.
	~BFieldManager ()=default
	Empty destructor: this is just a wrapper to access the database object.
ROOT::Math::XYZVector	calculate (const ROOT::Math::XYZVector &pos) const
	Calculate the field value at a given position and return it.

Private Attributes
DBObjPtr< MagneticField >	m_magfield
	Pointer to the actual magnetic field in the database.

Detailed Description

Bfield manager to obtain the magnetic field at any point.

This class is implemented as singleton, there can only be one magnetic field. It has static members to get the field at a given point.

Note

For internal use in the simulation, there is also a BFieldMap class in the geometry package with similar behaviour. To ensure consistent output, the BFieldFrameworkInterface component provides a wrapper around BFieldMap and is used by default.

Definition at line 32 of file BFieldManager.h.

Member Function Documentation

getField() [1/2]

static ROOT::Math::XYZVector getField ( const ROOT::Math::XYZVector &  pos )

inlinestatic

return the magnetic field at a given position.

Parameters

pos	position where to evaluate the magnetic field

Returns

magnetic field value at position pos in framework units

Definition at line 53 of file BFieldManager.h.

    {
      return BFieldManager::getInstance().calculate(pos);
    }

getField() [2/2]

static ROOT::Math::XYZVector getField ( double  x, double  y, double  z  )

inlinestatic

return the magnetic field at a given position.

Parameters

x	x coordinate of the position where to evaluate the magnetic field
y	y coordinate of the position where to evaluate the magnetic field
z	z coordinate of the position where to evaluate the magnetic field

Returns

magnetic field value at position pos in framework units

Definition at line 45 of file BFieldManager.h.

    {
      return getField(ROOT::Math::XYZVector(x, y, z));
    }

getFieldInTesla()

static ROOT::Math::XYZVector getFieldInTesla ( const ROOT::Math::XYZVector &  pos )

inlinestatic

return the magnetic field at a given position in Tesla.

Parameters

pos	position where to evaluate the magnetic field

Returns

magnetic field value at position pos in Tesla

Definition at line 61 of file BFieldManager.h.

    {
      return getField(pos) / Unit::T;
    }

getInstance()

BFieldManager & getInstance ( )

static

Return the instance of the magnetic field manager.

Definition at line 13 of file BFieldManager.cc.

{
  static BFieldManager instance;
  return instance;
}

Member Data Documentation

m_magfield

DBObjPtr<MagneticField> m_magfield

private

Pointer to the actual magnetic field in the database.

Definition at line 82 of file BFieldManager.h.

---

The documentation for this class was generated from the following files:

• framework/geometry/include/BFieldManager.h
• framework/geometry/src/BFieldManager.cc