tidy3d.CustomLorentz

tidy3d.CustomLorentz#

class CustomLorentz[source]#

Bases: CustomDispersiveMedium, Lorentz

A spatially varying dispersive medium described by the Lorentz 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, 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().
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.
viz_spec (Optional[VisualizationSpec] = None) – Plotting specification for visualizing medium.
heat_spec (Union[FluidSpec, SolidSpec, SolidMedium, FluidMedium, NoneType] = None) – DEPRECATED: Use MultiPhysicsMedium. Specification of the medium heat properties. They are used for solving the heat equation via the HeatSimulation interface. Such simulations can beused 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.
eps_inf (Union[SpatialDataArray, Annotated[Union[tidy3d.components.data.unstructured.triangular.TriangularGridDataset, tidy3d.components.data.unstructured.tetrahedral.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})]]) – [units = None (relative permittivity)]. Relative permittivity at infinite frequency (\(\epsilon_\infty\)).
coeffs (Tuple[tuple[Union[tidy3d.components.data.data_array.SpatialDataArray, Annotated[Union[tidy3d.components.data.unstructured.triangular.TriangularGridDataset, tidy3d.components.data.unstructured.tetrahedral.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})]], Union[tidy3d.components.data.data_array.SpatialDataArray, Annotated[Union[tidy3d.components.data.unstructured.triangular.TriangularGridDataset, tidy3d.components.data.unstructured.tetrahedral.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})]], Union[tidy3d.components.data.data_array.SpatialDataArray, Annotated[Union[tidy3d.components.data.unstructured.triangular.TriangularGridDataset, tidy3d.components.data.unstructured.tetrahedral.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})]]], ...]) – [units = (None (relative permittivity), Hz, Hz)]. List of (\(\Delta\epsilon_i, f_i, \delta_i\)) values for model.
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, apply the subpixel averaging method specified by Simulation’s field subpixel for this type of material on the interface of the structure, including exterior boundary and intersection interfaces with other structures.

Notes

The frequency-dependence of the complex-valued permittivity is described by:

\[\epsilon(f) = \epsilon_\infty + \sum_i \frac{\Delta\epsilon_i f_i^2}{f_i^2 - 2jf\delta_i - f^2}\]

Example

>>> x = np.linspace(-1, 1, 5)
>>> y = np.linspace(-1, 1, 6)
>>> z = np.linspace(-1, 1, 7)
>>> coords = dict(x=x, y=y, z=z)
>>> eps_inf = SpatialDataArray(np.ones((5, 6, 7)), coords=coords)
>>> d_epsilon = SpatialDataArray(np.random.random((5, 6, 7)), coords=coords)
>>> f = SpatialDataArray(1+np.random.random((5, 6, 7)), coords=coords)
>>> delta = SpatialDataArray(np.random.random((5, 6, 7)), coords=coords)
>>> lorentz_medium = CustomLorentz(eps_inf=eps_inf, coeffs=[(d_epsilon,f,delta),])
>>> eps = lorentz_medium.eps_model(200e12)

`is_spatially_uniform`	Whether the medium is spatially uniform.
`attrs`

tidy3d.CustomLorentz

Contents

tidy3d.CustomLorentz#