Skip to content

Euler

euler

Virtual euler cell factories.

BendEulerVKCell

Bases: Protocol

Factory for virtual euler bends.

Source code in kfactory/factories/virtual/euler.py
28
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
class BendEulerVKCell(Protocol):
    """Factory for virtual euler bends."""

    __name__: str

    def __call__(
        self,
        *,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
        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 euler bend.

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

        Args:
            radius: Radius off the backbone. [um]
            angle: Angle of the bend.
            resolution: Angle resolution for the backbone.
            cross_section: Cross section of the bend.
            width: Width of the core. [um] (legacy; requires ``layer``)
            layer: Main layer of the bend. (legacy)
            enclosure: Slab/exclude definition. (legacy)
        """
        ...

__call__

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

Create a virtual euler bend.

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

Parameters:

Name Type Description Default
radius um

Radius off the backbone. [um]

required
angle deg

Angle of the bend.

90
resolution float

Angle resolution for the backbone.

150
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

Slab/exclude definition. (legacy)

None
Source code in kfactory/factories/virtual/euler.py
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
def __call__(
    self,
    *,
    radius: um,
    angle: deg = 90,
    resolution: float = 150,
    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 euler bend.

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

    Args:
        radius: Radius off the backbone. [um]
        angle: Angle of the bend.
        resolution: Angle resolution for the backbone.
        cross_section: Cross section of the bend.
        width: Width of the core. [um] (legacy; requires ``layer``)
        layer: Main layer of the bend. (legacy)
        enclosure: Slab/exclude definition. (legacy)
    """
    ...

virtual_bend_euler_factory

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

Returns a function generating virtual euler 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 'bend_euler[...]'.

None
cell_kwargs Any

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

{}
Source code in kfactory/factories/virtual/euler.py
 64
 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
def virtual_bend_euler_factory(
    kcl: KCLayout,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    basename: str | None = None,
    **cell_kwargs: Any,
) -> BendEulerVKCell:
    """Returns a function generating virtual euler 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 'bend_euler[...]'.
        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
    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 "bend_euler", output_type=VKCell, **cell_kwargs)
    def bend_euler(
        cross_section: str | AnyCrossSectionInput,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
    ) -> VKCell:
        """Virtual euler 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 = euler_bend_points(angle, radius=radius, resolution=resolution)

        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,
                resolution=resolution,
            )
        )
        _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_euler")
    def virtual_bend_euler(
        *,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
        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 bend_euler(
            cross_section=xs, radius=radius, angle=angle, resolution=resolution
        )

    return virtual_bend_euler