tidy3d.BroadbandModeABCSpec

tidy3d.BroadbandModeABCSpec#

class BroadbandModeABCSpec[source]#

Bases: Tidy3dBaseModel

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

Parameters:

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

  • fit_param (BroadbandModeABCFitterParam = 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

frequency_range

fit_param

Methods

from_wavelength_range(wavelength_range[, ...])

Instantiate from a wavelength range.

validate_frequency_range(val)

Validate that max frequency is greater than min frequency.
frequency_range#
fit_param#
classmethod validate_frequency_range(val)[source]#

Validate that max frequency is greater than min frequency.

classmethod from_wavelength_range(wavelength_range, fit_param=BroadbandModeABCFitterParam())[source]#

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