replace WingAerodynamics with BodyAerodynamics

ufechner7 · ufechner7 · commit 592982061628 · 2025-02-23T00:40:50.000+01:00
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ add_section!(wing,
     "inviscid")
 
 # Step 3: Initialize aerodynamics
-wa = WingAerodynamics([wing])
+wa = BodyAerodynamics([wing])
 
 # Set inflow conditions
 vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -106,7 +106,7 @@ add_section!(wing,
     "inviscid")
 
 # Step 3: Initialize aerodynamics
-wa = WingAerodynamics([wing])
+wa = BodyAerodynamics([wing])
 
 # Set inflow conditions
 vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
diff --git a/docs/src/types.md b/docs/src/types.md
@@ -15,5 +15,5 @@ CurrentModule = VortexStepMethod
     BoundFilament
     Panel
     PanelProperties
-    WingAerodynamics
+    BodyAerodynamics
 ```
diff --git a/examples/ram_air_kite.jl b/examples/ram_air_kite.jl
@@ -10,7 +10,7 @@ using DataFrames
 
 # Create wing geometry
 wing = KiteWing("data/ram_air_kite_body.obj", "data/ram_air_kite_foil.dat")
-wing_aero = WingAerodynamics([wing])
+wing_aero = BodyAerodynamics([wing])
 
 # Create solvers
 VSM = Solver(
diff --git a/examples/rectangular_wing.jl b/examples/rectangular_wing.jl
@@ -25,7 +25,7 @@ add_section!(wing,
     "inviscid")
 
 # Step 3: Initialize aerodynamics
-wa = WingAerodynamics([wing])
+wa = BodyAerodynamics([wing])
 
 # Set inflow conditions
 vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
diff --git a/examples/stall_model.jl b/examples/stall_model.jl
@@ -38,7 +38,7 @@ CAD_wing = Wing(n_panels; spanwise_panel_distribution)
 for rib in rib_list
     add_section!(CAD_wing, rib[1], rib[2], rib[3])
 end
-wing_aero_CAD_19ribs = WingAerodynamics([CAD_wing])
+wing_aero_CAD_19ribs = BodyAerodynamics([CAD_wing])
 
 # Create solvers
 VSM = Solver(
diff --git a/src/VortexStepMethod.jl b/src/VortexStepMethod.jl
@@ -16,7 +16,7 @@ using SharedArrays
 
 # Export public interface
 export Wing, Section, KiteWing
-export WingAerodynamics
+export BodyAerodynamics
 export Solver, solve
 export calculate_results, solve_circulation_distribution
 export add_section!, set_va!
@@ -57,7 +57,7 @@ include("kite_geometry.jl")
 include("filament.jl")
 include("panel.jl")
 include("wake.jl")
-include("wing_aerodynamics.jl")
+include("body_aerodynamics.jl")
 include("solver.jl")
 
 # include plotting
diff --git a/src/body_aerodynamics.jl b/src/body_aerodynamics.jl
@@ -1,21 +1,21 @@
 
 """
-    WingAerodynamics
+    BodyAerodynamics
 
-Main structure for calculating aerodynamic properties of wings.
+Main structure for calculating aerodynamic properties of bodies.
 
 # Fields
 - panels::Vector{Panel}: Vector of Panel structs
 - n_panels::Int64: number of panels
-- wings::Vector{AbstractWing}: a vector of wings; but why more than one?
+- wings::Vector{AbstractWing}: a vector of wings; a body can have multiple wings
 - `_va`::Union{Nothing, Vector{Float64}, Tuple{Vector{Float64}, Float64}}: A vector of the apparent wind speed,  
                                                       or a tuple of the v_a vector and yaw rate (rad/s).
 - ` gamma_distribution`::Union{Nothing, Vector{Float64}}: unclear, please defined
 - `alpha_uncorrected`::Union{Nothing, Vector{Float64}}: unclear, please define
 - `alpha_corrected`::Union{Nothing, Vector{Float64}}: unclear, please define
 - `stall_angle_list`::Vector{Float64}: unclear, please define
 """
-mutable struct WingAerodynamics
+mutable struct BodyAerodynamics
     panels::Vector{Panel}
     n_panels::Int64             # TODO: Why is this needed? Just use length(panels)
     wings::Vector{AbstractWing} # TODO: Why not a concrete type? And why a vector?
@@ -29,7 +29,7 @@ mutable struct WingAerodynamics
     v_a_array::Vector{Float64}
     work_vectors::NTuple{10,Vector{Float64}}
 
-    function WingAerodynamics(
+    function BodyAerodynamics(
         wings::Vector{T};
         aerodynamic_center_location::Float64=0.25,
         control_point_location::Float64=0.75
@@ -88,14 +88,14 @@ mutable struct WingAerodynamics
     end
 end
 
-function Base.getproperty(obj::WingAerodynamics, sym::Symbol)
+function Base.getproperty(obj::BodyAerodynamics, sym::Symbol)
     if sym === :va
         return getfield(obj, :_va)
     end
     return getfield(obj, sym)
 end
 
-function Base.setproperty!(obj::WingAerodynamics, sym::Symbol, val)
+function Base.setproperty!(obj::BodyAerodynamics, sym::Symbol, val)
     if sym === :va
         set_va!(obj, val)
     else
@@ -227,7 +227,7 @@ function calculate_panel_properties(section_list::Vector{Section}, n_panels::Int
 end
 
 """
-    calculate_AIC_matrices(wa::WingAerodynamics, model::String, 
+    calculate_AIC_matrices(wa::BodyAerodynamics, model::String, 
                          core_radius_fraction::Float64,
                          va_norm_array::Vector{Float64}, 
                          va_unit_array::Matrix{Float64})
@@ -237,7 +237,7 @@ Calculate Aerodynamic Influence Coefficient matrices.
 Returns:
     Tuple of (AIC_x, AIC_y, AIC_z) matrices
 """
-function calculate_AIC_matrices(wa::WingAerodynamics, model::String,
+function calculate_AIC_matrices(wa::BodyAerodynamics, model::String,
                               core_radius_fraction::Float64,
                               va_norm_array::Vector{Float64}, 
                               va_unit_array::Matrix{Float64})
@@ -279,14 +279,14 @@ function calculate_AIC_matrices(wa::WingAerodynamics, model::String,
 end
 
 """
-    calculate_circulation_distribution_elliptical_wing(wa::WingAerodynamics, gamma_0::Float64=1.0)
+    calculate_circulation_distribution_elliptical_wing(wa::BodyAerodynamics, gamma_0::Float64=1.0)
 
 Calculate circulation distribution for an elliptical wing.
 
 Returns:
     Vector{Float64}: Circulation distribution along the wing
 """
-function calculate_circulation_distribution_elliptical_wing(wa::WingAerodynamics, gamma_0::Float64=1.0)
+function calculate_circulation_distribution_elliptical_wing(wa::BodyAerodynamics, gamma_0::Float64=1.0)
     length(wa.wings) == 1 || throw(ArgumentError("Multiple wings not yet implemented"))
     
     wing_span = wa.wings[1].span
@@ -350,7 +350,7 @@ function calculate_stall_angle_list(panels::Vector{Panel};
 end
 
 """
-    update_effective_angle_of_attack_if_VSM(wa::WingAerodynamics, gamma::Vector{Float64},
+    update_effective_angle_of_attack_if_VSM(wa::BodyAerodynamics, gamma::Vector{Float64},
                                           core_radius_fraction::Float64,
                                           x_airf_array::Matrix{Float64},
                                           y_airf_array::Matrix{Float64},
@@ -363,7 +363,7 @@ Update angle of attack at aerodynamic center for VSM method.
 Returns:
     Vector{Float64}: Updated angles of attack
 """
-function update_effective_angle_of_attack_if_VSM(wa::WingAerodynamics, 
+function update_effective_angle_of_attack_if_VSM(wa::BodyAerodynamics, 
     gamma::Vector{Float64},
     core_radius_fraction::Float64,
     x_airf_array::Matrix{Float64},
@@ -395,7 +395,7 @@ function update_effective_angle_of_attack_if_VSM(wa::WingAerodynamics,
 end
 
 """
-    calculate_results(wa::WingAerodynamics, gamma_new::Vector{Float64}, 
+    calculate_results(wa::BodyAerodynamics, gamma_new::Vector{Float64}, 
                      density::Float64, aerodynamic_model_type::String,
                      core_radius_fraction::Float64, mu::Float64,
                      alpha_array::Vector{Float64}, v_a_array::Vector{Float64},
@@ -410,7 +410,7 @@ Calculate final aerodynamic results.
 Returns:
     Dict: Results including forces, coefficients and distributions
 """
-function calculate_results(wa::WingAerodynamics,
+function calculate_results(wa::BodyAerodynamics,
     gamma_new::Vector{Float64},
     density::Float64,
     aerodynamic_model_type::String,
@@ -619,14 +619,14 @@ end
 
 
 """
-    set_va!(wa::WingAerodynamics, va::Union{Vector{Float64}, Tuple{Vector{Float64}, Float64}})
+    set_va!(wa::BodyAerodynamics, va::Union{Vector{Float64}, Tuple{Vector{Float64}, Float64}})
 
 Set velocity array and update wake filaments.
 
 # Arguments
 - `va`: Either a velocity vector or tuple of (velocity vector, yaw_rate)
 """
-function set_va!(wa::WingAerodynamics, va)
+function set_va!(wa::BodyAerodynamics, va)
     # Add length check for va_vec
     if va isa Vector{Float64} && length(va) != 3 && length(va) != wa.n_panels
         throw(ArgumentError("va must be length 3 or match number of panels"))
diff --git a/src/plotting.jl b/src/plotting.jl
@@ -143,20 +143,20 @@ function set_axes_equal!(ax; zoom=1.8)
 end
 
 """
-    create_geometry_plot(wing_aero::WingAerodynamics, title, view_elevation, view_azimuth; zoom=1.8)
+    create_geometry_plot(wing_aero::BodyAerodynamics, title, view_elevation, view_azimuth; zoom=1.8)
 
 Create a 3D plot of wing geometry including panels and filaments.
 
 # Arguments
-- wing_aero: struct of type WingAerodynamics
+- wing_aero: struct of type BodyAerodynamics
 - title: plot title
 - view_elevation: initial view elevation angle [°]
 - view_azimuth: initial view azimuth angle [°]
 
 # Keyword arguments
 - zoom: zoom factor (default: 1.8)
 """
-function create_geometry_plot(wing_aero::WingAerodynamics, title, view_elevation, view_azimuth; 
+function create_geometry_plot(wing_aero::BodyAerodynamics, title, view_elevation, view_azimuth; 
                               zoom=1.8)
     set_plot_style(28)
 
@@ -241,15 +241,15 @@ function create_geometry_plot(wing_aero::WingAerodynamics, title, view_elevation
 end
 
 """
-    plot_geometry(wing_aero::WingAerodynamics, title; 
+    plot_geometry(wing_aero::BodyAerodynamics, title; 
                   data_type=".pdf", save_path=nothing, 
                   is_save=false, is_show=false, 
                   view_elevation=15, view_azimuth=-120)
 
 Plot wing geometry from different viewpoints and optionally save/show plots.
 
 # Arguments:
-- `wing_aero`: struct of type WingAerodynamics
+- `wing_aero`: struct of type BodyAerodynamics
 - title: plot title
 
 # Keyword arguments:
@@ -261,7 +261,7 @@ Plot wing geometry from different viewpoints and optionally save/show plots.
 - `view_azimuth`: initial view azimuth angle (default: -120) [°]
 
 """
-function plot_geometry(wing_aero::WingAerodynamics, title;
+function plot_geometry(wing_aero::BodyAerodynamics, title;
     data_type=".pdf",
     save_path=nothing,
     is_save=false,
@@ -467,7 +467,7 @@ function plot_distribution(y_coordinates_list, results_list, label_list;
 end
 
 """
-    generate_polar_data(solver, wing_aero::WingAerodynamics, angle_range;     
+    generate_polar_data(solver, wing_aero::BodyAerodynamics, angle_range;     
                         angle_type="angle_of_attack", angle_of_attack=0.0,
                         side_slip=0.0, v_a=10.0)
 
@@ -489,7 +489,7 @@ Generate polar data for aerodynamic analysis over a range of angles.
 """
 function generate_polar_data(
     solver,
-    wing_aero::WingAerodynamics,
+    wing_aero::BodyAerodynamics,
     angle_range;
     angle_type="angle_of_attack",
     angle_of_attack=0.0,
diff --git a/src/solver.jl b/src/solver.jl
@@ -55,11 +55,11 @@ struct Solver
 end
 
 """
-    solve(solver::Solver, wing_aero::WingAerodynamics, gamma_distribution=nothing)
+    solve(solver::Solver, wing_aero::BodyAerodynamics, gamma_distribution=nothing)
 
 Main solving routine for the aerodynamic model.
 """
-function solve(solver::Solver, wing_aero::WingAerodynamics, gamma_distribution=nothing)
+function solve(solver::Solver, wing_aero::BodyAerodynamics, gamma_distribution=nothing)
     isnothing(wing_aero.panels[1].va) && throw(ArgumentError("Inflow conditions are not set, use set_va!(wing_aero, va)"))
     
     # Initialize variables
@@ -181,7 +181,7 @@ Main iteration loop for calculating circulation distribution.
 """
 function gamma_loop(
     solver::Solver,
-    wing_aero::WingAerodynamics,
+    wing_aero::BodyAerodynamics,
     gamma_new::Vector{Float64},
     AIC_x::Matrix{Float64},
     AIC_y::Matrix{Float64},
diff --git a/test/test_plotting.jl b/test/test_plotting.jl
@@ -26,7 +26,7 @@ function create_wa()
         "inviscid")
 
     # Step 3: Initialize aerodynamics
-    wa = WingAerodynamics([wing])
+    wa = BodyAerodynamics([wing])
     # Set inflow conditions
     vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
     set_va!(wa, (vel_app, 0.0))  # Second parameter is yaw rate
diff --git a/test/test_wing_aerodynamics.jl b/test/test_wing_aerodynamics.jl
@@ -1,4 +1,4 @@
-# using VortexStepMethod: Wing, WingAerodynamics, BoundFilament, SemiInfiniteFilament, add_section!, set_va!, solve, calculate_cl
+# using VortexStepMethod: Wing, BodyAerodynamics, BoundFilament, SemiInfiniteFilament, add_section!, set_va!, solve, calculate_cl
 using VortexStepMethod
 using VortexStepMethod: calculate_cl, calculate_cd_cm, calculate_projected_area, calculate_AIC_matrices
 using LinearAlgebra
@@ -38,7 +38,7 @@ include("utils.jl")
         )
     end
     
-    wing_aero = WingAerodynamics([wing])
+    wing_aero = BodyAerodynamics([wing])
     set_va!(wing_aero, (Uinf, 0.0))
 
     # Run analysis
@@ -135,7 +135,7 @@ end
         )
     end
     
-    wing_aero = WingAerodynamics([wing])
+    wing_aero = BodyAerodynamics([wing])
     set_va!(wing_aero, (Uinf, 0.0))
 
     # Calculate reference matrices using thesis functions
@@ -250,7 +250,7 @@ end
                 "inviscid"
             )
         end
-        wing_aero = WingAerodynamics([wing])
+        wing_aero = BodyAerodynamics([wing])
         set_va!(wing_aero, (Uinf, 0.0))
         
         return wing_aero, coord, Uinf, model
diff --git a/test/utils.jl b/test/utils.jl
@@ -1,7 +1,7 @@
 using LinearAlgebra
 using Logging
 using Statistics
-using VortexStepMethod: Wing, WingAerodynamics, Solver
+using VortexStepMethod: Wing, BodyAerodynamics, Solver
 
 include("thesis_oriol_cayon.jl")
 
