Skip to content
PhotonForge

parametric.route_u

route_u(
    *,
    port1: photonforge.Port
    | tuple[photonforge.Reference, str]
    | tuple[photonforge.Reference, str, int]
    | collections.abc.Sequence[
        photonforge.Port
        | tuple[photonforge.Reference, str]
        | tuple[photonforge.Reference, str, int]
    ]
    | None = None,
    port2: photonforge.Port
    | tuple[photonforge.Reference, str]
    | tuple[photonforge.Reference, str, int]
    | collections.abc.Sequence[
        photonforge.Port
        | tuple[photonforge.Reference, str]
        | tuple[photonforge.Reference, str, int]
    ]
    | None = None,
    radius: Annotated[float, exclusiveMinimum=0, units='μm'] | None = None,
    u_offset: Annotated[float, units='μm'] | None = None,
    relative: bool | None = None,
    pitch: Annotated[float, minimum=0, units='μm'] | None = None,
    bend: photonforge.Component
    | collections.abc.Sequence[photonforge.Component]
    | None = None,
    straight_kwargs: Annotated[dict[str, Any], _] | None = None,
    technology: photonforge.Technology | None = None,
    name: str | None = None,
    route_model: photonforge.Model | None = None,
    bundle_model: photonforge.Model | None = None,
) -> photonforge.Component

Route the connection between parallel ports.

Args

  • port1: First port to be connected. The port can be specified as a Port or as a tuple including a Reference, the port name, and the repetition index (optional, only for array references). A sequence of ports can be used for bundle routing.
  • port2: Second port to be connected. A sequence of ports can be used for bundle routing (with same length as port1).
  • radius: Radius used for bends, if needed.
  • u_offset: Position of the base of the U shape.
  • relative: If True, interpret u_offset relative to the frontmost port.
  • pitch: Center-to-center distance between adjacent waveguides in a bundle. If None, the largest snapped port width is used.
  • bend: 90° bend to be used for routing. If the bundle has different port specifications, a sequence of bends (one for each specification) must be provided. If None, the default parametric bend will be used.
  • straight_kwargs: Keyword arguments for straight.
  • technology: Component technology. If None, the default technology is used.
  • name: Component name.
  • route_model: Model to be used with each route sub-component. If None a CircuitModel is used.
  • bundle_model: Model to be used with the top-level route component. If None a CircuitModel is used.

Returns

Component with the route, including ports and model.

Example

>>> ports1 = [
...     pf.Port((0, 10), 0, "Rib"),
...     pf.Port((-10, 0), 0, "Strip"),
...     pf.Port((-15, -5), 0, "Strip"),
... ]
>>> ports2 = [
...     pf.Port((0, 65), 0, "Rib"),
...     pf.Port((0, 70), 0, "Strip"),
...     pf.Port((0, 75), 0, "Strip"),
... ]
>>> component = pf.parametric.route_u(
...     port1=ports1, port2=ports2, radius=10, u_offset=30, relative=True, pitch=5
... )

route_u