tidy3d.StructureSimulationBoundary

class StructureSimulationBoundary

Bases: AbstractBCPlacement

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

Parameters:

• structure (Attribute: structure) –

  Type	str
  Default
  Description	Name of the structure.

• surfaces (Attribute: surfaces) –

  Type	Tuple[Literal[‘x-’, ‘x+’, ‘y-’, ‘y+’, ‘z-’, ‘z+’], …]
  Default	= (‘x-’, ‘x+’, ‘y-’, ‘y+’, ‘z-’, ‘z+’)
  Description	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.