PYTHIA8/pythia8170/xmldoc/ErrorChecks.xml

   1 <chapter name="Error Checks">
   2
   3 <h2>Error Checks</h2>
   4
   5 There is a few settings related to error checking during program
   6 execution. Many other checks are performed as well, but do not
   7 have any specific setting related to themselves.
   8
   9 <flag name="Check:abortIfVeto" default="off">
  10 There are a few ways in which an event can be vetoed, the most
  11 common being a <aloc href="UserHooks">User Hooks</aloc> test.
  12 Normally this will simply mean that the next parton-level
  13 configuration is selected inside the <code>Pythia::next()</code>
  14 routine, without any need for a user intervention. With this
  15 option switched on, however, <code>Pythia::next()</code> will
  16 return <code>false</code>. It is then up to the user to decide
  17 what to do next.
  18 </flag>
  19
  20 <flag name="Check:particleData" default="off">
  21 Check the particle data tables for potential problems during
  22 initialization. This includes inconsistent use of charge in particle
  23 names, inconsistent setup of mass, mass range, width and lifetime,
  24 sum of branching ratios not unity (allowed but discouraged) or charge
  25 not conserved in a decay channel. Warnings should be viewed as reasons
  26 to check further, but need not indicate a true problem, and also not all
  27 problems may be caught.
  28 The <code>pythia.particleData.checkTable(level)</code> method,
  29 used for these checks, may also be called directly.
  30 </flag>
  31
  32 <modepick name="Check:levelParticleData" default="1">
  33 The level of verbosity and checks of particle data, if switched on.
  34 <option value="0">mimimal amount of checks, e.g. that no channels open.
  35 </option>
  36 <option value="1">further warning if individual channels closed,
  37 except for resonances.</option>
  38 <option value="2">also print branching-ratio-averaged threshold mass
  39 except for resonances.</option>
  40 <option value="11">as 1, but include resonances in detailed checks.
  41 </option>
  42 <option value="12">as 2, but include resonances in detailed checks.
  43 </option>
  44 </modepick>
  45
  46 <flag name="Check:event" default="on">
  47 When an event has been successfully generated, check that the
  48 final event record in <code>event</code> does not contain any
  49 unphysical particles, or nonconserved charge or energy-momentum.
  50 If this check fails, then <code>pythia.next()</code> obtains the
  51 value <code>false</code>, i.e. the event is counted as aborted.
  52 </flag>
  53
  54 <flag name="Check:history" default="on">
  55 When <code>Check:event = on</code> and the event is checked as above,
  56 further checks are made that all mother and daughter pointers are
  57 consistently set. Specifically that all daughters in the
  58 <code>daughterlist</code> (or <code>motherList</code>) have the
  59 particle in their respective <code>motherList</code>
  60 (or <code>daughterlist</code>). This operation takes a bit more
  61 time than the other error tests (of the order of 10% of what it takes
  62 to generate the event in the first place), and so could be switched off
  63 to save time.
  64 </flag>
  65
  66
  67 <modeopen name="Check:nErrList" default="0">
  68 The number of erroneous events, in the above check, for which
  69 event listing and other detailed information will be printed.
  70 After that, only the normal error messages will be issued.
  71 Error counters are always updated, and accumulated numbers can be
  72 shown with <code>pythia.statistics()</code> at the end of the run.
  73 </modeopen>
  74
  75 <parm name="Check:epTolErr" default="1e-4">
  76 Maximum allowed summed deviation of <ei>E</ei>, <ei>p_x</ei>,
  77 <ei>p_y</ei> and <ei>p_z</ei> between the incoming beams and the
  78 final state, as a fraction of the initial energy, above which the
  79 event is counted as aborted.
  80 (Unfortunetely roundoff errors do not scale linearly with the energy,
  81 and also have a very long tail. So while most events at lower energies
  82 may be correct to better than 1e-10, at LHC it does not have to signal
  83 any fundamental bug if also the default tolerance above is violated
  84 occasionally.)
  85 </parm>
  86
  87 <parm name="Check:epTolWarn" default="1e-6">
  88 A check on the same summed deviation as above, but counted as a
  89 warning rather than an error, and not leading to the event being
  90 classified as aborted.
  91 </parm>
  92
  93 </chapter>
  94
  95 <!-- Copyright (C) 2012 Torbjorn Sjostrand -->