Merge pull request #137 from GodotMisogi/develop

Version 0.4.10: Minor bugfixes

Author: Arjit Seth

Project.toml

@@ -1,7 +1,7 @@
 name = "AeroFuse"
 uuid = "477c59f4-51f5-487f-bf1e-8db39645b227"
 authors = ["GodotMisogi <[email protected]>"]
-version = "0.4.9"
+version = "0.4.10"
 
 [deps]
 Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"

README.md

@@ -69,7 +69,7 @@ If you use AeroFuse in your research, please cite the following until any releva
   author  = {Arjit Seth, Rhea P. Liem},
   title   = {AeroFuse},
   url     = {https://github.com/GodotMisogi/AeroFuse},
-  version = {0.4.9},
-  date    = {2023-04-10},
+  version = {0.4.10},
+  date    = {2023-05-02},
 }
 ```

docs/Project.toml

@@ -2,7 +2,6 @@
 Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
-FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 PlotlyBase = "a03496cd-edff-5a9b-9e67-9cda94a718b5"

docs/lit/howto.jl

@@ -93,7 +93,7 @@ locs     = panel_location.(panels);   # Upper or lower surface
 # 
 # To define a wing, AeroFuse provides a `Wing` constructor based on the following parametrization. The named arguments correspond to the foil shapes, chord and span lengths, twist, dihedral and sweep angles.
 # !!! info
-#    A **wing section** consists of two foil profiles and their chord lengths and twist angles. Between them is their span length with associated _leading-edge_ dihedral and sweep angles. So a general half-wing consisting of ``n`` sections will have ``n`` entries for spans $b$, dihedrals $\delta$, sweeps $\Lambda$, and ``n+1`` entries for foils, chords $c$, and twists $\iota$, for some ``n \in \mathbb N``.
+#     A **wing section** consists of two foil profiles and their chord lengths and twist angles. Between them is their span length with associated _leading-edge_ dihedral and sweep angles. So a general half-wing consisting of ``n`` sections will have ``n`` entries for spans $b$, dihedrals $\delta$, sweeps $\Lambda$, and ``n+1`` entries for foils, chords $c$, and twists $\iota$, for some ``n \in \mathbb N``.
 # 
 # ![](https://godot-bloggy.xyz/post/diagrams/WingGeometry.svg)
 airfoil = naca4((2,4,1,2))
@@ -302,8 +302,7 @@ Fs, Ms = surface_dynamics(system; axes = ax)
 # A Trefftz plane integration is performed to compute farfield forces.
 # 
 # !!! note
-#     The farfield forces are usually more accurate compared to nearfield forces. 
-#     (This is because the components do not interact as in the evaluation of the Biot-Savart integrals for the latter.)
+#     The farfield forces are usually more accurate compared to nearfield forces.
 # 
 # To obtain the nearfield coefficients of the components (in wind axes by definition):
 nfs = nearfield_coefficients(system)

docs/lit/tutorials-stability.jl

@@ -170,6 +170,7 @@ fs  = Freestream(
 # Similarly, define the reference values. Here, the reference flight condition will be set to Mach number $M = 0.84$.
 M = 0.84 # Mach number
 refs = References(
+    sound_speed = 330.,
     speed    = M * 330., 
     density  = 1.225,
     span     = b_w,
@@ -201,11 +202,11 @@ dvs = freestream_derivatives(
 # You can access the derivatives of each lifting surface based on the keys defined in the `ComponentVector`.
 ac_dvs = dvs.aircraft
 
-# These quantities are the force and moment coefficients $(C_X, C_Y, C_Z, C_l, C_m, C_n, C_{D_{i,ff}}, C_{Y_{ff}} C_{L_{ff}})$ generated from the nearfield and farfield analyses, and their derivatives respect to the Mach number $M$, freestream angles of attack and sideslip $(\alpha, \beta)$, and the non-dimensional angular velocity rates $(\bar{p}, \bar{q}, \bar{r})$. The keys corresponding to the freestream derivatives should be evident:
+# These quantities are the force and moment coefficients $(C_X, C_Y, C_Z, C_l, C_m, C_n, C_{D_{i,ff}}, C_{Y_{ff}} C_{L_{ff}})$ generated from the nearfield and farfield analyses, and their derivatives respect to the Mach number $M$, freestream angles of attack and sideslip $(\alpha, \beta)$, and the non-dimensional angular velocity rates in stability axes $(\bar{p}, \bar{q}, \bar{r})$. The keys corresponding to the freestream derivatives should be evident:
 keys(dvs.aircraft)
 
 # These can be accessed either like a dictionary, or by 'dot' syntax.
-ac_dvs[:CZ_al], ac_dvs.CZ_al, ac_dvs.CLff_al # Lift coefficient derivative wrt. alpha 
+ac_dvs[:CZ_al], ac_dvs.CZ_al, ac_dvs.CL_al # Lift coefficient derivative wrt. alpha 
 
 # Note that the nearfield forces and moments $(C_X, C_Y, C_Z, C_l, C_m, C_n)$ depend on the axis system used ($C_Z$ is not lift if body axes are used!). You can also pretty-print the derivatives for each surface.
 print_derivatives(dvs.aircraft, "Aircraft", farfield = true)
@@ -241,7 +242,7 @@ stab_plt = plot(
     xaxis = L"x", yaxis = L"y", zaxis = L"z",
     aspect_ratio = 1, 
     zlim = (-0.5, 0.5) .* span(wing_mesh),
-    camera = (0,90),
+    camera = (30,60),
 )
 plot!(fuse, label = "Fuselage", alpha = 0.6)
 plot!(stab_plt, wing_mesh, label = "Wing", mac = false)

docs/src/howto.md

@@ -130,7 +130,7 @@ How to work with wing geometry.
 
 To define a wing, AeroFuse provides a `Wing` constructor based on the following parametrization. The named arguments correspond to the foil shapes, chord and span lengths, twist, dihedral and sweep angles.
 !!! info
-   A **wing section** consists of two foil profiles and their chord lengths and twist angles. Between them is their span length with associated _leading-edge_ dihedral and sweep angles. So a general half-wing consisting of ``n`` sections will have ``n`` entries for spans $b$, dihedrals $\delta$, sweeps $\Lambda$, and ``n+1`` entries for foils, chords $c$, and twists $\iota$, for some ``n \in \mathbb N``.
+    A **wing section** consists of two foil profiles and their chord lengths and twist angles. Between them is their span length with associated _leading-edge_ dihedral and sweep angles. So a general half-wing consisting of ``n`` sections will have ``n`` entries for spans $b$, dihedrals $\delta$, sweeps $\Lambda$, and ``n+1`` entries for foils, chords $c$, and twists $\iota$, for some ``n \in \mathbb N``.
 
 ![](https://godot-bloggy.xyz/post/diagrams/WingGeometry.svg)
 
@@ -393,7 +393,6 @@ A Trefftz plane integration is performed to compute farfield forces.
 
 !!! note
     The farfield forces are usually more accurate compared to nearfield forces.
-    (This is because the components do not interact as in the evaluation of the Biot-Savart integrals for the latter.)
 
 To obtain the nearfield coefficients of the components (in wind axes by definition):
 

docs/src/index.md

@@ -61,8 +61,8 @@ If you use AeroFuse in your research, please cite the following until any releva
   author  = {Arjit Seth, Rhea P. Liem},
   title   = {AeroFuse},
   url     = {https://github.com/GodotMisogi/AeroFuse},
-  version = {0.4.9},
-  date    = {2023-03-27},
+  version = {0.4.10},
+  date    = {2023-05-02},
 }
 ```
 

