14 lines
747 B
Markdown
14 lines
747 B
Markdown
# API Overview
|
|
|
|
The package is documented directly from its docstrings. The most useful entry
|
|
points are:
|
|
|
|
- [meanas](meanas.md): top-level package overview
|
|
- [eigensolvers](eigensolvers.md): generic eigenvalue utilities used by the mode solvers
|
|
- [fdfd](fdfd.md): frequency-domain operators, sources, PML, solvers, and far-field transforms
|
|
- [waveguides](waveguides.md): straight, cylindrical, and 3D waveguide mode helpers
|
|
- [fdtd](fdtd.md): timestepping, CPML, energy/flux helpers, and phasor extraction
|
|
- [fdmath](fdmath.md): shared discrete operators, vectorization helpers, and derivation background
|
|
|
|
The waveguide and FDTD pages are the best places to start if you want the
|
|
mathematical derivations rather than just the callable reference.
|