Reference Lane
Recommended default lane
Section titled “Recommended default lane”Start with the uniform Cartesian Yee RF/FDTD lane:
- PEC, CPML, or bounded UPML boundaries
- point/current sources
- lumped and wire ports
- specialized microstrip-line and rectangular waveguide workflows where documented
- probes, flux monitors, Harminv resonance extraction, selected S-parameter workflows, and benchmarked far-field workflows
This is the lane to use first for ordinary RF examples and public tutorials.
Bounded envelopes
Section titled “Bounded envelopes”The following surfaces are narrower than the default lane and must be described with their exact calculator and support limits:
| Surface | Public status |
|---|---|
| rectangular waveguide S-matrix | documented rectangular-guide envelope via compute_waveguide_s_matrix(...) |
| microstrip-line S-matrix | specialized uniform-Yee workflow via compute_msl_s_matrix(...) |
| lumped/wire S-parameters | calculator-specific support envelope via run(compute_s_params=True) or forward(port_s11_freqs=...) |
| coaxial transmission-line reflection | one-port line-reflection envelope via compute_coaxial_line_reflection(...); not a general coaxial network solver |
| differentiable design loops | proxy-objective optimization; final claims inherit the observable/port-family evidence |
S-parameter API boundaries
Section titled “S-parameter API boundaries”run(compute_s_params=True)is the full S-matrix API for lumped/wireadd_port(...)workflows.compute_msl_s_matrix()is the microstrip-line S-matrix API.compute_waveguide_s_matrix()is the rectangular waveguide S-matrix API.compute_coaxial_line_reflection(...)is the bounded coaxial line-reflection method.- Field sources, TFSF, probes, DFT planes, and flux monitors are not port calculators.
Practical rule
Section titled “Practical rule”If a feature is not in the recommended default lane or a bounded envelope above, keep it out of public docs until the support matrix covers it.