Refactor Section, use @with_kw; refactor Wing (#82)

* export MVec3

* Refactor Section

* Add comment

* Both versions of Section now documented.

* cleanup

* document init!

* refactoring

* use outer constructor and document it (for Wing)

* Change inner to outer construcctor for KiteWing

* Add/ update docstrings for KiteWing

* update docstring

* Update docstring

* improve script build_docu.jl

---------

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

Author: ufechner7

docs/src/private_functions.md

@@ -5,4 +5,5 @@ CurrentModule = VortexStepMethod
 ## Private Functions
 ```@docs
 calculate_AIC_matrices!
+init!
 ```

docs/src/types.md

@@ -11,19 +11,25 @@ InitialGammaDistribution
 
 ## Basic Vectors
 ```@docs
-   MVec3
-   PosVector
-   VelVector
+MVec3
+PosVector
+VelVector
 ```
 
 ## 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.
 ```@docs
-    Section
-    Wing
-    KiteWing
-    BodyAerodynamics
+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, 
+         n_panels=54, n_sections=n_panels+1, spanwise_panel_distribution=UNCHANGED, 
+         spanwise_direction=[0.0, 1.0, 0.0])
+BodyAerodynamics
 ```
 
 ## The Solver

scripts/build_docu.jl

@@ -1,5 +1,9 @@
 # build and display the html documentation locally
 # you must have installed the package LiveServer in your global environment
 
-using TestEnv; TestEnv.activate()
+using Pkg
+if !("Documenter" ∈ keys(Pkg.project().dependencies))
+    using TestEnv
+    TestEnv.activate()
+end
 using LiveServer; servedocs(launch_browser=true)

src/VortexStepMethod.jl

@@ -22,7 +22,7 @@ export Solver, solve
 export calculate_results, solve_circulation_distribution
 export add_section!, set_va!
 export calculate_span, calculate_projected_area
-export menu
+export menu, MVec3
 export Model, VSM, LLT
 export AeroModel, LEI_AIRFOIL_BREUKELS, POLAR_DATA, INVISCID
 export PanelDistribution, LINEAR, COSINE, COSINE_VAN_GARREL, SPLIT_PROVIDED, UNCHANGED

src/kite_geometry.jl

@@ -209,70 +209,93 @@ mutable struct KiteWing <: AbstractWing
     te_interp::Extrapolation
     area_interp::Extrapolation
 
-    function KiteWing(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])
-        
-        !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
-        (!endswith(dat_path, ".dat")) && (dat_path *= ".dat")
-        (!isfile(dat_path)) && error("DAT file not found: $dat_path")
-        polar_path = dat_path[1:end-4] * "_polar.bin"
-        
-        (!endswith(obj_path, ".obj")) && (obj_path *= ".obj")
-        (!isfile(obj_path)) && error("OBJ file not found: $obj_path")
-        info_path = obj_path[1:end-4] * "_info.bin"
-
-        if !ispath(polar_path) || !ispath(info_path)
-            @info "Reading $obj_path"
-            vertices, faces = read_faces(obj_path)
-            center_of_mass = calculate_com(vertices, faces)
-            !(abs(center_of_mass[2]) < 0.01) && @error "Center of mass $center_of_mass has to lie on x-axis."
-            inertia_tensor = calculate_inertia_tensor(vertices, faces, mass, center_of_mass)
-    
-            circle_center_z, radius, gamma_tip = find_circle_center_and_radius(vertices)
-            le_interp, te_interp, area_interp = create_interpolations(vertices, circle_center_z, radius, gamma_tip)
-            @info "Writing $info_path"
-            serialize(info_path, (center_of_mass, inertia_tensor, circle_center_z, radius, gamma_tip, 
-                le_interp, te_interp, area_interp))
-
-            width = 2gamma_tip * radius
-            area = area_interp(gamma_tip)
-            @eval Main begin
-                foil_path, polar_path, v_wind, area, width, x_turn =
-                    $dat_path, $polar_path, $wind_vel, $gamma_tip, $width, $crease_frac
-                include("../scripts/polars.jl")
-            end
-        end
+end
 
