tidy3d.PMLParams

class PMLParams

Bases: AbsorberParams

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

Parameters:

• sigma_order (Attribute: sigma_order) –

  Type	NonNegativeInt
  Default	= 3
  Description	Order of the polynomial describing the absorber profile (~dist^sigma_order).

• sigma_min (Attribute: sigma_min) –

  Type	NonNegativeFloat
  Default	= 0.0
  Units	2*EPSILON_0/dt
  Description	Minimum value of the absorber conductivity.

• sigma_max (Attribute: sigma_max) –

  Type	NonNegativeFloat
  Default	= 1.5
  Units	2*EPSILON_0/dt
  Description	Maximum value of the absorber conductivity.

• kappa_order (Attribute: kappa_order) –

  Type	NonNegativeInt
  Default	= 3
  Description	Order of the polynomial describing the PML kappa profile (kappa~dist^kappa_order).

• kappa_min (Attribute: kappa_min) –

  Type	NonNegativeFloat
  Default	= 0.0
  Description

• kappa_max (Attribute: kappa_max) –

  Type	NonNegativeFloat
  Default	= 1.5
  Description

• alpha_order (Attribute: alpha_order) –

  Type	NonNegativeInt
  Default	= 3
  Description	Order of the polynomial describing the PML alpha profile (alpha~dist^alpha_order).

• alpha_min (Attribute: alpha_min) –

  Type	NonNegativeFloat
  Default	= 0.0
  Units	2*EPSILON_0/dt
  Description	Minimum value of the PML alpha.

• alpha_max (Attribute: alpha_max) –

  Type	NonNegativeFloat
  Default	= 1.5
  Units	2*EPSILON_0/dt
  Description	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.