FairRoot
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FairField Class Reference

#include <FairField.h>

Inheritance diagram for FairField:
FairConstField MyConstField MyConstField

Public Member Functions

 FairField ()
 
 FairField (const char *name, const char *title="FAIR Magnetic Field")
 
FairFieldoperator= (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 *)
 
virtual void FillParContainer ()
 

Protected Attributes

Int_t fType
 

Detailed Description

FairField.h

Author
M.Al-Turany <m.al/turany.de>
V.Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e
Since
06.01.2004 .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 36 of file FairField.h.

Constructor & Destructor Documentation

FairField::FairField ( )

Default constructor

Definition at line 16 of file FairField.cxx.

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 ( )
virtual

Destructor

Definition at line 26 of file FairField.cxx.

Member Function Documentation

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

Definition at line 97 of file FairField.h.

virtual void FairField::FillParContainer ( )
inlinevirtual

Fill Paramater

Reimplemented in FairConstField.

Definition at line 107 of file FairField.h.

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

Get x component of magnetic field [kG]

Parameters
x,y,zPosition [cm]

Reimplemented in MyConstField, MyConstField, and FairConstField.

Definition at line 67 of file FairField.h.

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

Definition at line 101 of file FairField.h.

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

Get y component of magnetic field [kG]

Parameters
x,y,zPosition [cm]

Reimplemented in MyConstField, MyConstField, and FairConstField.

Definition at line 76 of file FairField.h.

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

Get z component of magnetic field [kG]

Parameters
x,y,zPosition [cm]

Reimplemented in MyConstField, MyConstField, and FairConstField.

Definition at line 85 of file FairField.h.

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

Get magnetic field. For use of Geant3

Parameters
pointCoordinates [cm]
bField(return) Field components [kG]

Definition at line 44 of file FairField.cxx.

Int_t FairField::GetType ( ) const
inline

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

Definition at line 62 of file FairField.h.

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 53 of file FairField.h.

Bool_t FairField::IsConst ( )

Test whether field type is Constant

Definition at line 28 of file FairField.cxx.

Bool_t FairField::IsMap ( )

Test whether field typ is Map

Definition at line 36 of file FairField.cxx.

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

Definition at line 45 of file FairField.h.

virtual void FairField::Print ( Option_t *  ) const
inlinevirtual

Screen output. To be implemented in the concrete class.

Reimplemented in FairConstField.

Definition at line 100 of file FairField.h.

Member Data Documentation

Int_t FairField::fType
protected

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

Definition at line 111 of file FairField.h.


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