Ctrl+K

tidy3d.PMLParams

tidy3d.PMLParams#

class PMLParams[source]#

Bases: AbsorberParams

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

Parameters:

  • sigma_order (NonNegativeInt = 3) – Order of the polynomial describing the absorber profile (~dist^sigma_order).

  • sigma_min (NonNegativeFloat = 0.0) – [units = 2*EPSILON_0/dt]. Minimum value of the absorber conductivity.

  • sigma_max (NonNegativeFloat = 1.5) – [units = 2*EPSILON_0/dt]. Maximum value of the absorber conductivity.

  • kappa_order (NonNegativeInt = 3) – Order of the polynomial describing the PML kappa profile (kappa~dist^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~dist^alpha_order).

  • alpha_min (NonNegativeFloat = 0.0) – [units = 2*EPSILON_0/dt]. Minimum value of the PML alpha.

  • alpha_max (NonNegativeFloat = 1.5) – [units = 2*EPSILON_0/dt]. 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

Methods

kappa_order#
kappa_min#
kappa_max#
alpha_order#
alpha_min#
alpha_max#
__hash__()#

Hash method.