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 representations

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_transform or similarity_coordinate whose 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.

current and q

Pressure and energy

pressure and energy

Kinetic profiles

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.

dimensionless similarity

Generated tables

By spatial mapping

field 2d + scalar 0d → scalar 0d

FormulaMappingKindLocalityRole
virial_beta_p_from_volumefield 2d + scalar 0d → scalar 0dintegralglobalglobal descriptor
virial_li_from_volumefield 2d + scalar 0d → scalar 0dquadratic integralglobalglobal descriptor

field 2d → scalar 0d

FormulaMappingKindLocalityRole
virial_magnetic_energyfield 2d → scalar 0dquadratic integralglobalglobal descriptor
virial_thermal_energyfield 2d → scalar 0dintegralglobalglobal descriptor

profile 1d → profile 1d

FormulaMappingKindLocalityRole
ballooning_alpha_from_p_B_Rprofile 1d → profile 1ddifferentialflux surface localstability coordinate
cylindrical_poloidal_fieldprofile 1d → profile 1dnormalizationflux surface localprofile descriptor
cylindrical_safety_factor_from_r_Bprofile 1d → profile 1dnormalizationflux surface localstate coordinate
electron_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
ion_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
normalized_gradient_scale_lengthprofile 1d → profile 1ddifferentialflux surface localclosure input
shear_from_r_qprofile 1d → profile 1ddifferentialflux surface localstability coordinate

profile 1d → scalar 0d

FormulaMappingKindLocalityRole
kadomtsev_mixing_radiusprofile 1d → scalar 0dfeature extractionglobalprofile descriptor

scalar 0d → scalar 0d

FormulaMappingKindLocalityRole
beta_normal_from_beta_torscalar 0d → scalar 0dnormalizationglobalstability coordinate
beta_poloidal_from_pressure_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
beta_toroidal_from_p_B0scalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
calculate_peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
confinement_time_from_engineering_parametersscalar 0d → scalar 0dempirical scalingglobalclosure output
dimensionless_scaling_coeffs_from_engineering_scaling_coeffsscalar 0d → scalar 0dsimilarity transformglobalsimilarity coordinate
estimated_q95scalar 0d → scalar 0dclosureglobalglobal descriptor
greenwald_fractionscalar 0d → scalar 0ddimensionless normalizationglobalregime coordinate
kinetic_energy_from_beta_p_B_pa_V_pscalar 0d → scalar 0dnormalizationglobalglobal descriptor
li_1_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
li_3_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
nu_star_from_n_T_B_R_epsilon_kappa_Iscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
omega_i_tau_E_from_B_tau_E_Mscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
rho_star_from_M_T_B_R_epsilonscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
rhostar_from_Te_a_Btscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
stored_energy_from_p_Vscalar 0d → scalar 0dintegralglobalglobal descriptor

By reduction kind

closure

FormulaMappingKindLocalityRole
estimated_q95scalar 0d → scalar 0dclosureglobalglobal descriptor

differential

FormulaMappingKindLocalityRole
ballooning_alpha_from_p_B_Rprofile 1d → profile 1ddifferentialflux surface localstability coordinate
normalized_gradient_scale_lengthprofile 1d → profile 1ddifferentialflux surface localclosure input
shear_from_r_qprofile 1d → profile 1ddifferentialflux surface localstability coordinate

dimensionless normalization

FormulaMappingKindLocalityRole
beta_poloidal_from_pressure_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
beta_toroidal_from_p_B0scalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
calculate_peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
electron_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
greenwald_fractionscalar 0d → scalar 0ddimensionless normalizationglobalregime coordinate
ion_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
li_1_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
li_3_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
nu_star_from_n_T_B_R_epsilon_kappa_Iscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
omega_i_tau_E_from_B_tau_E_Mscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
rho_star_from_M_T_B_R_epsilonscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
rhostar_from_Te_a_Btscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate

empirical scaling

FormulaMappingKindLocalityRole
confinement_time_from_engineering_parametersscalar 0d → scalar 0dempirical scalingglobalclosure output

feature extraction

FormulaMappingKindLocalityRole
kadomtsev_mixing_radiusprofile 1d → scalar 0dfeature extractionglobalprofile descriptor

integral

FormulaMappingKindLocalityRole
stored_energy_from_p_Vscalar 0d → scalar 0dintegralglobalglobal descriptor
virial_beta_p_from_volumefield 2d + scalar 0d → scalar 0dintegralglobalglobal descriptor
virial_thermal_energyfield 2d → scalar 0dintegralglobalglobal descriptor

normalization

FormulaMappingKindLocalityRole
beta_normal_from_beta_torscalar 0d → scalar 0dnormalizationglobalstability coordinate
cylindrical_poloidal_fieldprofile 1d → profile 1dnormalizationflux surface localprofile descriptor
cylindrical_safety_factor_from_r_Bprofile 1d → profile 1dnormalizationflux surface localstate coordinate
kinetic_energy_from_beta_p_B_pa_V_pscalar 0d → scalar 0dnormalizationglobalglobal descriptor

quadratic integral

FormulaMappingKindLocalityRole
virial_li_from_volumefield 2d + scalar 0d → scalar 0dquadratic integralglobalglobal descriptor
virial_magnetic_energyfield 2d → scalar 0dquadratic integralglobalglobal descriptor

similarity transform

FormulaMappingKindLocalityRole
dimensionless_scaling_coeffs_from_engineering_scaling_coeffsscalar 0d → scalar 0dsimilarity transformglobalsimilarity coordinate

