Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.Custom2DVoltageIntegralSpec

Type: class │ Base(s): Custom2DPathIntegralSpec

Description

Section titled “Description”

Class for specifying the computation of voltage between two points defined by a custom path. Computed voltage is V=Vb−VaV=V_b-V_a, where position b is the final vertex in the supplied path.

Notes

Section titled “Notes”

Use AxisAlignedVoltageIntegralSpec if possible, since interpolation near conductors will not be accurate.

.. TODO Improve by including extrapolate_to_endpoints field, non-trivial extension.

Parameters

Section titled “Parameters”
axis [Axis]

Specifies dimension of the planar axis (0,1,2) -> (x,y,z).
position [float]

Position of the plane along the axis.
vertices [ArrayFloat2D]

List of (d1, d2) defining the 2 dimensional positions of the path. The index of dimension should be in the ascending order, which means if the axis corresponds with y, the coordinates of the vertices should be (x, z). The path is open: the first vertex defines position a and the last vertex defines position b for the voltage computation V = V_b - V_a.

Methods

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