Skip to main content

Module yee_fdtd

Module yee_fdtd 

Expand description

3D Cartesian Yee FDTD Solver, CFL Gate, and Discrete Dispersion Oracle (etalon-sim).

Provides the pure continuum 3D Cartesian Yee FDTD solver, exact 3D CFL admission gate, analytical discrete dispersion relation, and periodic plane-wave convergence runner.

Structs§

YeeMaterialParams
Homogeneous isotropic constitutive parameters for a 3D Yee grid domain.
YeePlaneWaveResult
Result of a periodic 3D Yee plane-wave propagation and exact-time phase evaluation at $T = L / c_0$.

Enums§

YeeSolverProfile
Supported Mode 2 Yee solver profiles.

Constants§

YEE_CONDUCTIVE_PERIODIC_NO_PHI_URI
Canonical model URI for Mode 2 conductive periodic no-phi Yee profile.
YEE_LOSSLESS_PERIODIC_NO_PHI_URI
Canonical model URI for Mode 2 lossless periodic no-phi Yee profile.

Functions§

admit_yee_timestep
Admit a candidate solver timestep $\Delta t$ against the 3D Cartesian Yee CFL bound.
run_yee_periodic_plane_wave_fixture
Evaluate the C02 Mode 2 periodic plane-wave fixture on a 3D isotropic Yee lattice.
yee_cfl_limit_3d
Compute the exact 3D Cartesian Yee Courant-Friedrichs-Lewy (CFL) maximum stable timestep: $$\Delta t_{\text{CFL}} = \frac{1}{v \sqrt{\Delta x^{-2} + \Delta y^{-2} + \Delta z^{-2}}}$$
yee_discrete_omega_rad_per_s
Evaluate the exact 3D Cartesian Yee discrete dispersion relation for wavevector $\mathbf{k}$: $$\sin^2\left(\frac{\omega_{\text{num}} \Delta t}{2}\right) = (v \Delta t)^2 \sum_{j \in {x,y,z}} \frac{\sin^2(k_j \Delta x_j / 2)}{\Delta x_j^2}$$
yee_step_leapfrog_in_place
Advance a 3D staggered Yee electromagnetic state by one full leapfrog step $\Delta t$.