tidy3d.SteadyEnergyBandMonitor

tidy3d.SteadyEnergyBandMonitor#

class SteadyEnergyBandMonitor[source]#

Bases: HeatChargeMonitor

Energy bands monitor for Charge simulations.

Parameters:

  • center (tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]] = (0.0, 0.0, 0.0)) – [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.

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

name

size

center

unstructured#