FairField Class Reference

#include <FairField.h>

Inherits TVirtualMagField.

Inherited by o2::field::ALICE3MagneticField, and o2::field::MagneticField.

Public Member Functions
	FairField ()
	FairField (const char *name, const char *title="FAIR Magnetic Field")
FairField &	operator= (const FairField &)
virtual	~FairField ()
virtual void	Init ()
Bool_t	IsConst ()
Bool_t	IsMap ()
Int_t	GetType () const
virtual Double_t	GetBx (Double_t, Double_t, Double_t)
virtual Double_t	GetBy (Double_t, Double_t, Double_t)
virtual Double_t	GetBz (Double_t, Double_t, Double_t)
virtual void	GetFieldValue (const Double_t point[3], Double_t *bField)
void	Field (const Double_t point[3], Double_t *B)
virtual void	Print (Option_t *) const
virtual void	GetBxyz (const Double_t[3], Double_t *)

Protected Attributes
Int_t	fType

Detailed Description

FairField.h

Author

M.Al-Turany <m.al/turany@gsi.de>

V.Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Since

06.01.2004 @version1.0

Abstract base class for magnetic fields in FAIR Concrete field should implement the pure virtual methods GetBx, GetBy and GetBz and/or GetBxyz

Note: Field values should be returned in kG (thanks to Geant3)

Definition at line 37 of file FairField.h.

Constructor & Destructor Documentation

FairField() [1/2]

FairField::FairField

(

)

Default constructor

Definition at line 16 of file FairField.cxx.

FairField() [2/2]

FairField::FairField	(	const char *	name,
		const char *	title = "FAIR Magnetic Field"
	)

Constructor with name and title

Definition at line 21 of file FairField.cxx.

~FairField()

FairField::~FairField ( )

virtual

Destructor

Definition at line 26 of file FairField.cxx.

Member Function Documentation

Field()

void FairField::Field ( const Double_t  point[3], Double_t *  B  )

inline

Definition at line 98 of file FairField.h.

GetBx()

virtual Double_t FairField::GetBx ( Double_t  , Double_t  , Double_t    )

inlinevirtual

Get x component of magnetic field [kG]

Parameters

x,y,z

Position [cm]

Reimplemented in o2::field::ALICE3MagneticField, and o2::field::MagneticField.

Definition at line 68 of file FairField.h.

GetBxyz()

virtual void FairField::GetBxyz ( const Double_t  [3], Double_t *    )

inlinevirtual

Reimplemented in o2::field::MagneticField.

Definition at line 102 of file FairField.h.

GetBy()

virtual Double_t FairField::GetBy ( Double_t  , Double_t  , Double_t    )

inlinevirtual

Get y component of magnetic field [kG]

Parameters

x,y,z

Position [cm]

Reimplemented in o2::field::ALICE3MagneticField, and o2::field::MagneticField.

Definition at line 77 of file FairField.h.

GetBz()

virtual Double_t FairField::GetBz ( Double_t  , Double_t  , Double_t    )

inlinevirtual

Get z component of magnetic field [kG]

Parameters

x,y,z

Position [cm]

Reimplemented in o2::field::ALICE3MagneticField, and o2::field::MagneticField.

Definition at line 86 of file FairField.h.

GetFieldValue()

void FairField::GetFieldValue ( const Double_t  point[3], Double_t *  bField  )

virtual

Get magnetic field. For use of Geant3

Parameters

point	Coordinates [cm]
bField	(return) Field components [kG]

Definition at line 44 of file FairField.cxx.

GetType()

Int_t FairField::GetType ( ) const

inline

Field type ( 0=constant, 1=map, 2=map sym2, 3 = map sym3 )

Definition at line 63 of file FairField.h.

Init()

virtual void FairField::Init ( )

inlinevirtual

Intialisation. E.g. read in the field map. If needed, to be implemented in the concrete class.

Definition at line 54 of file FairField.h.

IsConst()

Bool_t FairField::IsConst

(

)

Test whether field type is Constant

Definition at line 28 of file FairField.cxx.

IsMap()

Bool_t FairField::IsMap

(

)

Test whether field typ is Map

Definition at line 36 of file FairField.cxx.

operator=()

FairField & FairField::operator= ( const FairField &  )

inline

Definition at line 46 of file FairField.h.

Print()

virtual void FairField::Print ( Option_t *  ) const

inlinevirtual

Screen output. To be implemented in the concrete class.

Reimplemented in o2::field::MagneticField.

Definition at line 101 of file FairField.h.

Member Data Documentation

fType

Int_t FairField::fType

protected

Field type. 1 = constant field, 2 = field map.

Definition at line 110 of file FairField.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/3rdparty/FairRootBase/include/FairField.h
• /home/runner/work/AliceO2/AliceO2/Detectors/3rdparty/FairRootBase/src/FairField.cxx