tidy3d.SteadyEnergyBandData

class SteadyEnergyBandData

Bases: HeatChargeMonitorData

Stores energy bands in charge simulations.

Parameters:

• monitor (SteadyEnergyBandMonitor) – Energy bands data associated with a Charge simulation.

• symmetry (tuple[Literal[0, 1], Literal[0, 1], Literal[0, 1]] = (0, 0, 0)) – Symmetry of the original simulation in x, y, and z.

• symmetry_center (tuple[float, float, float] = (0, 0, 0)) – Symmetry center of the original simulation in x, y, and z.

• Ec (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = eV]. Contains the computed energy of the bottom of the conduction band \(E_c\).

• Ev (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = eV]. Contains the computed energy of the top of the valence band \(E_v\).

• Ei (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = eV]. Contains the computed intrinsic Fermi level for the material \(E_i\).

• Efn (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = eV]. Contains the computed quasi-Fermi level for electrons \(E_{fn}\).

• Efp (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = eV]. Contains the computed quasi-Fermi level for holes \(E_{fp}\).

Notes

This data contains the energy bands data [eV]:

Symbol	Parameter Name	Description
\(E_c\)	Ec	Energy of the bottom of the conduction band
\(E_v\)	Ev	Energy of the top of the valence band
\(E_i\)	Ei	Intrinsic Fermi level
\(E_{fn}\)	Efn	Quasi-Fermi level for electrons
\(E_{fp}\)	Efp	Quasi-Fermi level for holes

as defined in the monitor.

Attributes

field_components	Maps the field components to their associated data.
monitor
Ec
Ev
Ei
Efn
Efp
symmetry
symmetry_center

Methods

check_correct_data_type()	Issue error if incorrect data type is used
plot([ax])	Plot the 1D cross-section of the energy bandgap diagram.

monitor

Ec

Ev

Ei

Efn

Efp

property field_components

Maps the field components to their associated data.

check_correct_data_type()

Issue error if incorrect data type is used

plot(ax=None, **sel_kwargs)

Plot the 1D cross-section of the energy bandgap diagram.

Parameters:

• ax (matplotlib.axes._subplots.Axes = None) – matplotlib axes to plot on, if not specified, one is created.

• sel_kwargs (keyword arguments used to perform .sel() selection in the monitor data.) – These kwargs can select over the spatial dimensions (x, y, or z) and the bias voltage (voltage). For the plotting to work appropriately, the resulting data after selection must contain only one coordinate with len > 1. Furthermore, these should be spatial coordinates (x, y, or z).

Returns:

The supplied or created matplotlib axes.

Return type:

matplotlib.axes._subplots.Axes