docs/src/tutorials-stability.md

@@ -201,7 +201,7 @@ Similarly, define the reference values. Here, the reference flight condition wil
 ````@example tutorials-stability
 M = 0.84 # Mach number
 refs = References(
-    speed    = 0.84 * 330.,
+    speed    = M * 330.,
     density  = 1.225,
     span     = b_w,
     area     = S_w,
@@ -253,16 +253,16 @@ keys(dvs.aircraft)
 These can be accessed either like a dictionary, or by 'dot' syntax.
 
 ````@example tutorials-stability
-ac_dvs[:CZ_al], ac_dvs.CZ_al, ac_dvs.CLff_al # Lift coefficient derivative wrt. alpha
+ac_dvs[:CZ_al], ac_dvs.CZ_al, ac_dvs.CL_al # Lift coefficient derivative wrt. alpha
 ````
 
 Note that the nearfield forces and moments $(C_X, C_Y, C_Z, C_l, C_m, C_n)$ depend on the axis system used ($C_Z$ is not lift if body axes are used!). You can also pretty-print the derivatives for each surface.
 
 ````@example tutorials-stability
-print_derivatives(dvs.aircraft, "Aircraft")
-print_derivatives(dvs.wing, "Wing")
-print_derivatives(dvs.htail, "Horizontal Tail")
-print_derivatives(dvs.vtail, "Vertical Tail")
+print_derivatives(dvs.aircraft, "Aircraft", farfield = true)
+print_derivatives(dvs.wing, "Wing", farfield = true)
+print_derivatives(dvs.htail, "Horizontal Tail", farfield = true)
+print_derivatives(dvs.vtail, "Vertical Tail", farfield = true)
 ````
 
 ## Static Stability Analysis
@@ -298,7 +298,7 @@ stab_plt = plot(
     xaxis = L"x", yaxis = L"y", zaxis = L"z",
     aspect_ratio = 1,
     zlim = (-0.5, 0.5) .* span(wing_mesh),
-    camera = (0,90),
+    camera = (30,60),
 )
 plot!(fuse, label = "Fuselage", alpha = 0.6)
 plot!(stab_plt, wing_mesh, label = "Wing", mac = false)

examples/aerodynamics/3d_vortex_lattice_method/vlm_aircraft.jl

@@ -27,7 +27,7 @@ htail = Wing(
     dihedrals = [0.],
     sweeps    = [6.39],
     position  = [4., 0, -0.1],
-    angle     = -2.,
+    angle     = -2,
     axis      = [0., 1., 0.],
     symmetry  = true
 )
@@ -64,7 +64,7 @@ aircraft =  ComponentVector(
 
 ## Case
 fs  = Freestream(
-    alpha = 4.0, 
+    alpha = 3.0, 
     beta  = 0.0, 
     omega = [0., 0., 0.]
 );
@@ -85,15 +85,21 @@ ref = References(
     compressible     = true, # Compressibility correction flag
     print            = true, # Prints the results for only the aircraft
     print_components = true, # Prints the results for all components
-);
+)
 
 ## Compute forces, moments and velocities over each surface
-ax_sys = Wind() # Axis systems: Geometry(), Stability(), Body()
-@time CFs, CMs = surface_coefficients(sys; axes = ax_sys) # Coefficients
+
+# Axis system for reporting forces and moments of surfaces (not nearfield and farfield)
+# Available axis systems: Geometry(), Stability(), Body(), Wind()
+ax = Wind() # Custom choice of axes
+
+@time CFs, CMs = surface_coefficients(sys;
+    axes = ax
+) # Coefficients
 # Fs, Ms   = surface_dynamics(sys; axes = ax) # Forces and moments
 # Fs       = surface_forces(sys; axes = ax) # Forces only
 # vels     = surface_velocities(sys) # Velocities
-
+;
 ## Aerodynamic coefficients
 nf  = nearfield(sys)
 ff  = farfield(sys)
@@ -103,35 +109,35 @@ ffs = farfield_coefficients(sys)
 
 ## Force/moment coefficients and derivatives
 @time dvs = freestream_derivatives(sys; 
-    axes = ax_sys,
+    axes  = Stability(),  # Optional for changing the axes
     print = true,
     print_components = true,
-    farfield = true
+    farfield = true # Farfield coefficients and derivatives
 );
 
-## Viscous drag prediction
+## Parasitic drag estimation
 
-# Equivalent flat-plate skin friction estimation
-CDv_wing  = parasitic_drag_coefficient(wing,  sys.reference, 0.8)
-CDv_htail = parasitic_drag_coefficient(htail, sys.reference, 0.6)
-CDv_vtail = parasitic_drag_coefficient(vtail, sys.reference, 0.6)
+# Wetted-area method via equivalent flat-plate skin-friction
+CDp_wing  = parasitic_drag_coefficient(wing,  sys.reference, 0.5)
+CDp_htail = parasitic_drag_coefficient(htail, sys.reference, 0.0)
+CDp_vtail = parasitic_drag_coefficient(vtail, sys.reference, 0.0)
 
-CDv_plate = CDv_wing + CDv_htail + CDv_vtail
+CDp_plate = CDp_wing + CDp_htail + CDp_vtail
 
-## Local dissipation form factor friction estimation
+## Wetted-area method via local-friction and local-dissipation
 import LinearAlgebra: norm
 
 edge_speeds = norm.(surface_velocities(sys)); # Inviscid speeds on the surfaces
 
 # Drag coefficients
-CDvd_wing  = parasitic_drag_coefficient(wing_mesh,  sys.reference, 0.8, edge_speeds.wing)
-CDvd_htail = parasitic_drag_coefficient(htail_mesh, sys.reference, 0.6, edge_speeds.htail)
-CDvd_vtail = parasitic_drag_coefficient(vtail_mesh, sys.reference, 0.6, edge_speeds.vtail)
+CDpd_wing  = parasitic_drag_coefficient(wing_mesh,  sys.reference, 0.5, edge_speeds.wing)
+CDpd_htail = parasitic_drag_coefficient(htail_mesh, sys.reference, 0.0, edge_speeds.htail)
+CDpd_vtail = parasitic_drag_coefficient(vtail_mesh, sys.reference, 0.0, edge_speeds.vtail)
 
-CDv_diss = CDvd_wing + CDvd_htail + CDvd_vtail
+CDp_diss = CDpd_wing + CDpd_htail + CDpd_vtail
 
 ## Viscous drag coefficient
-CDv = CDv_diss
+CDp = CDp_diss
 
 ## Total force coefficients with empirical viscous drag prediction
 CDi_nf, CY_nf, CL_nf, Cl, Cm, Cn = nf = nearfield(sys) 
@@ -142,6 +148,8 @@ ff_v = [ CDi_ff + CDv; CDv; ff ]
 
 print_coefficients(nf_v, ff_v)
 
+@info "L/D" ff_v[5] / ff_v[1]
+
 ## Plotting
 #=========================================================#
 

examples/aerodynamics/3d_vortex_lattice_method/vlm_benchmark.jl

@@ -2,7 +2,7 @@
 using BenchmarkTools
 
 ## BYU Flow
-using VortexLattice
+import VortexLattice
 
 function vlm_byu()
     # Simple Wing with Uniform Spacing
@@ -24,33 +24,31 @@ function vlm_byu()
     Vinf = 1.0
     ref = VortexLattice.Reference(Sref, cref, bref, rref, Vinf)
 
-    alpha = 1.0*pi/180
-    beta = 0.0
+    alpha = 2.0*pi/180
+    beta = 4.0*pi/180
     Omega = [0.0; 0.0; 0.0]
     fs = VortexLattice.Freestream(Vinf, alpha, beta, Omega)
 
     # vortex rings with mirrored geometry
     mirror = true
     symmetric = false
 
-    _, surface = wing_to_surface_panels(xle, yle, zle, chord, theta, phi, ns, nc;
+    _, surface = VortexLattice.wing_to_surface_panels(xle, yle, zle, chord, theta, phi, ns, nc;
     mirror=mirror, spacing_s=spacing_s, spacing_c=spacing_c)
 
     surfaces = [surface]
 
-    system = steady_analysis(surfaces, ref, fs; symmetric=symmetric)
+    system = VortexLattice.steady_analysis(surfaces, ref, fs; symmetric=symmetric)
 
-    CF, CM = body_forces(system; frame=VortexLattice.Stability())
-    CDiff = far_field_drag(system)
+    CF, CM = VortexLattice.body_forces(system; frame=VortexLattice.Stability())
+    CDiff = VortexLattice.far_field_drag(system)
 
     return CF, CM, CDiff, system
 end 
 
 ##
 @time CF, CM, CDiff, byu_sys = vlm_byu();
 
-print_coefficients([CF; CM], [CDiff,"—","—"], "BYU")
-
 ## AeroFuse.jl
 using AeroFuse
 
@@ -72,8 +70,8 @@ function vlm_aerofuse()
 
     # Freestream conditions
     fs  = Freestream(
-        alpha = 1.0, # deg
-        beta  = 0.0, # deg
+        alpha = 2.0, # deg
+        beta  = 4.0, # deg
         omega = [0.,0.,0.]
     )
 
@@ -89,7 +87,7 @@ function vlm_aerofuse()
     )
 
     ## Horseshoes
-    ac_hs = ComponentVector(wing = make_horseshoes(wing_mesh))
+    ac_hs = ComponentVector(wing = make_vortex_rings(wing_mesh))
     system = VortexLatticeSystem(ac_hs, fs, ref)
 
     ## Vortex rings
@@ -102,6 +100,8 @@ end
 ##
 @time nfs, ffs, sys = vlm_aerofuse();
 
+##
+print_coefficients([CF; CM], [CDiff,"—","—"], "BYU")
 print_coefficients(nfs, ffs, "AeroFuse")
 
 ## Results

src/AeroFuse.jl

@@ -111,8 +111,6 @@ export Fuselage, projected_area, length, cosine_interpolation, volume, HyperElli
 # Wing
 import .AircraftGeometry: Wing, WingSection, affine_transformation, mean_aerodynamic_chord, span, aspect_ratio, projected_area, taper_ratio, leading_edge, trailing_edge, chop_leading_edge, chop_trailing_edge, chop_wing, chop_sections, chop_coordinates, chop_spanwise_sections, chop_chords, chop_spans, make_panels, mesh_chords, mesh_wing, mesh_cambers, mean_aerodynamic_center, panel_wing, number_of_spanwise_panels, symmetric_spacing, coordinates, chord_coordinates, camber_coordinates, surface_coordinates, foils, chords, twists, spans, dihedrals, sweeps, position, orientation, WingMesh, chord_panels, camber_panels, surface_panels, AbstractSpacing, Sine, Cosine, Uniform, properties, wetted_area_ratio
 
-# export Wing, WingSection
-
 export Wing, WingSection, affine_transformation, mean_aerodynamic_chord, span, aspect_ratio, projected_area, taper_ratio, leading_edge, trailing_edge, chop_leading_edge, chop_trailing_edge, chop_wing, chop_sections, chop_coordinates, chop_spanwise_sections, chop_chords, chop_spans, make_panels, mesh_chords, mesh_wing, mesh_cambers, mean_aerodynamic_center, panel_wing, number_of_spanwise_panels, symmetric_spacing, coordinates, chord_coordinates, camber_coordinates, surface_coordinates, foils, chords, twists, spans, dihedrals, sweeps, position, orientation, WingMesh, chord_panels, camber_panels, surface_panels, AbstractSpacing, Sine, Cosine, Uniform, properties, wetted_area_ratio
 
 # Surfaces
@@ -145,9 +143,36 @@ export total_velocity, source_velocity, vortex_velocity, vortex_influence_matrix
 ## Vortex lattice
 
 include("Aerodynamics/VortexLattice/VortexLattice.jl")
-import .VortexLattice: Horseshoe, AbstractVortexLatticeSystem, VortexLatticeSystem, References, AbstractAxisSystem, Stability, Wind, Body, Geometry, streamlines, influence_coefficient, influence_matrix, boundary_condition, solve_system, bound_leg_center, bound_leg_vector, control_point, Horseshoe, surface_velocity, surface_forces, surface_moments, nearfield_drag, geometry_to_wind_axes, geometry_to_stability_axes, stability_to_geometry_axes, wind_to_geometry_axes, rate_coefficient, nearfield, farfield, farfield_forces, surface_velocities, surface_forces, surface_dynamics, surface_coefficients, nearfield_coefficients, farfield_coefficients, VortexRing, velocity, kinematic_viscosity, mach_number, stream_velocity, center_of_pressure, freestream_derivatives!, freestream_derivatives, print_coefficients, print_derivatives
 
-export Horseshoe, VortexLatticeSystem, References, AbstractAxisSystem, Stability, Wind, Body, Geometry, streamlines, influence_coefficient, influence_matrix, boundary_condition, solve_system, bound_leg_center, bound_leg_vector, control_point, Horseshoe, surface_velocity, surface_forces, surface_moments, nearfield_drag, geometry_to_wind_axes, geometry_to_stability_axes, stability_to_geometry_axes, wind_to_geometry_axes, rate_coefficient, nearfield, farfield, farfield_forces, surface_velocities, surface_forces, surface_dynamics, surface_coefficients, nearfield_coefficients, farfield_coefficients, VortexRing, velocity, kinematic_viscosity, mach_number, stream_velocity, center_of_pressure, freestream_derivatives!, freestream_derivatives, print_coefficients, print_derivatives
+# Vortex types
+import .VortexLattice: Horseshoe, VortexRing, velocity, bound_leg_center, bound_leg_vector, control_point
+
+export Horseshoe, VortexRing, velocity, bound_leg_center, bound_leg_vector, control_point
+
+# Reference values
+import .VortexLattice: References, kinematic_viscosity, mach_number
+
+export References, kinematic_viscosity, mach_number
+
+# Reference frames and traits
+import .VortexLattice: AbstractAxisSystem, Stability, Wind, Body, Geometry, geometry_to_wind_axes, geometry_to_stability_axes, stability_to_geometry_axes, wind_to_geometry_axes, wind_to_body_axes
+
+export AbstractAxisSystem, Stability, Wind, Body, Geometry, geometry_to_wind_axes, geometry_to_stability_axes, stability_to_geometry_axes, wind_to_geometry_axes, wind_to_body_axes
+
+# System methods
+import .VortexLattice: AbstractPotentialFlowSystem, VortexLatticeSystem, surface_velocity, surface_forces, surface_moments, nearfield_drag, rate_coefficient, nearfield, farfield, farfield_forces, surface_velocities, surface_forces, surface_dynamics, surface_coefficients, nearfield_coefficients, farfield_coefficients, center_of_pressure
+
+export AbstractPotentialFlowSystem, VortexLatticeSystem, surface_velocity, surface_forces, surface_moments, nearfield_drag, rate_coefficient, nearfield, farfield, farfield_forces, surface_velocities, surface_forces, surface_dynamics, surface_coefficients, nearfield_coefficients, farfield_coefficients, center_of_pressure
+
+# Derivatives
+import .VortexLattice: freestream_derivatives
+
+export freestream_derivatives
+
+# Post-prrocessing
+import .VortexLattice: print_coefficients, print_derivatives, streamlines
+
+export print_coefficients, print_derivatives, streamlines
 
 ## Panel-VLM interface
 include("Aerodynamics/vlm_interface.jl")