gcmotion.plot.profile_energy_contour#

gcmotion.plot.profile_energy_contour(profile: Profile, **kwargs)#

Plots the Profile’s energy contour plot.

Parameters:
profile: Profile

The Profile entity.

Other Parameters:
thetalimlist, optional

The \(\theta\) span in radians. Defaults to [-π,π].

psilimlist, optional

The \(\psi\) span in units of psi_wall. Defaults to [0, 1.2].

levelsint, optional

The number of contour lines. Defaults to 25.

ycoord: {“psi”, “Ptheta”}, optional

Which coordinate to use for the y axis. Defaults to “psi”.

flux_unitsstr, optional

The units of the psi/Ptheta axis. Can be “Magnetic_flux”(same as “Tesla * meters^2”), “NUmagnetic_flux” (same as “NUTesla * NUmeters^2”), “psi_wall”, “NUpsi_wall”, or any other pint unit with the same dimensionality. Defaults to “Tesla * meters^2”.

E_unitsstr, optional

The Energy units. Can be “eV”, “keV”, “Joule”, “NUJoule” or any other pint unit with the same dimensionality. Defaults to “keV”.

potentialbool, optional

Whether or not to add the potential Φ term when calculating the Energy. Defaults to True.

wallbool, optional

Whether or not to shade the area above \(\psi_wall\). Defaults to True.

grid_density: int, optional

The contour’s grid density. Defaults to 200.