tidy3d.SteadyEnergyBandMonitor

tidy3d.SteadyEnergyBandMonitor#

class SteadyEnergyBandMonitor[source]#

Bases: HeatChargeMonitor

Energy bands monitor for Charge simulations.

Parameters:

  • center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

  • name (str) – Unique name for monitor.

  • unstructured (Literal[True] = True) – Return data on the original unstructured grid.

  • conformal (bool = False) – If True the simulation mesh will conform to the monitor’s geometry. While this can be set for both Cartesian and unstructured monitors, it bears higher significance for the latter ones. Effectively, setting conformal = True for unstructured monitors (unstructured = True) ensures that returned values will not be obtained by interpolation during postprocessing but rather directly transferred from the computational grid. Note: if the simulation mesh uses remove_fragments=True, this option is ignored (treated as False). Deprecated: this field will be removed in version 2.12.

Example

>>> import tidy3d as td
>>> energy_monitor_z0 = td.SteadyEnergyBandMonitor(
... center=(0, 0.14, 0), size=(0.6, 0.3, 0), name="bands_z0", unstructured=True,
... )

Attributes

unstructured

conformal

name

size

center

unstructured#