Ctrl+K

gplugins.gmeep.write_sparameters_grating

gplugins.gmeep.write_sparameters_grating#

gplugins.gmeep.write_sparameters_grating(plot: bool = False, plot_contour: bool = False, animate: bool = False, overwrite: bool = False, dirpath: str | Path | None = PosixPath('/home/runner/.gdsfactory/sp'), decay_by: float = 0.001, verbosity: int = 0, **settings) → ndarray[source]#

Write grating coupler with fiber Sparameters.

Parameters:

  • plot – plot simulation (do not run).

  • plot_contour – show contours.

  • animate – create animation.

  • overwrite – overwrites simulation if found.

  • dirpath – directory path.

  • decay_by – field decay to stop simulation.

  • verbosity – print messages.

  • core_materials – number of cores.

Keyword Arguments:

  • period – fiber grating period in um.

  • fill_factor – fraction of the grating period filled with the grating material.

  • n_periods – number of periods.

  • widths – Optional list of widths. Overrides period, fill_factor, n_periods.

  • gaps – Optional list of gaps. Overrides period, fill_factor, n_periods.

  • fiber_angle_deg – fiber angle in degrees.

  • fiber_xposition – xposition.

  • fiber_core_diameter – fiber diameter.

  • fiber_numerical_aperture – NA.

  • fiber_clad_material – fiber cladding index.

  • nwg – waveguide index.

  • nslab – slab refractive index.

  • clad_material – top cladding index.

  • nbox – box index bottom.

  • nsubstrate – index substrate.

  • pml_thickness – pml_thickness (um).

  • substrate_thickness – substrate_thickness (um).

  • box_thickness – thickness for bottom cladding (um).

  • core_thickness – core_thickness (um).

  • slab_thickness – slab thickness (um). etch_depth=core_thickness-slab_thickness.

  • top_clad_thickness – thickness of the top cladding.

  • air_gap_thickness – air gap thickness.

  • fiber_thickness – fiber_thickness.

  • resolution – resolution pixels/um.

  • wavelength_start – min wavelength (um).

  • wavelength_stop – max wavelength (um).

  • wavelength_points – wavelength points.

  • eps_averaging – epsilon averaging.

  • fiber_port_y_offset_from_air – y_offset from fiber to air (um).

  • waveguide_port_x_offset_from_grating_start – in um.

  • fiber_port_x_size – in um.

  • xmargin – margin from PML to grating end in um.

         fiber_xposition
          |
     fiber_core_diameter
  /     /  /     /       |
 /     /  /     /        | fiber_thickness
/     /  /     /    _ _ _| _ _ _ _ _ _  _
                         |
                         | air_gap_thickness
                    _ _ _| _ _ _ _ _ _  _
                         |
        clad_material            | top_clad_thickness
                    _ _ _| _ _ _ _ _ _  _
     _|-|_|-|_|-|___     |              _| etch_depth
      core_material        |     |core_thickness
     ______________|_ _ _|_ _ _ _ _ _ _ _
                         |
      nbox               |box_thickness
     ______________ _ _ _|_ _ _ _ _ _ _ _
                         |
      nsubstrate         |substrate_thickness
     ______________ _ _ _|
Contents