TFluka/TFluka.h

   1 #ifndef TFLUKA_H
   2 #define TFLUKA_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 // FLUKA implementation of the VirtualMC Interface                           //
  12 //                                                                           //
  13 //                                                                           //
  14 ///////////////////////////////////////////////////////////////////////////////
  15
  16
  17 #include "TVirtualMC.h"
  18
  19 //Forward declaration
  20 class TGeoMCGeometry;
  21 class TFlukaMCGeometry;
  22 class TGeoMaterial;
  23
  24 class TFluka : public TVirtualMC {
  25
  26  public:
  27   TFluka(const char *title, Int_t verbosity = 0,  Bool_t isRootGeometrySupported = 0);
  28   TFluka();
  29   virtual ~TFluka();
  30
  31   //
  32   // methods for building/management of geometry
  33   // ------------------------------------------------
  34   //
  35
  36   // functions from GCONS
  37   virtual void  Gfmate(Int_t imat, char *name, Float_t &a, Float_t &z,
  38                        Float_t &dens, Float_t &radl, Float_t &absl,
  39                        Float_t* ubuf, Int_t& nbuf);
  40   virtual void  Gfmate(Int_t imat, char *name, Double_t &a, Double_t &z,
  41                        Double_t &dens, Double_t &radl, Double_t &absl,
  42                        Double_t* ubuf, Int_t& nbuf);
  43
  44   // detector composition
  45   virtual void  Material(Int_t& kmat, const char* name, Double_t a,
  46                          Double_t z, Double_t dens, Double_t radl, Double_t absl,
  47                          Float_t* buf, Int_t nwbuf);
  48   virtual void  Material(Int_t& kmat, const char* name, Double_t a,
  49                          Double_t z, Double_t dens, Double_t radl, Double_t absl,
  50                          Double_t* buf, Int_t nwbuf);
  51   virtual void  Mixture(Int_t& kmat, const char *name, Float_t *a,
  52                         Float_t *z, Double_t dens, Int_t nlmat, Float_t *wmat);
  53   virtual void  Mixture(Int_t& kmat, const char *name, Double_t *a,
  54                         Double_t *z, Double_t dens, Int_t nlmat, Double_t *wmat);
  55   virtual void  Medium(Int_t& kmed, const char *name, Int_t nmat,
  56                        Int_t isvol, Int_t ifield, Double_t fieldm, Double_t tmaxfd,
  57                        Double_t stemax, Double_t deemax, Double_t epsil,
  58                        Double_t stmin, Float_t* ubuf, Int_t nbuf);
  59   virtual void  Medium(Int_t& kmed, const char *name, Int_t nmat,
  60                        Int_t isvol, Int_t ifield, Double_t fieldm, Double_t tmaxfd,
  61                        Double_t stemax, Double_t deemax, Double_t epsil,
  62                        Double_t stmin, Double_t* ubuf, Int_t nbuf);
  63   virtual void  Matrix(Int_t& krot, Double_t thetaX, Double_t phiX,
  64                        Double_t thetaY, Double_t phiY, Double_t thetaZ,
  65                        Double_t phiZ);
  66   virtual void  Gstpar(Int_t itmed, const char *param, Double_t parval);
  67
  68   // functions from GGEOM
  69   virtual Int_t  Gsvolu(const char *name, const char *shape, Int_t nmed,
  70                         Float_t *upar, Int_t np);
  71   virtual Int_t  Gsvolu(const char *name, const char *shape, Int_t nmed,
  72                         Double_t *upar, Int_t np);
  73   virtual void  Gsdvn(const char *name, const char *mother, Int_t ndiv,
  74                       Int_t iaxis);
  75   virtual void  Gsdvn2(const char *name, const char *mother, Int_t ndiv,
  76                        Int_t iaxis, Double_t c0i, Int_t numed);
  77   virtual void  Gsdvt(const char *name, const char *mother, Double_t step,
  78                       Int_t iaxis, Int_t numed, Int_t ndvmx);
  79   virtual void  Gsdvt2(const char *name, const char *mother, Double_t step,
  80                        Int_t iaxis, Double_t c0, Int_t numed, Int_t ndvmx);
  81   virtual void  Gsord(const char *name, Int_t iax);
  82   virtual void  Gspos(const char *name, Int_t nr, const char *mother,
  83                       Double_t x, Double_t y, Double_t z, Int_t irot,
  84                       const char *konly="ONLY");
  85   virtual void  Gsposp(const char *name, Int_t nr, const char *mother,
  86                        Double_t x, Double_t y, Double_t z, Int_t irot,
  87                        const char *konly, Float_t *upar, Int_t np);
  88   virtual void  Gsposp(const char *name, Int_t nr, const char *mother,
  89                        Double_t x, Double_t y, Double_t z, Int_t irot,
  90                        const char *konly, Double_t *upar, Int_t np);
  91   virtual void  Gsbool(const char* onlyVolName, const char* manyVolName);
  92
  93   virtual void  SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
  94                             Float_t *absco, Float_t *effic, Float_t *rindex);
  95   virtual void  SetCerenkov(Int_t itmed, Int_t npckov, Double_t *ppckov,
  96                             Double_t *absco, Double_t *effic, Double_t *rindex);
  97
  98
  99   // functions for drawing
 100   virtual void  DrawOneSpec(const char* /*name*/)
 101     {printf("WARNING: DrawOneSpec not yet implemented !\n");}
 102   virtual void  Gsatt(const char* name, const char* att, Int_t val);
 103   virtual void  Gdraw(const char*,Double_t /*theta = 30*/, Double_t /*phi = 30*/,
 104                       Double_t /*psi = 0*/, Double_t /*u0 = 10*/, Double_t /*v0 = 10*/,
 105                       Double_t /*ul = 0.01*/, Double_t /*vl = 0.01*/)
 106     {printf("WARNING: Gdraw not yet implemented !\n");}
 107
 108   // Euclid
 109   virtual void  WriteEuclid(const char*, const char*, Int_t, Int_t);
 110
 111   // get methods
 112   virtual Int_t VolId(const Text_t* volName) const;
 113   virtual const char* VolName(Int_t id) const;
 114   virtual Int_t NofVolumes() const {return fNVolumes;}
 115   virtual Int_t VolId2Mate(Int_t id) const;
 116   //
 117   // methods for physics management
 118   // ------------------------------------------------
 119   //
 120
 121   // set methods
 122   virtual Bool_t   SetProcess(const char* flagName, Int_t flagValue);
 123   virtual void     SetProcess(const char* flagName, Int_t flagValue, Int_t imed);
 124   virtual Bool_t   SetCut(const char* cutName, Double_t cutValue);
 125   virtual void     SetCut(const char* cutName, Double_t cutValue, Int_t imed);
 126   virtual Double_t Xsec(char*, Double_t, Int_t, Int_t);
 127
 128   // particle table usage
 129   virtual Int_t   IdFromPDG(Int_t id) const;
 130   virtual Int_t   PDGFromId(Int_t pdg) const;
 131   virtual void    DefineParticles()
 132   {printf("WARNING: DefineParticles not yet implemented !\n");}
 133
 134   //
 135   // methods for step management
 136   // ------------------------------------------------
 137   //
 138
 139   // action methods
 140   virtual void StopTrack()
 141     {printf("WARNING: StopTrack not yet implemented !\n");}
 142   virtual void StopEvent()
 143     {printf("WARNING: StopEvent not yet implemented !\n");}
 144   virtual void StopRun()
 145     {printf("WARNING: StopRun not yet implemented !\n");}
 146
 147   // set methods
 148   virtual void SetMaxStep(Double_t);
 149   virtual void SetMaxNStep(Int_t);
 150   virtual void SetUserDecay(Int_t);
 151
 152   // get methods
 153   // tracking volume(s)
 154   virtual Int_t    CurrentVolID(Int_t& copyNo) const;
 155   virtual Int_t    CurrentVolOffID(Int_t off, Int_t& copyNo) const;
 156   virtual const char* CurrentVolName() const;
 157   virtual const char* CurrentVolOffName(Int_t off) const;
 158   virtual Int_t    CurrentMaterial(Float_t &a, Float_t &z,
 159                                    Float_t &dens, Float_t &radl, Float_t &absl) const;
 160   virtual Int_t    CurrentEvent() const
 161       {printf("WARNING: CurrentEvent not yet implemented !\n"); return -1;}
 162   virtual void     Gmtod(Float_t* xm, Float_t* xd, Int_t iflag);
 163
 164   virtual void     Gmtod(Double_t* xm, Double_t* xd, Int_t iflag);
 165
 166   virtual void     Gdtom(Float_t* xd, Float_t* xm, Int_t iflag);
 167
 168   virtual void     Gdtom(Double_t* xd, Double_t* xm, Int_t iflag);
 169
 170   virtual Double_t MaxStep() const
 171     {printf("WARNING: MaxStep not yet implemented !\n"); return -1.;}
 172   virtual Int_t    GetMaxNStep() const
 173     {printf("WARNING: GetMaxNStep not yet implemented !\n"); return -1;}
 174   virtual Int_t    GetMedium() const;
 175
 176   // tracking particle
 177   // dynamic properties
 178   virtual void     TrackPosition(TLorentzVector& position) const;
 179   virtual void     TrackPosition(Double_t& x, Double_t& y, Double_t& z) const;
 180   virtual void     TrackMomentum(TLorentzVector& momentum) const;
 181   virtual void     TrackMomentum(Double_t& px, Double_t& py, Double_t& pz, Double_t& e) const;
 182   virtual Double_t TrackStep() const;
 183   virtual Double_t TrackLength() const;
 184   virtual Double_t TrackTime() const;
 185   virtual Double_t Edep() const;
 186   // static properties
 187   virtual Int_t    TrackPid() const;
 188   virtual Double_t TrackCharge() const;
 189   virtual Double_t TrackMass() const;
 190   virtual Double_t Etot() const;
 191   // track status
 192   virtual Bool_t   IsNewTrack() const;
 193   virtual Bool_t   IsTrackInside() const;
 194   virtual Bool_t   IsTrackEntering() const;
 195   virtual Bool_t   IsTrackExiting() const;
 196   virtual Bool_t   IsTrackOut() const;
 197   virtual Bool_t   IsTrackDisappeared() const;
 198   virtual Bool_t   IsTrackStop() const;
 199   virtual Bool_t   IsTrackAlive() const;
 200
 201   // secondaries
 202   virtual Int_t    NSecondaries() const ;
 203   virtual void     GetSecondary(Int_t isec, Int_t& particleId,
 204                         TLorentzVector& position, TLorentzVector& momentum);
 205   virtual TMCProcess ProdProcess(Int_t iproc) const ;
 206   virtual Int_t    StepProcesses(TArrayI &/*proc*/) const
 207     {printf("WARNING: StepProcesses not yet implemented !\n"); return -1;}
 208
 209
 210   //
 211   // Geant3 specific methods
 212   // !!! need to be transformed to common interface
 213   //
 214   virtual void Gdopt(const char*,const char*)
 215     {printf("WARNING: Gdopt not yet implemented !\n");}
 216   virtual void SetClipBox(const char*,Double_t=-9999,Double_t=0, Double_t=-9999,
 217                           Double_t=0,Double_t=-9999,Double_t=0)
 218     {printf("WARNING: SetClipBox not yet implemented !\n");}
 219   virtual void DefaultRange()
 220     {printf("WARNING: DefaultRange not yet implemented !\n");}
 221   virtual void Gdhead(Int_t, const char*, Double_t=0)
 222     {printf("WARNING: Gdhead not yet implemented !\n");}
 223   virtual void Gdman(Double_t, Double_t, const char*)
 224     {printf("WARNING: Gdman not yet implemented !\n");}
 225   virtual void SetColors()
 226     {printf("WARNING: SetColors not yet implemented !\n");}
 227   virtual void Gtreve()
 228     {printf("WARNING: Gtreve not yet implemented !\n");}
 229   virtual void GtreveRoot()
 230     {printf("WARNING: GtreveRoot not yet implemented !\n");}
 231   virtual void Gckmat(Int_t, char*)
 232     {printf("WARNING: Gckmat not yet implemented !\n");}
 233   virtual void InitLego()
 234     {printf("WARNING: InitLego not yet implemented !\n");}
 235   virtual void Gfpart(Int_t, char*, Int_t&, Float_t&, Float_t&, Float_t&)
 236     {printf("WARNING: Gfpart not yet implemented !\n");}
 237   virtual void Gspart(Int_t, const char*, Int_t, Double_t, Double_t, Double_t)
 238     {printf("WARNING: Gspart not yet implemented !\n");}
 239
 240     // Dummy methods
 241     virtual Bool_t DefineParticle(int, const char*, TMCParticleType, double, double, double) {return kTRUE;}
 242     virtual Bool_t DefineIon(const char*, int, int, int, double, double) {return kTRUE;}
 243     virtual TString  ParticleName(int) const {return "";}
 244     virtual Double_t ParticleMass(int) const {return 0.;}
 245     virtual Double_t ParticleCharge(int) const {return 0.;}
 246     virtual Double_t ParticleLifeTime(int) const {return 0.;}
 247     virtual TMCParticleType ParticleMCType(int) const {return (TMCParticleType) 0;}
 248   //
 249   // control methods
 250   // ------------------------------------------------
 251   //
 252
 253   virtual void Init();
 254   virtual void InitPhysics();
 255   virtual void FinishGeometry();
 256   virtual void BuildPhysics();
 257   virtual void ProcessEvent();
 258   virtual Bool_t ProcessRun(Int_t nevent);
 259
 260   //
 261   //New Getter and Setters
 262   // ------------------------------------------------
 263   //
 264   // - Core input file name
 265   TString GetCoreInputFileName() const {return fCoreInputFileName;}
 266   void SetCoreInputFileName(const char* n) {fCoreInputFileName = n;}
 267
 268   // - Input file name
 269   TString GetInputFileName() const {return fInputFileName;}
 270   void SetInputFileName(const char* n) {fInputFileName = n;}
 271
 272   // - SetProcess and SetCut
 273   Int_t GetProcessNb() const {return fNbOfProc;}
 274   void SetProcessNb(Int_t l) {fNbOfProc = l;}
 275   Int_t GetCutNb() const {return fNbOfProc;}
 276   void SetCutNb(Int_t l) {fNbOfCut = l;}
 277
 278   // - Verbosity level
 279   Int_t GetVerbosityLevel() const {return fVerbosityLevel;}
 280   void SetVerbosityLevel(Int_t l) {fVerbosityLevel = l;}
 281
 282   // - Fluka Draw procedures identifiers
 283   // bxdraw = 1  inside
 284   // bxdraw = 11 entering
 285   // bxdraw = 12 exiting
 286   // eedraw = 2
 287   // endraw = 3
 288   // mgdraw = 4
 289   // sodraw = 5
 290   // usdraw = 6
 291   Int_t GetCaller() const {return fCaller;}
 292   void SetCaller(Int_t l) {fCaller = l;}
 293
 294   // - Fluka Draw procedures formal parameters
 295   Int_t GetIcode() const {return fIcode;}
 296   void SetIcode(Int_t l) {fIcode = l;}
 297   // in the case of sodraw fIcode=0
 298
 299   Int_t GetMreg() const {return fCurrentFlukaRegion;}
 300   void SetMreg(Int_t l);
 301
 302   Int_t GetNewreg() const {return fNewReg;}
 303   void SetNewreg(Int_t l) {fNewReg = l;}
 304
 305   Double_t GetRull() const {return fRull;}
 306   void SetRull(Double_t r) {fRull = r;}
 307
 308   Double_t GetXsco() const {return fXsco;}
 309   void SetXsco(Double_t x) {fXsco = x;}
 310
 311   Double_t GetYsco() const {return fYsco;}
 312   void SetYsco(Double_t y) {fYsco = y;}
 313
 314   Double_t GetZsco() const {return fZsco;}
 315   void SetZsco(Double_t z) {fZsco = z;}
 316
 317   void SetCurrentFlukaRegion(Int_t reg) {fCurrentFlukaRegion=reg;}
 318   Int_t GetCurrentFlukaRegion() const {return fCurrentFlukaRegion;}
 319
 320   void   SetDummyBoundary(Int_t mode) {fDummyBoundary = mode;}
 321   Int_t  GetDummyBoundary() const {return fDummyBoundary;}
 322   Bool_t IsDummyBoundary() const {return (fDummyBoundary==0)?kFALSE:kTRUE;}
 323
 324   void   SetGeneratePemf(Bool_t flag=kTRUE) {fGeneratePemf = flag;}
 325   Bool_t IsGeneratePemf() const {return fGeneratePemf;}
 326
 327   void   EnableField(Bool_t flag=kTRUE) {fFieldFlag = flag;}
 328   Bool_t IsFieldEnabled() const {return fFieldFlag;}
 329   void SetTrackIsEntering(){fTrackIsEntering = kTRUE; fTrackIsExiting = kFALSE;}
 330   void SetTrackIsExiting() {fTrackIsExiting  = kTRUE; fTrackIsEntering = kFALSE;}
 331   void SetTrackIsInside()  {fTrackIsExiting  = kFALSE; fTrackIsEntering = kFALSE;}
 332   void SetTrackIsNew(Bool_t flag=kTRUE) {fTrackIsNew = flag;}
 333   Int_t GetMaterialIndex(Int_t idmat) const {return fMaterials[idmat];}
 334   TObjArray *GetFlukaMaterials();
 335
 336
 337  private:
 338   TFluka(const TFluka &mc): TVirtualMC(mc) {;}
 339   TFluka & operator=(const TFluka &) {return (*this);}
 340
 341
 342   Int_t   fVerbosityLevel; //Verbosity level (0 lowest - 3 highest)
 343
 344   TString fInputFileName;     //Name of the real input file (e.g. alice.inp)
 345   TString fCoreInputFileName; //Name of the input file (e.g. corealice.inp)
 346
 347   Int_t    fCaller; //Parameter to indicate who is the caller of the Fluka Draw
 348   Int_t    fIcode;  //Fluka Draw procedures formal parameter
 349   Int_t    fNewReg; //Fluka Draw procedures formal parameter
 350   Double_t fRull;   //Fluka Draw procedures formal parameter
 351   Double_t fXsco;   //Fluka Draw procedures formal parameter
 352   Double_t fYsco;   //Fluka Draw procedures formal parameter
 353   Double_t fZsco;   //Fluka Draw procedures formal parameter
 354   Bool_t   fTrackIsEntering;  // Flag for track entering
 355   Bool_t   fTrackIsExiting;   // Flag for track exiting
 356   Bool_t   fTrackIsNew;       // Flag for new track
 357   Bool_t   fFieldFlag;        // Flag for magnetic field
 358   Bool_t   fGeneratePemf;     // Flag for automatic .pemf generation
 359   Int_t    fDummyBoundary;    // Flag for crossing dummy boundaries
 360   //variables for SetProcess and SetCut
 361   Int_t    fNbOfProc;                // Current number of processes
 362   Int_t    fProcessValue[10000];     // User values assigned to processes
 363   Int_t    fProcessMaterial[10000];  // Materials assigned to user settings
 364   Char_t   fProcessFlag[10000][5];   // User flags assigned to processes
 365   Int_t    fNbOfCut;                 // Current number of cuts
 366   Double_t fCutValue[10000];         // User values assigned to cuts
 367   Char_t   fCutFlag[10000][7];       // User flags assigned to cuts
 368   Int_t    fCutMaterial[10000];      // Materials assigned to cuts
 369
 370   //Geometry through TGeo
 371   Int_t*               fMaterials;         //!Array of indices
 372   Int_t                fNVolumes;           //!Current number of volumes
 373   Int_t                fCurrentFlukaRegion; //Index of fluka region at each step
 374   TFlukaMCGeometry    *fGeom;               // TGeo-FLUKA interface
 375   TGeoMCGeometry      *fMCGeo;              // Interface to TGeo builder
 376
 377   ClassDef(TFluka,1)  //C++ interface to Fluka montecarlo
 378 };
 379
 380 #endif //TFLUKA
 381