tidy3d.plugins.microwave.AxisAlignedCurrentIntegral

class AxisAlignedCurrentIntegral

Bases: AxisAlignedCurrentIntegralSpec

Class for computing conduction current via Ampère’s circuital law on an axis-aligned loop.

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.

• sign (Literal['+', '-']) – Positive indicates current flowing in the positive normal axis direction.

• extrapolate_to_endpoints (bool = False) – This parameter is passed to AxisAlignedPathIntegral objects when computing the contour integral.

• snap_contour_to_grid (bool = False) – This parameter is passed to AxisAlignedPathIntegral objects when computing the contour integral.

Example

>>> current = AxisAlignedCurrentIntegral(
...     center=(0, 0, 0),
...     size=(1, 1, 0),
...     sign="+",
...     extrapolate_to_endpoints=True,
...     snap_contour_to_grid=True,
... )

Attributes

attrs

Methods

compute_current(em_field)

Compute current flowing in loop defined by the outer edge of a rectangle.

Inherited Common Usage

compute_current(em_field)

Compute current flowing in loop defined by the outer edge of a rectangle.

__hash__()

Hash method.