tidy3d.rf.AxisAlignedCurrentIntegral

tidy3d.rf.AxisAlignedCurrentIntegral#

class AxisAlignedCurrentIntegral[source]#

Bases: AxisAlignedCurrentIntegralSpec

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

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.

  • 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

sign

extrapolate_to_endpoints

snap_contour_to_grid

size

center

Methods

compute_current(em_field)

Compute current flowing in loop defined by the outer edge of a rectangle.
compute_current(em_field)[source]#

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

sign#
extrapolate_to_endpoints#
snap_contour_to_grid#
size#
center#