rfx Documentation
rfx is a JAX-based differentiable FDTD simulator for RF and microwave engineering.
How to read these docs
Section titled “How to read these docs”| Lane | What to expect |
|---|---|
| Recommended default | uniform Cartesian Yee RF workflows: cavity, waveguide, patch-style resonance, probes, Harminv, selected S-parameter workflows, and benchmarked far-field workflows |
| Experimental / under active validation | non-uniform mesh, distributed execution, Floquet/Bloch, SBP-SAT subgridding, coaxial and advanced port workflows, and inverse-design extensions |
Start with the recommended default lane unless you specifically need an experimental feature.
Getting Started
Section titled “Getting Started”| Guide | Description |
|---|---|
| Installation | Python/JAX install, GPU notes, dev setup |
| Quick Start | First simulation with the current high-level API |
| Your First Patch Antenna | First end-to-end resonance workflow |
Modeling & Setup
Section titled “Modeling & Setup”| Guide | Description |
|---|---|
| Simulation API | Simulation, Result, materials, sources, probes, ports, and NTFF helpers |
| Materials & Geometry | Material library, Debye/Lorentz models, CSG shapes, and PCB stackup basics |
| Sources & Ports | Soft sources, lumped/wire ports, waveguide ports, and experimental port surfaces |
| Probes & S-Parameters | DFT probes, S-matrix helpers, Harminv, de-embedding, and exports |
| Non-Uniform Mesh | Experimental thin-substrate mesh workflows |
| Waveguide Ports | Modal waveguide excitation and S-matrix extraction |
| Floquet Ports | Experimental Bloch-periodic unit-cell workflows |
Analysis & Validation
Section titled “Analysis & Validation”| Guide | Description |
|---|---|
| Validation | Public validation overview and support status |
| Convergence Study | Mesh-refinement workflow |
| Far-Field & RCS | NTFF radiation patterns and scattering workflows |
| Antenna Metrics | Gain, efficiency, beamwidth, bandwidth, and front-to-back ratio |
| Visualization & Analysis | Plots, exports, post-processing, and result interpretation |
| Solver Comparison | Feature and workflow comparison vs. Meep and OpenEMS |
Design & Optimization
Section titled “Design & Optimization”| Guide | Description |
|---|---|
| Inverse Design | Gradient-based optimization and advanced objectives |
| Topology Optimization | Density-based inverse design with filtering and projection |
| Parametric Sweeps | Sequential sweeps and jax.vmap batch evaluation |
| Material Fitting | CSV import, Debye/Lorentz fitting, and differentiable fitting workflows |
| Patch Antenna Design | Practical rectangular patch workflow |
| Microstrip Filter Design | Experimental coupled-line filter workflow |
Advanced / Experimental
Section titled “Advanced / Experimental”| Guide | Description |
|---|---|
| Advanced Features | Distributed runs, material fitting, mixed precision, nonlinear materials, and advanced workflows |
| Conformal PEC | Dey-Mittra method for curved PEC conductors |
| SBP-SAT Subgridding | Experimental local mesh refinement |
| Gradient Behavior | Where gradients are strong, weak, or noisy |
| Geometry & Limitations | Supported workflows, strengths, and current trade-offs |
Secondary hubs
Section titled “Secondary hubs”- Examples — recommended public runnable paths
- Validation — support and validation overview
- API — curated public API contract
- Generated API — subordinate generated symbol reference
Quick Links
Section titled “Quick Links”- GitHub: bk-squared/rfx
- Public docs snapshot: remilab.ai/rfx
- Top-level API exports:
rfx.__init__ - Package metadata:
pyproject.toml