pleiades.CoilPack

class pleiades.CoilPack(**kwargs)[source]

A component representing a single CoilPack

Parameters:
  • r0 (float) – The R location of the centroid of the Coil
  • z0 (float) – The Z location of the centroid of the Coil
  • current (float) – The current in each current of the Coil in amps (i.e power supply current). Defaults to 1 amp.
  • nr (float) – The number of current filaments in the R direction. Defaults to 10.
  • nz (float) – The number of current filaments in the Z direction. Defaults to 10.
  • dr (float) – The distance between current filaments in the R direction. Defaults to 0.01 m
  • dz (float) – The distance between current filaments in the Z direction. Defaults to 0.01 m
  • groups (list) – A list of all the groups that comprise this Component
  • labels (list of str) – A list of all the names for the groups that comprise this Component. Each label is also accessible as an attribute on the Component as well.
  • patch_mask (iterable of bool) – A list of booleans of the same length as the number of groups where True indicates to hide the patch for that particular group.
  • grid (pleiades.Grid instance) – A grid on which to compute the Green’s functions for flux and magnetic fields
Variables:
  • r0 (float) – The R location of the centroid of the Coil
  • z0 (float) – The Z location of the centroid of the Coil
  • current (float) – The current in each current of the Coil in amps (i.e power supply current). Defaults to 1 amp.
  • nr (float) – The number of current filaments in the R direction. Defaults to 10.
  • nz (float) – The number of current filaments in the Z direction. Defaults to 10.
  • dr (float) – The distance between current filaments in the R direction. Defaults to 0.01 m
  • dz (float) – The distance between current filaments in the Z direction. Defaults to 0.01 m
  • groups (list) – A list of all the groups that comprise this Component
  • labels (list of str) – A list of all the names for the groups that comprise this Component. Each label is also accessible as an attribute on the Component as well.
  • num_groups (int) – Number of groups that make up the Component
  • currents (list of float) – A list of currents representing the current in each group in the Component
  • nprocs (int) – The number of processors to use to compute the Green’s functions
  • patches (list of matplotlib.patches.Patch objects) – A list of all the patches that represent the Component
  • patch_mask (iterable of bool) – A list of booleans of the same length as the number of groups where True indicates to hide the patch for that particular group.
  • grid (pleiades.Grid instance) – A grid on which to compute the Green’s functions for flux and magnetic fields
  • gpsi (np.array) – Green’s function for magnetic flux psi
  • gBR (np.array) – Green’s function for magnetic field component BR
  • gBZ (np.array) – Green’s function for magnetic field component BZ
  • psi (np.array) – Magnetic flux evaluated on the grid
  • BR (np.array) – Magnetic field component BR evaluated on the grid
  • BZ (np.array) – Magnetic field component BZ evaluated on the grid