photonoxide 0.4.0

Validated photonics for Rust: materials with provenance, mode solvers, 2D and 3D FDFD with S-parameters and adjoints, circuits and compact models, with a live studio
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! Waveguide modes: the field patterns that propagate unchanged along a waveguide, and their
//! effective indices.
//!
//! - [`bend`]: the exact modes of a bent slab, and their radiation loss.
//! - [`dispersion`]: group index, dispersion and loss from the effective index, and one mode
//!   followed across wavelength.
//! - [`fields`]: a full-vector mode's six field components, its power, and its coupling into
//!   another mode.
//! - [`hadley`]: the full-vector modes by Hadley's high-accuracy equations, sixth order at
//!   interfaces and about second at dielectric corners.
//! - [`eim`]: the effective index method, a ridge's mode from two slab problems.
//! - [`marcatili`]: Marcatili's approximation for rectangular guides.
//! - [`multilayer`]: the bound modes and leaky waves of any planar stack, exactly, by
//!   transfer matrices.
//! - [`slab_fd`]: any planar profile (graded, lossy, leaky) by 1D finite differences.
//! - [`slab`]: the modes of a three-layer slab, exactly (TE and TM).
//! - [`vector`]: the full-vector modes of any cross-section, by finite differences.

pub mod bend;
pub mod dispersion;
pub mod eim;
pub mod fields;
pub mod hadley;
pub mod marcatili;
pub mod multilayer;
pub mod slab;
pub mod slab_fd;
pub mod vector;

/// The polarization of a slab mode.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Polarization {
    /// Transverse electric: the electric field lies in the slab's plane, across the direction of
    /// propagation.
    Te,
    /// Transverse magnetic: the magnetic field lies in the slab's plane, across the direction
    /// of propagation.
    Tm,
}