tidy3d.components.medium.CustomDispersiveMedium

class CustomDispersiveMedium

Bases: AbstractCustomMedium, DispersiveMedium, ABC

A spatially varying dispersive medium.

Parameters:

• name (Optional[str] = None) – Optional unique name for medium.

• frequency_range (Optional[Tuple[float, float]] = None) – [units = (Hz, Hz)]. Optional range of validity for the medium.

• allow_gain (bool = False) – Allow the medium to be active. Caution: simulations with a gain medium are unstable, and are likely to diverge.Simulations where ‘allow_gain’ is set to ‘True’ will still be charged even if diverged. Monitor data up to the divergence point will still be returned and can be useful in some cases.

• nonlinear_spec (Union[NonlinearSpec, NonlinearSusceptibility] = None) – Nonlinear spec applied on top of the base medium properties.

• modulation_spec (Optional[ModulationSpec] = None) – Modulation spec applied on top of the base medium properties.

• heat_spec (Union[FluidSpec, SolidSpec, NoneType] = None) – Specification of the medium heat properties. They are used for solving the heat equation via the HeatSimulation interface. Such simulations can be used for investigating the influence of heat propagation on the properties of optical systems. Once the temperature distribution in the system is found using HeatSimulation object, Simulation.perturbed_mediums_copy() can be used to convert mediums with perturbation models defined into spatially dependent custom mediums. Otherwise, the heat_spec does not directly affect the running of an optical Simulation.

• interp_method (Literal['nearest', 'linear'] = nearest) – Interpolation method to obtain permittivity values that are not supplied at the Yee grids; For grids outside the range of the supplied data, extrapolation will be applied. When the extrapolated value is smaller (greater) than the minimal (maximal) of the supplied data, the extrapolated value will take the minimal (maximal) of the supplied data.

• subpixel (bool = False) – If True and simulation’s subpixel is also True, applies subpixel averaging of the permittivity on the interface of the structure, including exterior boundary and intersection interfaces with other structures.

Attributes

is_isotropic	Whether the medium is isotropic.
n_cfl	This property computes the index of refraction related to CFL condition, so that the FDTD with this medium is stable when the time step size that doesn't take material factor into account is multiplied by n_cfl.
pole_residue	Representation of Medium as a pole-residue model.

Methods

Inherited Common Usage

property n_cfl

This property computes the index of refraction related to CFL condition, so that the FDTD with this medium is stable when the time step size that doesn’t take material factor into account is multiplied by n_cfl.

For PoleResidue model, it equals sqrt(eps_inf) [https://ieeexplore.ieee.org/document/9082879].

property is_isotropic

Whether the medium is isotropic.

property pole_residue

Representation of Medium as a pole-residue model.

__hash__()

Hash method.