tidy3d.AbsorberParams

tidy3d.AbsorberParams#

class AbsorberParams[source]#

Bases: Tidy3dBaseModel

Specifies parameters common to Absorbers and PMLs.

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.

Example

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

Attributes

attrs

Methods

Inherited Common Usage

sigma_order#
sigma_min#
sigma_max#
__hash__()#

Hash method.