tidy3d.Sellmeier#
- class Sellmeier[source]#
- Bases: - DispersiveMedium- A dispersive medium described by the Sellmeier model. - 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, - attrsare mutable. For example, the following is allowed for setting an- attr- obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a- TypeErrorif- attrscontain objects that can not be serialized. One can check if- attrsare serializable by calling- obj.json().
- 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 - HeatSimulationinterface. 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- HeatSimulationobject,- Simulation.perturbed_mediums_copy()can be used to convert mediums with perturbation models defined into spatially dependent custom mediums. Otherwise, the- heat_specdoes not directly affect the running of an optical- Simulation.
- coeffs (Tuple[Tuple[float, pydantic.v1.types.PositiveFloat], ...]) โ [units = (None, um^2)]. List of Sellmeier (\(B_i, C_i\)) coefficients. 
 
 - Notes - The frequency-dependence of the refractive index is described by: \[n(\lambda)^2 = 1 + \sum_i \frac{B_i \lambda^2}{\lambda^2 - C_i}\]- For lossless, weakly dispersive materials, the best way to incorporate the dispersion without doing complicated fits and without slowing the simulation down significantly is to provide the value of the refractive index dispersion \(\frac{dn}{d\lambda}\) in - tidy3d.Sellmeier.from_dispersion(). The value is assumed to be at the central frequency or wavelength (whichever is provided), and a one-pole model for the material is generated.- Example - >>> sellmeier_medium = Sellmeier(coeffs=[(1,2), (3,4)]) >>> eps = sellmeier_medium.eps_model(200e12) - See also - CustomSellmeier
- A spatially varying dispersive medium described by the Sellmeier model. 
 - Notebooks - Lectures - Attributes - Methods - eps_model(frequency)- Complex-valued permittivity as a function of frequency. - from_dispersion(n,ย freq[,ย dn_dwvl])- Convert - nand wavelength dispersion- dn_dwvlvalues at frequency- freqto a single-pole- Sellmeiermedium.- Inherited Common Usage - coeffs#
 - classmethod from_dispersion(n, freq, dn_dwvl=0, **kwargs)[source]#
- Convert - nand wavelength dispersion- dn_dwvlvalues at frequency- freqto a single-pole- Sellmeiermedium.- Parameters:
- n (float) โ Real part of refractive index. Must be larger than or equal to one. 
- dn_dwvl (float = 0) โ Derivative of the refractive index with wavelength (1/um). Must be negative. 
- freq (float) โ Frequency at which - nand- dn_dwvlare sampled.
 
- Returns:
- Single-pole Sellmeier medium with the prvoided refractive index and index dispersion valuesat at the prvoided frequency. 
- Return type:
 
 - __hash__()#
- Hash method.