Fix #111 KiteWing -> RamAirWing

Author: ufechner7

NEWS.md

@@ -7,17 +7,17 @@
 - In the `menu.jl`, changed `help` to `help_me`. It works better now, no more warnings on Linux, it should also work on MacOS now
 - The coordinate frames of the panels now use the same convention as the kite body frame
 - The page "Glossary" of the documentation is quite complete now
-- The center of mass field of the `KiteWing` is removed, and the geometry is created such that `[0, 0, 0]` is the center of mass
+- The center of mass field of the `RamAirWing` is removed, and the geometry is created such that `[0, 0, 0]` is the center of mass
 - Fix the calculation of force coefficients in `solve!`
 
 ## VortexStepMethod v1.1.0 2025-03-04
 ### Added
-- Dynamically deform the KiteWing by twisting the left side and right side, and deforming the trailing edges using deform! #19
+- Dynamically deform the RamAirWing by twisting the left side and right side, and deforming the trailing edges using deform! #19
 - Set turn rate `omega = [omega_x, omega_y, omega_z]` in kite body frame using set_va! #49
 - Add moment coefficient calculations around specified point to `solve` #17
 - Add moment distribution of the moment around the local panel y-axes around user-defined points on the panels to `solve!` #90
 - Add function `solve!()` which returns a `VSMSolution` struct #87
-- Add the option to remove the NaNs in `aero_data` vectors or matrices using the `remove_nan` keyword in the `Wing` and `KiteWing` constructors #98
+- Add the option to remove the NaNs in `aero_data` vectors or matrices using the `remove_nan` keyword in the `Wing` and `RamAirWing` constructors #98
 ### Changed
 - Add origin argument to `BodyAerodynamics` constructor #66
 - Improve documentation

docs/src/types.md

@@ -23,16 +23,16 @@ AeroData
 ```
 
 ## Wing Geometry, Panel and Aerodynamics
-A body is constructed of one or more abstract wings. An abstract wing can be a Wing or a KiteWing. 
-A Wing/ KiteWing has one or more sections.
+A body is constructed of one or more abstract wings. An abstract wing can be a Wing or a RamAirWing. 
+A Wing/ RamAirWing has one or more sections.
 ```@docs
 Section
 Section(LE_point::Vector{Float64}, TE_point::Vector{Float64}, aero_model=nothing, aero_data=nothing)
 Wing
 Wing(n_panels::Int; spanwise_panel_distribution::PanelDistribution=LINEAR,
      spanwise_direction::PosVector=MVec3([0.0, 1.0, 0.0]))
-KiteWing
-KiteWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
+RamAirWing
+RamAirWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
          n_panels=54, n_sections=n_panels+1, spanwise_panel_distribution=UNCHANGED, 
          spanwise_direction=[0.0, 1.0, 0.0])
 BodyAerodynamics

examples/bench.jl

@@ -57,7 +57,7 @@ println("Rectangular wing, solve:")
 @time solve(vsm_solver, wa)
 
 # Create wing geometry
-wing = KiteWing("data/ram_air_kite_body.obj", "data/ram_air_kite_foil.dat")
+wing = RamAirWing("data/ram_air_kite_body.obj", "data/ram_air_kite_foil.dat")
 body_aero = BodyAerodynamics([wing])
 
 # Create solvers

examples/ram_air_kite.jl

@@ -7,7 +7,7 @@ USE_TEX = false
 DEFORM = false
 
 # Create wing geometry
-wing = KiteWing("data/ram_air_kite_body.obj", "data/ram_air_kite_foil.dat")
+wing = RamAirWing("data/ram_air_kite_body.obj", "data/ram_air_kite_foil.dat")
 body_aero = BodyAerodynamics([wing];)
 
 if DEFORM

src/VortexStepMethod.jl

@@ -18,7 +18,7 @@ using SharedArrays
 using Pkg
 
 # Export public interface
-export Wing, Section, KiteWing
+export Wing, Section, RamAirWing
 export BodyAerodynamics
 export Solver, solve, solve_base, solve!, VSMSolution
 export calculate_results

src/body_aerodynamics.jl

