tidy3d.Drude#
- class Drude[source]#
Bases:
DispersiveMedium
A dispersive medium described by the Drude 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 anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.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
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 usingHeatSimulation
object,Simulation.perturbed_mediums_copy()
can be used to convert mediums with perturbation models defined into spatially dependent custom mediums. Otherwise, theheat_spec
does not directly affect the running of an opticalSimulation
.eps_inf (PositiveFloat = 1.0) β [units = None (relative permittivity)]. Relative permittivity at infinite frequency (\(\epsilon_\infty\)).
coeffs (Tuple[Tuple[float, pydantic.v1.types.PositiveFloat], ...]) β [units = (Hz, Hz)]. List of (\(f_i, \delta_i\)) values for model.
Notes
The frequency-dependence of the complex-valued permittivity is described by:
\[\epsilon(f) = \epsilon_\infty - \sum_i \frac{ f_i^2}{f^2 + jf\delta_i}\]Example
>>> drude_medium = Drude(eps_inf=2.0, coeffs=[(1,2), (3,4)]) >>> eps = drude_medium.eps_model(200e12)
See also
CustomDrude
:A spatially varying dispersive medium described by the Drude model.
- Notebooks
- Lectures
Attributes
Methods
eps_model
(frequency)Complex-valued permittivity as a function of frequency.
Inherited Common Usage
- eps_inf#
- coeffs#
- __hash__()#
Hash method.