Skip to content

Support Boundaries

This page gives the public support summary without internal validation details.

StatusMeaning
recommended defaultbest place to start for public examples and ordinary RF workflows
experimental / under active validationuseful, but support boundaries are narrower
unsupportedshould fail clearly rather than degrade silently
DimensionRecommended subset
grid / runneruniform Cartesian Yee
boundariesPEC, CPML, bounded UPML
sourcespoint/current, lumped port, wire port, specialized microstrip-line port, rectangular waveguide port
observablesprobes, flux, Harminv resonance, selected S-parameter workflows, documented far-field workflows
materialsisotropic linear, conductive, and documented dispersive subsets
workflowscavity, waveguide, patch-style resonance, simple scattering, de-embedding, selected differentiable proxy objectives
PrimitiveCalculation APIPublic status
lumped/wire add_port(...)run(compute_s_params=True)recommended for the matching port family
lumped/wire add_port(...)forward(port_s11_freqs=...)differentiable S11 vectors on the uniform single-device path
add_msl_port(...)compute_msl_s_matrix()specialized microstrip-line workflow
add_waveguide_port(...)compute_waveguide_s_matrix()rectangular waveguide workflow
add_coaxial_port(...)experimentalunder active validation
add_floquet_port(...)experimentalperiodic / unit-cell workflow under active validation
sources, TFSF, probes, flux monitorsnot port calculatorsfield/flux/time observables
LanePublic note
non-uniform meshuseful for thin-substrate experiments; not the default lane
SBP-SAT / subgriddingexperimental local mesh refinement
ADIexperimental accuracy/stability lane
distributed executionscaling lane; check feature combinations
Floquet/Blochexperimental periodic/unit-cell workflow
coaxial and advanced portsunder active validation
inverse-design extensionsavailable for selected workflows; check current examples

Unsupported combinations should fail clearly. Common examples include mixing non-uniform mesh with Floquet, TFSF, broad DFT-plane workflows, MSL S-matrix extraction, coaxial ports, or lumped RLC unless the relevant guide explicitly says that combination is supported.

If the workflow is not in the recommended default lane, describe it as experimental or under active validation and link to the current example or limitation page.