BREAKING: rename the public apparent-wind API to va / va_vec / va_dist
Second of the two PRs Bart chose with option A on #337 (comment 5705262071). Stack it on the PR from branch agent/337-one-name-per-apparent-wind-quantity-va-v, which renamed every local, argument, test, example and doc and left the public names alone.
Convention (#147): va = speed [m/s], va_vec = 3-vector, va_dist = per-panel speeds, va_vec_dist = per-panel P×3 vectors.
To rename, with a BREAKING changelog entry:
- body_aero.va property (getproperty/setproperty!) -> va_vec; field _va -> va_vec (drops the _ prefix) and has_distributed_va
- va= keyword of BodyAerodynamics(...) and reinit! -> va_vec=
- Panel.va field -> va_vec
- VSMSolution._va_dist -> va_vec_dist; va_unrefined_dist -> va_vec_unrefined_dist
- BaseResult.va_norm_dist -> va_dist
- v_a_dist fields on BodyAerodynamics and LoopResult: this is |v_rel x y_airf|, not the apparent wind speed; locals are already v_rel_dist
- SemiInfiniteFilament.vel_mag -> va
- v_a= keyword of plot_polars / plot_combined_analysis -> va=
- linearize va_idxs= -> va_vec_idxs=, and the "va_ref" result key, which holds a vector
- YAML airfoil.v_app (AirfoilSettings.v_app) -> va, and condition.wind_speed (ConditionSettings), which is also the apparent wind speed
Before writing code, ask whether each renamed name should keep a depwarn alias. Option C (deprecations) was not chosen, but body_aero.va silently switching to a scalar would be worse than an error. SymbolicAWEModels reads ._va, panel.va and solver.lr.v_a_dist, so it needs a follow-up PR.
BREAKING: rename the public apparent-wind API to va / va_vec / va_dist
Second of the two PRs Bart chose with option A on #337 (comment 5705262071). Stack it on the PR from branch agent/337-one-name-per-apparent-wind-quantity-va-v, which renamed every local, argument, test, example and doc and left the public names alone.
Convention (#147): va = speed [m/s], va_vec = 3-vector, va_dist = per-panel speeds, va_vec_dist = per-panel P×3 vectors.
To rename, with a BREAKING changelog entry:
Before writing code, ask whether each renamed name should keep a depwarn alias. Option C (deprecations) was not chosen, but body_aero.va silently switching to a scalar would be worse than an error. SymbolicAWEModels reads ._va, panel.va and solver.lr.v_a_dist, so it needs a follow-up PR.