-        @info "Loading polars and kite info from $polar_path and $info_path"
-        (alpha_range, beta_range, cl_matrix::Matrix, cd_matrix::Matrix, cm_matrix::Matrix) = deserialize(polar_path)
-    
-        (center_of_mass, inertia_tensor, circle_center_z, radius, gamma_tip, 
-            le_interp, te_interp, area_interp) = deserialize(info_path)
-        
-        # Create sections
-        sections = Section[]
-        for gamma in range(-gamma_tip, gamma_tip, n_sections)
-            aero_data = (collect(alpha_range), collect(beta_range), cl_matrix, cd_matrix, cm_matrix)
-            LE_point = [0.0, 0.0, circle_center_z] .+ [le_interp(gamma), sin(gamma) * radius, cos(gamma) * radius]
-            if !isapprox(alpha, 0.0)
-                local_y_vec = [0.0, sin(-gamma), cos(gamma)] × [1.0, 0.0, 0.0]
-                TE_point = LE_point .+ rotate_v_around_k([te_interp(gamma) - le_interp(gamma), 0.0, 0.0], local_y_vec, alpha)
-            else
-                TE_point = LE_point .+ [te_interp(gamma) - le_interp(gamma), 0.0, 0.0]
-            end
-            push!(sections, Section(LE_point, TE_point, POLAR_DATA, aero_data))
+"""
+    KiteWing(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])
+
+Constructor for a [KiteWing](@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
+- dat_path: Path to the `.dat` file, a standard format for 2d foil geometry
+
+# Keyword Parameters
+- alpha=0.0: Angle of attack of each segment relative to the x axis [rad]
+- crease_frac=0.75: The x coordinate around which the trailing edge rotates on a normalized 2d foil, 
+                    used in the xfoil polar generation
+- wind_vel=10.0: Apparent wind speed in m/s, used in the xfoil polar generation
+- mass=1.0: Mass of the wing in kg, used for the inertia calculations 
+- `n_panels`=54: Number of panels.
+- `n_sections`=n_panels+1: Number of sections (there is a section on each side of each panel.)
+- `spanwise_panel_distribution`=UNCHANGED: see: [PanelDistribution](@ref)
+- `spanwise_direction`=[0.0, 1.0, 0.0]
+"""
+function KiteWing(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])
+
+    !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
+    (!endswith(dat_path, ".dat")) && (dat_path *= ".dat")
+    (!isfile(dat_path)) && error("DAT file not found: $dat_path")
+    polar_path = dat_path[1:end-4] * "_polar.bin"
+
+    (!endswith(obj_path, ".obj")) && (obj_path *= ".obj")
+    (!isfile(obj_path)) && error("OBJ file not found: $obj_path")
+    info_path = obj_path[1:end-4] * "_info.bin"
+
+    if !ispath(polar_path) || !ispath(info_path)
+        @info "Reading $obj_path"
+        vertices, faces = read_faces(obj_path)
+        center_of_mass = calculate_com(vertices, faces)
+        !(abs(center_of_mass[2]) < 0.01) && @error "Center of mass $center_of_mass has to lie on x-axis."
+        inertia_tensor = calculate_inertia_tensor(vertices, faces, mass, center_of_mass)
+
+        circle_center_z, radius, gamma_tip = find_circle_center_and_radius(vertices)
+        le_interp, te_interp, area_interp = create_interpolations(vertices, circle_center_z, radius, gamma_tip)
+        @info "Writing $info_path"
+        serialize(info_path, (center_of_mass, inertia_tensor, circle_center_z, radius, gamma_tip, 
+            le_interp, te_interp, area_interp))
+
+        width = 2gamma_tip * radius
+        area = area_interp(gamma_tip)
+        @eval Main begin
+            foil_path, polar_path, v_wind, area, width, x_turn =
+                $dat_path, $polar_path, $wind_vel, $gamma_tip, $width, $crease_frac
+            include("../scripts/polars.jl")
         end
+    end
+
+    @info "Loading polars and kite info from $polar_path and $info_path"
+    (alpha_range, beta_range, cl_matrix::Matrix, cd_matrix::Matrix, cm_matrix::Matrix) = deserialize(polar_path)
+
+    (center_of_mass, inertia_tensor, circle_center_z, radius, gamma_tip, 
+        le_interp, te_interp, area_interp) = deserialize(info_path)
 
-        new(
-            n_panels, spanwise_panel_distribution, spanwise_direction, sections, sections,
-            mass, center_of_mass, circle_center_z, gamma_tip, inertia_tensor, radius,
-            le_interp, te_interp, area_interp
-        )
+    # Create sections
+    sections = Section[]
+    for gamma in range(-gamma_tip, gamma_tip, n_sections)
+        aero_data = (collect(alpha_range), collect(beta_range), cl_matrix, cd_matrix, cm_matrix)
+        LE_point = [0.0, 0.0, circle_center_z] .+ [le_interp(gamma), sin(gamma) * radius, cos(gamma) * radius]
+        if !isapprox(alpha, 0.0)
+            local_y_vec = [0.0, sin(-gamma), cos(gamma)] × [1.0, 0.0, 0.0]
+            TE_point = LE_point .+ rotate_v_around_k([te_interp(gamma) - le_interp(gamma), 0.0, 0.0], local_y_vec, alpha)
+        else
+            TE_point = LE_point .+ [te_interp(gamma) - le_interp(gamma), 0.0, 0.0]
+        end
+        push!(sections, Section(LE_point, TE_point, POLAR_DATA, aero_data))
     end
+
+    KiteWing(n_panels, spanwise_panel_distribution, spanwise_direction, sections, sections,
+        mass, center_of_mass, circle_center_z, gamma_tip, inertia_tensor, radius,
+        le_interp, te_interp, area_interp)
 end
 
+
 function rotate_v_around_k(v, k, θ)
     k = normalize(k)
     v_rot = v * cos(θ) + (k × v) * sin(θ)  + k * (k ⋅ v) * (1 - cos(θ))

src/wing_geometry.jl

