Reduced representations
VAFT holds many reduced descriptions of one plasma state: $q(\rho) \to q_{95}$, $B_p \to l_i$, $\langle p\rangle \to \beta$, and $T, B, a \to \rho_*$. Each output may be a scalar, but they are different operations. The first extracts a feature, the second is a quadratic integral, and the third and fourth are normalisations. The third also needs a volume average first. This page classifies them on four independent axes:
| Axis | Values | Question |
|---|---|---|
| spatial representation | field_3d, field_2d, profile_1d, scalar_0d, flux_surface_quantity, boundary_quantity, time_series |
what space the input and the output live in |
| reduction kind | integral, moment, quadratic_integral, weighted_average, projection, feature_extraction, extremum, differential, normalization, dimensionless_normalization, similarity_transform, closure, empirical_scaling |
which mathematical operation it is |
| locality | point_local, flux_surface_local, edge, global |
where the result is defined |
| physical role | state_coordinate, profile_descriptor, global_descriptor, regime_coordinate, similarity_coordinate, stability_coordinate, closure_input, closure_output |
why the reduced quantity is useful |
Dimensionless is not 0-D. A local $\nu^*(\rho)$ is a dimensionless_normalization with a
profile_1d output, and a global $\beta$ is one with a scalar_0d output. Likewise, $l_i$ is a quadratic
integral of $B_p$, not a moment of $j_\phi$.
reduced_representation_hierarchy_compact() draws the same axes and arrows with only the symbols in each
box, for slides and overview pages.
Declaring it
The formula’s docstring is the single source of truth. A formula declares its place in the taxonomy with
a Reduction section:
Reduction
---------
input: field_2d
output: scalar_0d
kind: quadratic_integral
locality: global
role: global_descriptor
The vocabulary lives in vaft/formula/_taxonomy.py. The catalog validates every value against it:
- a missing, repeated or unknown key is an error;
- so is a value outside the vocabulary;
- so is a
dimensionless_normalization,similarity_transformorsimilarity_coordinatewhose return unit is not-.
vaft.formula.describe(name).reduction exposes it. list_formulas(reduction_kind=..., locality=...,
role=..., output_representation=...) filters on it. The generated catalog snapshot carries it as
reduction, which is where the tables below come from. Generic numerical helpers carry no Reduction
section, because the taxonomy says nothing useful about them.
Families
Each graph is the relation metadata in vaft.formula._taxonomy.REDUCTION_FAMILIES, laid out by
vaft.diagram.reduction_graph. When an edge names a formula, its reduction kind is read from that formula’s
catalog entry, so the figure cannot disagree with the docstrings. A dashed edge is a step VAFT performs
elsewhere, such as a flux-surface average or a profile feature, and states its own kind.
Current and $q$
Both $B_p$ and $j_\phi$ derive from the poloidal flux. $B_p = |\nabla\psi|/R$, and Ampère’s law in Grad–Shafranov form is $\Delta^*\psi = -\mu_0Rj_\phi$. $B_\theta(r)$ is the same poloidal field, flux-surface averaged into the cylindrical profile that $q$ is computed from.
Pressure and energy
Kinetic profiles
Dimensionless similarity
The $\nu_$ and $\rho_$ here are the Verdoolaege engineering forms. The other definitions VAFT carries are tracked in #353 and are not declared equivalent.
Generated tables
By spatial mapping
field 2d + scalar 0d → scalar 0d
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
virial_beta_p_from_volume | field 2d + scalar 0d → scalar 0d | integral | global | global descriptor |
virial_li_from_volume | field 2d + scalar 0d → scalar 0d | quadratic integral | global | global descriptor |
field 2d → scalar 0d
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
virial_magnetic_energy | field 2d → scalar 0d | quadratic integral | global | global descriptor |
virial_thermal_energy | field 2d → scalar 0d | integral | global | global descriptor |
profile 1d → profile 1d
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
ballooning_alpha_from_p_B_R | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
cylindrical_poloidal_field | profile 1d → profile 1d | normalization | flux surface local | profile descriptor |
cylindrical_safety_factor_from_r_B | profile 1d → profile 1d | normalization | flux surface local | state coordinate |
electron_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
ion_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
normalized_gradient_scale_length | profile 1d → profile 1d | differential | flux surface local | closure input |
shear_from_r_q | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
profile 1d → scalar 0d
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
kadomtsev_mixing_radius | profile 1d → scalar 0d | feature extraction | global | profile descriptor |
scalar 0d → scalar 0d
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
beta_normal_from_beta_tor | scalar 0d → scalar 0d | normalization | global | stability coordinate |
beta_poloidal_from_pressure_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
beta_toroidal_from_p_B0 | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
calculate_peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
confinement_time_from_engineering_parameters | scalar 0d → scalar 0d | empirical scaling | global | closure output |
dimensionless_scaling_coeffs_from_engineering_scaling_coeffs | scalar 0d → scalar 0d | similarity transform | global | similarity coordinate |
estimated_q95 | scalar 0d → scalar 0d | closure | global | global descriptor |
greenwald_fraction | scalar 0d → scalar 0d | dimensionless normalization | global | regime coordinate |
kinetic_energy_from_beta_p_B_pa_V_p | scalar 0d → scalar 0d | normalization | global | global descriptor |
li_1_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
li_3_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
nu_star_from_n_T_B_R_epsilon_kappa_I | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
omega_i_tau_E_from_B_tau_E_M | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
rho_star_from_M_T_B_R_epsilon | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
rhostar_from_Te_a_Bt | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
stored_energy_from_p_V | scalar 0d → scalar 0d | integral | global | global descriptor |
By reduction kind
closure
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
estimated_q95 | scalar 0d → scalar 0d | closure | global | global descriptor |
differential
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
ballooning_alpha_from_p_B_R | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
normalized_gradient_scale_length | profile 1d → profile 1d | differential | flux surface local | closure input |
shear_from_r_q | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
dimensionless normalization
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
beta_poloidal_from_pressure_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
beta_toroidal_from_p_B0 | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
calculate_peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
electron_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
greenwald_fraction | scalar 0d → scalar 0d | dimensionless normalization | global | regime coordinate |
ion_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
li_1_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
li_3_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
nu_star_from_n_T_B_R_epsilon_kappa_I | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
omega_i_tau_E_from_B_tau_E_M | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
rho_star_from_M_T_B_R_epsilon | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
rhostar_from_Te_a_Bt | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
empirical scaling
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
confinement_time_from_engineering_parameters | scalar 0d → scalar 0d | empirical scaling | global | closure output |
feature extraction
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
kadomtsev_mixing_radius | profile 1d → scalar 0d | feature extraction | global | profile descriptor |
integral
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
stored_energy_from_p_V | scalar 0d → scalar 0d | integral | global | global descriptor |
virial_beta_p_from_volume | field 2d + scalar 0d → scalar 0d | integral | global | global descriptor |
virial_thermal_energy | field 2d → scalar 0d | integral | global | global descriptor |
normalization
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
beta_normal_from_beta_tor | scalar 0d → scalar 0d | normalization | global | stability coordinate |
cylindrical_poloidal_field | profile 1d → profile 1d | normalization | flux surface local | profile descriptor |
cylindrical_safety_factor_from_r_B | profile 1d → profile 1d | normalization | flux surface local | state coordinate |
kinetic_energy_from_beta_p_B_pa_V_p | scalar 0d → scalar 0d | normalization | global | global descriptor |
quadratic integral
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
virial_li_from_volume | field 2d + scalar 0d → scalar 0d | quadratic integral | global | global descriptor |
virial_magnetic_energy | field 2d → scalar 0d | quadratic integral | global | global descriptor |
similarity transform
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
dimensionless_scaling_coeffs_from_engineering_scaling_coeffs | scalar 0d → scalar 0d | similarity transform | global | similarity coordinate |
By locality
flux surface local
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
ballooning_alpha_from_p_B_R | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
cylindrical_poloidal_field | profile 1d → profile 1d | normalization | flux surface local | profile descriptor |
cylindrical_safety_factor_from_r_B | profile 1d → profile 1d | normalization | flux surface local | state coordinate |
electron_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
ion_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
normalized_gradient_scale_length | profile 1d → profile 1d | differential | flux surface local | closure input |
shear_from_r_q | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
global
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
beta_normal_from_beta_tor | scalar 0d → scalar 0d | normalization | global | stability coordinate |
beta_poloidal_from_pressure_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
beta_toroidal_from_p_B0 | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
calculate_peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
confinement_time_from_engineering_parameters | scalar 0d → scalar 0d | empirical scaling | global | closure output |
dimensionless_scaling_coeffs_from_engineering_scaling_coeffs | scalar 0d → scalar 0d | similarity transform | global | similarity coordinate |
estimated_q95 | scalar 0d → scalar 0d | closure | global | global descriptor |
greenwald_fraction | scalar 0d → scalar 0d | dimensionless normalization | global | regime coordinate |
kadomtsev_mixing_radius | profile 1d → scalar 0d | feature extraction | global | profile descriptor |
kinetic_energy_from_beta_p_B_pa_V_p | scalar 0d → scalar 0d | normalization | global | global descriptor |
li_1_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
li_3_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
nu_star_from_n_T_B_R_epsilon_kappa_I | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
omega_i_tau_E_from_B_tau_E_M | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
rho_star_from_M_T_B_R_epsilon | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
rhostar_from_Te_a_Bt | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
stored_energy_from_p_V | scalar 0d → scalar 0d | integral | global | global descriptor |
virial_beta_p_from_volume | field 2d + scalar 0d → scalar 0d | integral | global | global descriptor |
virial_li_from_volume | field 2d + scalar 0d → scalar 0d | quadratic integral | global | global descriptor |
virial_magnetic_energy | field 2d → scalar 0d | quadratic integral | global | global descriptor |
virial_thermal_energy | field 2d → scalar 0d | integral | global | global descriptor |
By physical role
closure input
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
normalized_gradient_scale_length | profile 1d → profile 1d | differential | flux surface local | closure input |
closure output
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
confinement_time_from_engineering_parameters | scalar 0d → scalar 0d | empirical scaling | global | closure output |
global descriptor
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
beta_poloidal_from_pressure_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
beta_toroidal_from_p_B0 | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
estimated_q95 | scalar 0d → scalar 0d | closure | global | global descriptor |
kinetic_energy_from_beta_p_B_pa_V_p | scalar 0d → scalar 0d | normalization | global | global descriptor |
li_1_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
li_3_from_Bp2_volume_integral | scalar 0d → scalar 0d | dimensionless normalization | global | global descriptor |
stored_energy_from_p_V | scalar 0d → scalar 0d | integral | global | global descriptor |
virial_beta_p_from_volume | field 2d + scalar 0d → scalar 0d | integral | global | global descriptor |
virial_li_from_volume | field 2d + scalar 0d → scalar 0d | quadratic integral | global | global descriptor |
virial_magnetic_energy | field 2d → scalar 0d | quadratic integral | global | global descriptor |
virial_thermal_energy | field 2d → scalar 0d | integral | global | global descriptor |
profile descriptor
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
calculate_peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
cylindrical_poloidal_field | profile 1d → profile 1d | normalization | flux surface local | profile descriptor |
kadomtsev_mixing_radius | profile 1d → scalar 0d | feature extraction | global | profile descriptor |
peaking_factor | scalar 0d → scalar 0d | dimensionless normalization | global | profile descriptor |
regime coordinate
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
electron_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
greenwald_fraction | scalar 0d → scalar 0d | dimensionless normalization | global | regime coordinate |
ion_collisionality_sauter | profile 1d → profile 1d | dimensionless normalization | flux surface local | regime coordinate |
similarity coordinate
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
dimensionless_scaling_coeffs_from_engineering_scaling_coeffs | scalar 0d → scalar 0d | similarity transform | global | similarity coordinate |
nu_star_from_n_T_B_R_epsilon_kappa_I | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
omega_i_tau_E_from_B_tau_E_M | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
rho_star_from_M_T_B_R_epsilon | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
rhostar_from_Te_a_Bt | scalar 0d → scalar 0d | dimensionless normalization | global | similarity coordinate |
stability coordinate
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
ballooning_alpha_from_p_B_R | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
beta_normal_from_beta_tor | scalar 0d → scalar 0d | normalization | global | stability coordinate |
shear_from_r_q | profile 1d → profile 1d | differential | flux surface local | stability coordinate |
state coordinate
| Formula | Mapping | Kind | Locality | Role |
|---|---|---|---|---|
cylindrical_safety_factor_from_r_B | profile 1d → profile 1d | normalization | flux surface local | state coordinate |