vmec_jax.external_fields.baseΒΆ

Provider dispatch for external free-boundary magnetic fields.

This module deliberately keeps the public internal API function-first: provider parameters are pytrees and sampling is a pure function. The legacy mgrid path remains the VMEC2000-compatibility backend, while direct_coils is the differentiable single-stage optimization backend.

Functions

broadcast_cylindrical_coordinates(R, Z, phi)

Return broadcasted cylindrical coordinates as JAX arrays.

sample_external_field_cylindrical(...)

Sample an external magnetic field in cylindrical components.

Classes

ExternalFieldProviderConfig(kind[, static])

Static metadata for an external-field provider.

ExternalFieldSample(br, bphi, bz)

Cylindrical magnetic-field components sampled on a VMEC boundary grid.