bend¶
- photonforge.parametric.bend(*, port_spec=None, radius=None, angle=None, euler_fraction=None, port_bends=None, active_model=None, technology=None, name=None, tidy3d_model_kwargs=None, waveguide_model_kwargs=None)[source]¶
Waveguide bend section.
- 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.
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) – Central arc radius.
angle (Annotated[float, _Metadata(type=None, title=None, description=None, units=°, required=False, minimum=-360, maximum=360, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Arc coverage angle. If
None
, defaults to 90.euler_fraction (Annotated[float, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=0, maximum=1, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Fraction of the bend that is created using an Euler spiral (see
photonforge.Path.arc()
). IfNone
, defaults to 0.port_bends (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) – Flag controllig whether to set a bend radius for the ports. Not used when
euler_factor > 0
. IfNone
, defaults toFalse
.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 circular bend section, ports and model.
- Return type:
component = bend(port_spec="Strip", radius=5, euler_fraction=0.5)