User knobs, buttons and switches (non-geometry)
Note: This is still fairly preliminary.
This is documents most of the non-geometry FFREAD cards
that were defined as of 7/2/96.
The details are still subject to change.
The use of FFREAD as the basic mechanism was chosen
simply for convenience (it is a CERN product, it is straightforward,
it works straight out of the box, it's already used by GEANT).
FFREAD long writeup @ CERN
General
MXST card
Usage: MXST nsteps
The MXST limits the maximum number of steps GEANT will take
while tracking a particle. This is useful for killing off straggling
muons or other such junk. In our case it can be something of a problem
since we have so many planes. The default for /GCTRAK/MAXNST
is 10000 which tends to chop muons off at about 2000 cm in length.
The introduction of this card pushes that limit up to 5000 and allows
the user to adjust it as they feel necessary.
MKIN card
Usage: MKIN method
Choose method for generating (or importing) events. The user can specify
the kinematics by using the usr_kine hook; the events can be
read from a file; generated with the neugen
(Soudan2) package; specified as the kinematics of a single particle.
Additional methods can be added by modifying GUKINE.
0 = call usr_kine
1 = call hepevt_file_kine
2 = call neugen_kine
3 = call single_part_kine (or if /GCKINE/IKINE.ne.0)
For method 3, one can set the basic kinematics using the KINE FFCARD
for input. The first value (an integer) is the *geant* particle code;
the next three (real don't forget decimal places!) are the components
of the momenta. Under gminos_inter one can change change these
before each event using the KINE command. A non-zero IKINE value
overrides the general MKIN method independent of what mode
was requested.
MTDK card
Usage: MTDK method
Method for handling tau decays. Note: the default method (0) is
effectively what has always been used, and generates no displacement
in the vertex since the tau itself is never propagated in geant.
0 = NEUGEN+tauola, no displaced vertex (default)
1 = GEANT GDECAY (not recommended)
2 = LUND performs the decay
GEANT tracks the event, GUDCAY call GLUDKY_MINOS
3 = NEUGEN+tauola for kinematics
GEANT displaces the vertex by tracking the
re-animated tau, and substitutes tauola's decay
products (not intially entered) when the tau decays
4 = tauola directly in GUDCAY
NEUGEN told not to call tauola (not yet implemented)
CCNC card
Usage: CCNC flag
Limit event types generated by NEUGEN.
-1 = generate either CC or NC event in right proportions (default)
1 = generate only CC events
2 = generate only NC events
QELR card
Usage: QELR flag
Limit event types generated by NEUGEN.
-1 = generate either QEL or Inelastic events (default)
0 = generate only QEL events
1 = generate only DIS events
RSCT card
Usage: RSCT flag
Control nuclear re-scattering in NEUGEN.
0 = no rescattering, INTRANUKE not called
1 = INTRANUKE called (default)
TAUB card
Usage: TAUB flag
Limit tau decay modes used by TAUOLA/NEUGEN
0 = generate with TAUOLA branching ratios (default)
1 = force tau -> e
2 = force tau -> mu
3 = force tau -> pi
4 = force tau -> rho
5 = force tau -> a1
6 = force tau -> K
7 = force tau -> K*
DKOF card
Usage: DKOF ipdg1 ipdg2 ...
Turn off NEUGEN's decay of individual particles types. Particle types s
hould be identified by PDG numbers; particles unknown to NEUGEN are ignored.
PLNL, FIDB and FIDZ cards
Usage: PLNL first_plane last_plane
Usage: FIDB R_outer R_inner
Usage: FIDZ R_outer R_inner x0 y0
Fiducial cuts on generated event vertices. The PLNL (plane
limits) card limits the range of plane numbers, the other two are
based on tubes (annulii in cross section); only vertices that lie within
the outer and inner radii of both cylinders (and satisfy the
PLNL card) will be generated.
The FIDB card specifies the outer and inner
radii of a tube directed (and centered) along the beam axis.
The FIDZ card defines two concentric cylinders parallel to
the z axis, centered on the point (x0,y0).
Take care not to specify an impossible condition set. If the intersection
of all the selection criteria is a null volume, this condition is not
tested for and will result in an infinite loop.
MFLX and FFLX cards
Usage: MFLX method
Usage: FFLX 'auxillary_file_name'
Choose method for generating neutrino flux. Method 0 requires no additional
files (all pertinent data is dataified in the routine), but this method
is only appropriate for use with a "Far" detector setup.
Additional methods can be added by modifying
GET_NU and GET_NU_INIT.
0 = E pulled from histograms (no transverse momentum)
relative flavors of nu_e,nu_e~,nu_mu,nu_mu~ based on gbeam
uniformly distributed across flux window
1 = Miller/Mufson flux files.
2 = Jim Hylen's gbeam ntuple files (not yet in library)
The FFLX allows the user to pass the flux method a file name
(which it may or may not use).
BCEN and BSLP cards
Usage: BCEN beam_x0 beam_y0 beam_z0
Usage: BSLP beam_dxdz beam_dydz
Position of the beam center and the slopes relative
to the detector (MARS) co-ordinate system.
ZREF and FREF cards
Usage: ZREF z_tgt2ref
Usage: FREF ref_z_nominal
These are relevant to the Miller/Mufson flux files (MFLX=1).
The z_tgt2ref variable is the desired z distance from the beamline
target to the reference plane of starting events.
The ref_z_nominal value should reflect what was used in generating
the flux file.
MFLV and PFLV cards
Usage: MFLV method
Usage: PFLV ipdg1 ipdg2 ipdg3 ipdg4 ipdg5 ipdg6
The currently implemented "oscillation" methods (MFLV) are:
0 = leave neutrino type unchanged
1 = fixed mapping between flavors (using PFLV)
For method 1, the PFLV array (6 values) hold the integer
PDG id for what nu_e, nu_mu, nu_tau, nu_e~, nu_mu~, nu_tau~ will become.
Each value must be a legal neutrino code:
| neutrino | - | anti-neutrino |
|---|
| nu_e | +12 | | nu_e~ | -12 |
| nu_mu | +14 | | nu_mu~ | -14 |
| nu_tau | +16 | | nu_tau~ | -16 |
FNDE card
Usage: FNDE ievt
When reading event from event file this card allows the user to skip
past events at the beginning. A value of 0 means start with first
event. A positive number looks for a match of ievt with
/HEPEVT/NEVHEP. A negative value means to skip
iabs(ievt) events from the beginning of the file before
processing the first event.
SXYZ card
Usage: SXYZ ilevel
Most useful during interactive sessions, should be set to 0 for batch
processing. This flag causes a call to GSXYZ to store the
current position during GUSTEP.
C SAVE_XYZ - controls whether GUSTEP calls GSXYZ
C if 0 nothing stored
C if - store only charged particles (+ store for all)
C if abs=1 store only position in active detector
C (2 store all steps)
C .... restrict it to only entrance point due to possibility
C of tiny step sizes in the sensitive volumes
GAFF and GAFN cards
Usage: GAFF iformat
Usage: GAFN 'file_name.xx_gaf'
These cards set the name and format of the GAF (Generic Adamo File)
output. A format of 0 is an ascii file, 1 is an exchange format
FZ file. The gaf file name can be up to 80 characters. They should
be enclosed within single quotes. If the file extension is '.xx_gaf'
then the 'xx' part will be replaced by "ie" or "fz" for ascii/fz files.
Active detector switches
FATL and FATN cards
Usage: FATL attn_len_short attn_len_long
Usage: FATN attn_norm_short attn_norm_long
Set the FLS fiber attenuation lengths. Provisions are made for a two
component system. The defaults are (350cm,1100cm) and (1.0,0.66).
STUB card
Usage: STUB fiber_tail
The additional length of fiber beyond the detector edge (currently
default of 100cm).
PEMU and ELMU cards
Usage: PEMU pe_per_muon
Usage: ELMU energy_loss_per_muon
This set is not yet fully implemented. PEMU, ELMU are used to set
the overall normalization. PEMU *should* the number of experimentally
observed photo-electrons seen for a muon; ELMU should be the true
energy loss by the muon. There should also be cards for the
photodetector efficiency, the fiber waveshift time constant (add to
FATL,FATN above), and the mirror end reflectivity.
QEPD card
Usage: QEPD photodetector_eff
This is the photo-detector quantum efficiency in the range from 0 to 1
(default 0.10). This is not multiplied against the PEMU
value, but rather affects only the Poisson statistics.
WTAU card
Usage: WTAU time
The decay constant for the waveshifting fiber in nano-seconds (default 12.0).
RMIR card
Usage: RMIR mirror_reflectivity
The reflectivity of the mirrored end of the waveshifting fiber. This
is a value in the range 0 to 1 (default 0.70).
BSAT card
Usage: BSAT saturation_coeff
This is the satturation coefficient of the scintillator (cf. difls_1cell.F).
The default value is 13.3.
Not yet active
EGEN, VGEN, BRAD card
select event generator, vertex selector methods, limit beam radius.
...not yet in place ... soooooon!
Obsolete?
VERT card
Usage: VERT i
Originally used to limit events to iron, concrete and/or active detectors.
Needs to be re-thought in new scheme.
EPIO card
hatcher@astro.indiana.edu
Last modified: Tue Jul 16 08:52:07 CDT 2002