tidy3d.SteadyFreeCarrierMonitor

class SteadyFreeCarrierMonitor

Bases: HeatChargeMonitor

Free-carrier monitor for 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().

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

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

• name (ConstrainedStrValue) – 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.

Example

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

Attributes

attrs

Methods

Inherited Common Usage

unstructured

__hash__()

Hash method.