@@ -1,39 +1,45 @@
 
 """
-    Section
+    mutable struct Section
 
 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_model`::AeroModel: [AeroModel](@ref)
-- `aero_data`: Can be:
+- `LE_point::MVec3` = zeros(MVec3): Leading edge point coordinates
+- `TE_point::MVec3` = zeros(MVec3): Trailing edge point coordinates
+- `aero_model`::AeroModel = INVISCID: [AeroModel](@ref)
+- `aero_data` = nothing: Can be:
   - nothing for INVISCID
   - (`tube_diameter`, camber) for `LEI_AIRFOIL_BREUKELS`
   - (`alpha_range`, `cl_vector`, `cd_vector`, `cm_vector`) for `POLAR_DATA`
   - (`alpha_range`, `beta_range`, `cl_matrix`, `cd_matrix`, `cm_matrix`) for `POLAR_DATA`        
 """
-mutable struct Section
-    LE_point::MVec3
-    TE_point::MVec3
-    aero_model::AeroModel
+@with_kw mutable struct Section
+    LE_point::MVec3 = zeros(MVec3)
+    TE_point::MVec3 = zeros(MVec3)
+    aero_model::AeroModel = INVISCID
     aero_data::Union{
         Nothing,
         NTuple{2, Float64},
         Tuple{Vector{Float64}, Vector{Float64}, Vector{Float64}, Vector{Float64}},
         Tuple{Vector{Float64}, Vector{Float64}, Matrix{Float64}, Matrix{Float64}, Matrix{Float64}}
-    }
-    function Section(
-            LE_point::PosVector = zeros(MVec3), 
-            TE_point::PosVector = zeros(MVec3), 
-            aero_model::AeroModel = INVISCID,
-            aero_data = nothing
-            )
-        new(LE_point, TE_point, aero_model, aero_data)
-    end
+    } = nothing
+end
+"""
+    Section(LE_point::Vector{Float64}, TE_point::Vector{Float64}, 
+            aero_model=INVISCID, aero_data=nothing)
+
+Constructor for [Section](@ref) that allows to pass Vectors of Float64 as point coordinates.
+"""
+function Section(LE_point::Vector{Float64}, TE_point::Vector{Float64}, aero_model=INVISCID, aero_data=nothing)
+    Section(MVec3(LE_point), MVec3(TE_point), aero_model, aero_data)
 end
 
+"""
+    init!(section::Section, LE_point, TE_point, aero_model=nothing, aero_data=nothing)
+
+Function to update a [Section](@ref) in place.
+"""
 function init!(section::Section, LE_point, TE_point, aero_model=nothing, aero_data=nothing)
     section.LE_point .= LE_point
     section.TE_point .= TE_point
@@ -69,26 +75,36 @@ Represents a wing composed of multiple sections with aerodynamic properties.
 # Fields
 - `n_panels::Int64`: Number of panels in aerodynamic mesh
 - `spanwise_panel_distribution`::PanelDistribution: [PanelDistribution](@ref)
-- `spanwise_direction::Vector{Float64}`: Wing span direction vector
-- `sections::Vector{Section}`: List of wing sections, see: [Section](@ref)
+- `spanwise_direction::MVec3`: Wing span direction vector
+- `sections::Vector{Section}`: Vector of wing sections, see: [Section](@ref)
+- `refined_sections::Vector{Section}`: Vector of refined wing sections, see: [Section](@ref)
 
 """
 mutable struct Wing <: AbstractWing
     n_panels::Int64
     spanwise_panel_distribution::PanelDistribution
-    spanwise_direction::PosVector
+    spanwise_direction::MVec3
     sections::Vector{Section}
     refined_sections::Vector{Section}
-    
-    function Wing(n_panels::Int;
-                 spanwise_panel_distribution::PanelDistribution=LINEAR,
-                 spanwise_direction::PosVector=MVec3([0.0, 1.0, 0.0]))
-        new(n_panels, 
-            spanwise_panel_distribution, 
-            spanwise_direction, 
-            Section[],
-            Section[])
-    end
+end
+
+"""
+    Wing(n_panels::Int;
+         spanwise_panel_distribution::PanelDistribution=LINEAR,
+         spanwise_direction::PosVector=MVec3([0.0, 1.0, 0.0]))
+
+Constructor for a [Wing](@ref) struct with default values that initializes the sections 
+and refined sections as empty arrays.
+
+# Parameters
+- `n_panels::Int64`: Number of panels in aerodynamic mesh
+- `spanwise_panel_distribution`::PanelDistribution = LINEAR: [PanelDistribution](@ref)
+- `spanwise_direction::MVec3` = MVec3([0.0, 1.0, 0.0]): Wing span direction vector
+"""
+function Wing(n_panels::Int;
+    spanwise_panel_distribution::PanelDistribution=LINEAR,
+    spanwise_direction::PosVector=MVec3([0.0, 1.0, 0.0]))
+    Wing(n_panels, spanwise_panel_distribution, spanwise_direction, Section[], Section[])
 end
 
 function init!(wing::AbstractWing; aero_center_location::Float64=0.25, control_point_location::Float64=0.75)