API Documentation

The FDTDX API is organized into several main components:

Core Package

The Core package provides fundamental data structures and utilities: - Configuration management - JAX integration - Array operations - Distributed computing support

Constraints

The Constraints package handles material and geometry constraints: - Material property mapping - Feature size control - Connectivity constraints - Binary operations

Objects

The Objects package defines simulation components: - Material definitions - Sources and detectors - Boundary conditions - Object positioning

Physics

The Physics package implements electromagnetic calculations: - Physical constants - Material properties - Field metrics - Mode solvers

FDTD

The FDTD package provides simulation algorithms: - Forward/backward propagation - FDTD implementations - Field updates - Curl operations

Utilities

The Utilities package contains support functions: - Visualization tools - File conversion - Image processing - Debugging utilities