USERDUMP

Summary

Defines a collision “tape” (or better a collision file, or a phase space file) to be written.

​​ ​

This command activates calls to the user routine MGDRAW and to its entries BXDRAW, EEDRAW, ENDRAW, SODRAW, USDRAW (see description in MGDRAW: general event interface).
The default version of the routine writes a complete dump (unformatted) of one or more of the following:

  • all source particles

  • all trajectories

  • all local (pointlike) energy deposition events

  • all continuous energy deposition events

  • user-defined events

​​​ ​ Users can modify the routine by removing the existing lines of code and by writing their own code under one or more of the entries.

For SDUM ≠ UDQUENCH:

WHAT(1) ≥ 100.0

: calls to MGDRAW and/or its entries are activated as directed by the values of WHAT(3) and WHAT(4)

= 0.0:

ignored

≤ -100:

the default is reset, i.e. no dump is written

> -100 and < 100: not allowed! Originally used to request another form of collision tape.

Presently only the “new” form of collision tape is possible (the old one being incompatible with the present version of FLUKA)

WHAT(2) :

if the default version of MGDRAW is used, number of the unformatted output unit. Values of WHAT(2)< 21.0 must be avoided because of possible conflicts with FLUKA pre-defined units.​

If a user version is used, the output file can be defined as formatted or unformatted, and the unit number can be defined by an explicit Fortran OPEN statement in MGDRAW.

Default

: 49.0

WHAT(3) :

if the default version of ``MGDRAW`` is used:

≤ 0.0:

source particles, trajectories, continuous and local energy losses are all dumped

= 1.0:

only source particles are dumped

= 2.0:

only trajectories and continuous energy losses are dumped

= 3.0:

only local energy losses are dumped (e.g. heavy recoil kerma, cutoff energy). Proton recoils are not included (since recoil protons are transported by FLUKA)​​​

= 4.0:

source particles, trajectories and continuous energy losses are dumped

= 5.0:

source particles and local energy losses are dumped

= 6.0:

trajectories and all energy losses (continuous and local) are dumped

≥ 7.0:

source particles, trajectories, continuous and local energy losses are not dumped (but user-defined dumps​ required by WHAT(4) are unaffected)

if a user version is used:

≤ 0.0:

call to MGDRAW at each particle step and at each occurrence of a continuous energy loss, to ENDRAW at each local energy loss, to SODRAW every time a source particle is started, to BXDRAW at each boundary crossing, and to EEDRAW at each end of event.

= 1.0:

calls to SODRAW and EEDRAW

= 2.0:

calls to MGDRAW, EEDRAW and BXDRAW

= 3.0:

calls to ENDRAW, EEDRAW and BXDRAW

= 4.0:

calls to SODRAW, MGDRAW, EEDRAW and BXDRAW

= 5.0:

calls to SODRAW, ENDRAW, EEDRAW and BXDRAW

= 6.0:

calls to MGDRAW, ENDRAW, EEDRAW and BXDRAW

≥ 7.0:

no calls to MGDRAW, SODRAW, ENDRAW, EEDRAW, BXDRAW (but calls to USDRAW and EEDRAW requested by WHAT(4) are unaffected)

Default

= 0.0  (calls are made to MGDRAW, ENDRAW, SODRAW, BXDRAW and EEDRAW, provided WHAT(1)≥ 100.0)

WHAT(4) ≥ 1.0:

user-defined dumps after collisions are activated (calls to USDRAW and EEDRAW)

= 0.0:

ignored

< 0.0:

resets to default (user dependent dumps after collisions are de-activated)

WHAT(5)

– WHAT(6): not used

SDUM

= name of the output file (max. 10 characters). The user can define a longer name by an   explicit Fortran OPEN statement in MGDRAW.

For SDUM = UDQUENCH:

WHAT(1) :

BRKMG1(1), First Birks parameter​ for quenching, to be used in MGDRAW for a first material, in g/(MeV\(\cdot\)cm\(^2\))

WHAT(2) :

BRKMG2(1), Second Birks parameter for quenching, to be used in MGDRAW for the first material, in g\(^2\)/(MeV\(^2\cdot\)cm\(^4\))

WHAT(3) :

BRKMG1(2), First Birks parameter for quenching, to be used in MGDRAW for a second material, in g/(MeV\(\cdot\)cm\(^2\))

WHAT(4) :

BRKMG2(2), Second Birks parameter for quenching, to be used in MGDRAW for the second material, in g\(^2\)/(MeV\(^2\cdot\)cm\(^4\))

WHAT(5) :

BRKMG1(3), First Birks parameter for quenching, to be used in MGDRAW for a third material, in g/(MeV\(\cdot\)cm\(^2\))

WHAT(6) :

BRKMG2(3), Second Birks parameter for quenching, to be used in MGDRAW for the third material, in g\(^2\)/(MeV\(^2\cdot\)cm\(^4\))

SDUM

= UDQUENCH

Default

(option USERDUMP not given): no dump will be written


Note
  1. The format of the default binary collision tape, the code number of the events and the variables written for the different type of events, are described in Collision tape.
    Be careful, if the default version of MGDRAW is used, the amount of output can be enormous.

  2. The default options described above can be changed by modifying the user routine MGDRAW (see description in MGDRAW: general event interface)

  3. Quenching, as requested with SDUM = UDQUENCH, can be applied to energy deposition (local at ENDRAW calls or continuous at MGDRAW calls). Some information about Birks law can be found in Note 1 to option TCQUENCH

Example:

*...+....1....+....2....+....3....+....4....+....5....+....6....+....7...+...8
USERDUMP        200.      37.0       2.0                              TRAKFILE
* It is requested to write a binary file TRAKFILE, containing all trajectories and
* continuous energy losses, and pre-connected to the logical output unit 37.