from __future__ import annotations
from functools import partial
import numpy as np
import gdsfactory as gf
from gdsfactory.components.via import via
from gdsfactory.components.via_stack import via_stack
from gdsfactory.cross_section import Section, xs_rc
from gdsfactory.typings import ComponentSpec, CrossSectionFactory, LayerSpec
cross_section_rib = partial(
gf.cross_section.strip,
sections=(Section(width=2 * 2.425, layer="SLAB90", name="slab"),),
)
cross_section_pn = partial(
gf.cross_section.pn,
width_doping=2.425,
width_slab=2 * 2.425,
layer_via="VIAC",
width_via=0.5,
layer_metal="M1",
width_metal=0.5,
)
heater_vias = partial(
via_stack,
size=(0.5, 0.5),
layers=("M1", "M2"),
vias=(
partial(
via,
layer="VIAC",
size=(0.1, 0.1),
spacing=(0.2, 0.2),
enclosure=0.1,
),
partial(
via,
layer="VIA1",
size=(0.1, 0.1),
spacing=(0.2, 0.2),
enclosure=0.1,
),
),
)
[docs]
@gf.cell
def ring_double_pn(
add_gap: float = 0.3,
drop_gap: float = 0.3,
radius: float = 5.0,
doping_angle: float = 85,
cross_section: CrossSectionFactory = xs_rc,
pn_cross_section: CrossSectionFactory = cross_section_pn,
doped_heater: bool = True,
doped_heater_angle_buffer: float = 10,
doped_heater_layer: LayerSpec = "NPP",
doped_heater_width: float = 0.5,
doped_heater_waveguide_offset: float = 2.175,
heater_vias: ComponentSpec = heater_vias,
) -> gf.Component:
"""Returns add-drop pn ring with optional doped heater.
Args:
add_gap: gap to add waveguide.
drop_gap: gap to drop waveguide.
radius: for the bend and coupler.
doping_angle: angle in degrees representing portion of ring that is doped.
length_x: ring coupler length.
length_y: vertical straight length.
cross_section: cross_section spec for non-PN doped rib waveguide sections.
pn_cross_section: cross section of pn junction.
doped_heater: boolean for if we include doped heater or not.
doped_heater_angle_buffer: angle in degrees buffering heater from pn junction.
doped_heater_layer: doping layer for heater.
doped_heater_width: width of doped heater.
doped_heater_waveguide_offset: distance from the center of the ring waveguide to the center of the doped heater.
heater_vias: components specifications for heater vias
"""
add_gap = gf.snap.snap_to_grid(add_gap, grid_factor=2)
drop_gap = gf.snap.snap_to_grid(drop_gap, grid_factor=2)
c = gf.Component()
pn_cross_section = gf.get_cross_section(pn_cross_section)
pn_cross_section = pn_cross_section
cross_section = gf.get_cross_section(cross_section)
undoping_angle = 180 - doping_angle
add_waveguide_path = gf.Path()
add_waveguide_path.append(
gf.path.straight(length=2 * radius * np.sin(np.pi / 360 * undoping_angle))
)
th_waveguide = c << add_waveguide_path.extrude(cross_section=cross_section)
th_waveguide.x = 0
th_waveguide.y = (
-radius
- add_gap
- th_waveguide.ports["o1"].width / 2
- pn_cross_section.width / 2
)
drop_waveguide_path = gf.Path()
drop_waveguide_path.append(
gf.path.straight(length=2 * radius * np.sin(np.pi / 360 * undoping_angle))
)
drop_waveguide = c << drop_waveguide_path.extrude(cross_section=cross_section)
drop_waveguide.x = 0
doped_path = gf.Path()
doped_path.append(gf.path.arc(radius=radius, angle=-doping_angle))
undoped_path = gf.Path()
undoped_path.append(gf.path.arc(radius=radius, angle=undoping_angle))
r = gf.Component()
left_doped_ring_ref = r << doped_path.extrude(cross_section=pn_cross_section)
right_doped_ring_ref = r << doped_path.extrude(cross_section=pn_cross_section)
bottom_undoped_ring_ref = r << undoped_path.extrude(cross_section=cross_section)
top_undoped_ring_ref = r << undoped_path.extrude(cross_section=cross_section)
bottom_undoped_ring_ref.rotate(-undoping_angle / 2)
bottom_undoped_ring_ref.x = th_waveguide.x
left_doped_ring_ref.connect("o1", bottom_undoped_ring_ref.ports["o1"])
right_doped_ring_ref.connect("o2", bottom_undoped_ring_ref.ports["o2"])
top_undoped_ring_ref.connect("o2", left_doped_ring_ref.ports["o2"])
ring = c << r
ring.y = 0
drop_waveguide.y = (
radius
+ drop_gap
+ th_waveguide.ports["o1"].width / 2
+ pn_cross_section.width / 2
)
if doped_heater:
heater_radius = radius - doped_heater_waveguide_offset
heater_path = gf.Path()
heater_path.append(
gf.path.arc(
radius=heater_radius, angle=undoping_angle - doped_heater_angle_buffer
)
)
top_heater_ref = c << heater_path.extrude(width=0.5, layer=doped_heater_layer)
top_heater_ref.rotate(180 - (undoping_angle - doped_heater_angle_buffer) / 2)
top_heater_ref.x = th_waveguide.x
top_heater_ref.ymax = drop_waveguide.y - (
doped_heater_waveguide_offset + doped_heater_width / 2 + drop_gap
)
top_left_heater_via = c << heater_vias()
top_left_heater_via.rotate(top_heater_ref.ports["o2"].orientation)
deltax = -abs(top_heater_ref.ports["o2"].x - top_left_heater_via.ports["e3"].x)
deltay = abs(top_heater_ref.ports["o2"].y - top_left_heater_via.ports["e3"].y)
top_left_heater_via.move((deltax, deltay))
top_right_heater_via = c << heater_vias()
top_right_heater_via.rotate(top_heater_ref.ports["o1"].orientation)
deltax = abs(top_heater_ref.ports["o1"].x - top_right_heater_via.ports["e3"].x)
deltay = abs(top_heater_ref.ports["o1"].y - top_right_heater_via.ports["e3"].y)
top_right_heater_via.move((deltax, deltay))
bottom_heater_ref = c << heater_path.extrude(
width=0.5, layer=doped_heater_layer
)
bottom_heater_ref.rotate(-(undoping_angle - doped_heater_angle_buffer) / 2)
bottom_heater_ref.x = th_waveguide.x
bottom_heater_ref.ymin = th_waveguide.y + (
doped_heater_waveguide_offset + doped_heater_width / 2 + add_gap
)
bottom_l_heater_via = c << heater_vias()
bottom_r_heater_via = c << heater_vias()
bottom_l_heater_via.connect(
"e3",
bottom_heater_ref.ports["o1"],
allow_layer_mismatch=True,
allow_type_mismatch=True,
)
bottom_r_heater_via.connect(
"e3",
bottom_heater_ref.ports["o2"],
allow_layer_mismatch=True,
allow_type_mismatch=True,
)
c.add_port("o1", port=th_waveguide.ports["o1"])
c.add_port("o2", port=th_waveguide.ports["o2"])
c.add_port("o3", port=drop_waveguide.ports["o2"])
c.add_port("o4", port=drop_waveguide.ports["o1"])
return c.flatten()
if __name__ == "__main__":
c = ring_double_pn(radius=20)
c.show()
