OpenTransitionAperture

class awg_designer.all.OpenTransitionAperture

Aperture consisting of a transition between two waveguide templates

The transition is made by default using i3.AutoTransitionFromPort, starting from the given trace_template and ending into the given aperture_trace_template.

Parameters:
slab_template: PCell and SlabTemplate, required

template for free propagation region

transition: PCell
field_ports:

list of regular ports that have field ports

aperture_trace_template: PCell and _TraceTemplate

template of the aperture cross-section

trace_template: PCell and _TraceTemplate

template of the start waveguide

name: String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters

The unique name of the pcell

Views

class Layout
Parameters:
transition_parameters:

dict of parameters for the aperture transition

fpr_depth: float and number > 0

depth of the virtual free propagation region

width: float and number > 0

width of the aperture

transition_length: float and number > 0

transition length

center: Coord2

center coordinate

front_shape: Shape

Shape of the ‘front’ of the aperture, where the light comes out

view_name: String that contains only alphanumeric characters from the ASCII set or contains _$. ASCII set is extended on PY3.

The name of the view

Other Parameters:
slab_layers: locked

list of layers that should be drawn as exclusion zone

class FieldModelFromFunction
Parameters:
field_width: float and number > 0

Extent of the field to consider (two-sided).

field_function:

Callable f(x, center) that returns an array of field values,given the 1 dimensional coordinates x along the aperture facet, centered around center.

positions: Shape

coordinates, in the local reference frame of the aperture, of the fields

netlist_view: NetlistView
layout_view: _LayoutView
n_o_passes: int and number > 0

number of simulation passes

space: _SlabPropagationEngine.Space

Space with all the elements representing the PCell

engine: _SlabPropagationEngine

Slab simulation engine

slab_modes: SlabModeDict

dict of Slab Modes

view_name: String that contains only alphanumeric characters from the ASCII set or contains _$. ASCII set is extended on PY3.

The name of the view

class FieldModelFromCamfr

Field model calculating the output fields from a CAMFR simulation.

Propagates from the input port to the field port.

Parameters:
material_stack_to_material_map: ( dict ), *None allowed*

Effective materials for each stack used in the virtual fabrication.

process_flow: VFabricationProcessFlow

Virtual fabrication process flow to use.

core_z_window: tuple2 and Tuple of <class ‘float’>

Window which describes the z-range of the core layer.

simulation_window: SizeInfo

SizeInfo which describes the region of the layout to simulate.

positions: Shape

coordinates, in the local reference frame of the aperture, of the fields

netlist_view: NetlistView
layout_view: _LayoutView
n_o_passes: int and number > 0

number of simulation passes

space: _SlabPropagationEngine.Space

Space with all the elements representing the PCell

engine: _SlabPropagationEngine

Slab simulation engine

slab_modes: SlabModeDict

dict of Slab Modes

view_name: String that contains only alphanumeric characters from the ASCII set or contains _$. ASCII set is extended on PY3.

The name of the view

class CircuitModel
Parameters:
slabfield_view: _SlabFieldModelView
simulation_wavelengths: ( list<Real, number and number > 0> ), *None allowed*

Wavelengths for which to simulate the underlying physical model.Defaults to None, in which case a physical simulation will be done for each requested wavelength.If a single wavelength is specified, the model will be wavelength independent.If multiple wavelengths are given, only these wavelengths are valid.

reflection: Number, number, complex

Complex reflection of the aperture

layout_view: ( _LayoutView ), *None allowed*
netlist_view: ( NetlistView ), *None allowed*
view_name: String that contains only alphanumeric characters from the ASCII set or contains _$. ASCII set is extended on PY3.

The name of the view

Other Parameters:
solver: str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters, locked

circuit solver to use