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:

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

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.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.

direction

grid_shift

boundary_spec

size

center

Methods

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

Plot this absorber.
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.