STEER/AliMC.h

   1 #ifndef ALIMC_H
   2 #define ALIMC_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 /* $Id$ */
   7
   8 ///////////////////////////////////////////////////////////////////////////////
   9 //                                                                           //
  10 //                                                                           //
  11 //   Abstract Monte Carlo interface                                          //
  12 //                                                                           //
  13 //                                                                           //
  14 ///////////////////////////////////////////////////////////////////////////////
  15
  16 #include <TNamed.h>
  17 #include <AliRndm.h>
  18 #include "AliMCProcess.h"
  19
  20 class TLorentzVector;
  21 class AliMC;
  22 class AliDecayer;
  23 class TArrayI;
  24
  25 R__EXTERN AliMC *gMC;
  26
  27 enum AliMCGeomType { kGeant3, kGeant4 , kFluka};
  28
  29 class AliMC : public TNamed, public AliRndm
  30 {
  31   public:
  32     AliMC(const char *name, const char *title);
  33     AliMC() {fRandom=0;}
  34     virtual ~AliMC() {fgMC=gMC=0;fRandom=0;}
  35
  36     // static access method
  37     static AliMC* GetMC() { return fgMC; }
  38
  39     //
  40     // methods for building/management of geometry
  41     // ------------------------------------------------
  42     //
  43
  44     // functions from GCONS
  45     virtual void  Gfmate(Int_t imat, char *name, Float_t &a, Float_t &z,
  46                          Float_t &dens, Float_t &radl, Float_t &absl,
  47                          Float_t* ubuf, Int_t& nbuf) = 0;
  48
  49     // detector composition
  50     virtual void  Material(Int_t& kmat, const char* name, Float_t a,
  51                      Float_t z, Float_t dens, Float_t radl, Float_t absl,
  52                      Float_t* buf, Int_t nwbuf) = 0;
  53     virtual void  Mixture(Int_t& kmat, const char *name, Float_t *a,
  54                      Float_t *z, Float_t dens, Int_t nlmat, Float_t *wmat) = 0;
  55     virtual void  Medium(Int_t& kmed, const char *name, Int_t nmat,
  56                      Int_t isvol, Int_t ifield, Float_t fieldm, Float_t tmaxfd,
  57                      Float_t stemax, Float_t deemax, Float_t epsil,
  58                      Float_t stmin, Float_t* ubuf, Int_t nbuf) = 0;
  59     virtual void  Matrix(Int_t& krot, Float_t thetaX, Float_t phiX,
  60                      Float_t thetaY, Float_t phiY, Float_t thetaZ,
  61                      Float_t phiZ) = 0;
  62     virtual void  Gstpar(Int_t itmed, const char *param, Float_t parval) = 0;
  63
  64     // functions from GGEOM
  65     virtual Int_t Gsvolu(const char *name, const char *shape, Int_t nmed,
  66                          Float_t *upar, Int_t np) = 0;
  67     virtual void  Gsdvn(const char *name, const char *mother, Int_t ndiv,
  68                         Int_t iaxis) = 0;
  69     virtual void  Gsdvn2(const char *name, const char *mother, Int_t ndiv,
  70                          Int_t iaxis, Float_t c0i, Int_t numed) = 0;
  71     virtual void  Gsdvt(const char *name, const char *mother, Float_t step,
  72                         Int_t iaxis, Int_t numed, Int_t ndvmx) = 0;
  73     virtual void  Gsdvt2(const char *name, const char *mother, Float_t step,
  74                          Int_t iaxis, Float_t c0, Int_t numed, Int_t ndvmx) = 0;
  75     virtual void  Gsord(const char *name, Int_t iax) = 0;
  76     virtual void  Gspos(const char *name, Int_t nr, const char *mother,
  77                         Float_t x, Float_t y, Float_t z, Int_t irot,
  78                         const char *konly="ONLY") = 0;
  79     virtual void  Gsposp(const char *name, Int_t nr, const char *mother,
  80                          Float_t x, Float_t y, Float_t z, Int_t irot,
  81                          const char *konly, Float_t *upar, Int_t np) = 0;
  82     virtual void  Gsbool(const char* onlyVolName, const char* manyVolName) = 0;
  83
  84     virtual void  SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
  85                   Float_t *absco, Float_t *effic, Float_t *rindex) = 0;
  86
  87
  88     // functions for drawing
  89     virtual void  DrawOneSpec(const char* name) = 0;
  90     virtual void  Gsatt(const char* name, const char* att, Int_t val) = 0;
  91     virtual void  Gdraw(const char*,Float_t theta = 30, Float_t phi = 30,
  92                         Float_t psi = 0, Float_t u0 = 10, Float_t v0 = 10,
  93                         Float_t ul = 0.01, Float_t vl = 0.01) = 0;
  94
  95     // Euclid
  96     virtual void WriteEuclid(const char*, const char*, Int_t, Int_t) = 0;
  97
  98     // get methods
  99     virtual Int_t VolId(const Text_t* volName) const = 0;
 100     virtual const char* VolName(Int_t id) const = 0;
 101     virtual Int_t NofVolumes() const = 0;
 102     virtual Int_t VolId2Mate(Int_t id) const = 0;
 103
 104     //
 105     // methods for physics management
 106     // ------------------------------------------------
 107     //
 108
 109     // set methods
 110     virtual void SetCut(const char* cutName, Float_t cutValue) = 0;
 111     virtual void SetProcess(const char* flagName, Int_t flagValue) = 0;
 112     virtual Float_t Xsec(char*, Float_t, Int_t, Int_t) = 0;
 113
 114         // particle table usage
 115     virtual Int_t   IdFromPDG(Int_t id) const =0;
 116     virtual Int_t   PDGFromId(Int_t pdg) const =0;
 117     virtual void    DefineParticles() = 0;
 118
 119     //
 120     // methods for step management
 121     // ------------------------------------------------
 122     //
 123
 124     // action methods
 125     virtual void StopTrack() =0;
 126     virtual void StopEvent() =0;
 127
 128     // set methods
 129     virtual void SetMaxStep(Float_t) = 0;
 130     virtual void SetMaxNStep(Int_t) = 0;
 131     virtual void SetUserDecay(Int_t) =0;
 132
 133     // get methods
 134          // tracking volume(s)
 135     virtual Int_t CurrentVolID(Int_t& copyNo) const =0;
 136     virtual Int_t CurrentVolOffID(Int_t off, Int_t& copyNo) const =0;
 137     virtual const char* CurrentVolName() const =0;
 138     virtual const char* CurrentVolOffName(Int_t off) const =0;
 139     virtual Int_t CurrentMaterial(Float_t &a, Float_t &z,
 140                     Float_t &dens, Float_t &radl, Float_t &absl) const =0;
 141     virtual Int_t CurrentEvent() const =0;
 142     virtual void  Gmtod(Float_t* xm, Float_t* xd, Int_t iflag) = 0;
 143     virtual void  Gdtom(Float_t* xd, Float_t* xm, Int_t iflag)= 0 ;
 144     virtual Float_t MaxStep() const =0;
 145     virtual Int_t GetMaxNStep() const = 0;
 146     virtual Int_t GetMedium() const =0;
 147
 148         // tracking particle
 149         // dynamic properties
 150     virtual void    TrackPosition(TLorentzVector& position) const =0;
 151     virtual void    TrackMomentum(TLorentzVector& momentum) const =0;
 152     virtual Float_t TrackStep() const =0;
 153     virtual Float_t TrackLength() const =0;
 154     virtual Float_t TrackTime() const =0;
 155     virtual Float_t Edep() const =0;
 156         // static properties
 157     virtual Int_t   TrackPid() const =0;
 158     virtual Float_t TrackCharge() const =0;
 159     virtual Float_t TrackMass() const =0;
 160     virtual Float_t Etot() const =0;
 161
 162         // track status
 163     virtual Bool_t  IsNewTrack() const =0;
 164     virtual Bool_t  IsTrackInside() const =0;
 165     virtual Bool_t  IsTrackEntering() const =0;
 166     virtual Bool_t  IsTrackExiting() const =0;
 167     virtual Bool_t  IsTrackOut() const =0;
 168     virtual Bool_t  IsTrackDisappeared() const =0;
 169     virtual Bool_t  IsTrackStop() const =0;
 170     virtual Bool_t  IsTrackAlive() const=0;
 171
 172         // secondaries
 173     virtual Int_t NSecondaries() const=0;
 174     virtual void  GetSecondary(Int_t isec, Int_t& particleId,
 175                     TLorentzVector& position, TLorentzVector& momentum) =0;
 176     virtual AliMCProcess ProdProcess(Int_t isec) const =0;
 177     virtual Int_t StepProcesses(TArrayI &proc) const = 0;
 178
 179     //
 180     // other (then geometry/step/run management) methods
 181     // ----------------------------------------------
 182     //
 183     virtual AliMCGeomType GetMCGeomType() const = 0;
 184
 185     //
 186     // Geant3 specific methods
 187     // !!! need to be transformed to common interface
 188     //
 189     virtual void Gdopt(const char*,const char*) = 0;
 190     virtual void SetClipBox(const char*,Float_t=-9999,Float_t=0, Float_t=-9999,Float_t=0,Float_t=-9999,Float_t=0) = 0;
 191     virtual void DefaultRange() = 0;
 192     virtual void Gdhead(Int_t, const char*, Float_t=0) = 0;
 193     virtual void Gdman(Float_t, Float_t, const char*) = 0;
 194     virtual void SetColors() = 0;
 195     virtual void Gtreve() = 0;
 196     virtual void GtreveRoot() = 0;
 197     virtual void Gckmat(Int_t, char*) = 0;
 198     virtual void InitLego() = 0;
 199     virtual void Gfpart(Int_t, char*, Int_t&, Float_t&, Float_t&, Float_t&) = 0;
 200     virtual void Gspart(Int_t, const char*, Int_t, Float_t, Float_t, Float_t) = 0;
 201
 202   // Control Methods
 203
 204   virtual void Init() = 0;
 205   virtual void FinishGeometry() = 0;
 206   virtual void BuildPhysics() = 0;
 207   virtual void ProcessEvent() = 0;
 208   virtual void ProcessRun(Int_t nevent) = 0;
 209   // External Decayer
 210   virtual void SetExternalDecayer(AliDecayer* decayer) =0;
 211   virtual AliDecayer* Decayer() const =0;
 212
 213   private:
 214   static AliMC*  fgMC;    // Pointer to the virtual MonteCarlo object
 215   AliMC(const AliMC &) {}
 216   AliMC & operator=(const AliMC &) {return (*this);}
 217
 218   ClassDef(AliMC,1)  //Virtual MonteCarlo Interface
 219 };
 220
 221 #endif
 222