Skip to content

One name per apparent-wind quantity: va, v_a, _va and va_*... #337

Description

@1-Bort-1

One name per apparent-wind quantity: va, v_a, _va and va_* made consistent

Third of the three parts of #147 (Refactoring part III). Stack it on #336 (*_array → vector/matrix names).

The convention agreed on #147: ufechner7 proposed va for the scalar norm, va_vec for the vector, and va_dist for the per-panel norms, with _vec as the suffix for any 1D vector. Bart accepted it as long as it holds everywhere, and on 2026-09-16 asked for consistent, readable naming across the package.

Ask Bart before writing code. The convention collides with public API that already uses va for the vector:

  • set_va!(body, va)
  • BodyAerodynamics(...; va=)
  • reinit!(...; va=)
  • the Panel.va field
  • the BodyAerodynamics.va property

The plotting keywords are v_a= for the scalar: plot_polars, plot_combined_analysis and generate_polar_data. Linearize has va_idxs=.

Following the convention literally is a BREAKING rename of those keywords and that field. The alternative keeps the public names and applies the convention to everything else. Those two produce materially different code.

Survey of main at 2b312ea:

  • 54 identifiers and 674 occurrences.
  • Fields mix _va, has_distributed_va, v_a_dist (1D norms, on BodyAerodynamics and LoopResult), VSMSolution._va_dist (P×3 matrix), va_unrefined_dist, and va_norm_dist/va_unit_dist on BaseResult.
  • Locals include va_norm, va_unit, va_ref_vector, va_ref_mag, va_panel_mag, va_input, va_distribution, va1..3, dva_1/2, and delta_va (a positional argument of the exported section_pitch_rate).
  • Examples, tests and docs also call the same quantity vel_app (21), v_app (9, including settings docs) and Uinf (the thesis test port).
  • Unrelated: va/vb in src/obj_adapter/obj_slice.jl:253-260 mean vertex a/b.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions