Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.AxisAlignedVoltageIntegralSpec

Type: class │ Base(s): AxisAlignedPathIntegralSpec

Description

Section titled “Description”

Class for specifying the voltage calculation between two points defined by an axis-aligned line.

Parameters

Section titled “Parameters”
size [TracedSize]

Size in x, y, and z directions.
sign [Direction]

Positive indicates V=Vb-Va where position b has a larger coordinate along the axis of integration.
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”
from_terminal_positions(plus_terminal: float, minus_terminal: float, x: float | None = None, y: float | None = None, z: float | None = None, extrapolate_to_endpoints: bool = True, snap_path_to_grid: bool = True)

Helper to create a AxisAlignedVoltageIntegralSpec from two coordinates that define a line and two positions indicating the endpoints of the path integral.
plot(x: float | None = None, y: float | None = None, z: float | None = None, ax: Ax = None, plot_markers: bool = True, **path_kwargs: Any)

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

Machine-Readable Export

Section titled “Machine-Readable Export”