tidy3d.PMLParams#

class PMLParams[source]#

Specifies full set of parameters needed for complex, frequency-shifted PML.

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().
sigma_order (NonNegativeInt = 3) – Order of the polynomial describing the absorber profile (~dist^sigma_order).
sigma_min (NonNegativeFloat = 0.0) – [units = 2*EPSILON_0/dt]. Minimum value of the absorber conductivity.
sigma_max (NonNegativeFloat = 1.5) – [units = 2*EPSILON_0/dt]. Maximum value of the absorber conductivity.
kappa_order (NonNegativeInt = 3) – Order of the polynomial describing the PML kappa profile (kappa~dist^kappa_order).
kappa_min (NonNegativeFloat = 0.0)
kappa_max (NonNegativeFloat = 1.5)
alpha_order (NonNegativeInt = 3) – Order of the polynomial describing the PML alpha profile (alpha~dist^alpha_order).
alpha_min (NonNegativeFloat = 0.0) – [units = 2*EPSILON_0/dt]. Minimum value of the PML alpha.
alpha_max (NonNegativeFloat = 1.5) – [units = 2*EPSILON_0/dt]. Maximum value of the PML alpha.

Example

>>> params = PMLParams(sigma_order=3, sigma_min=0.0, sigma_max=1.5, kappa_min=0.0)

Attributes

Methods

Inherited Common Usage

tidy3d.PMLParams