gvec.surface

pyGVEC postprocessing - Surface representation

This module provides a Surface class for representing a flux surface in 3D. Currently this surface is always defined in terms of the Boozer angles (theta_B, zeta_B).

gvec.surface.II_tt_B(ds: Dataset)

gvec.surface.II_tz_B(ds: Dataset)

gvec.surface.II_zz_B(ds: Dataset)

gvec.surface.e_theta_B(ds: Dataset)

gvec.surface.e_zeta_B(ds: Dataset)

gvec.surface.g_tt_B(ds: Dataset)

gvec.surface.g_tz_B(ds: Dataset)

gvec.surface.g_zz_B(ds: Dataset)

gvec.surface.get_xyz_hat(ds: Dataset, winding: int | None = None)

Compute the xhat, yhat, zhat coordiantes for a dataset with pointwise x, y, z, zeta coordinates.

gvec.surface.init_surface(pos: DataArray, nfp: int | DataArray = 1, ift: Literal['fft', 'eval'] | None = None, winding: int = 1) → Dataset

gvec.surface.k_tt_B(ds: Dataset)

gvec.surface.k_tz_B(ds: Dataset)

gvec.surface.k_zz_B(ds: Dataset)

gvec.surface.normal(ds: Dataset)

gvec.surface.pos(ds: Dataset)

gvec.surface.xyz(ds: Dataset)