tidy3d.InternalAbsorber

tidy3d.InternalAbsorber#

class InternalAbsorber[source]#

Bases: Box

Internally placed plane with one-way wave equation boundary conditions for absorption of electromagnetic waves. Note that internal absorbers are automatically wrapped in a PEC frame with a backing PEC plate on the non-absorbing side.

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().

  • center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) – [units = um]. Size in x, y, and z directions.

  • direction (Literal['+', '-']) – Indicates which direction of traveling waves are absorbed.

  • grid_shift (int = 0) – Displacement of absorber in the normal positive direction in number of cells. This could be used to conveniently place an absorber right behind a source: one can use the same size and center as for the source and simply set shift to 1.

  • boundary_spec (Union[ModeABCBoundary, ABCBoundary]) – Boundary specification for defining effective propagation index in the one-way wave equation.

Attributes

plot_params

Default parameters for plotting a port absorber object.

attrs

Methods

plot([x, y, z, ax])

Plot this absorber.

Inherited Common Usage

direction#
grid_shift#
boundary_spec#
property plot_params#

Default parameters for plotting a port absorber object.

plot(x=None, y=None, z=None, ax=None, **patch_kwargs)[source]#

Plot this absorber.

__hash__()#

Hash method.