tidy3d.rf.Custom2DVoltageIntegralSpec

tidy3d.rf.Custom2DVoltageIntegralSpec#

class Custom2DVoltageIntegralSpec[source]#

Bases: Custom2DPathIntegralSpec

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

Parameters:

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

  • position (float) – Position of the plane along the axis.

  • vertices (ArrayLike[dtype=float, ndim=2]) – [units = um]. 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). If you wish to indicate a closed contour, the final vertex should be made equal to the first vertex, i.e., vertices[-1] == vertices[0]

Notes

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

Attributes

axis

position

vertices

Methods

plot([x, y, z, ax, plot_markers])

Plot path integral at single (x,y,z) coordinate.
plot(x=None, y=None, z=None, ax=None, plot_markers=True, **path_kwargs)[source]#

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

Parameters:

  • x (float = None) – Position of plane in x direction, only one of x,y,z can be specified to define plane.

  • y (float = None) – Position of plane in y direction, only one of x,y,z can be specified to define plane.

  • z (float = None) – Position of plane in z direction, only one of x,y,z can be specified to define plane.

  • ax (matplotlib.axes._subplots.Axes = None) – Matplotlib axes to plot on, if not specified, one is created.

  • plot_markers (bool = True) – Whether to plot endpoint markers (+ and -). Default is True.

  • **path_kwargs – Optional keyword arguments passed to the matplotlib plotting of the line. For details on accepted values, refer to Matplotlib’s documentation.

Returns:

The supplied or created matplotlib axes.

Return type:

matplotlib.axes._subplots.Axes