fdtdx.GDSPortSpec

class fdtdx.GDSPortSpec(gds_layer, gds_datatype=0, propagation_axis=0, name_prefix='port')

Bases: object

Specification for a GDS port marker layer used to auto-generate sources or detectors.

A port marker is a polygon (typically a thin rectangle) on a dedicated GDS layer. Its centroid determines the x/y position of the source or detector plane inside the simulation. The source/detector is made 1 grid cell thick along propagation_axis and spans the full simulation cross-section on the remaining two axes.

Quick Reference

Attributes

• gds_datatype

• name_prefix

• propagation_axis

• gds_layer

Methods

Attributes

GDSPortSpec.gds_datatype: int = 0

GDS datatype of the port markers (default 0).

GDSPortSpec.name_prefix: str = 'port'

Prefix for generated object names. Objects are named "{name_prefix}_{index}".

GDSPortSpec.propagation_axis: int = 0

Simulation axis along which the mode propagates (0=x, 1=y). Must be 0 or 1; the GDS layout encodes x/y positions only.

GDSPortSpec.gds_layer: int

GDS layer containing the port marker polygons.

Methods

If you find any errors in the documentation, please report them in the Github Issues!