flex_rf.tidy3d.AxisAlignedCurrentIntegralSpec

Type: class │ Base(s): AbstractAxesRH, Box

Description

Class for specifying the computation of conduction current via Ampère’s circuital law on an axis-aligned loop.

current_spec = AxisAlignedCurrentIntegralSpec(
    center=(0, 0, 0),
    size=(1, 1, 0),
    sign="+",
    snap_contour_to_grid=True
)

size [TracedSize]

Size in x, y, and z directions.

sign [Direction]

Positive indicates current flowing in the positive normal axis direction.

center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

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.

main_axis()

Axis normal to loop

plot(x: float | None = None, y: float | None = None, z: float | None = None, ax: Ax = None, plot_arrow: bool = True, **path_kwargs: Any)

Plot path integral at single (x,y,z) coordinate.