Merge pull request #368 from OpenSourceAWE/agent/348-breaking-rename-the-public-apparent-wind

BREAKING: name the public apparent wind va, va_vec and va_dist, with no deprecation aliases

Author: 1-Bart-1

CHANGELOG.md

@@ -7,7 +7,7 @@
 - `stability_derivatives` gives the force and moment coefficients and their derivatives
   with respect to angle of attack and sideslip, and `trim_angle` the angles of attack at
   which `CMy` changes sign, with the slope that says whether each trim is stable.
-- `apparent_wind(alpha, beta, wind_speed)` gives the body-frame inflow vector at an angle
+- `apparent_wind(alpha, beta, va)` gives the body-frame inflow vector at an angle
   of attack and sideslip, as `set_va!(body_aero, settings)` sets it.
 - `Solver(settings)` and `Solver(n_panels, n_unrefined_sections)` build a solver without
   a `BodyAerodynamics`; keyword arguments override the settings.
@@ -30,6 +30,19 @@
 - BREAKING: `ObjAdapter.center_to_com!`, `calculate_inertia_tensor` and
   `calc_inertia_y_rotation` are removed. Mesh mass properties are computed by
   SymbolicAWEModels, which reads the mesh with `read_faces`.
+- BREAKING: the apparent wind is `va` for the speed [m/s], `va_vec` for the 3-vector and
+  `va_dist` / `va_vec_dist` per panel, and the old names error:
+  - `body_aero.va` becomes `body_aero.va_vec`, and `va=` becomes `va_vec=` in
+    `BodyAerodynamics(...)` and `reinit!`.
+  - `Panel.va` becomes `Panel.va_vec`, and `SemiInfiniteFilament.vel_mag` becomes `va`.
+  - On `VSMSolution`, `_va_dist` becomes `va_vec_dist` and `va_unrefined_dist` becomes
+    `va_vec_unrefined_dist`.
+  - `v_a_dist` on `BodyAerodynamics` and `solver.lr` becomes `v_rel_dist`, and
+    `solver.br.va_norm_dist` becomes `va_dist`.
+  - The `linearize` keyword `va_idxs` becomes `va_vec_idxs`, the `calculate_results` key
+    `"va_ref"` becomes `"va_ref_vec"`, and the `plot_polars` / `plot_combined_analysis`
+    keyword `v_a` becomes `va`.
+  - The settings keys `condition.wind_speed` and `airfoil.v_app` become `va`.
 - Requires Julia 1.12 or 1.13; 1.10 and 1.11 keep resolving v5.1.1.
 - The Makie `plot!` methods for a `Panel` or a `BodyAerodynamics` return a
   `Vector{Makie.AbstractPlot}` instead of a `Vector{Any}`; for a `BodyAerodynamics`

data/TUDELFT_V3_KITE/vsm_settings.yaml

@@ -34,7 +34,7 @@
 
 # Define the flight state for the aerodynamic analysis
 condition:
-    wind_speed: 2.82     # [m/s] Free stream velocity magnitude
+    va: 2.82             # [m/s] apparent wind speed
     alpha: 7.4           # [°] Angle of attack (pitch angle relative to flow)
     beta: 0.0            # [°] Sideslip angle (yaw angle relative to flow)
     yaw_rate: 0.0        # [°/s] Yaw rate (for dynamic analysis, 0 for static)

data/TUDELFT_V3_KITE/vsm_settings_coarse.yaml

@@ -36,7 +36,7 @@
 
 # Define the flight state for the aerodynamic analysis
 condition:
-  wind_speed: 10.0 # [m/s] Free stream velocity magnitude
+  va: 10.0 # [m/s] apparent wind speed
   alpha: 0.0 # [°] Angle of attack (pitch angle relative to flow)
   beta: 0.0 # [°] Sideslip angle (yaw angle relative to flow)
   yaw_rate: 0.0 # [°/s] Yaw rate (for dynamic analysis, 0 for static)

data/pyramid_model/vsm_settings.yaml

