models ¶

Shared models and errors for GDSFactory FDTD artifact generation.

Classes:

• FDTDArtifactError –

  Base error for invalid or unsupported GDSFactory FDTD artifacts.

• FDTDConfigError –

  Raised when settings cannot produce a valid GDSFactory FDTD config.

• FDTDGeometryError –

  Raised when geometry cannot produce a valid GDSFactory FDTD mesh.

• MeshGroup –

  One named three-dimensional Gmsh physical group.

• MeshManifest –

  Authoritative physical-group mapping emitted with a Gmsh mesh.

• PortMeshGroup –

  One named two-dimensional Gmsh port physical group.

• SimulationArtifacts –

  Paths and metadata produced by :meth:Simulation.write.

MeshGroup(name: str, physical_tag: int, material: str, priority: int)

MeshManifest(
    volumes: dict[str, MeshGroup],
    layers: dict[str, MeshGroup],
    ports: dict[str, PortMeshGroup],
    domain_min_nm: tuple[float, float, float],
    domain_max_nm: tuple[float, float, float],
)

PortMeshGroup(
    name: str,
    physical_name: str,
    physical_tag: int,
    layer: str,
    normal: tuple[int, int, int],
)

SimulationArtifacts(mesh_path: Path, config_path: Path, manifest: MeshManifest)