API Reference
rfx uses a curated API hub for the supported public surface. Anything not covered here should be treated as lower-level implementation detail unless a guide and support entry document it.
This hub is intentionally narrow:
- it documents the object model used by the current reference workflow
- it keeps solver, geometry, and workflow boundaries explicit
- it does not try to be a complete symbol inventory
What belongs here
Section titled “What belongs here”| Page | Focus | When to use it |
|---|---|---|
| Simulation | builder, run loop, auto-setup | you need to create and execute a job |
| Geometry & Materials | shapes, material registration, dispersive poles | you need to place or define media |
| Sources & Ports | excitation, impedance loading, calibration | you need to drive a structure or measure S-parameters |
| Results & Observables | return object fields and resonance extraction | you need to read solver outputs |
| Automation | auto_configure, Simulation.auto, mesh helpers | you want a derived starting point |
| Support Boundaries | recommended, bounded, and unsupported combinations | you need to know whether a feature is documented |
Canonical rule
Section titled “Canonical rule”Public API wording must stay aligned with the support matrix and reference workflow. If a capability is not described in the curated pages, do not present it as part of the documented public workflow.
Current reference workflow
Section titled “Current reference workflow”The curated public API reflects the current documented workflow:
- uniform Cartesian Yee RF workflows
- PEC / CPML / bounded UPML boundaries
- point/current sources
- lumped and wire ports
- specialized microstrip-line ports
- waveguide ports
- probes, Harminv resonance, benchmarked NTFF, and S-parameters only through the documented support envelopes
For the authoritative support scope, see Support Boundaries and Reference Lane.