document frame and rename global to body

Author: 1-Bart-1

src/body_aerodynamics.jl

@@ -406,7 +406,7 @@ end
                      va_unit_array::Matrix{Float64}, panels::Vector{Panel},
                      is_only_f_and_gamma_output::Bool)
 
-Calculate final aerodynamic results.
+Calculate final aerodynamic results. Reference point is in the kite body (KB) frame.
 
 Returns:
     Dict: Results including forces, coefficients and distributions
@@ -478,8 +478,8 @@ function calculate_results(
     cl_prescribed_va = Float64[]
     cd_prescribed_va = Float64[]
     cs_prescribed_va = Float64[]
-    f_global_3D = zeros(3, n_panels)
-    m_global_3D = zeros(3, n_panels)
+    f_body_3D = zeros(3, n_panels)
+    m_body_3D = zeros(3, n_panels)
     area_all_panels = 0.0
 
     # Initialize force sums
@@ -533,8 +533,8 @@ function calculate_results(
         side_prescribed_va = dot(lift_induced_va, spanwise_direction) + 
                            dot(drag_induced_va, spanwise_direction)
 
-        # Global forces
-        f_global_3D[:,i] .= [
+        # Body frame forces
+        f_body_3D[:,i] .= [
             dot(ftotal_induced_va, [1.0, 0.0, 0.0]),
             dot(ftotal_induced_va, [0.0, 1.0, 0.0]),
             dot(ftotal_induced_va, [0.0, 0.0, 1.0])
@@ -551,30 +551,30 @@ function calculate_results(
         push!(cs_prescribed_va, side_prescribed_va / (q_inf * panel.chord))
 
         ### Moment ###
-        # (1) Panel aerodynamic center in global frame:
-        panel_ac_global = panel.aero_center  # 3D [x, y, z]
+        # (1) Panel aerodynamic center in body frame:
+        panel_ac_body = panel.aero_center  # 3D [x, y, z]
 
-        # (2) Convert local (2D) pitching moment to a 3D vector in global coords.
+        # (2) Convert local (2D) pitching moment to a 3D vector in body coords.
         #     Use the axis around which the moment is defined,
         #     which is the z-axis pointing "spanwise"
-        moment_axis_global = panel.z_airf
+        moment_axis_body = panel.z_airf
 
         # Scale by panel width if your 'moment[i]' is 2D moment-per-unit-span:
-        M_local_3D = moment[i] * moment_axis_global * panel.width
+        M_local_3D = moment[i] * moment_axis_body * panel.width
 
         # Vector from panel AC to the chosen reference point:
-        r_vector = panel_ac_global - reference_point  # e.g. CG, wing root, etc.
+        r_vector = panel_ac_body - reference_point  # e.g. CG, wing root, etc.
 
         # Cross product to shift the force from panel AC to ref. point:
-        M_shift = cross(r_vector, f_global_3D[:,i])
+        M_shift = cross(r_vector, f_body_3D[:,i])
 
         # Total panel moment about the reference point:
-        m_global_3D[:,i] = M_local_3D + M_shift
+        m_body_3D[:,i] = M_local_3D + M_shift
     end
 
     if is_only_f_and_gamma_output
         return Dict{String,Any}(
-            "F_distribution" => f_global_3D,
+            "F_distribution" => f_body_3D,
             "gamma_distribution" => gamma_new
         )
     end
@@ -596,28 +596,28 @@ function calculate_results(
 
     # Create results dictionary
     results = Dict{String,Any}(
-        "Fx" => sum(f_global_3D[1,:]),
-        "Fy" => sum(f_global_3D[2,:]),
-        "Fz" => sum(f_global_3D[3,:]),
-        "Mx" => sum(m_global_3D[1,:]),
-        "My" => sum(m_global_3D[2,:]),
-        "Mz" => sum(m_global_3D[3,:]),
+        "Fx" => sum(f_body_3D[1,:]),
+        "Fy" => sum(f_body_3D[2,:]),
+        "Fz" => sum(f_body_3D[3,:]),
+        "Mx" => sum(m_body_3D[1,:]),
+        "My" => sum(m_body_3D[2,:]),
+        "Mz" => sum(m_body_3D[3,:]),
         "lift" => lift_wing_3D_sum,
         "drag" => drag_wing_3D_sum,
         "side" => side_wing_3D_sum,
         "cl" => lift_wing_3D_sum / (q_inf * projected_area),
         "cd" => drag_wing_3D_sum / (q_inf * projected_area),
         "cs" => side_wing_3D_sum / (q_inf * projected_area),
-        "cmx" => sum(m_global_3D[1,:]) / (q_inf * projected_area * max_chord),
-        "cmy" => sum(m_global_3D[2,:]) / (q_inf * projected_area * max_chord),
-        "cmz" => sum(m_global_3D[3,:]) / (q_inf * projected_area * max_chord),
+        "cmx" => sum(m_body_3D[1,:]) / (q_inf * projected_area * max_chord),
+        "cmy" => sum(m_body_3D[2,:]) / (q_inf * projected_area * max_chord),
+        "cmz" => sum(m_body_3D[3,:]) / (q_inf * projected_area * max_chord),
         "cl_distribution" => cl_prescribed_va,
         "cd_distribution" => cd_prescribed_va,
         "cs_distribution" => cs_prescribed_va,
-        "F_distribution" => f_global_3D,
-        "cfx" => (sum(f_global_3D[1,:]) / (q_inf * projected_area)),
-        "cfy" => (sum(f_global_3D[2,:]) / (q_inf * projected_area)),
-        "cfz" => (sum(f_global_3D[3,:]) / (q_inf * projected_area)),
+        "F_distribution" => f_body_3D,
+        "cfx" => (sum(f_body_3D[1,:]) / (q_inf * projected_area)),
+        "cfy" => (sum(f_body_3D[2,:]) / (q_inf * projected_area)),
+        "cfz" => (sum(f_body_3D[3,:]) / (q_inf * projected_area)),
         "alpha_at_ac" => alpha_corrected,
         "alpha_uncorrected" => alpha_array,
         "alpha_geometric" => alpha_geometric,

src/solver.jl

@@ -57,7 +57,7 @@ end
 """
     solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing; log=false)
 
-Main solving routine for the aerodynamic model.
+Main solving routine for the aerodynamic model. Reference point is in the kite body (KB) frame.
 """
 function solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing; log=false, reference_point=zeros(MVec3))
     isnothing(body_aero.panels[1].va) && throw(ArgumentError("Inflow conditions are not set, use set_va!(body_aero, va)"))