Skip to content

feat: allow custom GridSpec in tidy3d write_sparameters #729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vvahidd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: allow custom GridSpec in tidy3d write_sparameters #729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions gplugins/tidy3d/component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ def get_component_modeler(
bandwidth: float = 0.2,
num_freqs: int = 6,
min_steps_per_wvl: int = 30,
grid_spec: td.GridSpec | None = None,
center_z: float | str | None = None,
sim_size_z: float = 4.0,
port_size_mult: float | tuple[float, float] = (4.0, 3.0),
Expand All @@ -242,7 +243,8 @@ def get_component_modeler(
wavelength: The wavelength for the ModalComponentModeler. Defaults to 1.55.
bandwidth: The bandwidth for the ModalComponentModeler. Defaults to 0.2.
num_freqs: The number of frequencies for the ModalComponentModeler. Defaults to 21.
Comment thread
vvahidd marked this conversation as resolved.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30. Ignored when grid_spec is provided.
grid_spec: Optional tidy3d GridSpec for full control over the mesh (e.g. td.GridSpec.uniform(dl=20*nm) or per-axis AutoGrid). If None, defaults to td.GridSpec.auto(wavelength=wavelength, min_steps_per_wvl=min_steps_per_wvl).
center_z: The z-coordinate for the center of the ModalComponentModeler. If None, the z-coordinate of the component is used. Defaults to None.
sim_size_z: simulation size um in the z-direction for the ModalComponentModeler. Defaults to 4.
port_size_mult: The size multiplier for the ports in the ModalComponentModeler. Defaults to (4.0, 3.0).
Expand Down Expand Up @@ -276,7 +278,7 @@ def get_component_modeler(
wavelength - bandwidth / 2, wavelength + bandwidth / 2, num_freqs
)

grid_spec = td.GridSpec.auto(
grid_spec = grid_spec or td.GridSpec.auto(
wavelength=wavelength, min_steps_per_wvl=min_steps_per_wvl
)
Comment thread
vvahidd marked this conversation as resolved.

Expand Down Expand Up @@ -414,6 +416,7 @@ def write_sparameters(
bandwidth: float = 0.2,
num_freqs: int = 21,
min_steps_per_wvl: int = 30,
grid_spec: td.GridSpec | None = None,
center_z: float | str | None = None,
sim_size_z: float = 4.0,
port_size_mult: float | tuple[float, float] = (4.0, 3.0),
Expand Down Expand Up @@ -455,7 +458,10 @@ def write_sparameters(
wavelength: The wavelength for the ModalComponentModeler. Defaults to 1.55.
bandwidth: The bandwidth for the ModalComponentModeler. Defaults to 0.2.
num_freqs: The number of frequencies for the ModalComponentModeler. Defaults to 21.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30. Ignored when grid_spec is provided.
grid_spec: Optional tidy3d GridSpec for full control over the mesh
(e.g. td.GridSpec.uniform(dl=20*nm) or per-axis AutoGrid). If None,
defaults to td.GridSpec.auto(wavelength=wavelength, min_steps_per_wvl=min_steps_per_wvl).
center_z: The z-coordinate for the center of the ModalComponentModeler.
If None, the z-coordinate of the component is used. Defaults to None.
sim_size_z: simulation size um in the z-direction for the ModalComponentModeler. Defaults to 4.
Expand Down Expand Up @@ -504,6 +510,7 @@ def write_sparameters(
bandwidth=bandwidth,
num_freqs=num_freqs,
min_steps_per_wvl=min_steps_per_wvl,
grid_spec=grid_spec,
Comment thread
vvahidd marked this conversation as resolved.
center_z=center_z,
sim_size_z=sim_size_z,
port_size_mult=port_size_mult,
Expand Down Expand Up @@ -633,7 +640,10 @@ def write_sparameters_batch(
wavelength: The wavelength for the ModalComponentModeler. Defaults to 1.55.
bandwidth: The bandwidth for the ModalComponentModeler. Defaults to 0.2.
num_freqs: The number of frequencies for the ModalComponentModeler. Defaults to 21.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30.
min_steps_per_wvl: The minimum number of steps per wavelength for the ModalComponentModeler. Defaults to 30. Ignored when grid_spec is provided.
grid_spec: Optional tidy3d GridSpec for full control over the mesh
(e.g. td.GridSpec.uniform(dl=20*nm) or per-axis AutoGrid). If None,
defaults to td.GridSpec.auto(wavelength=wavelength, min_steps_per_wvl=min_steps_per_wvl).
center_z: The z-coordinate for the center of the ModalComponentModeler.
If None, the z-coordinate of the component is used. Defaults to None.
sim_size_z: simulation size um in the z-direction for the ModalComponentModeler. Defaults to 4.
Expand Down
Loading