Skip to content

FXC-3547-Adding mode sorting to ModeSpec #2869

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
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

FXC-3547-Adding mode sorting to ModeSpec #2869

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- Added support for `tidy3d-extras`, an optional plugin that enables more accurate local mode solving via subpixel averaging.
- `ModeFilterSpec` in `ModeSpec` allows for fine-grained filtering and sorting of modes. This also deprecates `filter_pol`. The equivalent usage for example to `filter_pol="te"` is `filter_spec=ModeFilterSpec(filter_key="TE_polarization", filter_reference=0.5)`.

### Changed
- Improved performance of antenna metrics calculation by utilizing cached wave amplitude calculations instead of recomputing wave amplitudes for each port excitation in the `TerminalComponentModelerData`.
Expand Down
80 changes: 80 additions & 0 deletions schemas/EMESimulation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4786,6 +4786,13 @@
],
"type": "string"
},
"filter_spec": {
"allOf": [
{
"$ref": "#/definitions/ModeFilterSpec"
}
]
},
"group_index_step": {
"anyOf": [
{
Expand Down Expand Up @@ -7484,6 +7491,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -7519,6 +7527,70 @@
],
"type": "object"
},
"ModeFilterSpec": {
"additionalProperties": false,
"properties": {
"attrs": {
"default": {},
"type": "object"
},
"filter_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"filter_order": {
"default": "over",
"enum": [
"over",
"under"
],
"type": "string"
},
"filter_reference": {
"default": 0.0,
"type": "number"
},
"sort_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"sort_order": {
"default": "descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
},
"sort_reference": {
"type": "number"
},
"type": {
"default": "ModeFilterSpec",
"enum": [
"ModeFilterSpec"
],
"type": "string"
}
},
"type": "object"
},
"ModeSolverMonitor": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -7684,6 +7756,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -7805,6 +7878,13 @@
],
"type": "string"
},
"filter_spec": {
"allOf": [
{
"$ref": "#/definitions/ModeFilterSpec"
}
]
},
"group_index_step": {
"anyOf": [
{
Expand Down
75 changes: 75 additions & 0 deletions schemas/ModeSimulation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6715,6 +6715,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -6750,6 +6751,70 @@
],
"type": "object"
},
"ModeFilterSpec": {
"additionalProperties": false,
"properties": {
"attrs": {
"default": {},
"type": "object"
},
"filter_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"filter_order": {
"default": "over",
"enum": [
"over",
"under"
],
"type": "string"
},
"filter_reference": {
"default": 0.0,
"type": "number"
},
"sort_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"sort_order": {
"default": "descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
},
"sort_reference": {
"type": "number"
},
"type": {
"default": "ModeFilterSpec",
"enum": [
"ModeFilterSpec"
],
"type": "string"
}
},
"type": "object"
},
"ModeMonitor": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -6885,6 +6950,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -7135,6 +7201,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -7309,6 +7376,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -7449,6 +7517,13 @@
],
"type": "string"
},
"filter_spec": {
"allOf": [
{
"$ref": "#/definitions/ModeFilterSpec"
}
]
},
"group_index_step": {
"anyOf": [
{
Expand Down
75 changes: 75 additions & 0 deletions schemas/Simulation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10199,6 +10199,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -10234,6 +10235,70 @@
],
"type": "object"
},
"ModeFilterSpec": {
"additionalProperties": false,
"properties": {
"attrs": {
"default": {},
"type": "object"
},
"filter_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"filter_order": {
"default": "over",
"enum": [
"over",
"under"
],
"type": "string"
},
"filter_reference": {
"default": 0.0,
"type": "number"
},
"sort_key": {
"enum": [
"TE_fraction",
"TM_fraction",
"k_eff",
"mode_area",
"n_eff",
"wg_TE_fraction",
"wg_TM_fraction"
],
"type": "string"
},
"sort_order": {
"default": "descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
},
"sort_reference": {
"type": "number"
},
"type": {
"default": "ModeFilterSpec",
"enum": [
"ModeFilterSpec"
],
"type": "string"
}
},
"type": "object"
},
"ModeMonitor": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -10369,6 +10434,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -10619,6 +10685,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -10793,6 +10860,7 @@
"bend_axis": null,
"bend_radius": null,
"filter_pol": null,
"filter_spec": null,
"group_index_step": false,
"num_modes": 1,
"num_pml": [
Expand Down Expand Up @@ -10933,6 +11001,13 @@
],
"type": "string"
},
"filter_spec": {
"allOf": [
{
"$ref": "#/definitions/ModeFilterSpec"
}
]
},
"group_index_step": {
"anyOf": [
{
Expand Down
Loading