Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.AxisAlignedCurrentIntegral

Type: class │ Base(s): AxisAlignedCurrentIntegralSpec

Description

Section titled “Description”

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

Example(s)

Section titled “Example(s)”
current = AxisAlignedCurrentIntegral(
    center=(0, 0, 0),
    size=(1, 1, 0),
    sign="+",
    extrapolate_to_endpoints=True,
    snap_contour_to_grid=True,
)

Parameters

Section titled “Parameters”
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.

Methods

Section titled “Methods”
compute_current(em_field: IntegrableMonitorDataType)

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

Machine-Readable Export

Section titled “Machine-Readable Export”