gtsimulation.common.codes#

Module Attributes

BreakCode

Simulation break reasons and the corresponding code.

BreakIndex

The inverse dict to BreakCode

SaveCode

The parameters that can be saved along the path and the corresponding indices in the matrix.
gtsimulation.common.codes.BreakCode = {'Death': -2, 'Dist2Path': 4, 'Loop': -1, 'MaxPath': 9, 'MaxRev': 11, 'MaxTime': 10, 'Rmax': 8, 'Rmin': 3, 'Xmax': 5, 'Xmin': 0, 'Ymax': 6, 'Ymin': 1, 'Zmax': 7, 'Zmin': 2}#

Simulation break reasons and the corresponding code.

Parameters:

  • Loop – The simulation went through all its steps

  • Xmin:Ymin:Zmin – The absolute value of x, y, z coordinate is less than Xmin, Ymin, Zmin (in magnetic_field units)

  • Xmax:Ymax:Zmax – The absolute value of x, y, z coordinate is greater than Xmax, Ymax, Zmax (in magnetic_field units)

  • Rmin:Rmax – The radius is less(greater) than Rmin`(`Rmax) (in MagneticField units)

  • Dist2Path – The fraction of the distance travelled to the path is less than the Dist2Path.

  • Death – The particle went into an nuclear interaction.

  • MaxPath:MaxTime – The path (time) travelled is greater than the parameters (in magnetic_field units for MaxPath)

  • MaxRev – The maximum number of revolutions.

gtsimulation.common.codes.BreakIndex = {-2: 'Death', -1: 'Loop', 0: 'Xmin', 1: 'Ymin', 2: 'Zmin', 3: 'Rmin', 4: 'Dist2Path', 5: 'Xmax', 6: 'Ymax', 7: 'Zmax', 8: 'Rmax', 9: 'MaxPath', 10: 'MaxTime', 11: 'MaxRev'}#

The inverse dict to BreakCode

gtsimulation.common.codes.SaveCode = {'Angles': (5, 12), 'Bfield': (4, slice(9, 12, 1)), 'Clock': (8, 15), 'Coordinates': (1, slice(0, 3, 1)), 'Density': (7, 14), 'Efield': (3, slice(6, 9, 1)), 'Energy': (9, 16), 'GuidingCenter': (12, slice(18, 21, 1)), 'LarmorRadii': (11, 18), 'Path': (6, 13), 'PitchAngles': (10, 17), 'Velocities': (2, slice(3, 6, 1))}#

The parameters that can be saved along the path and the corresponding indices in the matrix.