flex_rf.tidy3d.AnisotropicMedium

Type: class │ Base(s): AbstractMedium

Description

Diagonally anisotropic medium.

Notes

Only diagonal anisotropy is currently supported.

Example(s)

medium_xx = Medium(permittivity=4.0)
medium_yy = Medium(permittivity=4.1)
medium_zz = Medium(permittivity=3.9)
anisotropic_dielectric = AnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)

Parameters

xx [IsotropicUniformMediumType]

Medium describing the xx-component of the diagonal permittivity tensor.

yy [IsotropicUniformMediumType]

Medium describing the yy-component of the diagonal permittivity tensor.

zz [IsotropicUniformMediumType]

Medium describing the zz-component of the diagonal permittivity tensor.

name [str | None] = None

Optional unique name for medium.

frequency_range [FreqBound | None] = None

Optional range of validity for the medium.

nonlinear_spec [NonlinearSpec | NonlinearSusceptibility | None] = None

Nonlinear spec applied on top of the base medium properties.

modulation_spec [ModulationSpec | None] = None

Modulation spec applied on top of the base medium properties.

viz_spec [VisualizationSpec | None] = None

Plotting specification for visualizing medium.

heat_spec [ThermalSpecType | None] = 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.

allow_gain [bool | None] = None

This field is ignored. Please set allow_gain in each component

Attributes

elements [dict[str, IsotropicUniformMediumType]]

The diagonal elements of the medium as a dictionary.

Methods

components()

Dictionary of diagonal medium components.

eps_comp(row: Axis, col: Axis, frequency: float)

Single component the complex-valued permittivity tensor as a function of frequency.

eps_diagonal(frequency: float)

Main diagonal of the complex-valued permittivity tensor as a function of frequency.

eps_model(frequency: float)

Complex-valued permittivity as a function of frequency.

is_comp_pec(comp: Axis)

Whether the medium is a PEC.

is_comp_pmc(comp: Axis)

Whether the medium is a PMC.

is_pec()

Whether the medium is a PEC.

is_pmc()

Whether the medium is a PMC.

is_time_modulated()

Whether any component of the medium is time modulated.

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.

plot(freqs: float, ax: Ax = None)

Plot n, k of a Medium as a function of frequency.

sel_inside(bounds: Bound)

Return a new medium that contains the minimal amount data necessary to cover a spatial region defined by bounds.