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

#include <FairConstField.h>

Inheritance diagram for FairConstField:
FairField

Public Member Functions

 FairConstField ()
 
 FairConstField (const char *name, Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax, Double_t bX, Double_t bY, Double_t bZ)
 
 FairConstField (FairConstPar *fieldPar)
 
virtual ~FairConstField ()
 
void FillParContainer ()
 
void SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
 
void SetField (Double_t bX, Double_t bY, Double_t bZ)
 
virtual Double_t GetBx (Double_t x, Double_t y, Double_t z)
 
virtual Double_t GetBy (Double_t x, Double_t y, Double_t z)
 
virtual Double_t GetBz (Double_t x, Double_t y, Double_t z)
 
Double_t GetXmin () const
 
Double_t GetXmax () const
 
Double_t GetYmin () const
 
Double_t GetYmax () const
 
Double_t GetZmin () const
 
Double_t GetZmax () const
 
Double_t GetBx () const
 
Double_t GetBy () const
 
Double_t GetBz () const
 
virtual void Print (Option_t *) const
 
 ClassDef (FairConstField, 1)
 
- Public Member Functions inherited from FairField
 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 void GetFieldValue (const Double_t point[3], Double_t *bField)
 
void Field (const Double_t point[3], Double_t *B)
 
virtual void GetBxyz (const Double_t[3], Double_t *)
 

Additional Inherited Members

- Protected Attributes inherited from FairField
Int_t fType
 

Detailed Description

Definition at line 24 of file FairConstField.h.

Constructor & Destructor Documentation

FairConstField::FairConstField ( )

Default constructor

Definition at line 25 of file FairConstField.cxx.

FairConstField::FairConstField ( const char *  name,
Double_t  xMin,
Double_t  xMax,
Double_t  yMin,
Double_t  yMax,
Double_t  zMin,
Double_t  zMax,
Double_t  bX,
Double_t  bY,
Double_t  bZ 
)

Standard constructor

Parameters
nameObject name
xMin,xMaxx region of field (global coordinates)
yMin,yMaxy region of field (global coordinates)
zMin,zMaxz region of field (global coordinates)
bX,bY,bZField values [kG]

Definition at line 39 of file FairConstField.cxx.

FairConstField::FairConstField ( FairConstPar fieldPar)

Constructor from FairConstPar

Definition at line 64 of file FairConstField.cxx.

FairConstField::~FairConstField ( )
virtual

Destructor

Definition at line 93 of file FairConstField.cxx.

Member Function Documentation

FairConstField::ClassDef ( FairConstField  ,
 
)
void FairConstField::FillParContainer ( )
virtual

Fill Paramater

Reimplemented from FairField.

Definition at line 156 of file FairConstField.cxx.

Double_t FairConstField::GetBx ( Double_t  x,
Double_t  y,
Double_t  z 
)
virtual

Get components of field at a given point

Parameters
x,y,zPoint coordinates [cm]

Reimplemented from FairField.

Definition at line 117 of file FairConstField.cxx.

Double_t FairConstField::GetBx ( ) const
inline

Accessors to field values

Definition at line 84 of file FairConstField.h.

Double_t FairConstField::GetBy ( Double_t  ,
Double_t  ,
Double_t   
)
virtual

Get y component of magnetic field [kG]

Parameters
x,y,zPosition [cm]

Reimplemented from FairField.

Definition at line 125 of file FairConstField.cxx.

Double_t FairConstField::GetBy ( ) const
inline

Definition at line 85 of file FairConstField.h.

Double_t FairConstField::GetBz ( Double_t  ,
Double_t  ,
Double_t   
)
virtual

Get z component of magnetic field [kG]

Parameters
x,y,zPosition [cm]

Reimplemented from FairField.

Definition at line 133 of file FairConstField.cxx.

Double_t FairConstField::GetBz ( ) const
inline

Definition at line 86 of file FairConstField.h.

Double_t FairConstField::GetXmax ( ) const
inline

Definition at line 77 of file FairConstField.h.

Double_t FairConstField::GetXmin ( ) const
inline

Accessors to field region

Definition at line 76 of file FairConstField.h.

Double_t FairConstField::GetYmax ( ) const
inline

Definition at line 79 of file FairConstField.h.

Double_t FairConstField::GetYmin ( ) const
inline

Definition at line 78 of file FairConstField.h.

Double_t FairConstField::GetZmax ( ) const
inline

Definition at line 81 of file FairConstField.h.

Double_t FairConstField::GetZmin ( ) const
inline

Definition at line 80 of file FairConstField.h.

void FairConstField::Print ( Option_t *  ) const
virtual

Screen output

Reimplemented from FairField.

Definition at line 141 of file FairConstField.cxx.

void FairConstField::SetField ( Double_t  bX,
Double_t  bY,
Double_t  bZ 
)

Set the field values

Parameters
bX,bY,bZField values [kG]

Definition at line 110 of file FairConstField.cxx.

void FairConstField::SetFieldRegion ( Double_t  xMin,
Double_t  xMax,
Double_t  yMin,
Double_t  yMax,
Double_t  zMin,
Double_t  zMax 
)

Set the field region

Parameters
xMin,xMaxx region of field (global coordinates)
yMin,yMaxy region of field (global coordinates)
zMin,zMaxz region of field (global coordinates)

Definition at line 95 of file FairConstField.cxx.


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