tidy3d.ABCBoundary

class ABCBoundary

Bases: AbstractABCBoundary

One-way wave equation absorbing boundary conditions. See, for example, John B. Schneider, Understanding the Finite-Difference Time-Domain Method, Chapter 6.

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

• name (Optional[str] = None) – Optional unique name for boundary.

• permittivity (Optional[ConstrainedFloatValue] = None) – Effective permittivity for determining propagation constant. If None, this value will be automatically inferred from the medium at the domain boundary and the central frequency of the source.

• conductivity (Optional[NonNegativeFloat] = None) – [units = S/um]. Effective conductivity for determining propagation constant. If None, this value will be automatically inferred from the medium at the domain boundary and the central frequency of the source.

Attributes

attrs

Methods

Inherited Common Usage

permittivity

conductivity

__hash__()

Hash method.