tidy3d.PolarizedAveraging#
- class PolarizedAveraging[source]#
Bases:
AbstractSubpixelAveragingMethod
Apply a polarized subpixel averaging method to dielectric boundaries.
- 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 anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.json()
.
Note
The algorithm is based on:
A. Mohammadi, H. Nadgaran and M. Agio, “Contour-path effective permittivities for the two-dimensional finite-difference time-domain method”, Optics express, 13(25), 10367-10381 (2005).
Attributes
Methods
Inherited Common Usage
- __hash__()#
Hash method.