tidy3d.StablePML#

class StablePML[source]#

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 (Optional[str] = None) – Optional unique name for boundary.

  • num_layers (NonNegativeInt = 40) – Number of layers of ‘stable’ PML.

  • parameters (PMLParams = PMLParams(sigma_order=3, sigma_min=0.0, sigma_max=1.0, type='PMLParams', kappa_order=3, kappa_min=1.0, kappa_max=5.0, alpha_order=1, alpha_min=0.0, alpha_max=0.9)) – ‘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:
Lectures:

Attributes

Methods

Inherited Common Usage

num_layers#
parameters#
__hash__()#

Hash method.