from __future__ import annotations
import pathlib
import time
from collections.abc import Awaitable
import gdsfactory as gf
import matplotlib as mpl
import matplotlib.pyplot as plt
import numpy as np
import tidy3d as td
import yaml
from gdsfactory import logger
from gdsfactory.component import Component
from gdsfactory.serialization import clean_value_json
from gdsfactory.typings import (
Any,
ComponentSpec,
PathType,
Sparameters,
)
from gplugins.common.utils.get_sparameters_path import (
get_sparameters_path_tidy3d as get_sparameters_path,
)
from gplugins.tidy3d.get_results import _executor, get_results
from gplugins.tidy3d.get_simulation_grating_coupler import (
get_simulation_grating_coupler,
)
def plot_simulation(
sim: td.Simulation,
z: float = 0.0,
y: float = 0.0,
wavelength: float | None = 1.55,
figsize: tuple[float, float] = (11, 4),
):
"""Returns Simulation visual representation. Returns two views for 3D component and one view for 2D.
Args:
sim: simulation object.
z: (um).
y: (um).
wavelength: (um) for epsilon plot. None plot structures only.
figsize: figure size.
"""
fig = plt.figure(figsize=figsize)
if sim.size[2] > 0.1 and sim.size[1] > 0.1:
gs = mpl.gridspec.GridSpec(1, 2, figure=fig, width_ratios=[1, 1.4])
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[0, 1])
if wavelength:
freq = td.constants.C_0 / wavelength
sim.plot_eps(z=z, ax=ax1, freq=freq)
sim.plot_eps(y=y, ax=ax2, freq=freq)
else:
sim.plot(z=z, ax=ax1)
sim.plot(y=y, ax=ax2)
elif sim.size[2] > 0.1: # 2D grating sim_size_y = 0
gs = mpl.gridspec.GridSpec(1, 1, figure=fig, width_ratios=[1])
ax1 = fig.add_subplot(gs[0, 0])
if wavelength:
freq = td.constants.C_0 / wavelength
sim.plot_eps(y=y, ax=ax1, freq=freq)
else:
sim.plot(y=y, ax=ax1)
else: # 2D planar component size_z = 0
gs = mpl.gridspec.GridSpec(1, 1, figure=fig, width_ratios=[1])
ax1 = fig.add_subplot(gs[0, 0])
if wavelength:
freq = td.constants.C_0 / wavelength
sim.plot_eps(z=z, ax=ax1, freq=freq)
else:
sim.plot(z=z, ax=ax1)
plt.show()
return fig
[docs]
def write_sparameters_grating_coupler(
component: ComponentSpec,
dirpath: PathType | None = None,
filepath: PathType | None = None,
overwrite: bool = False,
port_waveguide_name: str = "o1",
fiber_port_prefix: str = "o2",
verbose: bool = False,
run: bool = True,
**kwargs,
) -> Sparameters:
"""Get sparameter matrix from a gdsfactory grating coupler.
Assumes grating coupler waveguide port is facing to the left (west).
TODO: add a fiber model (more realistic than a gaussian_beam).
Args:
component: grating coupler gdsfactory Component to simulate.
dirpath: directory to store sparameters in npz.
Defaults to active Pdk.sparameters_path.
filepath: optional sparameters file.
overwrite: overwrites stored Sparameter npz results.
verbose: prints info messages and progressbars.
run: runs simulation, if False, only plots simulation.
Keyword Args:
port_extension: extend ports beyond the PML.
layer_stack: contains layer to thickness, zmin and material.
Defaults to active pdk.layer_stack.
thickness_pml: PML thickness (um).
xmargin: left/right distance from component to PML.
xmargin_left: left distance from component to PML.
xmargin_right: right distance from component to PML.
ymargin: left/right distance from component to PML.
ymargin_top: top distance from component to PML.
ymargin_bot: bottom distance from component to PML.
zmargin: thickness for cladding above and below core.
clad_material: material for cladding.
box_material: for bottom cladding.
substrate_material: for substrate.
box_thickness: bottom cladding thickness in (um).
substrate_thickness: (um).
port_waveguide_name: input port name.
port_margin: margin on each side of the port.
distance_source_to_monitors: in (um) source goes before monitors.
port_waveguide_offset: mode solver workaround.
positive moves source forward, negative moves source backward.
wavelength: source center wavelength (um).
if None takes mean between wavelength_start, wavelength_stop.
wavelength_start: in (um).
wavelength_stop: in (um).
wavelength_points: number of wavelengths.
plot_modes: plot source modes.
num_modes: number of modes to plot.
run_time_ps: make sure it's sufficient for the fields to decay.
defaults to 10ps and counts on the automatic shutoff
to stop earlier if needed.
fiber_port_prefix: port prefix to place fiber source.
fiber_xoffset: fiber center xoffset to fiber_port_name.
fiber_z: fiber zoffset from grating zmax.
fiber_mfd: fiber mode field diameter (um).
fiber_angle_deg: fiber_angle in degrees with respect to normal.
material_name_to_tidy3d: dispersive materials have a wavelength dependent index.
Maps layer_stack names with tidy3d material database names.
is_3d: True by default runs in 3D.
with_all_monitors: stores all monitor fields.
kwargs: simulation settings.
"""
component = gf.get_component(component)
if not isinstance(component, Component):
raise ValueError(f"component should be a gdsfactory.Component not {component}")
filepath = filepath or get_sparameters_path(
component=component,
dirpath=dirpath,
**kwargs,
)
filepath = pathlib.Path(filepath).with_suffix(".npz")
filepath_sim_settings = filepath.with_suffix(".yml")
if filepath.exists() and not overwrite and run:
logger.info(f"Simulation loaded from {filepath!r}")
return dict(np.load(filepath))
sim = get_simulation_grating_coupler(
component,
fiber_port_prefix=fiber_port_prefix,
port_waveguide_name=port_waveguide_name,
**kwargs,
)
if not run:
plot_simulation(sim)
return {}
start = time.time()
sim_data = get_results(sim, verbose=verbose)
sim_data = sim_data.result()
direction_inp = "+"
monitor_entering = (
sim_data.monitor_data["waveguide"]
.amps.sel(direction=direction_inp)
.values.flatten()
)
direction_out = "-"
monitor_exiting = (
sim_data.monitor_data["waveguide"]
.amps.sel(direction=direction_out)
.values.flatten()
)
r = monitor_entering / monitor_exiting
t = monitor_exiting
fiber_port_name = None
port_names = [port.name for port in component.ports]
for port_name in port_names:
if port_name.startswith(fiber_port_prefix):
fiber_port_name = port_name
if fiber_port_name is None:
raise ValueError(f"No port named {fiber_port_prefix!r} in {port_names}")
freqs = sim_data.monitor_data["waveguide"].amps.sel(direction="+").f
port_name_input = port_waveguide_name
fiber_port_name = "o2"
key = f"{port_name_input}@0,{port_name_input}@0"
sp = {"wavelengths": td.constants.C_0 / freqs.values, key: r}
key = f"{fiber_port_name}@0,{fiber_port_name}@0"
sp[key] = r
key = f"{port_name_input}@0,{fiber_port_name}@0"
sp[key] = t
key = f"{fiber_port_name}@0,{port_name_input}@0"
sp[key] = t
end = time.time()
np.savez_compressed(filepath, **sp)
kwargs.update(compute_time_seconds=end - start)
kwargs.update(compute_time_minutes=(end - start) / 60)
filepath_sim_settings.write_text(yaml.dump(clean_value_json(kwargs)))
logger.info(f"Write simulation results to {str(filepath)!r}")
logger.info(f"Write simulation settings to {str(filepath_sim_settings)!r}")
return sp
[docs]
def write_sparameters_grating_coupler_batch(
jobs: list[dict[str, Any]], **kwargs
) -> list[Awaitable[Sparameters]]:
"""Returns Sparameters for a list of write_sparameters.
Each job runs in separate thread and is non blocking.
You need to get the results using sp.result().
Args:
jobs: list of kwargs for write_sparameters_grating_coupler.
kwargs: simulation settings.
"""
kwargs.update(verbose=False)
return [
_executor.submit(write_sparameters_grating_coupler, **job, **kwargs)
for job in jobs
]
if __name__ == "__main__":
c = gf.components.grating_coupler_elliptical_lumerical() # inverse design grating
offsets = [0, 5]
offsets = [0]
fiber_angle_deg = 8
sp = write_sparameters_grating_coupler(c, is_3d=False)
# dfs = [
# write_sparameters_grating_coupler(
# component=c,
# is_3d=False,
# fiber_angle_deg=fiber_angle_deg,
# fiber_xoffset=fiber_xoffset,
# filepath=PATH.sparameters_repo / f"gc_offset{fiber_xoffset}.npz",
# )
# for fiber_xoffset in offsets
# ]
# jobs = [
# dict(
# component=c,
# is_3d=False,
# fiber_angle_deg=fiber_angle_deg,
# fiber_xoffset=fiber_xoffset,
# filepath=PATH.sparameters_repo
# / f"gc_angle{fiber_angle_deg}_offset{fiber_xoffset}",
# )
# for fiber_xoffset in offsets
# ]
# sps = write_sparameters_grating_coupler_batch(jobs)
# import matplotlib.pyplot as plt
# import gplugins as sim
# sp = write_sparameters_grating_coupler(
# c,
# is_3d=False,
# fiber_angle_deg=-5,
# fiber_xoffset=+2,
# )
# sim.plot.plot_sparameters(sp)
# c = gf.components.grating_coupler_elliptical_arbitrary(
# widths=[0.343] * 25,
# gaps=[0.345] * 25,
# )
# sp = write_sparameters_grating_coupler(c, is_3d=False)
# t = sp.o1@0,o2@0
# print(f"Transmission = {t}")
# plt.plot(sp.wavelengths, sp.o1@0,o2@0)
# plt.show()
