pythtb.Wannier.plot_decay

Wannier.plot_decay(wan_idx, fig=None, ax=None, show=False)

Plot the Wannier function density as a function of distance from center.

Parameters:

wan_idxint

Index of the Wannier function to plot.

figmatplotlib.figure.Figure | None

Matplotlib figure object to plot on. If None, a new figure is created.

axmatplotlib.axes.Axes | None

Matplotlib axes object to plot on. If None, new axes are created.

showbool

If True, display the plot immediately.

Returns:

figmatplotlib.figure.Figure

The figure object containing the plot.

axmatplotlib.axes.Axes

The axes object containing the plot.