flex_rf.tidy3d.Custom2DVoltageIntegral

Type: class │ Base(s): Custom2DPathIntegral, Custom2DVoltageIntegralSpec

Description

Class for computing the 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.

Notes

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

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

Example(s)

import numpy as np
vertices = np.array([[0, 0], [0.5, 0.2], [1.0, 0.5]])
voltage = Custom2DVoltageIntegral(
    axis=2,
    position=0.0,
    vertices=vertices,
)

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

compute_voltage(em_field: IntegrableMonitorDataType)

Compute voltage along path defined by a line.