]> git.uio.no Git - u/mrichter/AliRoot.git/blame - TFluka/TFluka.h
git://git.uio.no / u / mrichter / AliRoot.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Example macros for using AliAODv0 class
[u/mrichter/AliRoot.git] / TFluka / TFluka.h
CommitLineData
6f5667d1 1#ifndef TFLUKA_H
2#define TFLUKA_H
829fb838 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"
a9ea1616 18#include "TFlukaCodes.h"
829fb838 19//Forward declaration
6f5667d1 20class TGeoMCGeometry;
829fb838 21class TFlukaMCGeometry;
22class TGeoMaterial;
23
24class 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 //
b496f27c 32 // Methods for building/management of geometry
829fb838 33 // ------------------------------------------------
34 //
35
b496f27c 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
829fb838 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);
b496f27c 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,
829fb838 80 Int_t iaxis, Double_t c0, Int_t numed, Int_t ndvmx);
b496f27c 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,
829fb838 84 const char *konly="ONLY");
b496f27c 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
a9ea1616 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
b496f27c 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);
b2be0e73 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);
b496f27c 129
130
131 // Functions for drawing
132 virtual void DrawOneSpec(const char* /*name*/)
a9ea1616 133 {Warning("DrawOneSpec", "Not yet implemented !\n");}
b496f27c 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*/)
a9ea1616 138 {Warning("Gdraw", "Not yet implemented !\n");}
829fb838 139
140 // Euclid
b496f27c 141 virtual void WriteEuclid(const char*, const char*, Int_t, Int_t);
829fb838 142
b496f27c 143 // Getters
a9ea1616 144 Int_t GetDummyRegion() const;
145 Int_t GetDummyLattice() const;
b496f27c 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;
829fb838 150 //
b496f27c 151 // Methods for physics management
829fb838 152 // ------------------------------------------------
153 //
154
b496f27c 155 // User configuration
b2129742 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);
fb2cbbec 160 virtual TObjArray* GetListOfUserConfigs() {return fUserConfig;}
b2129742 161 virtual Double_t Xsec(char*, Double_t, Int_t, Int_t);
f450e9d0 162
829fb838 163
b496f27c 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()
a9ea1616 168 {Warning("DefineParticles", "Not yet implemented !\n");}
829fb838 169
170 //
171 // methods for step management
172 // ------------------------------------------------
173 //
174
b496f27c 175 // Action methods
bd3d5c8a 176 virtual void StopTrack();
177 virtual void ResetStoppingCondition() {fStopped = kFALSE;}
eb49ba4d 178 virtual Bool_t GetStoppingCondition() const {return fStopped;}
bd3d5c8a 179
b496f27c 180 virtual void StopEvent() {fStopEvent = kTRUE;}
181 virtual void StopRun() {fStopEvent = kTRUE; fStopRun = kTRUE;}
eb49ba4d 182 virtual Bool_t EventIsStopped() const {return fStopEvent;}
b496f27c 183 virtual void SetStopEvent(Bool_t flag) {fStopEvent = flag;}
829fb838 184
b496f27c 185 // Set methods
07f5b33e 186 virtual void SetMaxStep (Double_t step);
829fb838 187 virtual void SetMaxNStep(Int_t);
188 virtual void SetUserDecay(Int_t);
189
b496f27c 190 // Get methods
191 // Tracking volume(s)
829fb838 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;
b496f27c 198 virtual Int_t CurrentEvent() const {return fNEvent;}
199
829fb838 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
2f09b80e 208 virtual Double_t MaxStep() const;
829fb838 209 virtual Int_t GetMaxNStep() const
a9ea1616 210 {Warning("GetMaxNStep", "Not yet implemented !\n"); return -1;}
829fb838 211 virtual Int_t GetMedium() const;
432716fc 212 virtual Int_t CurrentMedium() const {return GetMedium();}
829fb838 213
b496f27c 214 // Tracking particle
829fb838 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;
b496f27c 224 // Static properties
18e0cabb 225 virtual Int_t CorrectFlukaId() const;
829fb838 226 virtual Int_t TrackPid() const;
227 virtual Double_t TrackCharge() const;
228 virtual Double_t TrackMass() const;
229 virtual Double_t Etot() const;
b496f27c 230 // Track status
829fb838 231 virtual Bool_t IsNewTrack() const;
232 virtual Bool_t IsTrackInside() const;
233 virtual Bool_t IsTrackEntering() const;
234 virtual Bool_t IsTrackExiting() const;
235 virtual Bool_t IsTrackOut() const;
236 virtual Bool_t IsTrackDisappeared() const;
237 virtual Bool_t IsTrackStop() const;
238 virtual Bool_t IsTrackAlive() const;
239
b496f27c 240 // Secondaries
7b203b6e 241 virtual Int_t NSecondaries() const;
242 virtual void SetNCerenkov(Int_t nc) {fNCerenkov = nc;}
243
829fb838 244 virtual void GetSecondary(Int_t isec, Int_t& particleId,
245 TLorentzVector& position, TLorentzVector& momentum);
bd3d5c8a 246 virtual Bool_t SecondariesAreOrdered() const {return kFALSE;}
829fb838 247 virtual TMCProcess ProdProcess(Int_t iproc) const ;
b496f27c 248 virtual Int_t StepProcesses(TArrayI & proc) const;
829fb838 249 //
250 // Geant3 specific methods
251 // !!! need to be transformed to common interface
252 //
253 virtual void Gdopt(const char*,const char*)
a9ea1616 254 {Warning("Gdopt", "Not yet implemented !\n");}
829fb838 255 virtual void SetClipBox(const char*,Double_t=-9999,Double_t=0, Double_t=-9999,
256 Double_t=0,Double_t=-9999,Double_t=0)
a9ea1616 257 {Warning("SetClipBox", "Not yet implemented !\n");}
829fb838 258 virtual void DefaultRange()
a9ea1616 259 {Warning("DefaultRange", "Not yet implemented !\n");}
829fb838 260 virtual void Gdhead(Int_t, const char*, Double_t=0)
a9ea1616 261 {Warning("Gdhead", "Not yet implemented !\n");}
829fb838 262 virtual void Gdman(Double_t, Double_t, const char*)
a9ea1616 263 {Warning("Gdman", "Not yet implemented !\n");}
829fb838 264 virtual void SetColors()
a9ea1616 265 {Warning("SetColors", "Not yet implemented !\n");}
829fb838 266 virtual void Gtreve()
a9ea1616 267 {Warning("Gtreve", "Not yet implemented !\n");}
829fb838 268 virtual void GtreveRoot()
a9ea1616 269 {Warning("GtreveRoot", "Not yet implemented !\n");}
829fb838 270 virtual void Gckmat(Int_t, char*)
a9ea1616 271 {Warning("Gckmat", "Not yet implemented !\n");}
829fb838 272 virtual void InitLego()
a9ea1616 273 {Warning("InitLego", "Not yet implemented !\n");}
b496f27c 274//
275 virtual void Gfpart(Int_t pdg, char* name, Int_t& type, Float_t& mass, Float_t& charge, Float_t& tlife);
829fb838 276 virtual void Gspart(Int_t, const char*, Int_t, Double_t, Double_t, Double_t)
a9ea1616 277 {Warning("Gspart", "Not yet implemented !\n");}
b496f27c 278
b496f27c 279 //
280 // Particle Properties
281 // -------------------
282 //
283 virtual Bool_t DefineParticle(int, const char*, TMCParticleType, double, double, double) {return kFALSE;}
284 virtual Bool_t DefineIon(const char*, int, int, int, double, double) {return kFALSE;}
285 virtual TString ParticleName(int pdg) const;
286 virtual Double_t ParticleMass(int pdg) const;
ece92b30 287 virtual Double_t ParticleMassFPC(int fpc) const;
b496f27c 288 virtual Double_t ParticleCharge(int pdg) const;
289 virtual Double_t ParticleLifeTime(int pdg) const;
290 virtual TMCParticleType ParticleMCType(int) const {return (TMCParticleType) 9;}
829fb838 291 //
b496f27c 292 // Control methods
829fb838 293 // ------------------------------------------------
294 //
295
296 virtual void Init();
297 virtual void InitPhysics();
298 virtual void FinishGeometry();
299 virtual void BuildPhysics();
300 virtual void ProcessEvent();
301 virtual Bool_t ProcessRun(Int_t nevent);
302
f450e9d0 303
304 //
305 // FLUKA Scoring specific methods
306 // ------------------------------
307 //
308 virtual void SetUserScoring(const char* option, Int_t npr,char* outfile, Float_t* what);
309 virtual void SetUserScoring(const char* option, Int_t npr,char* outfile, Float_t* what,
310 const char* det1, const char* det2, const char* det3);
829fb838 311 //
b496f27c 312 // New Getter and Setters
829fb838 313 // ------------------------------------------------
314 //
315 // - Core input file name
316 TString GetCoreInputFileName() const {return fCoreInputFileName;}
3b8c325d 317 void SetCoreInputFileName(const char* file = "coreFlukaVmc.inp") {fCoreInputFileName = file;}
829fb838 318
319 // - Input file name
320 TString GetInputFileName() const {return fInputFileName;}
3b8c325d 321 void SetInputFileName(const char* file = "FlukaVmc.inp") {fInputFileName = file;}
829fb838 322
829fb838 323 // - Verbosity level
324 Int_t GetVerbosityLevel() const {return fVerbosityLevel;}
325 void SetVerbosityLevel(Int_t l) {fVerbosityLevel = l;}
326
327 // - Fluka Draw procedures identifiers
328 // bxdraw = 1 inside
329 // bxdraw = 11 entering
330 // bxdraw = 12 exiting
331 // eedraw = 2
332 // endraw = 3
333 // mgdraw = 4
334 // sodraw = 5
335 // usdraw = 6
a9ea1616 336 FlukaCallerCode_t GetCaller() const {return fCaller;}
337 void SetCaller(FlukaCallerCode_t l) {fCaller = l;}
829fb838 338
a9ea1616 339 FlukaProcessCode_t GetIcode() const {return fIcode;}
340 void SetIcode(FlukaProcessCode_t l) {fIcode = l;}
829fb838 341
342 Int_t GetMreg() const {return fCurrentFlukaRegion;}
a9ea1616 343 void SetMreg(Int_t l, Int_t lttc);
829fb838 344
345 Int_t GetNewreg() const {return fNewReg;}
a9ea1616 346 void SetNewreg(Int_t l, Int_t /*lttc*/) {fNewReg = l;}
829fb838 347
348 Double_t GetRull() const {return fRull;}
349 void SetRull(Double_t r) {fRull = r;}
350
351 Double_t GetXsco() const {return fXsco;}
352 void SetXsco(Double_t x) {fXsco = x;}
353
354 Double_t GetYsco() const {return fYsco;}
355 void SetYsco(Double_t y) {fYsco = y;}
356
357 Double_t GetZsco() const {return fZsco;}
358 void SetZsco(Double_t z) {fZsco = z;}
359
360 void SetCurrentFlukaRegion(Int_t reg) {fCurrentFlukaRegion=reg;}
361 Int_t GetCurrentFlukaRegion() const {return fCurrentFlukaRegion;}
362
363 void SetDummyBoundary(Int_t mode) {fDummyBoundary = mode;}
364 Int_t GetDummyBoundary() const {return fDummyBoundary;}
365 Bool_t IsDummyBoundary() const {return (fDummyBoundary==0)?kFALSE:kTRUE;}
366
7f13be31 367 void SetGeneratePemf(Bool_t flag = kTRUE) {fGeneratePemf = flag;}
829fb838 368 Bool_t IsGeneratePemf() const {return fGeneratePemf;}
369
370 void EnableField(Bool_t flag=kTRUE) {fFieldFlag = flag;}
371 Bool_t IsFieldEnabled() const {return fFieldFlag;}
372 void SetTrackIsEntering(){fTrackIsEntering = kTRUE; fTrackIsExiting = kFALSE;}
373 void SetTrackIsExiting() {fTrackIsExiting = kTRUE; fTrackIsEntering = kFALSE;}
374 void SetTrackIsInside() {fTrackIsExiting = kFALSE; fTrackIsEntering = kFALSE;}
7cad64b7 375 void SetTrackIsNew(Bool_t flag = kTRUE);
376
6f5667d1 377 Int_t GetMaterialIndex(Int_t idmat) const {return fMaterials[idmat];}
829fb838 378 TObjArray *GetFlukaMaterials();
ece92b30 379 virtual void SetRootGeometry() {;} // Dummy
a2f1f85d 380 virtual Int_t NofVolDaughters(const char* volName) const;
381 virtual const char* VolDaughterName(const char* volName, Int_t i) const;
382 virtual Int_t VolDaughterCopyNo(const char* volName, Int_t i) const;
383 virtual const char* CurrentVolPath();
384 virtual void ForceDecayTime(Float_t){;}
b496f27c 385 private:
8e5bf079 386 void PrintHeader();
78df7be0 387 void AddParticlesToPdgDataBase() const;
829fb838 388 TFluka(const TFluka &mc): TVirtualMC(mc) {;}
389 TFluka & operator=(const TFluka &) {return (*this);}
a9ea1616 390
391
829fb838 392
393 Int_t fVerbosityLevel; //Verbosity level (0 lowest - 3 highest)
b496f27c 394 Int_t fNEvent; //Current event number
3b8c325d 395 TString fInputFileName; //Name of the real input file
396 TString fCoreInputFileName; //Name of the input file
829fb838 397
a9ea1616 398 FlukaCallerCode_t fCaller; //Parameter to indicate who is the caller of the Fluka Draw
399 FlukaProcessCode_t fIcode; //Fluka Draw procedures formal parameter
829fb838 400 Int_t fNewReg; //Fluka Draw procedures formal parameter
401 Double_t fRull; //Fluka Draw procedures formal parameter
402 Double_t fXsco; //Fluka Draw procedures formal parameter
403 Double_t fYsco; //Fluka Draw procedures formal parameter
404 Double_t fZsco; //Fluka Draw procedures formal parameter
405 Bool_t fTrackIsEntering; // Flag for track entering
406 Bool_t fTrackIsExiting; // Flag for track exiting
407 Bool_t fTrackIsNew; // Flag for new track
408 Bool_t fFieldFlag; // Flag for magnetic field
409 Bool_t fGeneratePemf; // Flag for automatic .pemf generation
410 Int_t fDummyBoundary; // Flag for crossing dummy boundaries
bd3d5c8a 411 Bool_t fStopped; // Flag for stopping
b496f27c 412 Bool_t fStopEvent; // Flag for stopped event
413 Bool_t fStopRun; // Flag for stopped run
bd3d5c8a 414
b496f27c 415 //
829fb838 416 //Geometry through TGeo
b496f27c 417 //
418 Int_t* fMaterials; //!Array of indices
829fb838 419 Int_t fNVolumes; //!Current number of volumes
7b203b6e 420 Int_t fCurrentFlukaRegion; // Index of fluka region at each step
421 Int_t fNCerenkov; // Number of cerekov photons
829fb838 422 TFlukaMCGeometry *fGeom; // TGeo-FLUKA interface
423 TGeoMCGeometry *fMCGeo; // Interface to TGeo builder
424
1df5fa54 425 // SetProcess, SetCut and user Scoring dynamic storage
fb2cbbec 426 TObjArray* fUserConfig; // List of user physics configuration
1df5fa54 427 TObjArray* fUserScore; // List of user scoring options
428
829fb838 429 ClassDef(TFluka,1) //C++ interface to Fluka montecarlo
a2f1f85d 430
431
432 // Temporary implementation of new functions
433 // To be removed with the next release
829fb838 434};
a2f1f85d 435 inline Int_t TFluka::NofVolDaughters(const char* /*volName*/) const {
436 Warning("NofVolDaughters", "New function - not yet implemented.");
437 return 0;
438 }
439
440 inline const char* TFluka::VolDaughterName(const char* /*volName*/, Int_t /*i*/) const {
441 Warning("VolDaughterName", "New function - not yet implemented.");
442 return "";
443 }
444
445 inline Int_t TFluka::VolDaughterCopyNo(const char* /*volName*/, Int_t /*i*/) const {
446 Warning("VolDaughterCopyNo", "New function - not yet implemented.");
447 return 0;
448 }
449
d59acfe7 450
829fb838 451
452#endif //TFLUKA
453