Crate photonoxide 

photonoxide

Validated photonics for Rust: materials with provenance, mode solvers, 2D and 3D FDFD with S-parameters and adjoints, components and circuits, and compact models, with a studio to watch every run live. Every method is checked against an analytic solution or a published result (validation).

• material: dispersion models with their source, validity range and temperature, and a catalogue of photonic materials, every number read from its paper.
• mode: waveguide modes, from the exact slab and multilayers to full-vector finite differences of a cross-section, with bends, dispersion and loss.
• fdfd: frequency-domain finite differences in 2D and 3D on Yee’s grid, with PMLs, mode ports, S-parameters and adjoint gradients.
• circuit: components with ports and S-matrices, connected into netlists, solved as one sparse system and differentiated by the circuit adjoint.
• compact: compact models by vector fitting, over parameters, and Touchstone files.
• run and job: jobs as TOML files, and runs recorded as events that replay exactly; the studio, the photonoxide program attached to each release, runs and shows them.

Alpha: the API is being built milestone by milestone, and will change. FDTD, thermal and electro-optic devices, inverse design, layout and PDKs are planned, not here yet: see the roadmap.

Re-exports

pub use error::Error;

pub use error::Result;

Modules

circuit

Components and circuits: devices described by their S-matrices, connected into netlists.

compact

Compact models and Touchstone files: a device’s S-matrix spectrum as a few numbers.

error

Errors returned by photonoxide.

fdfd

Frequency-domain finite differences (FDFD): Maxwell’s equations at one frequency, on a grid, as one sparse linear system.

geometry

Planar shapes: what is drawn on a layer, seen from above.

job

The jobs photonoxide run knows, and the events they record.

material

Optical materials: dispersion models, and data with their provenance.

mode

Waveguide modes: the field patterns that propagate unchanged along a waveguide, and their effective indices.

raster

Rasters: a structure’s permittivity sampled on a rectangular grid, for pictures and checks.

run

Runs: job descriptions, run directories, event records and replay.

stack

Layer stacks: the vertical structure of a chip, and what is drawn on its layers.

units

Typed quantities and the conventions every solver follows.

validation

The validation harness: every check of photonoxide against something it must agree with.

Constants

VERSION

photonoxide’s version, e.g. "0.2.0".

Type Aliases

Complex64

Alias for a Complex<f64>