add enum PanelDistribution (#71)

* add comment

* add enum PanelDistribution

* add enum PanelDistribution

* update examples

* update docu

* fix typos

* export enum

---------

Co-authored-by: Uwe Fechner <[email protected]>

Author: ufechner7

docs/src/types.md

@@ -4,6 +4,7 @@ CurrentModule = VortexStepMethod
 ## Enumerations
 ```@docs
 Model
+PanelDistribution
 ```
 
 ## Basic Vectors

examples/rectangular_wing.jl

@@ -14,7 +14,7 @@ alpha_deg = 30.0       # Angle of attack [degrees]
 alpha = deg2rad(alpha_deg)
 
 # Step 2: Create wing geometry with linear panel distribution
-wing = Wing(n_panels, spanwise_panel_distribution=:linear)
+wing = Wing(n_panels, spanwise_panel_distribution=LINEAR)
 
 # Add wing sections - defining only tip sections with inviscid airfoil model
 add_section!(wing, 

examples/stall_model.jl

@@ -17,7 +17,7 @@ mkpath(save_folder)
 
 # Defining discretisation
 n_panels = 54
-spanwise_panel_distribution = :split_provided
+spanwise_panel_distribution = SPLIT_PROVIDED
 
 # Load rib data from CSV
 csv_file_path = joinpath(

src/VortexStepMethod.jl

@@ -25,6 +25,7 @@ export calculate_span, calculate_projected_area
 export plot_wing, plot_circulation_distribution, plot_geometry, plot_distribution, plot_polars
 export show_plot, save_plot, menu
 export Model, VSM, LLT
+export PanelDistribution, LINEAR, COSINE, COSINE_VAN_GARREL, SPLIT_PROVIDED, UNCHANGED
 
 """
    const MVec3    = MVector{3, Float64}
@@ -58,6 +59,26 @@ Enumeration of the implemented model types.
 """
 @enum Model VSM LLT
 
+"""
+   PanelDistribution `LINEAR` `COSINE` `COSINE_VAN_GARREL` `SPLIT_PROVIDED` `UNCHANGED`
+
+Enumeration of the implemented model types.
+
+# Elements
+- LINEAR               # Linear distribution
+- COSINE               # Cosine distribution
+- `COSINE_VAN_GARREL`  # van Garrel cosine distribution
+- `SPLIT_PROVIDED`     # Split provided sections
+- UNCHANGED            # Keep original sections
+"""
+@enum PanelDistribution begin
+   LINEAR             # Linear distribution
+   COSINE             # Cosine distribution
+   COSINE_VAN_GARREL  # van Garrel cosine distribution
+   SPLIT_PROVIDED     # Split provided sections
+   UNCHANGED          # Keep original sections
+end
+
 abstract type AbstractWing end
 
 function menu()

src/kite_geometry.jl

@@ -176,7 +176,7 @@ Represents a curved wing that inherits from Wing with additional geometric prope
 # Fields
 - All fields from Wing:
   - `n_panels::Int`: Number of panels in aerodynamic mesh
-  - `spanwise_panel_distribution::Symbol`: Panel distribution type
+  - `spanwise_panel_distribution`::PanelDistribution
   - `spanwise_direction::MVec3`: Wing span direction vector
   - `sections::Vector{Section}`: List of wing sections
 - Additional fields:
@@ -189,7 +189,7 @@ Same as Wing
 """
 mutable struct KiteWing <: AbstractWing
     n_panels::Int64
-    spanwise_panel_distribution::Symbol
+    spanwise_panel_distribution::PanelDistribution
     spanwise_direction::MVec3
     sections::Vector{Section}
 
@@ -205,7 +205,7 @@ mutable struct KiteWing <: AbstractWing
     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])
+        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]"
 

src/solver.jl

@@ -47,7 +47,7 @@ struct Solver
         aerodynamic_model_type::Model    = VSM,
         density::Float64                 = 1.225,
         max_iterations::Int64            = 1500,
-        allowed_error::Float64           = 1e-5,
+        allowed_error::Float64           = 1e-5, # rel_err
         tol_reference_error::Float64     = 0.001,
         relaxation_factor::Float64       = 0.03,
         is_with_artificial_damping::Bool = false,

src/wing_geometry.jl

@@ -30,25 +30,19 @@ Represents a wing composed of multiple sections with aerodynamic properties.
 
 # Fields
 - `n_panels::Int64`: Number of panels in aerodynamic mesh
-- `spanwise_panel_distribution::Symbol`: Panel distribution type
+- `spanwise_panel_distribution`::PanelDistribution: [PanelDistribution](@ref)
 - `spanwise_direction::Vector{Float64}`: Wing span direction vector
 - `sections::Vector{Section}`: List of wing sections
 
-# Distribution types
-- :linear: Linear distribution
-- :cosine: Cosine distribution
-- :`cosine_van_Garrel`: van Garrel cosine distribution
-- :split_provided: Split provided sections
-- :unchanged: Keep original sections
 """
 mutable struct Wing <: AbstractWing
     n_panels::Int64
-    spanwise_panel_distribution::Symbol
+    spanwise_panel_distribution::PanelDistribution
     spanwise_direction::PosVector
     sections::Vector{Section}
 
     function Wing(n_panels::Int;
-                 spanwise_panel_distribution::Symbol=:linear,
+                 spanwise_panel_distribution::PanelDistribution=LINEAR,
                  spanwise_direction::PosVector=MVec3([0.0, 1.0, 0.0]))
         new(n_panels, 
             spanwise_panel_distribution, 
@@ -132,7 +126,7 @@ function refine_aerodynamic_mesh(wing::AbstractWing)
     end
 
     # Handle special cases
-    if wing.spanwise_panel_distribution === :unchanged || length(wing.sections) == n_sections
+    if wing.spanwise_panel_distribution == UNCHANGED || length(wing.sections) == n_sections
         return wing.sections
     end
 
@@ -145,9 +139,9 @@ function refine_aerodynamic_mesh(wing::AbstractWing)
     end
 
     # Handle different distribution types
-    if wing.spanwise_panel_distribution === :split_provided
+    if wing.spanwise_panel_distribution == SPLIT_PROVIDED
         return refine_mesh_by_splitting_provided_sections(wing)
-    elseif wing.spanwise_panel_distribution in [:linear, :cosine, :cosine_van_Garrel]
+    elseif wing.spanwise_panel_distribution in (LINEAR, COSINE, COSINE_VAN_GARREL)
         return refine_mesh_for_linear_cosine_distribution(
             wing.spanwise_panel_distribution,
             n_sections,
@@ -239,7 +233,7 @@ end
 
 """
     refine_mesh_for_linear_cosine_distribution(
-        spanwise_panel_distribution::Symbol,
+        spanwise_panel_distribution::PanelDistribution,
         n_sections::Int,
         LE::Matrix{Float64},
         TE::Matrix{Float64},
@@ -248,7 +242,7 @@ end
 Refine wing mesh using linear or cosine spacing.
 
 # Arguments
-- `spanwise_panel_distribution`: Distribution type (:linear, :cosine, or :cosine_van_Garrel)
+- `spanwise_panel_distribution`: [PanelDistribution](@ref)
 - `n_sections`: Number of sections to generate
 - `LE`: Matrix of leading edge points
 - `TE`: Matrix of trailing edge points
@@ -258,7 +252,7 @@ Returns:
     Vector{Section}: List of refined sections
 """
 function refine_mesh_for_linear_cosine_distribution(
-    spanwise_panel_distribution::Symbol,
+    spanwise_panel_distribution::PanelDistribution,
     n_sections::Int,
     LE,
     TE,
@@ -273,9 +267,9 @@ function refine_mesh_for_linear_cosine_distribution(
     qc_cum_length = vcat(0, cumsum(qc_lengths))
 
     # 2. Define target lengths
-    target_lengths = if spanwise_panel_distribution === :linear
+    target_lengths = if spanwise_panel_distribution == LINEAR
         range(0, qc_total_length, n_sections)
-    elseif spanwise_panel_distribution in [:cosine, :cosine_van_Garrel]
+    elseif spanwise_panel_distribution in (COSINE, COSINE_VAN_GARREL)
         theta = range(0, π, n_sections)
         qc_total_length .* (1 .- cos.(theta)) ./ 2
     else
@@ -464,7 +458,7 @@ function refine_mesh_by_splitting_provided_sections(wing::AbstractWing)
 
             # Generate sections for this pair
             new_splitted_sections = refine_mesh_for_linear_cosine_distribution(
-                :linear,
+                LINEAR,
                 num_new_sections + 2,  # +2 for endpoints
                 LE_pair,
                 TE_pair,

test/bench.jl

@@ -23,7 +23,7 @@ using LinearAlgebra
     alpha_deg = 30.0       # Angle of attack [degrees]
     alpha = deg2rad(alpha_deg)
 
-    wing = Wing(n_panels, spanwise_panel_distribution=:linear)
+    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

test/test_body_aerodynamics.jl

@@ -23,7 +23,7 @@ include("utils.jl")
     core_radius_fraction = 1e-20
     coord = generate_coordinates_el_wing(max_chord, span, N, dist)
     coord_left_to_right = flip_created_coord_in_pairs(deepcopy(coord))
-    wing = Wing(N; spanwise_panel_distribution=:unchanged)
+    wing = Wing(N; spanwise_panel_distribution=UNCHANGED)
     for idx in 1:2:length(coord_left_to_right[:, 1])
         @debug "coord_left_to_right[$idx] = $(coord_left_to_right[idx,:])"
         add_section!(
@@ -124,7 +124,7 @@ end
     # Create wing geometry
     core_radius_fraction = 1e-20
     coord_left_to_right = flip_created_coord_in_pairs(deepcopy(coord))
-    wing = Wing(n_panels; spanwise_panel_distribution=:unchanged)
+    wing = Wing(n_panels; spanwise_panel_distribution=UNCHANGED)
     for idx in 1:2:size(coord_left_to_right, 1)
         add_section!(
             wing,
@@ -242,7 +242,7 @@ end
         end
 
         coord_left_to_right = flip_created_coord_in_pairs(deepcopy(coord))
-        wing = Wing(N; spanwise_panel_distribution=:unchanged)
+        wing = Wing(N; spanwise_panel_distribution=UNCHANGED)
         for i in 1:2:size(coord_left_to_right, 1)
             add_section!(
                 wing,

test/test_kite_geometry.jl

@@ -141,7 +141,7 @@ using Serialization
         wing = KiteWing(test_obj_path, test_dat_path)
 
         @test wing.n_panels == 54  # Default value
-        @test wing.spanwise_panel_distribution === :linear
+        @test wing.spanwise_panel_distribution == LINEAR
         @test wing.spanwise_direction ≈ [0.0, 1.0, 0.0]
         @test length(wing.sections) > 0  # Should have sections now
         @test wing.mass ≈ 1.0