By locality

flux surface local

FormulaMappingKindLocalityRole
ballooning_alpha_from_p_B_Rprofile 1d → profile 1ddifferentialflux surface localstability coordinate
cylindrical_poloidal_fieldprofile 1d → profile 1dnormalizationflux surface localprofile descriptor
cylindrical_safety_factor_from_r_Bprofile 1d → profile 1dnormalizationflux surface localstate coordinate
electron_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
ion_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
normalized_gradient_scale_lengthprofile 1d → profile 1ddifferentialflux surface localclosure input
shear_from_r_qprofile 1d → profile 1ddifferentialflux surface localstability coordinate

global

FormulaMappingKindLocalityRole
beta_normal_from_beta_torscalar 0d → scalar 0dnormalizationglobalstability coordinate
beta_poloidal_from_pressure_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
beta_toroidal_from_p_B0scalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
calculate_peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
confinement_time_from_engineering_parametersscalar 0d → scalar 0dempirical scalingglobalclosure output
dimensionless_scaling_coeffs_from_engineering_scaling_coeffsscalar 0d → scalar 0dsimilarity transformglobalsimilarity coordinate
estimated_q95scalar 0d → scalar 0dclosureglobalglobal descriptor
greenwald_fractionscalar 0d → scalar 0ddimensionless normalizationglobalregime coordinate
kadomtsev_mixing_radiusprofile 1d → scalar 0dfeature extractionglobalprofile descriptor
kinetic_energy_from_beta_p_B_pa_V_pscalar 0d → scalar 0dnormalizationglobalglobal descriptor
li_1_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
li_3_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
nu_star_from_n_T_B_R_epsilon_kappa_Iscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
omega_i_tau_E_from_B_tau_E_Mscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
rho_star_from_M_T_B_R_epsilonscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
rhostar_from_Te_a_Btscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
stored_energy_from_p_Vscalar 0d → scalar 0dintegralglobalglobal descriptor
virial_beta_p_from_volumefield 2d + scalar 0d → scalar 0dintegralglobalglobal descriptor
virial_li_from_volumefield 2d + scalar 0d → scalar 0dquadratic integralglobalglobal descriptor
virial_magnetic_energyfield 2d → scalar 0dquadratic integralglobalglobal descriptor
virial_thermal_energyfield 2d → scalar 0dintegralglobalglobal descriptor

By physical role

closure input

FormulaMappingKindLocalityRole
normalized_gradient_scale_lengthprofile 1d → profile 1ddifferentialflux surface localclosure input

closure output

FormulaMappingKindLocalityRole
confinement_time_from_engineering_parametersscalar 0d → scalar 0dempirical scalingglobalclosure output

global descriptor

FormulaMappingKindLocalityRole
beta_poloidal_from_pressure_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
beta_toroidal_from_p_B0scalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
estimated_q95scalar 0d → scalar 0dclosureglobalglobal descriptor
kinetic_energy_from_beta_p_B_pa_V_pscalar 0d → scalar 0dnormalizationglobalglobal descriptor
li_1_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
li_3_from_Bp2_volume_integralscalar 0d → scalar 0ddimensionless normalizationglobalglobal descriptor
stored_energy_from_p_Vscalar 0d → scalar 0dintegralglobalglobal descriptor
virial_beta_p_from_volumefield 2d + scalar 0d → scalar 0dintegralglobalglobal descriptor
virial_li_from_volumefield 2d + scalar 0d → scalar 0dquadratic integralglobalglobal descriptor
virial_magnetic_energyfield 2d → scalar 0dquadratic integralglobalglobal descriptor
virial_thermal_energyfield 2d → scalar 0dintegralglobalglobal descriptor

profile descriptor

FormulaMappingKindLocalityRole
calculate_peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor
cylindrical_poloidal_fieldprofile 1d → profile 1dnormalizationflux surface localprofile descriptor
kadomtsev_mixing_radiusprofile 1d → scalar 0dfeature extractionglobalprofile descriptor
peaking_factorscalar 0d → scalar 0ddimensionless normalizationglobalprofile descriptor

regime coordinate

FormulaMappingKindLocalityRole
electron_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate
greenwald_fractionscalar 0d → scalar 0ddimensionless normalizationglobalregime coordinate
ion_collisionality_sauterprofile 1d → profile 1ddimensionless normalizationflux surface localregime coordinate

similarity coordinate

FormulaMappingKindLocalityRole
dimensionless_scaling_coeffs_from_engineering_scaling_coeffsscalar 0d → scalar 0dsimilarity transformglobalsimilarity coordinate
nu_star_from_n_T_B_R_epsilon_kappa_Iscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
omega_i_tau_E_from_B_tau_E_Mscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
rho_star_from_M_T_B_R_epsilonscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate
rhostar_from_Te_a_Btscalar 0d → scalar 0ddimensionless normalizationglobalsimilarity coordinate

stability coordinate

FormulaMappingKindLocalityRole
ballooning_alpha_from_p_B_Rprofile 1d → profile 1ddifferentialflux surface localstability coordinate
beta_normal_from_beta_torscalar 0d → scalar 0dnormalizationglobalstability coordinate
shear_from_r_qprofile 1d → profile 1ddifferentialflux surface localstability coordinate

state coordinate

FormulaMappingKindLocalityRole
cylindrical_safety_factor_from_r_Bprofile 1d → profile 1dnormalizationflux surface localstate coordinate

results matching ""

    No results matching ""