tidy3d.SteadyEnergyBandData

tidy3d.SteadyEnergyBandData#

class SteadyEnergyBandData[source]#

Bases: HeatChargeMonitorData

Stores energy bands in charge simulations.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • 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)) – [units = um]. Symmetry center of the original simulation in x, y, and z.

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

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

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

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

  • Efp (Union[TriangularGridDataset, TetrahedralGridDataset] = None) – 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.

attrs

Methods

check_correct_data_type(values)

Issue error if incorrect data type is used

plot([ax])

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

Inherited Common Usage

monitor#
Ec#
Ev#
Ei#
Efn#
Efp#
property field_components#

Maps the field components to their associated data.

classmethod check_correct_data_type(values)[source]#

Issue error if incorrect data type is used

plot(ax=None, **sel_kwargs)[source]#

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

__hash__()#

Hash method.