tidy3d.Boundary.stable_pml

Contents

tidy3d.Boundary.stable_pml#

class stable_pml#

Bases:

Stable PML boundary specification on both sides along a dimension.

Parameters:

  • num_layers (int = 40) – Number of layers of ‘stable’ PML to add to + and - boundaries.

  • parameters (PMLParams) – ‘Stable’ parameters of the complex frequency-shifted absorption poles.

  • extrude_structures (bool = True) – Forwarded to StablePML. Defaults to True to match StablePML’s class default. Set False to opt out, for example when a wave-port source intentionally spans the full lateral domain via symmetry.

Example

>>> stable_pml = Boundary.stable_pml(num_layers=40)
>>> stable_pml = Boundary.stable_pml(extrude_structures=False)