tidy3d.SteadyPotentialMonitor

class SteadyPotentialMonitor

Bases: HeatChargeMonitor

Electric potential (\(\psi\)) monitor.

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 (bool = True) – Return data on the original unstructured grid.

Example

>>> import tidy3d as td
>>> voltage_monitor_z0 = td.SteadyPotentialMonitor(
... center=(0, 0.14, 0), size=(0.6, 0.3, 0), name="voltage_z0", unstructured=True,
... )

Attributes

unstructured
name
size
center