tidy3d.BroadbandModeABCSpec

class BroadbandModeABCSpec

Bases: Tidy3dBaseModel

Specifies the broadband mode absorption boundary conditions. The mode propagation index is approximated by a sum of pole-residue pairs.

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().

• frequency_range (Tuple[float, float]) – [units = (Hz, Hz)]. Frequency range for the broadband mode absorption boundary conditions.

• fit_param (BroadbandModeABCFitterParam = BroadbandModeABCFitterParam(attrs={}, max_num_poles=5, tolerance_rms=1e-06, frequency_sampling_points=15, type='BroadbandModeABCFitterParam')) – Parameters for fitting the mode propagation index over the frequency range using pole-residue pair model.

Example

>>> broadband_mode_abc_spec = BroadbandModeABCSpec(frequency_range=(100e12, 120e12), fit_param=BroadbandModeABCFitterParam())

Attributes

attrs

Methods

from_wavelength_range(wavelength_range[, ...])	Instantiate from a wavelength range.
validate_frequency_range(val, values)	Validate that max frequency is greater than min frequency.

Inherited Common Usage

frequency_range

fit_param

classmethod validate_frequency_range(val, values)

Validate that max frequency is greater than min frequency.

classmethod from_wavelength_range(wavelength_range, fit_param=BroadbandModeABCFitterParam(attrs={}, max_num_poles=5, tolerance_rms=1e-06, frequency_sampling_points=15, type='BroadbandModeABCFitterParam'))

Instantiate from a wavelength range.

Parameters:

• wavelength_range (FreqBound) – Wavelength range for the broadband mode absorption boundary conditions.

• fit_param (BroadbandModeABCFitterParam = DEFAULT_BROADBAND_MODE_ABC_FITTER_PARAMS) – Parameters for fitting the mode propagation index over the frequency range using pole-residue pair model.

Returns:

Broadband mode absorption boundary conditions.

Return type:

BroadbandModeABCSpec

__hash__()

Hash method.