Writing of FLUKA input cards for physics configuration is now the responsibility of
[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"
829fb838 18
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
93 virtual void SetCerenkov(Int_t itmed, Int_t npckov, Float_t *ppckov,
94 Float_t *absco, Float_t *effic, Float_t *rindex);
95 virtual void SetCerenkov(Int_t itmed, Int_t npckov, Double_t *ppckov,
96 Double_t *absco, Double_t *effic, Double_t *rindex);
97
98
99 // Functions for drawing
100 virtual void DrawOneSpec(const char* /*name*/)
101 {printf("WARNING: DrawOneSpec not yet implemented !\n");}
102 virtual void Gsatt(const char* name, const char* att, Int_t val);
103 virtual void Gdraw(const char*,Double_t /*theta = 30*/, Double_t /*phi = 30*/,
104 Double_t /*psi = 0*/, Double_t /*u0 = 10*/, Double_t /*v0 = 10*/,
105 Double_t /*ul = 0.01*/, Double_t /*vl = 0.01*/)
106 {printf("WARNING: Gdraw not yet implemented !\n");}
829fb838 107
108 // Euclid
b496f27c 109 virtual void WriteEuclid(const char*, const char*, Int_t, Int_t);
829fb838 110
b496f27c 111 // Getters
112 virtual Int_t VolId(const Text_t* volName) const;
113 virtual const char* VolName(Int_t id) const;
114 virtual Int_t NofVolumes() const {return fNVolumes;}
115 virtual Int_t VolId2Mate(Int_t id) const;
829fb838 116 //
b496f27c 117 // Methods for physics management
829fb838 118 // ------------------------------------------------
119 //
120
b496f27c 121 // User configuration
b2129742 122 virtual Bool_t SetProcess(const char* flagName, Int_t flagValue);
123 virtual void SetProcess(const char* flagName, Int_t flagValue, Int_t imed);
124 virtual Bool_t SetCut(const char* cutName, Double_t cutValue);
125 virtual void SetCut(const char* cutName, Double_t cutValue, Int_t imed);
fb2cbbec 126 virtual TObjArray* GetListOfUserConfigs() {return fUserConfig;}
b2129742 127 virtual Double_t Xsec(char*, Double_t, Int_t, Int_t);
829fb838 128
b496f27c 129 // Particle table usage
130 virtual Int_t IdFromPDG(Int_t id) const;
131 virtual Int_t PDGFromId(Int_t pdg) const;
132 virtual void DefineParticles()
829fb838 133 {printf("WARNING: DefineParticles not yet implemented !\n");}
134
135 //
136 // methods for step management
137 // ------------------------------------------------
138 //
139
b496f27c 140 // Action methods
bd3d5c8a 141 virtual void StopTrack();
142 virtual void ResetStoppingCondition() {fStopped = kFALSE;}
eb49ba4d 143 virtual Bool_t GetStoppingCondition() const {return fStopped;}
bd3d5c8a 144
b496f27c 145 virtual void StopEvent() {fStopEvent = kTRUE;}
146 virtual void StopRun() {fStopEvent = kTRUE; fStopRun = kTRUE;}
eb49ba4d 147 virtual Bool_t EventIsStopped() const {return fStopEvent;}
b496f27c 148 virtual void SetStopEvent(Bool_t flag) {fStopEvent = flag;}
829fb838 149
b496f27c 150 // Set methods
07f5b33e 151 virtual void SetMaxStep (Double_t step);
829fb838 152 virtual void SetMaxNStep(Int_t);
153 virtual void SetUserDecay(Int_t);
154
b496f27c 155 // Get methods
156 // Tracking volume(s)
829fb838 157 virtual Int_t CurrentVolID(Int_t& copyNo) const;
158 virtual Int_t CurrentVolOffID(Int_t off, Int_t& copyNo) const;
159 virtual const char* CurrentVolName() const;
160 virtual const char* CurrentVolOffName(Int_t off) const;
161 virtual Int_t CurrentMaterial(Float_t &a, Float_t &z,
162 Float_t &dens, Float_t &radl, Float_t &absl) const;
b496f27c 163 virtual Int_t CurrentEvent() const {return fNEvent;}
164
829fb838 165 virtual void Gmtod(Float_t* xm, Float_t* xd, Int_t iflag);
166
167 virtual void Gmtod(Double_t* xm, Double_t* xd, Int_t iflag);
168
169 virtual void Gdtom(Float_t* xd, Float_t* xm, Int_t iflag);
170
171 virtual void Gdtom(Double_t* xd, Double_t* xm, Int_t iflag);
172
2f09b80e 173 virtual Double_t MaxStep() const;
829fb838 174 virtual Int_t GetMaxNStep() const
2f09b80e 175 {printf("WARNING: GetMaxNStep not yet implemented !\n"); return -1;}
829fb838 176 virtual Int_t GetMedium() const;
177
b496f27c 178 // Tracking particle
829fb838 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;
b496f27c 188 // Static properties
829fb838 189 virtual Int_t TrackPid() const;
190 virtual Double_t TrackCharge() const;
191 virtual Double_t TrackMass() const;
192 virtual Double_t Etot() const;
b496f27c 193 // Track status
829fb838 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
b496f27c 203 // Secondaries
7b203b6e 204 virtual Int_t NSecondaries() const;
205 virtual void SetNCerenkov(Int_t nc) {fNCerenkov = nc;}
206
829fb838 207 virtual void GetSecondary(Int_t isec, Int_t& particleId,
208 TLorentzVector& position, TLorentzVector& momentum);
bd3d5c8a 209 virtual Bool_t SecondariesAreOrdered() const {return kFALSE;}
829fb838 210 virtual TMCProcess ProdProcess(Int_t iproc) const ;
b496f27c 211 virtual Int_t StepProcesses(TArrayI & proc) const;
829fb838 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");}
b496f27c 237//
238 virtual void Gfpart(Int_t pdg, char* name, Int_t& type, Float_t& mass, Float_t& charge, Float_t& tlife);
829fb838 239 virtual void Gspart(Int_t, const char*, Int_t, Double_t, Double_t, Double_t)
b496f27c 240 {printf("WARNING: Gspart not yet implemented !\n");}
241
242
243 //
244 // FLUKA Scoring specific methods
245 // ------------------------------
246 //
247 virtual void SetUserScoring(const char* option, Int_t npar, Float_t* what);
248 //
249 // Particle Properties
250 // -------------------
251 //
252 virtual Bool_t DefineParticle(int, const char*, TMCParticleType, double, double, double) {return kFALSE;}
253 virtual Bool_t DefineIon(const char*, int, int, int, double, double) {return kFALSE;}
254 virtual TString ParticleName(int pdg) const;
255 virtual Double_t ParticleMass(int pdg) const;
256 virtual Double_t ParticleCharge(int pdg) const;
257 virtual Double_t ParticleLifeTime(int pdg) const;
258 virtual TMCParticleType ParticleMCType(int) const {return (TMCParticleType) 9;}
829fb838 259 //
b496f27c 260 // Control methods
829fb838 261 // ------------------------------------------------
262 //
263
264 virtual void Init();
265 virtual void InitPhysics();
266 virtual void FinishGeometry();
267 virtual void BuildPhysics();
268 virtual void ProcessEvent();
269 virtual Bool_t ProcessRun(Int_t nevent);
270
271 //
b496f27c 272 // New Getter and Setters
829fb838 273 // ------------------------------------------------
274 //
275 // - Core input file name
276 TString GetCoreInputFileName() const {return fCoreInputFileName;}
3b8c325d 277 void SetCoreInputFileName(const char* file = "coreFlukaVmc.inp") {fCoreInputFileName = file;}
829fb838 278
279 // - Input file name
280 TString GetInputFileName() const {return fInputFileName;}
3b8c325d 281 void SetInputFileName(const char* file = "FlukaVmc.inp") {fInputFileName = file;}
829fb838 282
829fb838 283 // - Verbosity level
284 Int_t GetVerbosityLevel() const {return fVerbosityLevel;}
285 void SetVerbosityLevel(Int_t l) {fVerbosityLevel = l;}
286
287 // - Fluka Draw procedures identifiers
288 // bxdraw = 1 inside
289 // bxdraw = 11 entering
290 // bxdraw = 12 exiting
291 // eedraw = 2
292 // endraw = 3
293 // mgdraw = 4
294 // sodraw = 5
295 // usdraw = 6
296 Int_t GetCaller() const {return fCaller;}
297 void SetCaller(Int_t l) {fCaller = l;}
298
299 // - Fluka Draw procedures formal parameters
300 Int_t GetIcode() const {return fIcode;}
301 void SetIcode(Int_t l) {fIcode = l;}
302 // in the case of sodraw fIcode=0
303
304 Int_t GetMreg() const {return fCurrentFlukaRegion;}
305 void SetMreg(Int_t l);
306
307 Int_t GetNewreg() const {return fNewReg;}
308 void SetNewreg(Int_t l) {fNewReg = l;}
309
310 Double_t GetRull() const {return fRull;}
311 void SetRull(Double_t r) {fRull = r;}
312
313 Double_t GetXsco() const {return fXsco;}
314 void SetXsco(Double_t x) {fXsco = x;}
315
316 Double_t GetYsco() const {return fYsco;}
317 void SetYsco(Double_t y) {fYsco = y;}
318
319 Double_t GetZsco() const {return fZsco;}
320 void SetZsco(Double_t z) {fZsco = z;}
321
322 void SetCurrentFlukaRegion(Int_t reg) {fCurrentFlukaRegion=reg;}
323 Int_t GetCurrentFlukaRegion() const {return fCurrentFlukaRegion;}
324
325 void SetDummyBoundary(Int_t mode) {fDummyBoundary = mode;}
326 Int_t GetDummyBoundary() const {return fDummyBoundary;}
327 Bool_t IsDummyBoundary() const {return (fDummyBoundary==0)?kFALSE:kTRUE;}
328
7f13be31 329 void SetGeneratePemf(Bool_t flag = kTRUE) {fGeneratePemf = flag;}
829fb838 330 Bool_t IsGeneratePemf() const {return fGeneratePemf;}
331
332 void EnableField(Bool_t flag=kTRUE) {fFieldFlag = flag;}
333 Bool_t IsFieldEnabled() const {return fFieldFlag;}
334 void SetTrackIsEntering(){fTrackIsEntering = kTRUE; fTrackIsExiting = kFALSE;}
335 void SetTrackIsExiting() {fTrackIsExiting = kTRUE; fTrackIsEntering = kFALSE;}
336 void SetTrackIsInside() {fTrackIsExiting = kFALSE; fTrackIsEntering = kFALSE;}
7cad64b7 337 void SetTrackIsNew(Bool_t flag = kTRUE);
338
6f5667d1 339 Int_t GetMaterialIndex(Int_t idmat) const {return fMaterials[idmat];}
829fb838 340 TObjArray *GetFlukaMaterials();
b496f27c 341 private:
829fb838 342 TFluka(const TFluka &mc): TVirtualMC(mc) {;}
343 TFluka & operator=(const TFluka &) {return (*this);}
344
345
346 Int_t fVerbosityLevel; //Verbosity level (0 lowest - 3 highest)
b496f27c 347 Int_t fNEvent; //Current event number
3b8c325d 348 TString fInputFileName; //Name of the real input file
349 TString fCoreInputFileName; //Name of the input file
829fb838 350
351 Int_t fCaller; //Parameter to indicate who is the caller of the Fluka Draw
352 Int_t fIcode; //Fluka Draw procedures formal parameter
353 Int_t fNewReg; //Fluka Draw procedures formal parameter
354 Double_t fRull; //Fluka Draw procedures formal parameter
355 Double_t fXsco; //Fluka Draw procedures formal parameter
356 Double_t fYsco; //Fluka Draw procedures formal parameter
357 Double_t fZsco; //Fluka Draw procedures formal parameter
358 Bool_t fTrackIsEntering; // Flag for track entering
359 Bool_t fTrackIsExiting; // Flag for track exiting
360 Bool_t fTrackIsNew; // Flag for new track
361 Bool_t fFieldFlag; // Flag for magnetic field
362 Bool_t fGeneratePemf; // Flag for automatic .pemf generation
363 Int_t fDummyBoundary; // Flag for crossing dummy boundaries
bd3d5c8a 364 Bool_t fStopped; // Flag for stopping
b496f27c 365 Bool_t fStopEvent; // Flag for stopped event
366 Bool_t fStopRun; // Flag for stopped run
bd3d5c8a 367
b496f27c 368 //
829fb838 369 //Geometry through TGeo
b496f27c 370 //
371 Int_t* fMaterials; //!Array of indices
829fb838 372 Int_t fNVolumes; //!Current number of volumes
7b203b6e 373 Int_t fCurrentFlukaRegion; // Index of fluka region at each step
374 Int_t fNCerenkov; // Number of cerekov photons
829fb838 375 TFlukaMCGeometry *fGeom; // TGeo-FLUKA interface
376 TGeoMCGeometry *fMCGeo; // Interface to TGeo builder
377
1df5fa54 378 // SetProcess, SetCut and user Scoring dynamic storage
fb2cbbec 379 TObjArray* fUserConfig; // List of user physics configuration
1df5fa54 380 TObjArray* fUserScore; // List of user scoring options
381
829fb838 382 ClassDef(TFluka,1) //C++ interface to Fluka montecarlo
383};
384
385#endif //TFLUKA
386