Merge branch 'main' into perf/cut-alloc

Author: 1-Bart-1

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint
+Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint, Uwe Fechner
 Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft
 Copyright (c) 2022 Oriol Cayon, TU Delft 
 

NEWS.md

@@ -4,5 +4,6 @@ This project is based on version 1.0 of the Python project [Vortex-Step-Method](
 ## Noteworthy Differences
 - implemented in Julia, therefore about 20 times faster
 - an importer for `.obj` wing geometry files was added (see: [#10](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/issues/10))
+- automatic creation of polars using Xfoil.jl was added (see: [#43](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/pull/43))
 - a ram-air kite example was added
-- `Umag` was replaced with `v_a` as variable name for the norm of the apparent wind speed
+- `Umag` was replaced with `v_a` as variable name for the norm of the apparent wind speed

Project.toml

@@ -8,7 +8,6 @@ BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 ControlPlots = "23c2ee80-7a9e-4350-b264-8e670f12517c"
 DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
-Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -20,7 +19,6 @@ SharedArrays = "1a1011a3-84de-559e-8e89-a11a2f7dc383"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Timers = "21f18d07-b854-4dab-86f0-c15a3821819a"
-Xfoil = "19641d66-a62d-11e8-2441-8f57a969a9c4"
 
 [compat]
 BenchmarkTools = "1"
@@ -33,10 +31,15 @@ Measures = "0.3"
 NonlinearSolve = "4"
 StaticArrays = "1"
 Statistics = "1"
+Timers = "0.1"
 
 [extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Xfoil = "19641d66-a62d-11e8-2441-8f57a969a9c4"
 
 [targets]
-test = ["Test", "Documenter"]
+test = ["Test", "DataFrames", "CSV", "Distributed", "Documenter", "Xfoil"]

README.md

@@ -56,9 +56,10 @@ In Julia, first update the packages:
 using Pkg
 Pkg.update()
 ```
-and then you can execute the first example:
+and then you can display a menu with the available examples:
 ```julia
-include("examples/rectangular_wing.jl")
+using VortexStepMethod
+menu()
 ```
 To browse the code, it is suggested to use [VSCode](https://code.visualstudio.com/) with the Julia plugin.
 
@@ -104,7 +105,7 @@ add_section!(wing,
     "inviscid")
 
 # Step 3: Initialize aerodynamics
-wa = WingAerodynamics([wing])
+wa = BodyAerodynamics([wing])
 
 # Set inflow conditions
 vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
@@ -121,14 +122,19 @@ Surfplan files can be converted to an input for `VortexStepMethod.jl` using the
 
 ## Citation
 If you use this project in your research, please consider citing it. 
-Citation details can be found in the [CITATION.cff](CITATION.cff) file included in this repository.
+Citation details can be found in the [CITATION.cff](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/CITATION.cff) file included in this repository.
 
 ## License
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
+## WAIVER
+Technische Universiteit Delft hereby disclaims all copyright interest in the package “VortexStepMethod.jl” written by the Author(s).
+
+Prof.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering
+
 ### Copyright
 Copyright (c) 2022 Oriol Cayon
 
 Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft
 
-Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint
+Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint, Uwe Fechner

docs/make.jl

@@ -17,7 +17,9 @@ makedocs(;
     format = Documenter.HTML(prettyurls = haskey(ENV, "CI")),
     pages=[
         "Home" => "index.md",
+        "How it works" => "explanation.md",
         "Exported Functions" => "functions.md",
+        "Exported Types" => "types.md",
     ],
 )
 

docs/src/Flowchart.jpg

@@ -0,0 +1,13 @@
+## How the model works
+
+Flowchart that describes how this software works:
+
+![Flowchart](Flowchart.png)
+
+**AIC:** Aerodynamic Influence Coefficient (AIC). The AIC matrix represents the relationship between the induced velocities or pressures on aerodynamic surfaces and the circulation strength or modal deformations of the lifting surfaces.
+
+### References:
+
+[Fast Aero-Structural Model of a Leading-Edge Inflatable Kite](https://www.mdpi.com/1996-1073/16/7/3061) by Oriol Canon, Mac Gaunaa and Roland Schmehl, Energies 2023 16(7),   doi: 10.3390/en16073061
+
+For extensions of the original work see: [News.md](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/NEWS.md).

docs/src/Flowchart.png

@@ -0,0 +1,6 @@
+**First Term**  
+This is the definition of the first term.
+
+**Second Term**  
+This is one definition of the second term.
+This is another definition of the second term.

docs/src/explanation.md

@@ -57,9 +57,10 @@ In Julia, first update the packages:
 using Pkg
 Pkg.update()
 ```
-and then you can execute the first example:
+and then you can display a menu with the available examples:
 ```julia
-include("examples/rectangular_wing.jl")
+using VortexStepMethod
+menu()
 ```
 To browse the code, it is suggested to use [VSCode](https://code.visualstudio.com/) with the Julia plugin.
 
@@ -105,7 +106,7 @@ add_section!(wing,
     "inviscid")
 
 # Step 3: Initialize aerodynamics
-wa = WingAerodynamics([wing])
+wa = BodyAerodynamics([wing])
 
 # Set inflow conditions
 vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
@@ -125,12 +126,16 @@ If you use this project in your research, please consider citing it.
 Citation details can be found in the [CITATION.cff](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/CITATION.cff) file included in this repository.
 
 ## License
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE]((https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/LICENSE) file for details.
+
+## WAIVER
+Technische Universiteit Delft hereby disclaims all copyright interest in the package “VortexStepMethod.jl” written by the Author(s).
+
+Prof.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering
 
 ### Copyright
 Copyright (c) 2022 Oriol Cayon
 
 Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft
 
-Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint
-
+Copyright (c) 2025 Oriol Cayon, Jelle Poland, Bart van de Lint, Uwe Fechner