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