State
Event flags for the Monte Carlo simulation.
Attributes
| Name | Type | Description |
|---|---|---|
| none | boolean |
No event. |
| start | boolean |
Start of a Monte Carlo transport. |
| medium | boolean |
A change of medium. |
| weight | boolean |
Null or negative Monte Carlo weight. |
| stop | boolean |
Stop of Monte Carlo transport. |
| limit | boolean |
Any external limit: distance, grammage, kinetic energy or time. |
| vertex | boolean |
Any interaction (desintegration) vertex. |
| vertex_coulomb | boolean |
A Coulomb interaction vertex. |
| vertex_decay | boolean |
A decay vertex. |
| vertex_del | boolean |
Any discrete energy loss (DEL): Bremsstrahlung, delta ray, e^+e^- pair creation or photonuclear event. |
| vertex_bremsstrahlung | boolean |
A Bremsstrahlung DEL vertex. |
| vertex_delta_ray | boolean |
A delta ray DEL vertex. |
| vertex_pair_creation | boolean |
An e^+e^- pair creation DEL vertex. |
| vertex_photonuclear | boolean |
A photonuclear DEL vertex. |
| limit_distance | boolean |
A travelled distance external limit. |
| limit_energy | boolean |
A kinetic energy external limit. |
| limit_grammage | boolean |
A travelled grammage external limit. |
| limit_time | boolean |
A proper time external limit. |
Note
When getting the status of a multi-cases event, e.g. limit, true is
returned if any case is true, otherwise false is returned, i.e. if all
cases are false. But when setting a multi case event all cases are set to
true or false.
Constructor
The Monte Carlo Event constructor has two forms as illustrated in
the synopsis below. The first form is a copy constructor from another
Event instance. The second form takes an arbitrary number of event
flags as argument. Event flags must correspond to the attributes listed
above. Any provided flag is initialized to true. By default a
none event is returned, i.e. all other flags are false.
Synopsis
pumas.Event(event)
pumas.Event(flag, ...)
Arguments
| Name | Type | Description |
|---|---|---|
| event | Event | Another event instance to copy. |
| flag | string |
The argument must reference a flag defined as attribute, e.g. 'medium', 'vertex', etc. The corresponding flag is set to true. |
See also
Event.clear
Clear the Monte Carlo event reseting all its flags to zero, i.e. to the none event.
Synopsis
Event:clear()
Arguments
None, except self.
Returns
| Type | Description |
|---|---|
| Event | Reference to the updated Monte Carlo event. |