Merge branch 'main' into feat/moment

Author: 1-Bart-1

Project.toml

@@ -4,7 +4,6 @@ authors = ["1-Bart-1 <[email protected]>"]
 version = "0.1.2"
 
 [deps]
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
 DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
@@ -40,6 +39,7 @@ Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Xfoil = "19641d66-a62d-11e8-2441-8f57a969a9c4"
+BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 
 [targets]
-test = ["Test", "DataFrames", "CSV", "Distributed", "Documenter", "Xfoil"]
+test = ["Test", "DataFrames", "CSV", "Distributed", "Documenter", "Xfoil", "BenchmarkTools"]

README.md

@@ -102,11 +102,11 @@ wing = Wing(n_panels, spanwise_panel_distribution="linear")
 add_section!(wing, 
     [0.0, span/2, 0.0],    # Left tip LE 
     [chord, span/2, 0.0],  # Left tip TE
-    "inviscid")
+    :inviscid)
 add_section!(wing, 
     [0.0, -span/2, 0.0],   # Right tip LE
     [chord, -span/2, 0.0], # Right tip TE
-    "inviscid")
+    :inviscid)
 
 # Step 3: Initialize aerodynamics
 wa = BodyAerodynamics([wing])

docs/src/functions.md

@@ -1,6 +1,11 @@
 ```@meta
 CurrentModule = VortexStepMethod
 ```
