79b027ae23ddcf380c3e484253073cf047a262dc
[u/mrichter/AliRoot.git] / TFluka / TFluka.h
1 #ifndef TFLUKA
2 #define TFLUKA
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 "TMCProcess.h" 
19
20 #include <map>
21 #include <vector>
22
23 //Forward declaration
24 class TG4GeometryManager;
25 class TG4DetConstruction;
26 class TClonesArray;
27
28
29 class TFluka : public TVirtualMC {
30   
31  public:
32   TFluka(const char *title, Int_t verbosity = 0,  Bool_t isRootGeometrySupported = 0);
33   TFluka();
34   virtual ~TFluka();
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   virtual void  SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
99                             Float_t *absco, Float_t *effic, Float_t *rindex);
100   virtual void  SetCerenkov(Int_t itmed, Int_t npckov, Double_t *ppckov,
101                             Double_t *absco, Double_t *effic, Double_t *rindex);
102   
103   
104   // functions for drawing
105   virtual void  DrawOneSpec(const char* /*name*/)
106     {printf("WARNING: DrawOneSpec not yet implemented !\n");}
107   virtual void  Gsatt(const char* /*name*/, const char* /*att*/, Int_t /*val*/)
108     {printf("WARNING: Gsatt not yet implemented !\n");}
109   virtual void  Gdraw(const char*,Double_t /*theta = 30*/, Double_t /*phi = 30*/,
110                       Double_t /*psi = 0*/, Double_t /*u0 = 10*/, Double_t /*v0 = 10*/,
111                       Double_t /*ul = 0.01*/, Double_t /*vl = 0.01*/)
112     {printf("WARNING: Gdraw not yet implemented !\n");}
113   
114   // Euclid
115   virtual void  WriteEuclid(const char*, const char*, Int_t, Int_t);
116   
117   // get methods
118   virtual Int_t VolId(const Text_t* volName) const;
119   virtual const char* VolName(Int_t id) const;
120   virtual Int_t NofVolumes() const {return fNVolumes;}
121   virtual Int_t VolId2Mate(Int_t id) const;
122   //
123   // methods for physics management
124   // ------------------------------------------------
125   //
126   
127   // set methods
128   virtual void     SetProcess(const char* flagName, Int_t flagValue);
129   virtual void     SetCut(const char* cutName, Double_t cutValue);
130   virtual Double_t Xsec(char*, Double_t, Int_t, Int_t);
131   
132   // particle table usage         
133   virtual Int_t   IdFromPDG(Int_t id) const;
134   virtual Int_t   PDGFromId(Int_t pdg) const;
135   virtual void    DefineParticles()
136   {printf("WARNING: DefineParticles not yet implemented !\n");}     
137   
138   //
139   // methods for step management
140   // ------------------------------------------------
141   //
142   
143   // action methods
144   virtual void StopTrack()
145     {printf("WARNING: StopTrack not yet implemented !\n");}
146   virtual void StopEvent()
147     {printf("WARNING: StopEvent not yet implemented !\n");}   
148   
149   // set methods
150   virtual void SetMaxStep(Double_t);
151   virtual void SetMaxNStep(Int_t);
152   virtual void SetUserDecay(Int_t);
153   
154   // get methods
155   // tracking volume(s) 
156   virtual Int_t    CurrentVolID(Int_t& copyNo) const;
157   virtual Int_t    CurrentVolOffID(Int_t off, Int_t& copyNo) const;
158   virtual const char* CurrentVolName() const;
159   virtual const char* CurrentVolOffName(Int_t off) const;
160   virtual Int_t    CurrentMaterial(Float_t &a, Float_t &z, 
161                                    Float_t &dens, Float_t &radl, Float_t &absl) const;
162   virtual Int_t    CurrentEvent() const
163       {printf("WARNING: CurrentEvent not yet implemented !\n"); return -1;} 
164   virtual void     Gmtod(Float_t* xm, Float_t* xd, Int_t iflag);
165   
166   virtual void     Gmtod(Double_t* xm, Double_t* xd, Int_t iflag);
167   
168   virtual void     Gdtom(Float_t* xd, Float_t* xm, Int_t iflag);
169   
170   virtual void     Gdtom(Double_t* xd, Double_t* xm, Int_t iflag);
171   
172   virtual Double_t MaxStep() const
173     {printf("WARNING: MaxStep not yet implemented !\n"); return -1.;}
174   virtual Int_t    GetMaxNStep() const
175     {printf("WARNING: GetMaxNStep not yet implemented !\n"); return -1;}
176   virtual Int_t    GetMedium() const;
177   
178   // tracking particle 
179   // dynamic properties
180   virtual void     TrackPosition(TLorentzVector& position) const;
181   virtual void     TrackPosition(Double_t& x, Double_t& y, Double_t& z) const;
182   virtual void     TrackMomentum(TLorentzVector& momentum) const;
183   virtual void     TrackMomentum(Double_t& px, Double_t& py, Double_t& pz, Double_t& e) const;
184   virtual Double_t TrackStep() const;
185   virtual Double_t TrackLength() const;
186   virtual Double_t TrackTime() const;
187   virtual Double_t Edep() const;
188   // static properties
189   virtual Int_t    TrackPid() const;
190   virtual Double_t TrackCharge() const;
191   virtual Double_t TrackMass() const;
192   virtual Double_t Etot() const;
193   // track status
194   virtual Bool_t   IsNewTrack() const;
195   virtual Bool_t   IsTrackInside() const;
196   virtual Bool_t   IsTrackEntering() const;
197   virtual Bool_t   IsTrackExiting() const;
198   virtual Bool_t   IsTrackOut() const;
199   virtual Bool_t   IsTrackDisappeared() const;
200   virtual Bool_t   IsTrackStop() const;
201   virtual Bool_t   IsTrackAlive() const;
202  
203   // secondaries
204   virtual Int_t    NSecondaries() const ;
205   virtual void     GetSecondary(Int_t isec, Int_t& particleId, 
206                         TLorentzVector& position, TLorentzVector& momentum);
207   virtual TMCProcess ProdProcess(Int_t iproc) const ;
208   virtual Int_t    StepProcesses(TArrayI &/*proc*/) const
209     {printf("WARNING: StepProcesses not yet implemented !\n"); return -1;}
210   
211   
212   //
213   // Geant3 specific methods
214   // !!! need to be transformed to common interface
215   //
216   virtual void Gdopt(const char*,const char*)
217     {printf("WARNING: Gdopt not yet implemented !\n");}
218   virtual void SetClipBox(const char*,Double_t=-9999,Double_t=0, Double_t=-9999,
219                           Double_t=0,Double_t=-9999,Double_t=0)
220     {printf("WARNING: SetClipBox not yet implemented !\n");}
221   virtual void DefaultRange()
222     {printf("WARNING: DefaultRange not yet implemented !\n");}
223   virtual void Gdhead(Int_t, const char*, Double_t=0)
224     {printf("WARNING: Gdhead not yet implemented !\n");}  
225   virtual void Gdman(Double_t, Double_t, const char*)
226     {printf("WARNING: Gdman not yet implemented !\n");}
227   virtual void SetColors()
228     {printf("WARNING: SetColors not yet implemented !\n");}
229   virtual void Gtreve()
230     {printf("WARNING: Gtreve not yet implemented !\n");}
231   virtual void GtreveRoot()
232     {printf("WARNING: GtreveRoot not yet implemented !\n");}
233   virtual void Gckmat(Int_t, char*)
234     {printf("WARNING: Gckmat not yet implemented !\n");}
235   virtual void InitLego()
236     {printf("WARNING: InitLego not yet implemented !\n");}
237   virtual void Gfpart(Int_t, char*, Int_t&, Float_t&, Float_t&, Float_t&)
238     {printf("WARNING: Gfpart not yet implemented !\n");}
239   virtual void Gspart(Int_t, const char*, Int_t, Double_t, Double_t, Double_t)
240     {printf("WARNING: Gspart not yet implemented !\n");}
241   
242     // Dummy methods 
243     virtual void DefineParticle(int, const char*, TMCParticleType, double, double, double){;}
244     virtual void DefineIon(const char*, int, int, int, double, double){;}
245     virtual TString  ParticleName(int) const {return "";}
246     virtual Double_t ParticleMass(int) const {return 0.;}
247     virtual Double_t ParticleCharge(int) const {return 0.;}
248     virtual Double_t ParticleLifeTime(int) const {return 0.;}
249     virtual TMCParticleType ParticleMCType(int) const {return (TMCParticleType) 0;}
250   //
251   // control methods
252   // ------------------------------------------------
253   //
254   
255   virtual void Init();
256   virtual void InitPhysics();
257   virtual void FinishGeometry();
258   virtual void BuildPhysics();
259   virtual void ProcessEvent();
260   virtual void ProcessRun(Int_t nevent);
261   
262
263   //
264   //New Getter and Setters
265   // ------------------------------------------------
266   //
267   // - Core input file name
268   TString GetCoreInputFileName() const {return sCoreInputFileName;}
269   void SetCoreInputFileName(const char* n) {sCoreInputFileName = n;}
270
271   // - Input file name
272   TString GetInputFileName() const {return sInputFileName;}
273   void SetInputFileName(const char* n) {sInputFileName = n;}
274
275   // - SetProcess and SetCut
276   Int_t GetProcessNb() const {return iNbOfProc;}
277   void SetProcessNb(Int_t l) {iNbOfProc = l;}
278   Int_t GetCutNb() const {return iNbOfProc;}
279   void SetCutNb(Int_t l) {iNbOfCut = l;}
280
281   // - Verbosity level
282   Int_t GetVerbosityLevel() const {return fVerbosityLevel;}
283   void SetVerbosityLevel(Int_t l) {fVerbosityLevel = l;}
284
285   // - Fluka Draw procedures identifiers
286   // bxdraw = 1  inside
287   // bxdraw = 11 entering
288   // bxdraw = 12 exiting
289   // eedraw = 2
290   // endraw = 3
291   // mgdraw = 4
292   // sodraw = 5
293   // usdraw = 6
294   Int_t GetCaller() const {return fCaller;}
295   void SetCaller(Int_t l) {fCaller = l;}
296   
297   // - Fluka Draw procedures formal parameters
298   Int_t GetIcode() const {return fIcode;}
299   void SetIcode(Int_t l) {fIcode = l;}
300   // in the case of sodraw fIcode=0
301
302   Int_t GetMreg() const {return fCurrentFlukaRegion;}
303   void SetMreg(Int_t l) {fCurrentFlukaRegion = l;}
304
305   Int_t GetNewreg() const {return iNewreg;}
306   void SetNewreg(Int_t l) {iNewreg = l;}
307
308   Double_t GetRull() const {return fRull;}
309   void SetRull(Double_t r) {fRull = r;}
310
311   Double_t GetXsco() const {return fXsco;}
312   void SetXsco(Double_t x) {fXsco = x;}
313
314   Double_t GetYsco() const {return fYsco;}
315   void SetYsco(Double_t y) {fYsco = y;}
316
317   Double_t GetZsco() const {return fZsco;}
318   void SetZsco(Double_t z) {fZsco = z;}
319
320   void SetCurrentFlukaRegion(Int_t reg) {fCurrentFlukaRegion=reg;}
321   Int_t GetCurrentFlukaRegion() const {return fCurrentFlukaRegion;}
322
323   void SetTrackIsEntering(){fTrackIsEntering = kTRUE; fTrackIsExiting = kFALSE;}
324   void SetTrackIsExiting() {fTrackIsExiting  = kTRUE; fTrackIsEntering = kFALSE;}
325   void SetTrackIsInside()  {fTrackIsExiting  = kFALSE; fTrackIsEntering = kFALSE;}
326   void SetTrackIsNew(Bool_t flag=kTRUE) {fTrackIsNew = flag;}
327
328  private:
329   TFluka(const TFluka &mc): TVirtualMC(mc) {;}
330   TFluka & operator=(const TFluka &) {return (*this);}
331                                                                                 
332  protected:
333   Int_t   fVerbosityLevel; //Verbosity level (0 lowest - 3 highest)
334                                                                                 
335   TString sInputFileName;     //Name of the real input file (e.g. alice.inp)
336   TString sCoreInputFileName; //Name of the input file (e.g. corealice.inp)
337                                                                                 
338   Int_t    fCaller; //Parameter to indicate who is the caller of the Fluka Draw
339   Int_t    fIcode;  //Fluka Draw procedures formal parameter
340   Int_t    iNewreg; //Fluka Draw procedures formal parameter
341   Double_t fRull;   //Fluka Draw procedures formal parameter
342   Double_t fXsco;   //Fluka Draw procedures formal parameter
343   Double_t fYsco;   //Fluka Draw procedures formal parameter
344   Double_t fZsco;   //Fluka Draw procedures formal parameter
345   Bool_t   fTrackIsEntering;  // Flag for track entering
346   Bool_t   fTrackIsExiting;   // Flag for track exiting
347   Bool_t   fTrackIsNew;       // Flag for new track
348                                                                                 
349   //variables for SetProcess and SetCut
350   Int_t    iNbOfProc;
351   Int_t    iProcessValue[100];
352   Char_t   sProcessFlag[100][5];
353   Int_t    iNbOfCut;
354   Double_t fCutValue[100];
355   Char_t   sCutFlag[100][7];
356                                                                                 
357   //Geometry through Geant4 for the time being!!!
358   TG4GeometryManager*  fGeometryManager; //Geometry manager
359   TG4DetConstruction*  fDetector;        //Detector
360                                                                                 
361   TClonesArray*        fVolumeMediaMap;  //!Transient list of volumes
362
363   Int_t                fNVolumes;        //!Current number of volumes
364   Int_t*               fMediaByRegion;   //!Media by Fluka region
365   Int_t                fCurrentFlukaRegion; //Index of fluka region at each step
366
367   ClassDef(TFluka,1)  //C++ interface to Fluka montecarlo
368 };
369
370 #endif //TFLUKA
371