gvec.quantities

GVEC Postprocessing - computable quantities

This module defines various quantities and their computation functions for the GVEC package.

The module contains functions that compute different physical quantities such as rotational transform and pressure profiles, coordinate mappings and their derivatives, magnetic field, current density and more.

These functions are registered with compute.QUANTITIES using the @register function decorator.

gvec.quantities.B(ds: Dataset)

gvec.quantities.B_contra_t_B(ds: Dataset)

gvec.quantities.B_contra_z_B(ds: Dataset)

gvec.quantities.B_theta_avg(ds: Dataset)

gvec.quantities.B_zeta_avg(ds: Dataset)

gvec.quantities.F(ds: Dataset)

gvec.quantities.F_r_avg(ds: Dataset)

gvec.quantities.I_pol(ds: Dataset)

gvec.quantities.I_tor(ds: Dataset)

gvec.quantities.J(ds: Dataset)

gvec.quantities.Jac(ds: Dataset)

gvec.quantities.Jac_B(ds: Dataset)

gvec.quantities.Jac_P(ds: Dataset)

gvec.quantities.Jac_derivs(ds: Dataset)

gvec.quantities.Jac_h(ds: Dataset)

gvec.quantities.Jac_h_derivs(ds: Dataset, state: State)

gvec.quantities.LA(ds: Dataset, state: State)

gvec.quantities.N_FP(ds: Dataset, state: State)

gvec.quantities.Phi(ds: Dataset, state: State)

gvec.quantities.Phi_edge(ds: Dataset, state: State)

gvec.quantities.V(ds: Dataset)

gvec.quantities.W_MHD(ds: Dataset)

gvec.quantities.X1(ds: Dataset, state: State)

gvec.quantities.X2(ds: Dataset, state: State)

gvec.quantities.chi(ds: Dataset, state: State)

gvec.quantities.dB(ds: Dataset)

gvec.quantities.dNU_B_dt(ds: Dataset)

gvec.quantities.dNU_B_dz(ds: Dataset)

gvec.quantities.dPhi_dr(ds: Dataset, state: State)

gvec.quantities.dPhi_drr(ds: Dataset, state: State)

gvec.quantities.dV_dPhi_n(ds: Dataset)

gvec.quantities.dV_dPhi_n2(ds: Dataset)

gvec.quantities.dchi_dr(ds: Dataset, state: State)

gvec.quantities.dchi_drr(ds: Dataset, state: State)

gvec.quantities.diota_dr(ds: Dataset, state: State)

gvec.quantities.diota_drr(ds: Dataset, state: State)

gvec.quantities.dp_dr(ds: Dataset, state: State)

gvec.quantities.dp_drr(ds: Dataset, state: State)

gvec.quantities.e_rho(ds: Dataset)

gvec.quantities.e_theta(ds: Dataset)

gvec.quantities.e_theta_B(ds: Dataset)

gvec.quantities.e_zeta(ds: Dataset)

gvec.quantities.e_zeta_B(ds: Dataset)

gvec.quantities.g_rr(ds: Dataset)

gvec.quantities.g_rt(ds: Dataset)

gvec.quantities.g_rz(ds: Dataset)

gvec.quantities.g_tt(ds: Dataset)

gvec.quantities.g_tz(ds: Dataset)

gvec.quantities.g_zz(ds: Dataset)

gvec.quantities.gamma(ds: Dataset)

gvec.quantities.grad_rho(ds: Dataset)

gvec.quantities.grad_theta(ds: Dataset)

gvec.quantities.grad_theta_P(ds: Dataset)

gvec.quantities.grad_zeta(ds: Dataset)

gvec.quantities.hmap(ds: Dataset, state: State)

gvec.quantities.iota(ds: Dataset, state: State)

gvec.quantities.iota_0(ds: Dataset)

gvec.quantities.iota_avg(ds: Dataset)

gvec.quantities.iota_curr(ds: Dataset)

gvec.quantities.iota_curr_0(ds: Dataset)

gvec.quantities.metric(ds: Dataset, state: State)

gvec.quantities.minor_major_radius(ds: Dataset)

gvec.quantities.mu0(ds: Dataset)

gvec.quantities.p(ds: Dataset, state: State)

gvec.quantities.shear(ds: Dataset)

gvec.quantities.theta_P(ds: Dataset)

gvec.quantities.xyz(ds: Dataset)