plot_outline()

Grid.plot_outline(phi: float = 0.0, fig: Figure | None = None, ax: Axes | None = None, show_phi: bool = True, **kwargs) → tuple[Figure | None, Axes]Source

Plotting EMC3-EIRENE-defined grid outline in \(R–Z\) plane.

This method allows users to plot grid outline at a specific toroidal angle \(\varphi\). The toroidal angle is arbitrary, where the grid outline is calculated by linear interpolation between two nearest toroidal grids.

Parameters:

phifloat, optional

Toroidal grid in [degree], by default 0.0.

figFigure, optional

Matplotlib figure object, by default fig = plt.figure().

axAxes, optional

Matplotlib axes object, by default ax = fig.add_subplot().

show_phibool

Show toroidal angle text in the plot, by default True.

**kwargsdict

matplotlib.lines.Line2D properties, by default {"color": "black", "linewidth": 0.5}.

Returns:

figFigure | None

Matplotlib figure object. If fig is not specified but axis is, return None.

axAxes

Matplotlib axes object.

Examples

>>> grid = Grid("zone0")
>>> grid.plot_outline(4.2)