tidy3d.rf.MicrowaveModeData

class MicrowaveModeData

Bases: MicrowaveModeDataBase, ModeData

Data associated with a ModeMonitor for microwave and RF applications: modal amplitudes, propagation indices, mode profiles, and transmission line data.

Parameters:

• attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

• Ex (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the x-component of the electric field of the mode.

• Ey (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the y-component of the electric field of the mode.

• Ez (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the z-component of the electric field of the mode.

• Hx (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the x-component of the magnetic field of the mode.

• Hy (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the y-component of the magnetic field of the mode.

• Hz (Optional[ScalarModeFieldDataArray] = None) – Spatial distribution of the z-component of the magnetic field of the mode.

• monitor (MicrowaveModeMonitor) – Mode monitor associated with the data.

• symmetry (Tuple[Literal[0, -1, 1], Literal[0, -1, 1], Literal[0, -1, 1]] = (0, 0, 0)) – Symmetry eigenvalues of the original simulation in x, y, and z.

• symmetry_center (Optional[Tuple[float, float, float]] = None) – Center of the symmetry planes of the original simulation in x, y, and z. Required only if any of the symmetry field are non-zero.

• grid_expanded (Optional[Grid] = None) – Grid discretization of the associated monitor in the simulation which created the data. Required if symmetries are present, as well as in order to use some functionalities like getting Poynting vector and flux.

• grid_primal_correction (Union[float, FreqDataArray, TimeDataArray, FreqModeDataArray, EMEFreqModeDataArray] = 1.0) – Correction factor that needs to be applied for data corresponding to a 2D monitor to take into account the finite grid in the normal direction in the simulation in which the data was computed. The factor is applied to fields defined on the primal grid locations along the normal direction.

• grid_dual_correction (Union[float, FreqDataArray, TimeDataArray, FreqModeDataArray, EMEFreqModeDataArray] = 1.0) – Correction factor that needs to be applied for data corresponding to a 2D monitor to take into account the finite grid in the normal direction in the simulation in which the data was computed. The factor is applied to fields defined on the dual grid locations along the normal direction.

• n_complex (ModeIndexDataArray) – Complex-valued effective propagation constants associated with the mode.

• n_group_raw (Optional[GroupIndexDataArray] = None) – Index associated with group velocity of the mode.

• dispersion_raw (Optional[ModeDispersionDataArray] = None) – [units = ps/(nm km)]. Dispersion parameter for the mode.

• amps (ModeAmpsDataArray) – Complex-valued amplitudes associated with the mode.

• eps_spec (Optional[List[Literal['diagonal', 'tensorial_real', 'tensorial_complex']]] = None) – Characterization of the permittivity profile on the plane where modes are computed. Possible values are ‘diagonal’, ‘tensorial_real’, ‘tensorial_complex’.

• transmission_line_data (Optional[TransmissionLineDataset] = None) – Additional data relevant to transmission lines in RF and microwave applications, like characteristic impedance. This field is populated when a MicrowaveModeSpec has been used to set up the monitor or mode solver.

Notes

This class extends ModeData with additional microwave-specific data including characteristic impedance, voltage coefficients, and current coefficients. The data is stored as DataArray objects using the xarray package.

The microwave mode data contains all the information from ModeData plus additional microwave dataset with impedance calculations performed using voltage and current line integrals as specified in the MicrowaveModeSpec.

Example

>>> import tidy3d as td
>>> import numpy as np
>>> from tidy3d.components.data.data_array import (
...     CurrentFreqModeDataArray,
...     ImpedanceFreqModeDataArray,
...     ModeAmpsDataArray,
...     ModeIndexDataArray,
...     VoltageFreqModeDataArray,
... )
>>> from tidy3d.components.microwave.data.dataset import TransmissionLineDataset
>>> direction = ["+", "-"]
>>> f = [1e14, 2e14, 3e14]
>>> mode_index = np.arange(3)
>>> index_coords = dict(f=f, mode_index=mode_index)
>>> index_data = ModeIndexDataArray((1+1j) * np.random.random((3, 3)), coords=index_coords)
>>> amp_coords = dict(direction=direction, f=f, mode_index=mode_index)
>>> amp_data = ModeAmpsDataArray((1+1j) * np.random.random((2, 3, 3)), coords=amp_coords)
>>> impedance_data = ImpedanceFreqModeDataArray(50 * np.ones((3, 3)), coords=index_coords)
>>> voltage_data = VoltageFreqModeDataArray((1+1j) * np.random.random((3, 3)), coords=index_coords)
>>> current_data = CurrentFreqModeDataArray((0.02+0.01j) * np.random.random((3, 3)), coords=index_coords)
>>> tl_data = TransmissionLineDataset(
...     Z0=impedance_data,
...     voltage_coeffs=voltage_data,
...     current_coeffs=current_data
... )
>>> monitor = td.MicrowaveModeMonitor(
...    center=(0, 0, 0),
...    size=(2, 0, 6),
...    freqs=[2e14, 3e14],
...    mode_spec=td.MicrowaveModeSpec(num_modes=3, impedance_specs=td.AutoImpedanceSpec()),
...    name='microwave_mode',
... )
>>> data = MicrowaveModeData(
...     monitor=monitor,
...     amps=amp_data,
...     n_complex=index_data,
...     transmission_line_data=tl_data
... )

Attributes

attrs

Methods

Inherited Common Usage

monitor

__hash__()

Hash method.