STEER/AliMagF.h

   1 #ifndef ALIMAGF_H
   2 #define ALIMAGF_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 //
   7 // Interface between the TVirtualMagField and AliMagWrapCheb: wrapper to
   8 // the set of magnetic field data + Tosca parameterization by
   9 // Chebyshev polynomials
  10 //
  11 // Author: ruben.shahoyan@cern.ch
  12 //
  13
  14 //#include <TGeoGlobalMagField.h>
  15 #include <TVirtualMagField.h>
  16 class AliMagWrapCheb;
  17
  18 class AliMagF : public TVirtualMagField
  19 {
  20  public:
  21   enum BMap_t      {k2kG, k5kG, k5kGUniform};
  22   enum BeamType_t  {kNoBeamField, kBeamTypepp, kBeamTypeAA};
  23   enum PolarityConvention_t {kConvLHC,kConvDCS2008,kConvMap2005};
  24   enum             {kOverrideGRP=BIT(14)}; // don't recreate from GRP if set
  25   //
  26   AliMagF();
  27   AliMagF(const char *name, const char* title, Double_t factorSol=1., Double_t factorDip=1.,
  28           BMap_t maptype = k5kG, BeamType_t btype=kBeamTypepp,
  29           Double_t benergy=-1., Int_t integ=2, Double_t fmax=10,
  30           const char* path="$(ALICE_ROOT)/data/maps/mfchebKGI_sym.root");
  31   AliMagF(const AliMagF& src);
  32   AliMagF& operator=(const AliMagF& src);
  33   virtual ~AliMagF();
  34   //
  35   virtual void Field(const Double_t *x, Double_t *b);
  36   void       GetTPCInt(const Double_t *xyz, Double_t *b)        const;
  37   void       GetTPCIntCyl(const Double_t *rphiz, Double_t *b)   const;
  38   Double_t   GetBz(const Double_t *xyz)                         const;
  39   //
  40   AliMagWrapCheb* GetMeasuredMap()                              const {return fMeasuredMap;}
  41   //
  42   // former AliMagF methods or their aliases
  43   void         SetFactorSol(Float_t fc=1.);
  44   void         SetFactorDip(Float_t fc=1.);
  45   Double_t     GetFactorSol()                                   const;
  46   Double_t     GetFactorDip()                                   const;
  47   Double_t     Factor()                                         const {return GetFactorSol();}
  48   Double_t     GetCurrentSol()                                  const {return GetFactorSol()*(fMapType==k2kG ? 12000:30000);}
  49   Double_t     GetCurrentDip()                                  const {return GetFactorDip()*6000;}
  50   Bool_t       IsUniform()                                      const {return fMapType == k5kGUniform;}
  51   //
  52   void         MachineField(const Double_t  *x, Double_t *b)    const;
  53   BMap_t       GetMapType()                                     const {return fMapType;}
  54   BeamType_t   GetBeamType()                                    const {return fBeamType;}
  55   const char*  GetBeamTypeText()                                const;
  56   Double_t     GetBeamEnergy()                                  const {return fBeamEnergy;}
  57   Double_t     Max()                                            const {return fMax;}
  58   Int_t        Integ()                                          const {return fInteg;}
  59   Int_t        PrecInteg()                                      const {return fPrecInteg;}
  60   Double_t     SolenoidField()                                  const {return fFactorSol*fSolenoid;}
  61   //
  62   Char_t*      GetDataFileName()                                const {return (Char_t*)fParNames.GetName();}
  63   Char_t*      GetParamName()                                   const {return (Char_t*)fParNames.GetTitle();}
  64   void         SetDataFileName(const Char_t* nm)                      {fParNames.SetName(nm);}
  65   void         SetParamName(const Char_t* nm)                         {fParNames.SetTitle(nm);}
  66   //
  67   Bool_t       LoadParameterization();
  68   static Int_t GetPolarityConvention()                                {return Int_t(fgkPolarityConvention);}
  69   static AliMagF* CreateFieldMap(Float_t l3Current=-30000., Float_t diCurrent=-6000.,
  70                                  Int_t convention=0, Bool_t uniform = kFALSE,
  71                                  Float_t benergy=7000., const Char_t* btype="pp",
  72                                  const Char_t* path="$(ALICE_ROOT)/data/maps/mfchebKGI_sym.root");
  73   //
  74  protected:
  75   // not supposed to be changed during the run, set only at the initialization via constructor
  76   void         InitMachineField(BeamType_t btype, Double_t benergy);
  77   void         SetBeamType(BeamType_t type)                           {fBeamType = type;}
  78   void         SetBeamEnergy(Float_t energy)                          {fBeamEnergy = energy;}
  79   //
  80  protected:
  81   AliMagWrapCheb*  fMeasuredMap;     //! Measured part of the field map
  82   BMap_t           fMapType;         // field map type
  83   Double_t         fSolenoid;        // Solenoid field setting
  84   BeamType_t       fBeamType;        // Beam type: A-A (fBeamType=0) or p-p (fBeamType=1)
  85   Double_t         fBeamEnergy;      // Beam energy in GeV
  86   //
  87   Int_t            fInteg;           // Default integration method as indicated in Geant
  88   Int_t            fPrecInteg;       // Alternative integration method, e.g. for higher precision
  89   Double_t         fFactorSol;       // Multiplicative factor for solenoid
  90   Double_t         fFactorDip;       // Multiplicative factor for dipole
  91   Double_t         fMax;             // Max Field as indicated in Geant
  92   Bool_t           fDipoleOFF;       // Dipole ON/OFF flag
  93   //
  94   Double_t         fQuadGradient;    // Gradient field for inner triplet quadrupoles
  95   Double_t         fDipoleField;     // Field value for D1 and D2 dipoles
  96   Double_t         fCCorrField;      // Side C 2nd compensator field
  97   Double_t         fACorr1Field;     // Side A 1st compensator field
  98   Double_t         fACorr2Field;     // Side A 2nd compensator field
  99   //
 100   TNamed           fParNames;        // file and parameterization loadad
 101   //
 102   static const Double_t  fgkSol2DipZ;    // conventional Z of transition from L3 to Dipole field
 103   static const UShort_t  fgkPolarityConvention; // convention for the mapping of the curr.sign on main component sign
 104   //
 105   ClassDef(AliMagF, 2)           // Class for all Alice MagField wrapper for measured data + Tosca parameterization
 106 };
 107
 108
 109 #endif