tidy3d.PMLParams

tidy3d.PMLParams#

class PMLParams[source]#

Specifies full set of parameters needed for complex, frequency-shifted PML.

Parameters:

sigma_order (NonNegativeInt = 3) – Order of the polynomial describing the absorber profile (\(\mathrm{dist}^{\text{sigma\_order}}\)).
sigma_min (NonNegativeFloat = 0.0) – [units = \(2\epsilon_0/\Delta t\)]. Minimum value of the absorber conductivity.
sigma_max (NonNegativeFloat = 1.5) – [units = \(2\epsilon_0/\Delta t\)]. Maximum value of the absorber conductivity.
kappa_order (NonNegativeInt = 3) – Order of the polynomial describing the PML kappa profile (\(\kappa\sim\mathrm{dist}^{\text{kappa\_order}}\)).
kappa_min (NonNegativeFloat = 0.0)
kappa_max (NonNegativeFloat = 1.5)
alpha_order (NonNegativeInt = 3) – Order of the polynomial describing the PML alpha profile (\(\alpha\sim\mathrm{dist}^{\text{alpha\_order}}\)).
alpha_min (NonNegativeFloat = 0.0) – [units = \(2\epsilon_0/\Delta t\)]. Minimum value of the PML alpha.
alpha_max (NonNegativeFloat = 1.5) – [units = \(2\epsilon_0/\Delta t\)]. Maximum value of the PML alpha.

Example

>>> params = PMLParams(sigma_order=3, sigma_min=0.0, sigma_max=1.5, kappa_min=0.0)

Attributes