tidy3d.StablePML#

class StablePML[source]#

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

Parameters:

attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().
name (Optional[str] = None) – Optional unique name for boundary.
num_layers (NonNegativeInt = 40) – Number of layers of ‘stable’ PML.
parameters (PMLParams = PMLParams(attrs={}, 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)

tidy3d.StablePML