essos.fields¶

Classes¶

`BiotSavart`
`BiotSavart_from_gamma`
`Vmec`
`near_axis`

Functions¶

`d_dtheta_fft`(f_theta)
`d2_dtheta2_fft`(f_theta)
`gamma_dash_from_gamma`(gamma)
`gamma_dashdash_from_gamma`(gamma)

Module Contents¶

class essos.fields.BiotSavart(coils)¶

coils¶

currents¶

gamma¶

gamma_dash¶

gamma_dashdash¶

coils_length¶

coils_curvature¶

r_axis¶

z_axis¶

sqrtg(points)¶

B(points)¶

B_covariant(points)¶

B_contravariant(points)¶

AbsB(points)¶

dB_by_dX(points)¶

dAbsB_by_dX(points)¶

grad_B_covariant(points)¶

curl_B(points)¶

curl_b(points)¶

kappa(points)¶

to_xyz(points)¶

essos.fields.d_dtheta_fft(f_theta)¶

essos.fields.d2_dtheta2_fft(f_theta)¶

essos.fields.gamma_dash_from_gamma(gamma)¶

essos.fields.gamma_dashdash_from_gamma(gamma)¶

class essos.fields.BiotSavart_from_gamma(gamma, gamma_dash=None, gamma_dashdash=None, currents=None)¶

currents = None¶

gamma¶

r_axis = None¶

z_axis = None¶

coils_length¶

coils_curvature¶

sqrtg(points)¶

B(points)¶

B_covariant(points)¶

B_contravariant(points)¶

AbsB(points)¶

dB_by_dX(points)¶

dAbsB_by_dX(points)¶

grad_B_covariant(points)¶

curl_B(points)¶

curl_b(points)¶

kappa(points)¶

to_xyz(points)¶

class essos.fields.Vmec(wout_filename, ntheta=50, nphi=50, close=True, range_torus='full torus')¶

wout_filename¶

nc¶

nfp¶

bmnc¶

xm¶

xn¶

rmnc¶

zmns¶

bsubsmns¶

bsubumnc¶

bsubvmnc¶

bsupumnc¶

bsupvmnc¶

gmnc¶

xm_nyq¶

xn_nyq¶

len_xm_nyq¶

ns¶

s_full_grid = None¶

ds¶

s_half_grid¶

r_axis¶

z_axis¶

mpol¶

ntor¶

range_torus = 'full torus'¶

_surface¶

Aminor_p¶

property surface¶

B_covariant(points)¶

B_contravariant(points)¶

sqrtg(points)¶

B(points)¶

AbsB(points)¶

dB_by_dX(points)¶

dAbsB_by_dX(points)¶

grad_B_covariant(points)¶

curl_B(points)¶

curl_b(points)¶

kappa(points)¶

to_xyz(points)¶

class essos.fields.near_axis(rc=jnp.array([1, 0.1]), zs=jnp.array([0, 0.1]), etabar=1.0, B0=1, sigma0=0, I2=0, nphi=31, spsi=1, sG=1, nfp=2, order='r1', B2c=0, p2=0)¶

rc¶

zs¶

etabar = 1.0¶

nphi = 31¶

sigma0 = 0¶

I2 = 0¶

spsi = 1¶

sG = 1¶

B0 = 1¶

nfp = 2¶

order = 'r1'¶

B2c = 0¶

p2 = 0¶

_dofs¶

phi = None¶

nfourier¶

property dofs¶

property x¶

_tree_flatten()¶

classmethod _tree_unflatten(aux_data, children)¶

B_covariant(points)¶

B_contravariant(points)¶

AbsB(points)¶

jacobian(points)¶

calculate(rc, zs, etabar)¶

residual_phi0_of_theta_varphi_func(phi_0, r, theta, varphi)¶

phi_of_theta_varphi(r, theta, varphi)¶

interpolated_array_at_point(array, point)¶

Frenet_to_cylindrical_residual_func(phi0, phi_target, X_at_this_theta, Y_at_this_theta)¶

Frenet_to_cylindrical_1_point(phi0, X_at_this_theta, Y_at_this_theta)¶

Frenet_to_cylindrical(r, ntheta=20, phi_is_varphi=False)¶

to_Fourier(R_2D, Z_2D, nfp, mpol, ntor)¶

get_boundary(r=0.1, ntheta=30, nphi=120, ntheta_fourier=20, mpol=5, ntor=5, phi_is_varphi=False, phi_offset=0.0)¶

B_mag(r, theta, phi)¶

plot(r=0.1, ntheta=40, nphi=120, ntheta_fourier=20, ax=None, show=True, close=False, axis_equal=True, **kwargs)¶

to_vtk(filename, r=0.1, ntheta=40, nphi=120, ntheta_fourier=20, extra_data=None, field=None)¶