circular_spiral

photonforge.parametric.circular_spiral(*, port_spec=None, turns=None, radius=None, separation=None, full_length=None, align_ports=None, active_model=None, technology=None, name=None, tidy3d_model_kwargs=None, waveguide_model_kwargs=None)[source]

Circular spiral.

Parameters:

  • port_spec (Annotated[str | PortSpec, _Metadata(type=PortSpec, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Port specification describing waveguide cross-section.

  • turns (Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=0, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Number of turns in each of the 2 spiral arms. Does not need to be an integer.

  • radius (Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=None, maximum=None, exclusive_minimum=0, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Bend radius for the internal spiral turns.

  • separation (Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=0, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Distance between waveguide centers in parallel sections. If None, defaults to the port width.

  • full_length (Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=None, maximum=None, exclusive_minimum=0, exclusive_maximum=None, min_items=None, max_items=None)]) – Desired spiral length. If set to a positive value, ‘turns’ is calculated automatically.

  • align_ports (Annotated[bool, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Optionally align ports on the same side of the spiral. If None, defaults to False.

  • active_model (Annotated[Literal['Tidy3D', 'Waveguide'], ~photonforge.parametric._Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Name of the model to be used by default; must be either "Tidy3D" or "Waveguide" (default).

  • technology (Annotated[Technology, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Component technology. If None, the default technology is used.

  • name (Annotated[str, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Component name.

  • tidy3d_model_kwargs (Annotated[dict[str, Any], _Metadata(type=required, title=False, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Dictionary of keyword arguments passed to the component’s photonforge.Tidy3DModel.

  • waveguide_model_kwargs (Annotated[dict[str, Any], _Metadata(type=required, title=False, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Dictionary of keyword arguments passed to the component’s photonforge.WaveguideModel.

Returns:

Component with the spiral section, ports and model.

Return type:

Component

Note

The full length of the spiral can be computed with the photonforge.route_length() function.

component1 = circular_spiral(port_spec="Strip", radius=5, turns=1.25)

# Aligned ports
component2 = circular_spiral(port_spec="Strip", radius=5, turns=3, align_ports=True)
circular_spiral