+## Functions for creating the geometry
+```@docs
+add_section!
+```
+
 ## Main Plotting Functions
 ```@docs
 plot_geometry

examples/bench.jl

@@ -40,7 +40,8 @@ vsm_solver = Solver(aerodynamic_model_type=:VSM)
 # Step 5: Solve using both methods
 results_vsm = solve(vsm_solver, wa)
 @time results_vsm = solve(vsm_solver, wa)
-# time Python: 32.0 ms
-# time Julia:   0.6 ms
+# time Python: 32.0 ms Ryzen 7950x
+# time Julia:   0.6 ms Ryzen 7950x
+#               0.8 ms laptop, performance mode, battery 
 
 nothing

examples/ram_air_kite.jl

@@ -2,8 +2,9 @@ using VortexStepMethod
 using LinearAlgebra
 using Pkg
 
-if ! ("CSV" ∈ keys(Pkg.project().dependencies))
-    using TestEnv; TestEnv.activate()
+if !("CSV" ∈ keys(Pkg.project().dependencies))
+    using TestEnv
+    TestEnv.activate()
 end
 using CSV
 using DataFrames
@@ -50,7 +51,7 @@ plot && plot_geometry(
 )
 
 # Solving and plotting distributions
-@time results = solve(VSM, body_aero)
+results = solve(VSM, body_aero)
 @time results = solve(VSM, body_aero)
 
 CAD_y_coordinates = [panel.aero_center[2] for panel in body_aero.panels]

examples/rectangular_wing.jl

@@ -8,7 +8,7 @@ plot = true
 n_panels = 20          # Number of panels
 span = 20.0            # Wing span [m]
 chord = 1.0            # Chord length [m]
-v_a = 20.0            # Magnitude of inflow velocity [m/s]
+v_a = 20.0             # Magnitude of inflow velocity [m/s]
 density = 1.225        # Air density [kg/m³]
 alpha_deg = 30.0       # Angle of attack [degrees]
 alpha = deg2rad(alpha_deg)

src/body_aerodynamics.jl

@@ -112,19 +112,18 @@ Structure to hold calculated panel properties.
 - `control_points`::Vector{MVec3}
 - `bound_points_1`::Vector{MVec3}
 - `bound_points_2`::Vector{MVec3}
-- `x_airf`::Vector{Vector{Float64}}: unclear, please define
-- `y_airf`::Vector{Vector{Float64}}: unclear, please define
-- `z_airf`::Vector{Vector{Float64}}: unclear, please define
-
+- `x_airf`::Vector{MVec3}: Vector of unit vectors perpendicular to chord line
+- `y_airf`::Vector{MVec3}: Vector of unit vectors parallel to chord line
+- `z_airf`::Vector{MVec3}: Vector of unit vectors in spanwise direction
 """
 struct PanelProperties
     aero_centers::Vector{MVec3}
     control_points::Vector{MVec3}
     bound_points_1::Vector{MVec3}
     bound_points_2::Vector{MVec3}
-    x_airf::Vector{Vector{Float64}}
-    y_airf::Vector{Vector{Float64}}
-    z_airf::Vector{Vector{Float64}}
+    x_airf::Vector{MVec3}
+    y_airf::Vector{MVec3}
+    z_airf::Vector{MVec3}
 end
 
 """
@@ -139,23 +138,23 @@ Returns:
 function calculate_panel_properties(section_list::Vector{Section}, n_panels::Int,
                                   aero_center_loc::Float64, control_point_loc::Float64)
     # Initialize arrays
-    aero_centers = Vector{Float64}[]
-    control_points = Vector{Float64}[]
-    bound_points_1 = Vector{Float64}[]
-    bound_points_2 = Vector{Float64}[]
-    x_airf = Vector{Float64}[]
-    y_airf = Vector{Float64}[]
-    z_airf = Vector{Float64}[]
+    aero_centers = MVec3[]
+    control_points = MVec3[]
+    bound_points_1 = MVec3[]
+    bound_points_2 = MVec3[]
+    x_airf = MVec3[]
+    y_airf = MVec3[]
+    z_airf = MVec3[]
 
     # Define coordinates matrix
     coords = zeros(2 * (n_panels + 1), 3)
     @debug "Shape of coordinates: $(size(coords))"
 
     for i in 1:n_panels
-        coords[2i-1, :] = section_list[i].LE_point
-        coords[2i, :] = section_list[i].TE_point
-        coords[2i+1, :] = section_list[i+1].LE_point
-        coords[2i+2, :] = section_list[i+1].TE_point
+        coords[2i-1, :] .= section_list[i].LE_point
+        coords[2i, :]   .= section_list[i].TE_point
+        coords[2i+1, :] .= section_list[i+1].LE_point
+        coords[2i+2, :] .= section_list[i+1].TE_point
     end
 
     @debug "Coordinates: $coords"

src/kite_geometry.jl

@@ -204,7 +204,9 @@ mutable struct KiteWing <: AbstractWing
     te_interp::Extrapolation
     area_interp::Extrapolation
 
-    function KiteWing(obj_path, dat_path; alpha=0.0, n_sections=20, crease_frac=0.75, wind_vel=10., mass=1.0, n_panels=54, spanwise_panel_distribution=:linear, spanwise_direction=[0.0, 1.0, 0.0])
+    function KiteWing(obj_path, dat_path; alpha=0.0, n_sections=20, crease_frac=0.75, wind_vel=10., mass=1.0, 
+        n_panels=54, spanwise_panel_distribution=:linear, spanwise_direction=[0.0, 1.0, 0.0])
+        
         !isapprox(spanwise_direction, [0.0, 1.0, 0.0]) && @error "Spanwise direction has to be [0.0, 1.0, 0.0]"
 
         # Load or create polars

src/panel.jl

@@ -414,17 +414,16 @@ Calculate the velocity induced by a vortex ring at a control point.
 end
 
 """
-    calculate_velocity_induced_bound_2D!(panel::Panel, evaluation_point::Vector{Float64})
+    calculate_velocity_induced_bound_2D!(U2D, panel::Panel, evaluation_point, work_vectors)
 
 Calculate velocity induced by bound vortex filaments at the control point.
 Only needed for VSM, as LLT bound and filament align, thus no induced velocity.
 
 # Arguments
+- U_2D: resulting 2D velocity vector
 - `panel::Panel`: Panel object
-- `evaluation_point::Vector{Float64}`: Point where induced velocity is evaluated
-
-# Returns
-- `Vector{Float64}`: Induced velocity at the control point
+- `evaluation_point`: Point where induced velocity is evaluated
+- work_vectors: unclear
 """
 function calculate_velocity_induced_bound_2D!(
     U_2D,

src/wing_geometry.jl

@@ -1,16 +1,13 @@
 
 """
-    Section
+    Section{T}
 
 Represents a wing section with leading edge, trailing edge, and aerodynamic properties.
 
 # Fields
 - `LE_point::MVec3`: Leading edge point coordinates
 - `TE_point::MVec3`: Trailing edge point coordinates
-- `aero_input::Vector{Any}`: Aerodynamic input data for the section:
-    - `("inviscid")`: Inviscid aerodynamics
-    - `("polar_data", [alpha_column,CL_column,CD_column,CM_column])`: Polar data aerodynamics
-    - `("lei_airfoil_breukels", [d_tube,camber])`: LEI airfoil with Breukels parameters
+- `aero_input`::T: Aerodynamic input, one of three possible types
 """
 struct Section{T}
     LE_point::MVec3
@@ -61,10 +58,17 @@ mutable struct Wing <: AbstractWing
 end
 
 """
-    add_section!(wing::Wing, LE_point::PosVector, 
-                TE_point::PosVector, aero_input::Vector{Any})
+    add_section!(wing::Wing, LE_point::PosVector, TE_point::PosVector, aero_input)
 
 Add a new section to the wing.
+
+# Arguments:
+- LE_point::PosVector: position of the point on the side of the leading edge
+- TE_point::PosVector: position of the point on the side of the leading edge
+- aero_input: Can be:
+  - :inviscid
+  - :`lei_airfoil_breukels`
+  - (:interpolations, (`cl_interp`, `cd_interp`, `cm_interp`))
 """
 function add_section!(wing::Wing, LE_point::Vector{Float64}, 
                      TE_point::Vector{Float64}, aero_input)
@@ -182,7 +186,7 @@ function interpolate_to_common_alpha(alpha_common,
 end
 
 """
-    calculate_new_aero_input(aero_input::Vector{Any}, 
+    calculate_new_aero_input(aero_input, 
                             section_index::Int,
                             left_weight::Float64,
                             right_weight::Float64)
@@ -272,7 +276,7 @@ end
         n_sections::Int,
         LE::Matrix{Float64},
         TE::Matrix{Float64},
-        aero_input::Vector{Any})
+        aero_input)
 
 Refine wing mesh using linear or cosine spacing.