API Reference

The pages below define the documented rfx API. Treat importable symbols not covered here as lower-level implementation details unless a guide and support entry document their use.

This section:

• documents the object model used by the current recommended configuration;
• keeps solver, geometry, and workflow restrictions explicit; and
• does not try to be a complete symbol inventory.

Pages

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, limited, and unsupported combinations	you need to know whether a feature is documented

Documentation rule

The documented API must stay aligned with Support Boundaries and the Recommended Configuration. If a capability is absent from these pages, it is not part of the documented workflow.

Current documented configuration

The documented API covers:

• uniform Cartesian Yee RF workflows
• PEC and CPML boundaries, plus UPML within its documented limits
• point/current sources
• lumped and wire ports
• specialized microstrip-line ports
• waveguide ports
• one-port coaxial line reflection with float32 precision, a nonperiodic 3D second-order uniform Yee grid, CPML on all six boundary faces with positive thickness on both z faces, cpml_axes="z", and exactly one face="top" coaxial port; Sources and Ports lists the method’s self-contained model and accepted arguments
• probes, Harminv resonance, benchmarked NTFF, and S-parameters only within the stated validation limits

For the exact configuration and restrictions, see Recommended Configuration and Support Boundaries.