tidy3d.MeshOverrideStructure

class MeshOverrideStructure

Bases: AbstractStructure

Defines an object that is only used in the process of generating the mesh.

Parameters:

• geometry (Attribute: geometry) –

  Type	Union[Box, Transformed, ClipOperation, GeometryGroup, Sphere, Cylinder, PolySlab, ComplexPolySlabBase, TriangleMesh]
  Default
  Description	Defines geometric properties of the structure.

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional name for the structure.

• dl (Attribute: dl) –

  Type	Tuple[PositiveFloat, PositiveFloat, PositiveFloat]
  Default
  Units	um
  Description	Grid size along x, y, z directions.

• enforce (Attribute: enforce) –

  Type	bool
  Default	= False
  Description	If True, enforce the grid size setup inside the structure even if the structure is inside a structure of smaller grid size. In the intersection region of multiple structures of enforce=True, grid size is decided by the last added structure of enforce=True.

Notes

A MeshOverrideStructure is a combination of geometry Geometry, grid size along x, y, z directions, and a boolean on whether the override will be enforced.

Example

>>> from tidy3d import Box
>>> box = Box(center=(0,0,1), size=(2, 2, 2))
>>> struct_override = MeshOverrideStructure(geometry=box, dl=(0.1,0.2,0.3), name='override_box')

Attributes

geometry

Methods

dl

enforce

__hash__()

Hash method.