tidy3d.StructureStructureInterface

class StructureStructureInterface

Bases: AbstractBCPlacement

Placement of boundary conditions between two structures.

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

• structures (Tuple[str, str]) – Names of two structures.

Example

>>> bc_placement = StructureStructureInterface(structures=["box", "sphere"])

Attributes

attrs

Methods

unique_names(val)

Error if the same structure is provided twice

Inherited Common Usage

structures

classmethod unique_names(val)

Error if the same structure is provided twice

__hash__()

Hash method.