Develop #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

jellepoland merged 89 commits into main from develop

Sep 25, 2025

.gitignore

-Original file line number
+Diff line change
@@ -1,9 +1,16 @@
     # User defined files and folders
     #data/
     # processed_data/
-    # results/
+    results/
     old_code/
     venv/
+    V9_KITE/
+    # Data directories - exclude files but keep README.md
+    data/ml_models/*
+    !data/mlmodels/README.md
+    data/cache/*
+    !data/cache/README.md
     # Byte-compiled / optimized / DLL files
@@ Expand Down @@

.vscode/settings.json

-Original file line number
+Diff line change
@@ -0,0 +1,7 @@
+    {
+        "python.testing.pytestArgs": [
+            "tests"
+        ],
+        "python.testing.unittestEnabled": false,
+        "python.testing.pytestEnabled": true
+    }

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,31 @@
  
    # Vortex Step Method

    The Vortex Step Method (VSM) is an enhanced lifting line method that improves upon the classic approach by solving the circulation system at the three-quarter chord position, among the most important details. This adjustment allows for more accurate calculations of lift and drag forces, particularly addressing the shortcomings in induced drag prediction. VSM is further refined by coupling it with 2D viscous airfoil polars, making it well-suited for complex geometries, including low aspect ratio wings, as well as configurations with sweep, dihedral, and anhedral angles.

    The Vortex Step Method (VSM) is an enhanced lifting line method that improves upon the classic approach by solving the circulation system at the three-quarter chord position. This adjustment allows for more accurate calculations of lift and drag forces, particularly addressing the shortcomings in induced drag prediction. VSM is further refined by coupling it with 2D viscous airfoil polars, making it well-suited for complex geometries, including low aspect ratio wings, as well as configurations with sweep, dihedral, and anhedral angles. Which are typical for leading-edge inflatable (LEI) kites, that are used in airborne wind energy production, boat-towing and kite-surfing. An open-source example kite is the [TU Delft V3 Kite](https://awegroup.github.io/TUDELFT_V3_KITE/), of which a video is shown below, made using the internal plotting library.

    The software presented here includes a couple of examples: a rectangular wing and a leading-edge inflatable kite.

    ![](docs/TUDELFT_V3_KITE_plotly.gif)

    The software presented here includes examples for: a rectangular wing and a leading-edge inflatable kite.

    A Julia version of this project is available at [VortexStepMethod.jl](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl)

    ## Documentation

    For detailed documentation, please refer to the following resources.

    **Explanatory Notes**

    - [Aerodynamic Model](docs/Aerodynamic_model.pdf)

    - [Paper: Fast Aero-Structural Model of a Leading-Edge Inflatable Kite](https://doi.org/10.3390/en16073061)

    **Code Core**

    - [Airfoil Aerodynamics](docs/AirfoilAerodynamics.md)

    - [Body Aerodynamics](docs/BodyAerodynamics.md)

    - [Filament](docs/Filament.md)

    - [Panel](docs/Panel.md)

    - [Solver](docs/Solver.md)

    - [Wake](docs/Wake.md)

    - [WingGeometry](docs/WingGeometry.md)

    **Other**

    - [Nomenclature](docs/nomenclature.md)

    - [Style Guide](docs/style_guide.md)

    ## Installation Instructions

    1. Clone the repository:

    @@ -52,7 +76,7 @@ The software presented here includes a couple of examples: a rectangular wing an
  
        For ubuntu add:

        ```

        pip instal pyqt5

        pip install pyqt5

        sudo apt install cm-super

        sudo apt install dvipng

       ```

    @@ -61,26 +85,33 @@ The software presented here includes a couple of examples: a rectangular wing an
  
        ```bash

        deactivate

        ```

    ### Dependencies

    - numpy

    - matplotlib>=3.7.1

    - seaborn

    - scipy

    - numba

    - ipykernel

    - screeninfo

    ## Dependencies

    -  numpy

    -  matplotlib

    -  scipy

    -  plotly

    -  pandas

    -  neuralfoil

    -  PyYAML

    -  scikit-learn

    -  numba

    -  screeninfo

    See also [pyproject.toml](pyproject.toml)

    **Machine Learning**

    The code base is adapted to work with a machine learning model trained on more than a hundred thousands Reynolds-average Navier Stokes (RANS) Computational Fluid Dynamics (CFD) simulations made for leading-edge inflatable airfoils, documented in the MSc. thesis of [K.R.G. Masure](https://resolver.tudelft.nl/uuid:865d59fc-ccff-462e-9bac-e81725f1c0c9), the [code base is also open-source accessible](https://github.com/awegroup/Pointwise-Openfoam-toolchain).

    As the three trained models, for Reynolds number = 1e6, 5e6 and 1e7 are too large (~2.3GB) for GitHub, they have to be downloaded separately, and added to the `data/ml_models` folder. They are accessible trough [Zenodo](https://doi.org/10.5281/zenodo.16925758), and so is the [CFD data](https://doi.org/10.5281/zenodo.16925833) on which the models are trained. More description on its usages is found in [Airfoil Aerodynamics](docs/AirfoilAerodynamics.md).

    ## Usages

    Please look at the tutorial on a rectangular wing, where the code usage and settings are fully detailed.

    You can find it in `examples/rectangular_wing/tutorial_rectangular_wing.py`

    Another tutorial is present under `examples/TUDELFT_V3_LEI_KITE/tutorial_testing_stall_model.py` where a geometry is loaded from .csv, plotted, distributions are plotted and polars are created to demonstrate the effect of the stall model.

    For more detailed information one is referred to:

    - [Aerodynamic model](docs/Aerodynamic_model.pdf)

    - [Paper: Fast Aero-Structural Model of a Leading-Edge Inflatable Kite](https://doi.org/10.3390/en16073061) 

    A Julia version of this project is available at [VortexStepMethod.jl](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl)

    Another tutorial is present under `examples/TUDELFT_V3_LEI_KITE/tutorial.py` where a geometry is loaded from .yaml, plotted, distributions are plotted and polars are created to demonstrate the effect of the stall model.

    ## Contributing Guide

    Please report issues and create pull requests using the URL:

changelog.md

-Original file line number
+Diff line change
@@ -0,0 +1,230 @@
+    # Change Log
+    All notable changes to this project will be documented in this file.
+    The format is based on [Keep a Changelog](http://keepachangelog.com/)
+    and this project adheres to [Semantic Versioning](http://semver.org/).
+    ## 2025-09-22
+    ### ⚠️ Breaking Changes
+    - **Class rename:** `WingAerodynamics` → **`BodyAerodynamics`**.
+    - **Dataset path rename:** `TUDELFT_V3_LEI_KITE` → **`TUDELFT_V3_KITE`**.
+    - **Polar input format update:**
+      - 3D: `alpha, CL, CD, CM`
+      - 2D: `alpha, Cl, Cd, Cm` (note the capitalization difference)
+    - **Defaults & options:**
+      - Default spanwise panel distribution → **`uniform`**
+      - Removed options/attributes: **`using_previous gamma`**, **`min_relaxation_error`**, **`is_new_vector_definition`**.
+    - **Stall model refactor:** Simonet-related stall logic moved out of `Solver` into **`solver_functions`** and a dedicated *stall* branch.
+    ---
+    ### Added
+    - **AirfoilAerodynamics framework**
+      - New base class **`AirfoilAerodynamics`** (parent for all airfoil types).
+      - **`masure_regression`** airfoil with on-disk **caching** for fast reuse.
+      - **YAML** configuration input for airfoil definitions.
+      - New **tests** for `AirfoilAerodynamics`.
+    - **LEI parametric model (masure_regression_lei_parametric)**
+      - Examples showing how to reconstruct a **LEI airfoil** using 6 parameters:
+        `t, eta, kappa, delta, lambda, phi`.
+      - Utilities for generating **airfoil geometry** and exporting **.csv / .dat**.
+    - **Half-wing inputs**
+      - Support for *half-wing* inputs in both **polar generation** and **geometry CSV** export.
+    - **Plotting & tutorials**
+      - Improved **convergence plotting** utilities.
+      - New **sensitivity analysis** examples & script (`sensitivity_analysis.py`).
+      - Updated **tutorials** (usage, sensitivity, convergence workflows).
+    - **Solver & VSM pipeline**
+      - `Solver` gains **artificial viscosity** (property + setter).
+      - Added **non-linear gamma loop** variants and **gamma loop type** selector.
+      - New `compute_aerodynamic_quantities` helper.
+      - New initial **gamma distribution** options: `elliptical`, `cosine`, `zero`.
+      - `BodyAerodynamics`:
+        - Added/renamed circulation helpers:
+          - `calculate_circulation_distribution_elliptical_wing`
+          - `calculate_circulation_distribution_cosine`
+      - **Panel**:
+        - New property: `panel_polar_data`.
+        - New `_panel_aero_model` option: `"cl_is_pisinalpha"`.
+    - **Validation & examples**
+      - Added **elliptical wing planform** test (Simonet ch. 4.1).
+      - Added **rectangular wing** test.
+      - Git now **ignores** `results/`.
+    - **(From develop) Extra analysis tools**
+      - Interactive **Plotly** visualization environment.
+      - **Moment** calculations + plotting (incl. user-defined reference point).
+      - **Panel polar investigation** function.
+      - **NeuralFoil** integration for cross-checking polars.
+      - **Bridle line forces**:
+        - Support for inputs like:
+          - `bridle_line1 = [p1, p2, diameter]` where `p1 = [x, y, z]`
+          - `bridle_lines = [bridle_line1, bridle_line2, ...]`
+      - `BodyAerodynamics` API sugar:
+        - `instantiate_body_aerodynamics` function
+        - `BodyAerodynamics.from_file(...)`
+    ---
+    ### Changed
+    - **Polars & plotting**
+      - `plotting.py::generate_3D_polar_data` now passes a **gamma distribution**
+        into the solver:
+        `results = solver.solve(body_aero, gamma_distrbution=gamma)`
+      - Legends for **distributions** and **polars** are displayed **below** plots.
+      - Improved clarity and formatting of plot outputs.
+    - **Solver internals**
+      - Revised `__init__`, added artificial viscosity, refactored internal state to `self.*` for broader accessibility.
+      - Revised **gamma initialization** and **feedback** handling.
+      - Adjusted **Simonet** model plumbing and naming (`elliptic` → `elliptical`).
+    - **BodyAerodynamics**
+      - `calculate_panel_properties`: replaced hardcoded `0.25 / 0.75` with **`ac`** (aerodynamic center) and **`cp`** (center of pressure).
+    - **Docs & tutorials**
+      - Updated **docstrings**, **tutorials**, and **user guides** to reflect the new APIs and behaviors.
+      - Expanded convergence & sensitivity study guidance (e.g., `n_panels`).
+    - **Vector conventions**
+      - Normalized aerodynamic vector handling for consistency across modules.
+    - **Polar engineering**
+      - Updated to use **Surfplan** profiles; adjusted `POLAR` behavior and tests.
+    ---
+    ### Fixed
+    - Polar data **input robustness** and format handling.
+    - **Reference point** handling in moment computations.
+    - Multiple failing tests in **Panel**.
+    - Plot output issues (including prior formatting issues, e.g. #85).
+    - Numerous **docstring** and minor consistency fixes.
+    ---
+    ### Removed
+    - `min_relaxation_error` and `is_new_vector_definition` fields.
+    - `using_previous gamma` option (gamma initialization is now explicit/controlled).
+    - Consolidated/moved **stall models** into dedicated modules/branch.
+    - Extracted **polar_engineering** work to its own branch.
+    ---
+    ### Migration Notes
+    - **Imports / classes**
+      - Replace:
+        ```python
+        from VSM.core import WingAerodynamics
+        ```
+        with:
+        ```python
+        from VSM.core import BodyAerodynamics
+        ```
+    - **Datasets & configs**
+      - Update any paths from:
+        ```
+        TUDELFT_V3_LEI_KITE → TUDELFT_V3_KITE
+        ```
+    - **Polar files & arrays**
+      - Ensure 3D data is in: `alpha, CL, CD, CM`
+      - Ensure 2D data is in: `alpha, Cl, Cd, Cm`
+      - If you relied on the old format, update your CSV writers/loaders and tests accordingly.
+    - **Solver usage**
+      - Specify the desired **gamma initialization** and **loop type** explicitly:
+        ```python
+        solver.gamma_initial_distribution_type = "elliptical"  # or "cosine", "zero"
+        solver.gamma_loop_type = "non_linear"                  # or "base"
+        solver.artificial_viscosity =  ...                     # set as needed
+        results = solver.solve(body_aero, gamma_distrbution="cosine")
+        ```
+      - Remove any reliance on `using_previous gamma`.
+    - **Panel model**
+      - If you used `_panel_aero_model`, you can now set:
+        ```python
+        panel._panel_aero_model = "cl_is_pisinalpha"
+        ```
+    - **Plotting**
+      - Legends for certain plots are now at the **bottom**; if you have custom layout logic, adjust figure margins accordingly.
+    - **Half-wing workflows**
+      - When generating polars or exporting geometry, adjust scripts to provide **half-wing** inputs if desired.
+    - **Caching (masure_regression)**
+      - The regression model caches results on disk; verify your `ml_models_dir` and cache paths are writable in CI.
+    ## [1.0.0] - 2024-09-29
+    ### Added
+    - Refactored code to object oriented.
+      - Introduced the main VSM (Vortex Step Method) parent class.
+      - Added a dedicated Panel Properties class.
+      - Set up an initial Horseshoe class and later introduced child classes.
+      - Defined global functions supporting each of the classes.
+      - Added a Filaments class and a Wake class.
+      - Introduced an Abstract class for 2D infinite filaments.
+    - **Solver & Geometry Enhancements:**
+      - Re-structured the code skeleton and overhauled the solver with all necessary methods.
+      - Added new functions to support curved wing, swept wing, and elliptical wing geometries.
+      - Implemented a calculate_results function based on earlier thesis code and refined it.
+    - **Visualization and Plotting:**
+      - Added functions for plotting wing geometry, distributions, and polar plots.
+      - Updated examples (e.g., rectangular wing case, V3 example folder with CFD/WindTunne interfaces).
+    - **Testing & Documentation:**
+      - Integrated initial pytests across modules (Panel, Filaments, etc.), coverage 66%
+      - Populated configuration files like `citation.cff`, `.gitignore`, and `pyproject.toml` for improved packaging.
+      - Added user instructions, docstrings for each function, and updated tutorial content.
+    - **Performance Optimizations:**
+      - Introduced significant speed improvements by refactoring loops (e.g., removing nested loops and moving functions outside loops) and optimizing AIC matrix computations (#50).
+    - **Additional Functionalities:**
+      - Added a yaw rate implementation with an accompanying V3 kite example.
+      - Implemented polar data interpolation for sections with different datasets.
+    ### Changed
+    - **Code Refactoring:**
+      - Renamed and refactored class names and variable identifiers across VSM, Panel, and WingAerodynamics.
+      - Removed redundant properties from WingAerodynamics, now accessing values directly from the Panel.
+    - **Solver & Algorithm Improvements:**
+      - Updated the global functions and solver structure to improve convergence and reliability.
+      - Refined the handling of gamma distributions, reference system definitions, and spacing (including cosine van Garrel spacing for elliptical wings, #24).
+      - Revised the induced_velocity function for better accuracy (#21).
+    - **Documentation & User Interface:**
+      - Enhanced the README with additional images, detailed tutorial updates, and more user-friendly instructions.
+      - Improved code comments and added TODO markers to guide future development.
+    - **Robustness & Configuration:**
+      - Made the code robust against unordered or right-to-left section inputs.
+      - Removed hardcoded values and replaced them with parameterized configurations.
+    ### Fixed
+    - **Bug Resolutions:**
+      - Fixed various issues in solver functionality, geometry processing, and test cases.
+      - Corrected the induced_velocity function and core-radius handling in pytests (#21).
+      - Adjusted the narrow angle-of-attack (aoa) range in aerodynamic data inputs (#42).
+      - Resolved alignment issues in V3 comparisons and output formatting.
+      - Fixed bugs in the stall model (ensuring the stall angle is calculated per plate) and revised related test scripts (#29, #68).
+      - Addressed wake modeling issues and enhanced logging for error tracking.
+    - **Testing and Stability:**
+      - Resolved discrepancies in AIC matrix calculations and convergence tests.
+      - Fixed issues with PDF/PNG outputs in test scripts (#61).
+    - **Performance Corrections:**
+      - Eliminated redundant calculations and optimized nested loops to achieve faster runtime.
+      - Resolved pytesting issues related to numba and streamlined optimization routines.
+    ### Removed
+    - **Deprecated and Redundant Code:**
+      - Removed the older Horseshoe class in favor of the new implementation.
+      - Eliminated unnecessary attributes from WingAerodynamics and cleaned out redundant code sections.
+      - Removed legacy code and virtual environment folders from the project directory.
+      - Cleared outdated TODOs and extraneous comments to streamline the codebase.

.../TUDELFT_V3_KITE/3D_polars_literature/CFD_RANS_Rey_10e5_Poland2025_alpha_sweep_beta_0.csv

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    alpha,beta,CL,CD,CS,CMy
+.02,0,0.2278625272194466,0.0490919571607997,-0.028991478200473,-0.0971304889257096
+.02,0,0.4610104802890269,0.0516566817024969,-0.06116291297791359,-0.177995425157634
+.02,0,0.6748642166054709,0.0643789856608573,-0.09170612013580448,-0.2399628564061313
+.02,0,0.8685945393341531,0.0841781647387978,-0.12014981939630065,-0.2873743657009342
+.02,0,1.042518829707241,0.1099699784207837,-0.14632493718395287,-0.3234126609849657
+.02,0,1.147266423064987,0.1293063892392999,-0.16260131332214534,-0.3422906659660041
+.02,0,1.248363457881334,0.1505397278170317,-0.17819835351371366,-0.3593648645427019
+.02,0,1.340909392696446,0.172443901716702,-0.19275273990602687,-0.3729793258363525

...ELFT_V3_KITE/3D_polars_literature/CFD_RANS_Rey_10e5_Poland2025_beta_sweep_alpha_13_02.csv

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    alpha,beta,CL,CD,CS,CMx,CMy,CMz
+.02,0,1.049472106225422,0.1109605616360219,2.4385142992888863e-05,0.0002462075273015,-0.3256966363266202,-0.000111600945403
+.02,4,1.034347132862086,0.1187231349047993,-0.040581606940825916,-0.0989628231010319,-0.3252096762447942,-0.0635164012620871
+.02,8,0.9946801617025854,0.1413864496187794,-0.07900689629021146,-0.1933768769462073,-0.3261046083196199,-0.1265382345550858
+.02,12,0.9328481343698932,0.1769306090870539,-0.11428499995717821,-0.2874548226069351,-0.3295173645788699,-0.1855631093369855

data/TUDELFT_V3_KITE/3D_polars_literature/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    For more information on how the .csv files in this directory are generated, the relevant sources or how they should be structured please see:
+    - https://github.com/awegroup/TUDELFT_V3_KITE/tree/main?tab=readme-ov-file
+    OR
+    - https://awegroup.github.io/TUDELFT_V3_KITE/

...polars_literature/V3_CL_CD_CS_alpha_sweep_for_beta_0_WindTunnel_Poland_2025_Rey_560e4.csv

-Original file line number
+Diff line change
@@ -0,0 +1,18 @@
+    CL,CL_ci,CD,CD_ci,alpha
+    -0.280233153560818,0.0110705335388759,0.0978529777593977,0.0129358291967856,-11.5681211570017
+    -0.214491373614373,0.0122872270418091,0.0685357795740722,0.0155251384847079,-6.09905950161158
+    -0.00076803912330013,0.0106850856430888,0.0488586773900786,0.00766964551596273,-1.99963855771642
+.0739899513915977,0.00953159417113588,0.0573908146562723,0.00888991109005732,-1.33481996708469
+.465192674677979,0.00947570706047279,0.0561678776611973,0.00908481079346789,3.08107846652584
+.610180915884597,0.00452502283166885,0.0743102433724348,0.00462168981528609,5.41284642026105
+.743035635092799,0.00946575579590553,0.0866430637231721,0.00963341345922823,7.35032445798279
+.887298865863501,0.0106380475782356,0.102336952277841,0.00900521264610847,9.38243360452917
+.925565515163773,0.0142384313990637,0.175994396308134,0.0150712042894669,11.4644251663019
+.932725198798349,0.0158775060283244,0.188886748057569,0.0169368686663311,12.4610557905447
+.951228281361335,0.014573344990979,0.21274544018436,0.0180470531864394,13.3523481658782
+.977071520361125,0.0181030479414339,0.227886839663643,0.0204637541133525,14.540186234232
+.00856267581916,0.0166588473137047,0.24447585438451,0.0183782349712973,16.2253663705088
+.06810346425319,0.0154900038338791,0.319919197381967,0.0229888926456552,18.2973462373086
+.00999380129617,0.0154476585577098,0.35730163245484,0.0151447117903846,20.2246928771348
+.997963560484868,0.0118111212863406,0.419985118207109,0.0116052986279285,23.0303543565816
+.974927517924153,0.0130172960362764,0.434984255224326,0.0121749295096374,24.5411952103548

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Develop #144

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!