pleiades.Current

class pleiades.Current(loc=None, current=1.0)

Represents an axisymmetric ring of toroidal current.

Parameters:

• loc (tuple, optional) – The (R, Z) location of the current centroid in meters. Defaults to None
• current (float, optional) – The current in the ring in amps, defaults to 1 amp.

Variables:

• loc (tuple, optional) – The (R, Z) location of the current centroid in meters. Defaults to None
• current (float, optional) – The current in the ring in amps, defaults to 1 amp.
• marker (str) – A matplotlib marker string forplotting current direction “x” for “into the page”, etc.

classmethod from_dict(cls_dict)

Create Current instance from a dictionary

Parameters:cls_dict (dict) – The dictionary from which to construct a Current.

plot(ax)

Plot current locations with markers for +/-

Parameters:ax (matplotlib.Axes object) – The axis on which to plot the current location

to_dict()

Represent Current object as a dictionary