tidy3d.StructureSimulationBoundary

class StructureSimulationBoundary

Bases: AbstractBCPlacement

Placement of boundary conditions on the simulation box boundary covered by the structure.

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

• structure (str) – Name of the structure.

• surfaces (Tuple[Literal['x-', 'x+', 'y-', 'y+', 'z-', 'z+'], ...] = ('x-', 'x+', 'y-', 'y+', 'z-', 'z+')) – Surfaces of simulation domain where to apply boundary conditions.

Example

>>> bc_placement = StructureSimulationBoundary(structure="box", surfaces=["y-", "y+"])

Attributes

attrs

Methods

Inherited Common Usage

structure

surfaces

__hash__()

Hash method.