@@ -112,7 +112,7 @@ function init!(body_aero::BodyAerodynamics;
 
         # Create panels
         for i in 1:wing.n_panels
-            if wing isa KiteWing
+            if wing isa RamAirWing
                 beta = wing.beta_dist[i]
             else
                 beta = 0.0

src/kite_geometry.jl

@@ -297,7 +297,7 @@ end
 
 
 """
-    KiteWing
+    RamAirWing
 
 Represents a curved wing that inherits from Wing with additional geometric properties.
 
@@ -319,15 +319,15 @@ Represents a curved wing that inherits from Wing with additional geometric prope
   - area_interp::Extrapolation
 
 """
-mutable struct KiteWing <: AbstractWing
+mutable struct RamAirWing <: AbstractWing
     n_panels::Int64
     spanwise_panel_distribution::PanelDistribution
     spanwise_direction::MVec3
     sections::Vector{Section}
     refined_sections::Vector{Section}
     remove_nan::Bool
 
-    # Additional fields for KiteWing
+    # Additional fields for RamAirWing
     non_deformed_sections::Vector{Section}
     mass::Float64
     circle_center_z::Float64
@@ -342,11 +342,11 @@ mutable struct KiteWing <: AbstractWing
 end
 
 """
-    KiteWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
+    RamAirWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
              n_panels=54, n_sections=n_panels+1, spanwise_panel_distribution=UNCHANGED, 
              spanwise_direction=[0.0, 1.0, 0.0], remove_nan::Bool=true)
 
-Constructor for a [KiteWing](@ref) that allows to use an `.obj` and a `.dat` file as input.
+Constructor for a [RamAirWing](@ref) that allows to use an `.obj` and a `.dat` file as input.
 
 # Parameters
 - obj_path: Path to the `.obj` file used for creating the geometry
@@ -364,7 +364,7 @@ Constructor for a [KiteWing](@ref) that allows to use an `.obj` and a `.dat` fil
 - `spanwise_direction`=[0.0, 1.0, 0.0]
 - `remove_nan::Bool`: Wether to remove the NaNs from interpolations or not
 """
-function KiteWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
+function RamAirWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10., mass=1.0, 
                   n_panels=54, n_sections=n_panels+1, spanwise_panel_distribution=UNCHANGED, 
                   spanwise_direction=[0.0, 1.0, 0.0], remove_nan=true)
 
@@ -420,26 +420,26 @@ function KiteWing(obj_path, dat_path; alpha=0.0, crease_frac=0.75, wind_vel=10.,
         push!(sections, Section(LE_point, TE_point, POLAR_MATRICES, aero_data))
     end
 
-    KiteWing(n_panels, spanwise_panel_distribution, spanwise_direction, sections, sections, remove_nan, sections,
+    RamAirWing(n_panels, spanwise_panel_distribution, spanwise_direction, sections, sections, remove_nan, sections,
         mass, circle_center_z, gamma_tip, inertia_tensor, radius,
         le_interp, te_interp, area_interp, zeros(n_panels), zeros(n_panels))
 end
 
 """
-    deform!(wing::KiteWing, alphas::AbstractVector, betas::AbstractVector; width)
+    deform!(wing::RamAirWing, alphas::AbstractVector, betas::AbstractVector; width)
 
 Deform wing by applying left and right alpha and beta.
 
 # Arguments
-- `wing`: KiteWing to deform
+- `wing`: RamAirWing to deform
 - `alphas`: [left, right] the angle between of the kite and the body x-axis in radians
 - `betas`: [left, right] the deformation of the trailing edges
 - `width`: Transition width in meters to smoothe out the transition from left to right deformation
 
 # Effects
 Updates wing.sections with deformed geometry
 """
-function deform!(wing::KiteWing, alphas::AbstractVector, betas::AbstractVector; width)
+function deform!(wing::RamAirWing, alphas::AbstractVector, betas::AbstractVector; width)
     local_y = zeros(MVec3)
     chord = zeros(MVec3)
 

test/test_kite_geometry.jl

@@ -147,8 +147,8 @@ using Serialization
         @test isapprox([te_interp[i](0.0) for i in 1:3], [1.0, 0.0, r+z_center], atol=0.03)
     end
 
-    @testset "KiteWing Construction" begin
-        wing = KiteWing(test_obj_path, test_dat_path; remove_nan=true)
+    @testset "RamAirWing Construction" begin
+        wing = RamAirWing(test_obj_path, test_dat_path; remove_nan=true)
 
         @test wing.n_panels == 54  # Default value
         @test wing.spanwise_panel_distribution == UNCHANGED
@@ -161,7 +161,7 @@ using Serialization
         @test !isnan(wing.sections[1].aero_data[4][end])
         @test !isnan(wing.sections[1].aero_data[5][end])
 
-        wing = KiteWing(test_obj_path, test_dat_path; remove_nan=false)
+        wing = RamAirWing(test_obj_path, test_dat_path; remove_nan=false)
         @test isnan(wing.sections[1].aero_data[3][end])
         @test isnan(wing.sections[1].aero_data[4][end])
         @test isnan(wing.sections[1].aero_data[5][end])

test/test_plotting.jl

@@ -102,7 +102,7 @@ plt.ioff()
         rm("/tmp/Rectangular_Wing_Polars.pdf")
 
         # Step 9: Test polar data plotting
-        wing = KiteWing("test/data/ram_air_kite_body.obj", "test/data/ram_air_kite_foil.dat")
+        wing = RamAirWing("test/data/ram_air_kite_body.obj", "test/data/ram_air_kite_foil.dat")
         body_aero = BodyAerodynamics([wing])
         fig = plot_polar_data(body_aero; is_show=false)
         @test fig isa plt.PyPlot.Figure