tidy3d.StablePML

class StablePML

Bases: AbsorberSpec

Specifies a ‘stable’ PML along a single dimension. This PML deals handles possibly divergent simulations better, but at the expense of more layers.

Parameters:

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional unique name for boundary.

• num_layers (Attribute: num_layers) –

  Type	NonNegativeInt
  Default	= 40
  Description	Number of layers of ‘stable’ PML.

• parameters (Attribute: parameters) –

  Type	PMLParams
  Default	= PMLParams(sigma_order3, sigma_min0.0, sigma_max1.0, type’PMLParams’, kappa_order3, kappa_min1.0, kappa_max5.0, alpha_order1, alpha_min0.0, alpha_max0.9)
  Description	’Stable’ parameters of the complex frequency-shifted absorption poles.

Example

>>> pml = StablePML(num_layers=40)

See also

PML:

A standard PML along a single dimension.

Absorber:

Specifies an adiabatic absorber along a single dimension.

Notebooks:

• How to troubleshoot a diverged FDTD simulation

Lectures:

• Introduction to perfectly matched layer (PML) tutorial

Attributes

Methods

num_layers

parameters

__hash__()

Hash method.