Skip to content

Circular

circular

Virtual circular cell factories.

BendCircularVKCell

Bases: Protocol

Factory for virtual circular bend.

Source code in kfactory/factories/virtual/circular.py
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class BendCircularVKCell(Protocol):
    """Factory for virtual circular bend."""

    __name__: str

    def __call__(
        self,
        *,
        radius: um,
        angle: deg = 90,
        angle_step: float = 1,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> VKCell:
        """Create a virtual circular bend.

        Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

        Args:
            radius: Radius of the backbone. [um]
            angle: Angle amount of the bend.
            angle_step: Angle amount per backbone point of the bend.
            cross_section: Cross section of the bend.
            width: Width of the core. [um] (legacy; requires ``layer``)
            layer: Main layer of the bend. (legacy)
            enclosure: Optional enclosure. (legacy)
        """
        ...

__call__

__call__(
    *,
    radius: um,
    angle: deg = 90,
    angle_step: float = 1,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> VKCell

Create a virtual circular bend.

Either pass a cross_section or the legacy width/layer/enclosure.

Parameters:

Name Type Description Default
radius um

Radius of the backbone. [um]

required
angle deg

Angle amount of the bend.

90
angle_step float

Angle amount per backbone point of the bend.

1
cross_section str | AnyCrossSectionInput | CrossSectionSpecDict | DCrossSectionSpecDict | None

Cross section of the bend.

None
width um | None

Width of the core. [um] (legacy; requires layer)

None
layer LayerInfo | None

Main layer of the bend. (legacy)

None
enclosure LayerEnclosure | None

Optional enclosure. (legacy)

None
Source code in kfactory/factories/virtual/circular.py
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def __call__(
    self,
    *,
    radius: um,
    angle: deg = 90,
    angle_step: float = 1,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> VKCell:
    """Create a virtual circular bend.

    Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

    Args:
        radius: Radius of the backbone. [um]
        angle: Angle amount of the bend.
        angle_step: Angle amount per backbone point of the bend.
        cross_section: Cross section of the bend.
        width: Width of the core. [um] (legacy; requires ``layer``)
        layer: Main layer of the bend. (legacy)
        enclosure: Optional enclosure. (legacy)
    """
    ...

virtual_bend_circular_factory

virtual_bend_circular_factory(
    kcl: KCLayout,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    basename: str | None = None,
    **cell_kwargs: Any,
) -> BendCircularVKCell

Returns a function generating virtual circular bends.

The returned function is the generic interface (cross_section or the legacy width/layer/enclosure).

Parameters:

Name Type Description Default
kcl KCLayout

The KCLayout which will be owned

required
additional_info Callable[..., dict[str, MetaData]] | dict[str, MetaData] | None

Add additional key/values to the VKCell.info. Can be a static dict mapping info name to info value. Or can a callable which takes the bend functions' parameters as kwargs and returns a dict with the mapping.

None
basename str | None

Overwrite the prefix of the resulting VKCell's name. By default the VKCell will be named 'virtual_bend_circular[...]'.

None
cell_kwargs Any

Additional arguments passed as @kcl.vcell(**cell_kwargs).

{}
Source code in kfactory/factories/virtual/circular.py
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def virtual_bend_circular_factory(
    kcl: KCLayout,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    basename: str | None = None,
    **cell_kwargs: Any,
) -> BendCircularVKCell:
    """Returns a function generating virtual circular bends.

    The returned function is the generic interface (``cross_section`` or the legacy
    ``width``/``layer``/``enclosure``).

    Args:
        kcl: The KCLayout which will be owned
        additional_info: Add additional key/values to the
            [`VKCell.info`][kfactory.settings.Info]. Can be a static dict
            mapping info name to info value. Or can a callable which takes the bend
            functions' parameters as kwargs and returns a dict with the mapping.
        basename: Overwrite the prefix of the resulting VKCell's name. By default
            the VKCell will be named 'virtual_bend_circular[...]'.
        cell_kwargs: Additional arguments passed as `@kcl.vcell(**cell_kwargs)`.
    """
    _additional_info: dict[str, MetaData]
    if _is_additional_info_func(additional_info):
        _additional_info_func: Callable[
            ...,
            dict[str, MetaData],
        ] = additional_info
        _additional_info = {}
    else:

        def additional_info_func(
            **kwargs: Any,
        ) -> dict[str, MetaData]:
            return {}

        _additional_info_func = additional_info_func
        _additional_info = additional_info or {}  # ty:ignore[invalid-assignment]

    @kcl.vcell(
        basename=basename or "virtual_bend_circular", output_type=VKCell, **cell_kwargs
    )
    def virtual_bend_circular(
        cross_section: str | AnyCrossSectionInput,
        radius: um,
        angle: deg = 90,
        angle_step: float = 1,
    ) -> VKCell:
        """Virtual circular bend defined by a cross section (um)."""
        c = kcl.vkcell()
        if angle < 0:
            logger.critical(
                f"Negative lengths are not allowed {angle} as ports"
                " will be inverted. Please use a positive number. Forcing positive"
                " lengths."
            )
            angle = -angle

        xs = kcl.get_base_cross_section(cross_section)
        backbone = [
            kdb.DPoint(x, y)
            for x, y in [
                [
                    np.sin(_angle / 180 * np.pi) * radius,
                    (-np.cos(_angle / 180 * np.pi) + 1) * radius,
                ]
                for _angle in np.linspace(
                    0, angle, int(angle // angle_step + 0.5), endpoint=True
                )
            ]
        ]

        extrude_backbone_cross_section(
            c,
            backbone=backbone,
            cross_section=xs,
            start_angle=0,
            end_angle=angle,
        )
        _info: dict[str, MetaData] = {}
        _info.update(
            _additional_info_func(
                cross_section=xs,
                radius=radius,
                angle=angle,
                angle_step=angle_step,
            )
        )
        _info.update(_additional_info)
        c.info = Info(**_info)

        c.create_port(
            name="o1",
            cross_section=xs,
            dcplx_trans=kdb.DCplxTrans(1, 180, False, backbone[0].to_v()),
        )
        c.create_port(
            name="o2",
            dcplx_trans=kdb.DCplxTrans(1, angle, False, backbone[-1].to_v()),
            cross_section=xs,
        )
        return c

    @kcl.generic_factory(name=basename or "virtual_bend_circular")
    def virtual_bend_circular_generic(
        *,
        radius: um,
        angle: deg = 90,
        angle_step: float = 1,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> VKCell:
        if cross_section is None:
            if width is None or layer is None:
                raise ValueError(
                    "Provide a cross_section, or width and layer (legacy call)."
                )
            if width < 0:
                logger.critical(
                    f"Negative widths are not allowed {width}. Forcing positive width."
                )
                width = -width
            xs = cross_section_from_width(kcl, kcl.to_dbu(width), layer, enclosure)
        else:
            xs = kcl.get_icross_section(cross_section)
        return virtual_bend_circular(
            cross_section=xs, radius=radius, angle=angle, angle_step=angle_step
        )

    return virtual_bend_circular_generic