Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.AxisAlignedPathIntegral

Type: class │ Base(s): AxisAlignedPathIntegralSpec

Description

Section titled “Description”

Class for defining the simplest type of path integral, which is aligned with Cartesian axes.

Example(s)

Section titled “Example(s)”
path = AxisAlignedPathIntegral(
    center=(0, 0, 1),
    size=(0, 0, 2),
    extrapolate_to_endpoints=True,
    snap_path_to_grid=False,
)

Parameters

Section titled “Parameters”
size [TracedSize]

Size in x, y, and z directions.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.
extrapolate_to_endpoints [bool] = False

If the endpoints of the path integral terminate at or near a material interface, the field is likely discontinuous. When this field is True, fields that are outside and on the bounds of the integral are ignored. Should be enabled when computing voltage between two conductors.
snap_path_to_grid [bool] = False

It might be desirable to integrate exactly along the Yee grid associated with a field. When this field is True, the integration path will be snapped to the grid.

Methods

Section titled “Methods”
compute_integral(scalar_field: EMScalarFieldType)

Computes the defined integral given the input scalar_field.

Machine-Readable Export

Section titled “Machine-Readable Export”