mapflpy.globals.Polarity.ERROR

Contents

mapflpy.globals.Polarity.ERROR#

ERROR = Polarity.ERROR#

Enumeration of magnetic fieldline polarity classifications.

This enumeration is used to label the connectivity of magnetic fieldlines based on their endpoints. The values encode both the type of connectivity (open, closed, or invalid) and, for open lines, the sign of the radial magnetic field at the footpoint.

Variables:

  • R0_R1_NEG (int (-2)) – Open fieldline connecting from the inner boundary (R0) to the outer boundary (R1) with a negative radial magnetic field (Br < 0) at the inner boundary footpoint.

  • R0_R0 (int (-1)) – Closed fieldline with both endpoints anchored at the inner boundary (R0).

  • ERROR (int (0)) – Indicates an undefined or unclassified trace, typically used when the endpoints do not terminate at a boundary.

  • R1_R1 (int (1)) – Closed fieldline with both endpoints anchored at the outer boundary (R1) e.g. “Disconnected” trace.

  • R0_R1_POS (int (2)) – Open fieldline connecting from the inner boundary (R0) to the outer boundary (R1) with a positive radial magnetic field (Br > 0) at the inner boundary footpoint.

Notes

The sign convention assumes that the radial magnetic field (Br) is evaluated at the inner boundary footpoint of the fieldline.

Contents