@@ -34,7 +34,7 @@
 
 # Define the flight state for the aerodynamic analysis
 condition:
-    wind_speed: 10.0     # [m/s] Free stream velocity magnitude
+    va: 10.0             # [m/s] apparent wind speed
     alpha: 5.0           # [°] Angle of attack (pitch angle relative to flow)
     beta: 0.0            # [°] Sideslip angle (yaw angle relative to flow)
     yaw_rate: 0.0        # [°/s] Yaw rate (for dynamic analysis, 0 for static)

docs/src/examples.md

@@ -118,7 +118,7 @@ julia> plot_combined_analysis(
            solver_label=["LLT", "VSM"],
            angle_range=angle_range,
            angle_type="angle_of_attack",
-           v_a=va,
+           va=va,
            title="Rectangular Wing",
            is_show=true,
        )

docs/src/settings.md

@@ -29,7 +29,7 @@ values shown are those defaults, and the docstrings linked below carry the rest.
 
 ```yaml
 condition:
-  wind_speed: 10.0                # free-stream velocity magnitude [m/s]
+  va: 10.0                        # apparent wind speed [m/s]
   alpha: 5.0                      # angle of attack [°]
   beta: 0.0                       # sideslip angle [°]
   yaw_rate: 0.0                   # turn rate about the body z axis [°/s]
@@ -67,7 +67,7 @@ wings:
       delta_range: [-40, 10, 40]  # flap-deflection sweep [°]; null for no flap sweep
       # angles off the reference angle a live polar is re-solved at [°]
       live_offsets: [-12, -9, -6, -3, 0, 3, 6, 9, 12]
-      v_app: 25.0                 # apparent wind the Reynolds number is taken at [m/s]
+      va: 25.0                    # apparent wind the Reynolds number is taken at [m/s]
       chord_ref: 1.0              # reference (maximum panel) chord [m]
       table_format: arrow         # per-node table format: csv or arrow
 
@@ -111,4 +111,4 @@ One block answers for both the tables a mesh is sliced into and the live polars
 deformed section is re-solved on, so the two cannot be generated at different
 transition settings or off different networks. [`alpha_range`](@ref),
 [`delta_range`](@ref) and [`reynolds`](@ref) turn the sweeps and the
-`density * v_app * chord_ref / mu` reference into what the polar generator takes.
+`density * va * chord_ref / mu` reference into what the polar generator takes.

examples/V3_kite.jl

@@ -94,7 +94,7 @@ labels = [solver_labels;
      "WindTunnel Re=5e5"]] #with struts
 beta_labels = [solver_labels; ["Wind Tunnel Re=5e5 beta sweep alpha=7.4"]]
 
-wind_speed = settings.condition.wind_speed
+va = settings.condition.va
 angle_of_attack_deg = settings.condition.alpha
 sideslip_deg = settings.condition.beta
 yaw_rate = settings.condition.yaw_rate
@@ -111,7 +111,7 @@ PLOT && plot_polars(
     angle_type="angle_of_attack",
     angle_of_attack=angle_of_attack_deg,
     side_slip=sideslip_deg,
-    v_a=wind_speed,
+    va=va,
     title="$(wing.n_panels)_panels_$(wing.spanwise_distribution)_from_yaml_settings",
     save_path=OUTPUT_DIR,
     is_save=false || SAVE_ALL,
@@ -141,7 +141,7 @@ PLOT && plot_distribution(
     [body_y_coordinates],
     [results],
     ["VSM"];
-    title="CAD_spanwise_distributions_alpha_$(round(angle_of_attack_deg, digits=1))_delta_$(round(sideslip_deg, digits=1))_yaw_$(round(yaw_rate, digits=1))_va_$(round(wind_speed, digits=1))",
+    title="CAD_spanwise_distributions_alpha_$(round(angle_of_attack_deg, digits=1))_delta_$(round(sideslip_deg, digits=1))_yaw_$(round(yaw_rate, digits=1))_va_$(round(va, digits=1))",
     save_path=OUTPUT_DIR,
     is_save=false || SAVE_ALL,
     is_show=true,
@@ -158,7 +158,7 @@ PLOT && plot_polars(
     angle_type="side_slip",
     angle_of_attack=angle_of_attack_deg,
     side_slip=sideslip_deg,
-    v_a=wind_speed,
+    va=va,
     title="beta sweep",
     show_moments=true,
     save_path=OUTPUT_DIR,

examples/V3_neuralfoil.jl

@@ -109,7 +109,7 @@ fig = plot_polars(
      "Wind tunnel (Poland 2025)"];
     literature_path_list=literature_paths,
     angle_range,
-    v_a=va,
+    va=va,
     title="TU Delft V3 Kite: CFD vs NeuralFoil (Re=$RE)",
     is_save=false,
 )

examples/billowing.jl

@@ -83,13 +83,13 @@ solver_flat = Solver(settings; reference_point=[0.422646, 0.0, 9.3667])
 solver_bill = Solver(settings; reference_point=[0.422646, 0.0, 9.3667])
 
 # --- Set flight conditions ---
-wind_speed = settings.condition.wind_speed
+va = settings.condition.va
 angle_of_attack_deg = 10.0
 sideslip_deg = settings.condition.beta
 
 α0 = deg2rad(angle_of_attack_deg)
 β0 = deg2rad(sideslip_deg)
-va_vec = apparent_wind(α0, β0, wind_speed)
+va_vec = apparent_wind(α0, β0, va)
 set_va!(body_aero_flat, va_vec)
 set_va!(body_aero_bill, va_vec)
 
@@ -141,7 +141,7 @@ if PLOT
         angle_type="angle_of_attack",
         angle_of_attack=angle_of_attack_deg,
         side_slip=sideslip_deg,
-        v_a=wind_speed,
+        va=va,
         title="V3 Kite flat vs billowing $(BILLOWING_PCT)%",
         save_path=OUTPUT_DIR,
         is_save=false || SAVE_ALL,

examples/linearize_check.jl

@@ -39,16 +39,16 @@ va_vec_b_0 = apparent_wind(aoa_rad, side_slip, va)
 omega_b_0  = zeros(3)
 theta_0    = zeros(n_unrefined)
 
-theta_idxs = 1:n_unrefined
-va_idxs    = (n_unrefined + 1):(n_unrefined + 3)
-omega_idxs = (n_unrefined + 4):(n_unrefined + 6)
-y0         = [theta_0; va_vec_b_0; omega_b_0]
+theta_idxs  = 1:n_unrefined
+va_vec_idxs = (n_unrefined + 1):(n_unrefined + 3)
+omega_idxs  = (n_unrefined + 4):(n_unrefined + 6)
+y0          = [theta_0; va_vec_b_0; omega_b_0]
 
 @info "Computing FiniteDiff Jacobian …"
 t_fd = @elapsed begin
     jac_fd, x0_fd, conv_fd = linearize(
         solver, body_aero, y0;
-        theta_idxs, va_idxs, omega_idxs,
+        theta_idxs, va_vec_idxs, omega_idxs,
         aero_coeffs=true,
         backend=AutoFiniteDiff(absstep=1e-5, relstep=1e-5),
     )
@@ -59,7 +59,7 @@ conv_fd || @warn "FiniteDiff linearize did not converge at operating point"
 t_fwd = @elapsed begin
     jac_fwd, x0_fwd, conv_fwd = linearize(
         solver, body_aero, y0;
-        theta_idxs, va_idxs, omega_idxs,
+        theta_idxs, va_vec_idxs, omega_idxs,
         aero_coeffs=true,
         backend=AutoForwardDiff(),
     )
@@ -105,7 +105,7 @@ last_theta = fill(NaN, n_unrefined)
 
 function solve_at!(y)
     theta = y[theta_idxs]
-    va_vec = y[va_idxs]
+    va_vec = y[va_vec_idxs]
     omega = y[omega_idxs]
     if !all(theta .== last_theta)
         unrefined_deform!(wing, theta, nothing; smooth=false)