Belle II Software development
Public Member Functions | List of all members
BFieldComponentAbs Class Referenceabstract
Packages » geometry

The BFieldComponentAbs class. More...

#include <BFieldComponentAbs.h>

Inheritance diagram for BFieldComponentAbs:
BFieldComponent3d BFieldComponentBeamline BFieldComponentConstant BFieldComponentKlm1 BFieldComponentQuad BFieldComponentRadial

Public Member Functions

 BFieldComponentAbs ()=default
 The BFieldComponentAbs constructor.
 
virtual ~BFieldComponentAbs ()=default
 The BFieldComponentAbs destructor.
 
virtual void initialize ()
 Initializes the magnetic field component.
 
virtual ROOT::Math::XYZVector calculate (const ROOT::Math::XYZVector &point) const =0
 Calculates the magnetic field vector at the specified space point.
 
virtual void terminate ()
 Terminates the magnetic field component.
 

Detailed Description

The BFieldComponentAbs class.

This abstract class represents a component of the Belle II detector magnetic field. Usually, a component represents the magnetic field in a certain region of the Belle II detector. The check if a specified space point lies inside the region described by the component, has to be done by the component class itself.

All magnetic field components have to inherit from this class.

Definition at line 30 of file BFieldComponentAbs.h.

Member Function Documentation

◆ calculate()

virtual ROOT::Math::XYZVector calculate ( const ROOT::Math::XYZVector &  point) const
pure virtual

Calculates the magnetic field vector at the specified space point.

All magnetic field component classes have to overwrite this method. Please note: The magnetic field component class has to perform the check if the space point lies within the space region it describes by itself. If the space point given doesn't lie inside the space region this method should return TVector(0,0,0).

Parameters
pointThe space point in Cartesian coordinates (x,y,z) in [cm] at which the magnetic field vector should be calculated.
Returns
The magnetic field vector at the given space point in [T]. Return a zero vector TVector(0,0,0) if the space point lies outside the region described by the component.

Implemented in BFieldComponent3d, BFieldComponentBeamline, BFieldComponentConstant, BFieldComponentKlm1, BFieldComponentQuad, and BFieldComponentRadial.

◆ initialize()

virtual void initialize ( )
inlinevirtual

Initializes the magnetic field component.

This method should be used to open and load files containing the magnetic field data.

Reimplemented in BFieldComponent3d, BFieldComponentBeamline, BFieldComponentKlm1, BFieldComponentQuad, and BFieldComponentRadial.

Definition at line 45 of file BFieldComponentAbs.h.

45{};

◆ terminate()

virtual void terminate ( )
inlinevirtual

Terminates the magnetic field component.

This method should be used to close files that have been opened in the initialize() method.

Reimplemented in BFieldComponent3d, BFieldComponentBeamline, BFieldComponentKlm1, and BFieldComponentRadial.

Definition at line 66 of file BFieldComponentAbs.h.

66{};
The documentation for this class was generated from the following file: