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§
- YeeMaterial
Params - Homogeneous isotropic constitutive parameters for a 3D Yee grid domain.
- YeePlane
Wave Result - Result of a periodic 3D Yee plane-wave propagation and exact-time phase evaluation at $T = L / c_0$.
Enums§
- YeeSolver
Profile - 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$.