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