tidy3d.Boundary.pml

Contents

tidy3d.Boundary.pml#

class pml#

Bases:

PML boundary specification on both sides along a dimension.

Parameters:

  • num_layers (int = 12) – Number of layers of standard PML to add to + and - boundaries.

  • parameters (PMLParams) – Parameters of the complex frequency-shifted absorption poles.

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

Example

>>> pml = Boundary.pml(num_layers=20)
>>> pml = Boundary.pml(extrude_structures=False)