Representation of a point in a poloidal slice (or analogous).

Public members¶

x1 : float

Coordinate in first dimension

x2 : float

Coordinate in second dimension

system : CoordinateSystem

The type of coordinates being used

Constructors¶

SliceCoord(x1: float, x2: float, system: CoordinateSystem)

Initialize self. See help(type(self)) for accurate signature.

Special methods¶

__iter__() → Iterator[float]

Iterate over the coordinates of the point.

__repr__()

Return repr(self).

__eq__(other)

Return self==value.

__hash__()

Return hash(self).

Methods¶

round_to(figures: int = 8) → SliceCoord

Round coordinate values to the desired number of significant figures.

to_3d_coord(x3: float) → Coord

Create a 3D coordinate object from this 2D one.

approx_eq(other: SliceCoord, rtol: float = 1e-09, ...) → bool

Check equality of coordinates within the the tolerance.