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 #include "TFlukaCodes.h"
  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    // functions for access to geometry
  94    //
  95    // Return the Transformation matrix between the volume specified by
  96    // the path volumePath and the top or master volume.
  97    virtual Bool_t GetTransformation(const TString& volumePath,
  98                         TGeoHMatrix& matrix);
  99
 100    // Return the name of the shape and its parameters for the volume
 101    // specified by the volume name.
 102    virtual Bool_t GetShape(const TString& volumePath,
 103                         TString& shapeType, TArrayD& par);
 104
 105    // Returns the material parameters for the volume specified by
 106    // the volume name.
 107    virtual Bool_t GetMaterial(const TString& volumeName,
 108                  TString& name, Int_t& imat,
 109                  Double_t& a, Double_t& z, Double_t& density,
 110                  Double_t& radl, Double_t& inter, TArrayD& par);
 111
 112    // Returns the medium parameters for the volume specified by the
 113    // volume name.
 114    virtual Bool_t GetMedium(const TString& volumeName,
 115                         TString& name, Int_t& imed,
 116                  Int_t& nmat, Int_t& isvol, Int_t& ifield,
 117                  Double_t& fieldm, Double_t& tmaxfd, Double_t& stemax,
 118                  Double_t& deemax, Double_t& epsil, Double_t& stmin,
 119                  TArrayD& par);
 120
 121   virtual void   SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
 122                              Float_t *absco, Float_t *effic, Float_t *rindex);
 123   virtual void   SetCerenkov(Int_t itmed, Int_t npckov, Double_t *ppckov,
 124                              Double_t *absco, Double_t *effic, Double_t *rindex);
 125   virtual void   SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
 126                              Float_t *absco, Float_t *effic, Float_t *rindex, Float_t *rfl);
 127   virtual void   SetCerenkov(Int_t itmed, Int_t npckov, Double_t *ppckov,
 128                              Double_t *absco, Double_t *effic, Double_t *rindex, Double_t *rfl);
 129
 130
 131   // Functions for drawing
 132   virtual void   DrawOneSpec(const char* /*name*/)
 133       {Warning("DrawOneSpec",  "Not yet implemented !\n");}
 134   virtual void   Gsatt(const char* name, const char* att, Int_t val);
 135   virtual void   Gdraw(const char*,Double_t /*theta = 30*/, Double_t /*phi = 30*/,
 136                        Double_t /*psi = 0*/, Double_t /*u0 = 10*/, Double_t /*v0 = 10*/,
 137                        Double_t /*ul = 0.01*/, Double_t /*vl = 0.01*/)
 138       {Warning("Gdraw", "Not yet implemented !\n");}
 139
 140   // Euclid
 141   virtual void   WriteEuclid(const char*, const char*, Int_t, Int_t);
 142
 143   // Getters
 144   Int_t          GetDummyRegion() const;
 145   Int_t          GetDummyLattice() const;
 146   virtual Int_t  VolId(const Text_t* volName) const;
 147   virtual const  char* VolName(Int_t id) const;
 148   virtual Int_t  NofVolumes() const {return fNVolumes;}
 149   virtual Int_t  VolId2Mate(Int_t id) const;
 150   //
 151   // Methods for physics management
 152   // ------------------------------------------------
 153   //
 154
 155   // User configuration
 156   virtual Bool_t     SetProcess(const char* flagName, Int_t flagValue);
 157   virtual void       SetProcess(const char* flagName, Int_t flagValue, Int_t imed);
 158   virtual Bool_t     SetCut(const char* cutName, Double_t cutValue);
 159   virtual void       SetCut(const char* cutName, Double_t cutValue, Int_t imed);
 160   virtual TObjArray* GetListOfUserConfigs() {return fUserConfig;}
 161   virtual Double_t   Xsec(char*, Double_t, Int_t, Int_t);
 162
 163
 164   // Particle table usage
 165   virtual Int_t    IdFromPDG(Int_t id) const;
 166   virtual Int_t    PDGFromId(Int_t pdg) const;
 167   virtual void     DefineParticles()
 168   {Warning("DefineParticles", "Not yet implemented !\n");}
 169
 170   //
 171   // methods for step management
 172   // ------------------------------------------------
 173   //
 174
 175   // Action methods
 176   virtual void   StopTrack();
 177   virtual void   ResetStoppingCondition() {fStopped = kFALSE;}
 178   virtual Bool_t GetStoppingCondition() const   {return fStopped;}
 179
 180   virtual void   StopEvent() {fStopEvent = kTRUE;}
 181   virtual void   StopRun()   {fStopEvent = kTRUE; fStopRun   = kTRUE;}
 182   virtual Bool_t EventIsStopped() const {return fStopEvent;}
 183   virtual void   SetStopEvent(Bool_t flag) {fStopEvent = flag;}
 184
 185   // Set methods
 186   virtual void SetMaxStep (Double_t step);
 187   virtual void SetMaxNStep(Int_t);
 188   virtual void SetUserDecay(Int_t);
 189
 190   // Get methods
 191   // Tracking volume(s)
 192   virtual Int_t    CurrentVolID(Int_t& copyNo) const;
 193   virtual Int_t    CurrentVolOffID(Int_t off, Int_t& copyNo) const;
 194   virtual const char* CurrentVolName() const;
 195   virtual const char* CurrentVolOffName(Int_t off) const;
 196   virtual Int_t    CurrentMaterial(Float_t &a, Float_t &z,
 197                                    Float_t &dens, Float_t &radl, Float_t &absl) const;
 198   virtual Int_t    CurrentEvent() const {return fNEvent;}
 199
 200   virtual void     Gmtod(Float_t* xm, Float_t* xd, Int_t iflag);
 201
 202   virtual void     Gmtod(Double_t* xm, Double_t* xd, Int_t iflag);
 203
 204   virtual void     Gdtom(Float_t* xd, Float_t* xm, Int_t iflag);
 205
 206   virtual void     Gdtom(Double_t* xd, Double_t* xm, Int_t iflag);
 207
 208   virtual Double_t MaxStep() const;
 209   virtual Int_t    GetMaxNStep() const
 210       {Warning("GetMaxNStep",  "Not yet implemented !\n"); return -1;}
 211   virtual Int_t    GetMedium() const;
 212   virtual Int_t    CurrentMedium() const {return GetMedium();}
 213
 214   // Tracking particle
 215   // dynamic properties
 216   virtual void     TrackPosition(TLorentzVector& position) const;
 217   virtual void     TrackPosition(Double_t& x, Double_t& y, Double_t& z) const;
 218   virtual void     TrackMomentum(TLorentzVector& momentum) const;
 219   virtual void     TrackMomentum(Double_t& px, Double_t& py, Double_t& pz, Double_t& e) const;
 220   virtual Double_t TrackStep() const;
 221   virtual Double_t TrackLength() const;
 222   virtual Double_t TrackTime() const;
 223   virtual Double_t Edep() const;
 224   // Static properties
 225   virtual Int_t    TrackPid() const;
 226   virtual Double_t TrackCharge() const;
 227   virtual Double_t TrackMass() const;
 228   virtual Double_t Etot() const;
 229   // Track status
 230   virtual Bool_t   IsNewTrack() const;
 231   virtual Bool_t   IsTrackInside() const;
 232   virtual Bool_t   IsTrackEntering() const;
 233   virtual Bool_t   IsTrackExiting() const;
 234   virtual Bool_t   IsTrackOut() const;
 235   virtual Bool_t   IsTrackDisappeared() const;
 236   virtual Bool_t   IsTrackStop() const;
 237   virtual Bool_t   IsTrackAlive() const;
 238
 239   // Secondaries
 240   virtual Int_t    NSecondaries() const;
 241   virtual void     SetNCerenkov(Int_t nc) {fNCerenkov = nc;}
 242
 243   virtual void     GetSecondary(Int_t isec, Int_t& particleId,
 244                         TLorentzVector& position, TLorentzVector& momentum);
 245   virtual Bool_t   SecondariesAreOrdered() const {return kFALSE;}
 246   virtual TMCProcess ProdProcess(Int_t iproc) const ;
 247   virtual Int_t    StepProcesses(TArrayI & proc) const;
 248   //
 249   // Geant3 specific methods
 250   // !!! need to be transformed to common interface
 251   //
 252   virtual void Gdopt(const char*,const char*)
 253     {Warning("Gdopt", "Not yet implemented !\n");}
 254   virtual void SetClipBox(const char*,Double_t=-9999,Double_t=0, Double_t=-9999,
 255                           Double_t=0,Double_t=-9999,Double_t=0)
 256     {Warning("SetClipBox", "Not yet implemented !\n");}
 257   virtual void DefaultRange()
 258     {Warning("DefaultRange", "Not yet implemented !\n");}
 259   virtual void Gdhead(Int_t, const char*, Double_t=0)
 260     {Warning("Gdhead", "Not yet implemented !\n");}
 261   virtual void Gdman(Double_t, Double_t, const char*)
 262     {Warning("Gdman", "Not yet implemented !\n");}
 263   virtual void SetColors()
 264     {Warning("SetColors", "Not yet implemented !\n");}
 265   virtual void Gtreve()
 266     {Warning("Gtreve", "Not yet implemented !\n");}
 267   virtual void GtreveRoot()
 268     {Warning("GtreveRoot", "Not yet implemented !\n");}
 269   virtual void Gckmat(Int_t, char*)
 270     {Warning("Gckmat", "Not yet implemented !\n");}
 271   virtual void InitLego()
 272     {Warning("InitLego", "Not yet implemented !\n");}
 273 //
 274   virtual void Gfpart(Int_t pdg, char* name, Int_t& type, Float_t& mass, Float_t& charge, Float_t& tlife);
 275   virtual void Gspart(Int_t, const char*, Int_t, Double_t, Double_t, Double_t)
 276       {Warning("Gspart", "Not yet implemented !\n");}
 277
 278   //
 279   // Particle Properties
 280   // -------------------
 281   //
 282   virtual Bool_t DefineParticle(int, const char*, TMCParticleType, double, double, double) {return kFALSE;}
 283   virtual Bool_t DefineIon(const char*, int, int, int, double, double) {return kFALSE;}
 284   virtual TString  ParticleName(int pdg)      const;
 285   virtual Double_t ParticleMass(int pdg)      const;
 286   virtual Double_t ParticleMassFPC(int fpc)   const;
 287   virtual Double_t ParticleCharge(int pdg)    const;
 288   virtual Double_t ParticleLifeTime(int pdg)  const;
 289   virtual TMCParticleType ParticleMCType(int) const {return (TMCParticleType) 9;}
 290   //
 291   // Control methods
 292   // ------------------------------------------------
 293   //
 294
 295   virtual void Init();
 296   virtual void InitPhysics();
 297   virtual void FinishGeometry();
 298   virtual void BuildPhysics();
 299   virtual void ProcessEvent();
 300   virtual Bool_t ProcessRun(Int_t nevent);
 301
 302
 303   //
 304   // FLUKA Scoring specific methods
 305   // ------------------------------
 306   //
 307   virtual void SetUserScoring(const char* option, Int_t npr,char* outfile, Float_t* what);
 308   virtual void SetUserScoring(const char* option, Int_t npr,char* outfile, Float_t* what,
 309                               const char* det1, const char* det2, const char* det3);
 310   //
 311   // New Getter and Setters
 312   // ------------------------------------------------
 313   //
 314   // - Core input file name
 315   TString GetCoreInputFileName() const {return fCoreInputFileName;}
 316   void SetCoreInputFileName(const char* file = "coreFlukaVmc.inp") {fCoreInputFileName = file;}
 317
 318   // - Input file name
 319   TString GetInputFileName() const {return fInputFileName;}
 320   void SetInputFileName(const char* file = "FlukaVmc.inp") {fInputFileName = file;}
 321
 322   // - Verbosity level
 323   Int_t GetVerbosityLevel() const {return fVerbosityLevel;}
 324   void SetVerbosityLevel(Int_t l) {fVerbosityLevel = l;}
 325
 326   // - Fluka Draw procedures identifiers
 327   // bxdraw = 1  inside
 328   // bxdraw = 11 entering
 329   // bxdraw = 12 exiting
 330   // eedraw = 2
 331   // endraw = 3
 332   // mgdraw = 4
 333   // sodraw = 5
 334   // usdraw = 6
 335   FlukaCallerCode_t GetCaller() const {return fCaller;}
 336   void SetCaller(FlukaCallerCode_t l) {fCaller = l;}
 337
 338   FlukaProcessCode_t GetIcode() const {return fIcode;}
 339   void  SetIcode(FlukaProcessCode_t l) {fIcode = l;}
 340
 341   Int_t GetMreg() const {return fCurrentFlukaRegion;}
 342   void SetMreg(Int_t l, Int_t lttc);
 343
 344   Int_t GetNewreg() const {return fNewReg;}
 345   void SetNewreg(Int_t l, Int_t /*lttc*/) {fNewReg = l;}
 346
 347   Double_t GetRull() const {return fRull;}
 348   void SetRull(Double_t r) {fRull = r;}
 349
 350   Double_t GetXsco() const {return fXsco;}
 351   void SetXsco(Double_t x) {fXsco = x;}
 352
 353   Double_t GetYsco() const {return fYsco;}
 354   void SetYsco(Double_t y) {fYsco = y;}
 355
 356   Double_t GetZsco() const {return fZsco;}
 357   void SetZsco(Double_t z) {fZsco = z;}
 358
 359   void SetCurrentFlukaRegion(Int_t reg) {fCurrentFlukaRegion=reg;}
 360   Int_t GetCurrentFlukaRegion() const {return fCurrentFlukaRegion;}
 361
 362   void   SetDummyBoundary(Int_t mode) {fDummyBoundary = mode;}
 363   Int_t  GetDummyBoundary() const {return fDummyBoundary;}
 364   Bool_t IsDummyBoundary() const {return (fDummyBoundary==0)?kFALSE:kTRUE;}
 365
 366   void   SetGeneratePemf(Bool_t flag = kTRUE) {fGeneratePemf = flag;}
 367   Bool_t IsGeneratePemf() const {return fGeneratePemf;}
 368
 369   void   EnableField(Bool_t flag=kTRUE) {fFieldFlag = flag;}
 370   Bool_t IsFieldEnabled() const {return fFieldFlag;}
 371   void SetTrackIsEntering(){fTrackIsEntering = kTRUE; fTrackIsExiting = kFALSE;}
 372   void SetTrackIsExiting() {fTrackIsExiting  = kTRUE; fTrackIsEntering = kFALSE;}
 373   void SetTrackIsInside()  {fTrackIsExiting  = kFALSE; fTrackIsEntering = kFALSE;}
 374   void SetTrackIsNew(Bool_t flag = kTRUE);
 375
 376   Int_t GetMaterialIndex(Int_t idmat) const {return fMaterials[idmat];}
 377   TObjArray *GetFlukaMaterials();
 378   virtual void SetRootGeometry() {;} // Dummy
 379   virtual Int_t        NofVolDaughters(const char* volName) const;
 380   virtual const char*  VolDaughterName(const char* volName, Int_t i) const;
 381   virtual Int_t        VolDaughterCopyNo(const char* volName, Int_t i) const;
 382   virtual const char*  CurrentVolPath();
 383   virtual void         ForceDecayTime(Float_t){;}
 384   private:
 385   void PrintHeader();
 386   void AddParticlesToPdgDataBase() const;
 387   TFluka(const TFluka &mc): TVirtualMC(mc) {;}
 388   TFluka & operator=(const TFluka &) {return (*this);}
 389
 390
 391
 392   Int_t   fVerbosityLevel; //Verbosity level (0 lowest - 3 highest)
 393   Int_t   fNEvent;         //Current event number
 394   TString fInputFileName;     //Name of the real input file
 395   TString fCoreInputFileName; //Name of the input file
 396
 397   FlukaCallerCode_t     fCaller; //Parameter to indicate who is the caller of the Fluka Draw
 398   FlukaProcessCode_t    fIcode;  //Fluka Draw procedures formal parameter
 399   Int_t    fNewReg; //Fluka Draw procedures formal parameter
 400   Double_t fRull;   //Fluka Draw procedures formal parameter
 401   Double_t fXsco;   //Fluka Draw procedures formal parameter
 402   Double_t fYsco;   //Fluka Draw procedures formal parameter
 403   Double_t fZsco;   //Fluka Draw procedures formal parameter
 404   Bool_t   fTrackIsEntering;  // Flag for track entering
 405   Bool_t   fTrackIsExiting;   // Flag for track exiting
 406   Bool_t   fTrackIsNew;       // Flag for new track
 407   Bool_t   fFieldFlag;        // Flag for magnetic field
 408   Bool_t   fGeneratePemf;     // Flag for automatic .pemf generation
 409   Int_t    fDummyBoundary;    // Flag for crossing dummy boundaries
 410   Bool_t   fStopped;          // Flag for stopping
 411   Bool_t   fStopEvent;        // Flag for stopped event
 412   Bool_t   fStopRun;          // Flag for stopped run
 413
 414   //
 415   //Geometry through TGeo
 416   //
 417   Int_t*               fMaterials;          //!Array of indices
 418   Int_t                fNVolumes;           //!Current number of volumes
 419   Int_t                fCurrentFlukaRegion; // Index of fluka region at each step
 420   Int_t                fNCerenkov;          // Number of cerekov photons
 421   TFlukaMCGeometry    *fGeom;               // TGeo-FLUKA interface
 422   TGeoMCGeometry      *fMCGeo;              // Interface to TGeo builder
 423
 424   // SetProcess, SetCut and user Scoring dynamic storage
 425   TObjArray* fUserConfig;            // List of user physics configuration
 426   TObjArray* fUserScore;             // List of user scoring options
 427
 428   ClassDef(TFluka,1)  //C++ interface to Fluka montecarlo
 429
 430
 431   // Temporary implementation of new functions
 432   // To be removed with the next release
 433 };
 434   inline Int_t TFluka::NofVolDaughters(const char* /*volName*/) const {
 435     Warning("NofVolDaughters", "New function - not yet implemented.");
 436     return 0;
 437   }
 438
 439   inline const char*  TFluka::VolDaughterName(const char* /*volName*/, Int_t /*i*/) const {
 440     Warning("VolDaughterName", "New function - not yet implemented.");
 441     return "";
 442   }
 443
 444   inline Int_t  TFluka::VolDaughterCopyNo(const char* /*volName*/, Int_t /*i*/) const {
 445     Warning("VolDaughterCopyNo", "New function - not yet implemented.");
 446     return 0;
 447   }
 448
 449
 450
 451 #endif //TFLUKA
 452