tidy3d.StructureSimulationBoundary#

class StructureSimulationBoundary[source]#

Bases: AbstractBCPlacement

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

Parameters:
  • 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

Methods

structure#
surfaces#
__hash__()#

Hash method.