gcmotion.plot.machine_coords_profile

gcmotion.plot.machine_coords_profile(entity: Tokamak | Profile, **kwargs)

Plots the selected quantity’s (\(\Psi\), E, B, I, g, \(\frac{\partial B}{\partial\theta}\), \(\frac{\partial B}{\partial\psi}\), \(\frac{\partial I}{\partial\psi}\), \(\frac{\partial g}{\partial\psi}\)) contour plot in R, Z tokamak (cylindrical) coordinates, and in separate figures. Can also plot fixed points on certain contours.

Todo

fixed point analysis to be implemented.

Parameters:

entityTokamak | Profile

The Tokamak or Profile entity. Energy contour is available only if entity is of type Profile.

Other Parameters:

parametric_densityint, optional

Practiacally the density of the \(\theta\), \(\psi\) contour meshgrid, from which the R, Z grid is calculated. Defults to 500.

xmargin_percfloat, optional

x-axis margin of xlim so that there is some blank (white) space in between the plot limits and each contour drawing. Defaults to 0.1.

ymargin_percfloat, optional

y-axis margin of ylim so that there is some blank (white) space in between the plot limits and each contour drawing. Defaults to 0.1.

whichUnion[{“fp”, “E”, “b”, “i”, “g”}], optional

String of the form ‘fp E b i g’, ‘fp E b i’, ‘fp E b g’, ‘fp E i g’, i’, ‘E g’ ‘b i g’, ‘b i’, ‘b g’, ‘i g’, ‘b’, ‘i’, ‘g’ (case insensitive) that determines which figures will be plotted, that of the Energy and magnetic flux, that of the magnetic field and its derivatives and/or that of the toroidal current and its derivative and/or that of the poloidal current and its derivatives. Defaults to ‘E b i g’.

Notes

For a full list of all available optional parameters, see the dataclass MachineCoordsContoursConfig at gcmotion/configuration/plot_parameters. The defaults values are set there, and are overwritten if passed as arguments.