legume.viz.wavef

legume.viz.wavef(struct, kind, mind, val='abs2', N1=100, N2=200, cbar=True)

Visualize wafeunction over a 2D slice in xy plane

Note

The wavefunction must be solved for and stored in the ExcitonSchroedEq object prior to calling this function.

Parameters:

• struct (ExcitonSchroedEq)

• kind (int) – The wave vector index to plot

• mind (int) – The mode index to plot

• val ({'re', 'im', 'abs2'}, optional)

• N1 (int, optional) – Number of grid points to sample in first spatial dim

• N2 (int, optional) – Number of grid points to sample in second spatial dim

• cbar (bool, optional) – Whether to include a colorbar

Returns:

fig – Figure object for the plot.

Return type:

matplotlib figure object