StRoot: StarMagField/StarMagField.h Source File

00001 /***********************************************************************
00002  *
00003  * $Id: StarMagField.h,v 1.8 2009/12/11 14:19:07 fisyak Exp $
00004  *
00005  * Author: Jim Thomas   11/1/2000
00006  *
00007  ***********************************************************************
00008  *
00009  * Description: the STAR Magnetic Field
00010  *
00011  ***********************************************************************
00012  *
00013  * $Log: StarMagField.h,v $
00014  * Revision 1.8  2009/12/11 14:19:07  fisyak
00015  * switch from define to enum
00016  *
00017  * Revision 1.7  2009/12/08 15:33:57  fisyak
00018  * Hold replacement defines via enum till StMagUtilities will be updated
00019  *
00020  * Revision 1.6  2009/12/07 23:38:15  fisyak
00021  * Move size definition from #define  to enumerations
00022  *
00023  * Revision 1.5  2009/01/13 03:19:44  perev
00024  * Mag field nou controlled from starsim. BugFix
00025  *
00026  * Revision 1.4  2007/09/21 21:07:08  fisyak
00027  * Remove ClassDef and ClassImp
00028  *
00029  * Revision 1.3  2007/09/13 00:00:27  fisyak
00030  * add mag.field in steel, from Lijuan Ruan
00031  *
00032  * Revision 1.2  2005/07/28 19:46:01  fisyak
00033  * Add:
00034  * -  frindge magnetic field from P.Nevski extrapolation,
00035  * -  lock mechanism for Magnetic Field parameters
00036  * Remove:
00037  * -  Electric Field (Still part of StDbUtilitie/StMagUtilities)
00038  *
00039  * Comparision between mfldgeo and StarMagField calculation for Z and R components of mag.field
00040  * is at http://www.star.bnl.gov/~fisyak/star/MagField/
00041  *
00042  * Revision 1.1.1.1  2005/07/07 14:13:55  fisyak
00043  * The version of STAR mag. field extracted from StDbUtilities/StMagUtilities to be used in Simulation and Reconstruction instead of agufld
00044  *
00045  * Revision 1.2  2005/07/07 14:07:55  fisyak
00046  * Final version before moving to official repository
00047  *
00048  * Revision 1.1  2004/03/12 13:26:24  fisyak
00049  * Singleton for STAR magnetic field
00050  *
00051   ***********************************************************************/
00053 //                                                                      //
00054 // StarMagField Class                                                 //
00055 //                                                                      //
00057 #ifndef StarMagField_H
00058 #define StarMagField_H
00059  
00060 #include <math.h>
00061 #include <stdio.h>
00062 #include <stdlib.h>
00063 #include <Stiostream.h>
00064 #include <Rtypes.h>
00065 class StarMagField  {
00066  public:
00067   enum   EBField  { kUndefined = 0, kConstant = 1, kMapped = 2, kChain = 3 } ;
00068   enum   ESmFSizes {nZ = 57, nR = 28, nPhi = 37, nZSteel = 16, nRSteel = 115, nPhiSteel = 25};
00069   static  void    Search ( Int_t N, const Float_t Xarray[], Float_t x, Int_t &low ) ;
00070   virtual Float_t Interpolate ( const Float_t Xarray[], const Float_t Yarray[], 
00071                                 const Int_t ORDER, const Float_t x ) ;
00072   virtual void    Interpolate2DBfield ( const Float_t r, const Float_t z, 
00073                                         Float_t &Br_value, Float_t &Bz_value ) ;
00074   virtual void    Interpolate2ExtDBfield ( const Float_t r, const Float_t z, 
00075                                         Float_t &Br_value, Float_t &Bz_value ) ;
00076   virtual void    Interpolate3DBfield ( const Float_t r, const Float_t z, const Float_t phi,
00077                                 Float_t &Br_value, Float_t &Bz_value, Float_t &Bphi_value ) ;
00078 
00079  private:
00080 
00081   virtual void    ReadField ( ) ;
00082  public:
00083   //added by Lijuan
00084   
00085   virtual void    Interpolate3DBSteelfield ( const Float_t r, const Float_t z, const Float_t phi,
00086                                              Float_t &Br_value, Float_t &Bz_value, Float_t &Bphi_value );
00087   //end added by Lijuan
00088 
00089 
00090   static StarMagField *fgInstance;
00091 
00092   EBField  fMap;       // (D) = kMapped; Global flag to indicate static arrays are full
00093   Float_t  fFactor;    // (D) = 1.0    ; Multiplicative factor (allows scaling and sign reversal)
00094   Float_t  fRescale;   // (D) = 1.0    ; Multiplicative factor (allows re-scaling wrt which map read)
00095   Float_t  fBDipole;   // (D) = -42.67 ; field value (kG)
00096   Float_t  fRmaxDip;   // (D) =  15.34 ; Inner field volume radius
00097   Float_t  fZminDip;   // (D) =  980.0 ; StArt of the DX mAgnet in Z
00098   Float_t  fZmaxDip;   // (D) = 1350.0 ; End of the DX mAgnet in Z
00099   Bool_t   fLock;      // (D) = kFALSE ; Set kTRUE if lock above values 
00100 
00101   Float_t  Bz[nZ][nR], Br[nZ][nR] ;         
00102   Float_t  Radius[nR], ZList[nZ] ;         
00103   Float_t  Bz3D[nPhi][nZ][nR], Br3D[nPhi][nZ][nR], Bphi3D[nPhi][nZ][nR] ;         
00104   Float_t  R3D[nR], Z3D[nZ], Phi3D[nPhi] ;         
00105   Float_t  R3DSteel[nRSteel], Z3DSteel[nZSteel], Phi3DSteel[nPhiSteel] ;         
00106   Float_t  Bz3DSteel[nPhiSteel][nZSteel][nRSteel];
00107   Float_t  Bx3DSteel[nPhiSteel][nZSteel][nRSteel], By3DSteel[nPhiSteel][nZSteel][nRSteel] ;        
00108 
00109   //added by Lijuan
00110   Float_t  Br3DSteel[nPhiSteel][nZSteel][nRSteel], Bphi3DSteel[nPhiSteel][nZSteel][nRSteel] ;        
00111   //end added by Lijuan
00112  
00113  public:
00114 
00115   StarMagField ( EBField map     = kMapped, Float_t Factor  =      1, 
00116                  Bool_t  Lock    =  kFALSE, Float_t Rescale =      1, 
00117                  Float_t Bdipole =  -42.67, Float_t Rmaxdip =  15.34,
00118                  Float_t Zmindip =   980.0, Float_t Zmaxdip = 1350.0) ;
00119   static StarMagField *Instance() {return fgInstance;}
00120   virtual ~StarMagField () { fgInstance = 0; }
00121 
00122 
00123   virtual void    BField   ( const Float_t x[], Float_t B[] ) ;
00124   virtual void    BField   ( const Double_t x[], Double_t B[] ) ;
00125   virtual void    BrBzField( const Float_t r, const Float_t z, Float_t &Br_value, Float_t &Bz_value ) ;
00126   virtual void    B3DField ( const Float_t x[], Float_t B[] ) ;
00127   virtual void    BrBz3DField ( const Float_t r, const Float_t z, const Float_t phi,
00128                                 Float_t &Br_value, Float_t &Bz_value, Float_t &Bphi_value ) ;
00129   virtual void    SetFactor (Float_t factor = 1);
00130   virtual void    SetRescale(Float_t factor = 1);
00131   virtual void    SetBDipole(Float_t m = -42.67);
00132   virtual void    SetRmaxDip(Float_t m =   15.3);
00133   virtual void    SetZminDip(Float_t m =  980.0);
00134   virtual void    SetZmaxDip(Float_t m = 1350.0);
00135   virtual void    SetLock();
00136   virtual EBField GetMap()     {return fMap;}
00137   virtual Float_t GetFactor()  {return fFactor;}
00138   virtual Float_t GetRescale() {return fRescale;}
00139   virtual Bool_t  IsLocked()   {return fLock;}
00140   virtual void    Print();
00141   //  ClassDef(StarMagField,1)    // Base class for all STAR MagField
00142 
00143 };
00144 
00145 #endif