Bases: PhasorDetector
Detector for measuring the overlap of a waveguide mode with the simulation fields.
This detector computes the overlap of a mode with the phasor fields at a specified
frequency, enabling frequency-domain analysis of the electromagnetic fields.
The mode overlap is calculated by integrating the cross product of the mode fields
with the simulation fields over a cross-sectional plane. This is useful for
analyzing waveguide coupling efficiency, transmission coefficients, and modal
decomposition of electromagnetic fields.
| Attributes: |
-
direction
(Literal['+', '-'])
–
Direction of mode propagation, either "+" (forward) or "-" (backward).
Determines which direction along the waveguide axis the mode is
assumed to propagate.
-
mode_index
(int)
–
Index of the waveguide mode to use for overlap calculation.
Defaults to 0 (fundamental mode). Higher indices correspond to higher-order modes.
-
filter_pol
(Literal['te', 'tm'] | None)
–
Optional polarization filter for the mode calculation.
Can be "te" (transverse electric), "tm" (transverse magnetic), or None (no filtering).
When specified, only modes of the given polarization type are considered. Defaults to None.
-
components
(Sequence[Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']])
–
Cannot be specified here since
the detector needs all components.
-
plot
(bool)
–
Cannot be specified here since plotting a single scalar is useless.
|