tidy3d.rf.AxisAlignedVoltageIntegral

class AxisAlignedVoltageIntegral

Bases: AxisAlignedPathIntegral, AxisAlignedVoltageIntegralSpec

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

Parameters:

• center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

• size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

• 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.

• sign (Literal['+', '-']) – Positive indicates V=Vb-Va where position b has a larger coordinate along the axis of integration.

Example

>>> voltage = AxisAlignedVoltageIntegral(
...     center=(0, 0, 0),
...     size=(0, 0, 2),
...     sign="+",
...     extrapolate_to_endpoints=True,
...     snap_path_to_grid=True,
... )

Attributes

sign
extrapolate_to_endpoints
snap_path_to_grid
size
center

Methods

compute_voltage(em_field)

Compute voltage along path defined by a line.

compute_voltage(em_field)

Compute voltage along path defined by a line.

sign

extrapolate_to_endpoints

snap_path_to_grid

size

center