Add a geometry from yaml constructor for Wing #186

1-Bart-1 · 2025-08-04T16:58:06Z

No description provided.

added yaml_geometry: enabling one to run VSM defined from a yaml file.

codecov · 2025-08-04T17:09:45Z

Codecov Report

❌ Patch coverage is 88.55422% with 19 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/yaml_geometry.jl	91.30%	8 Missing ⚠️
src/plotting.jl	70.83%	7 Missing ⚠️
src/VortexStepMethod.jl	0.00%	4 Missing ⚠️

📢 Thoughts on this report? Let us know!

…r V3 Kite, and adjusting plotting script to handle arbitrary column sorting of literature input

…indTunnel Data and Python

1-Bart-1 · 2025-08-05T13:12:10Z

@jellepoland when you feel like this pull request is ready, you can convert it from a draft pull request to a normal pull request by marking it ready for review, and request a review from me and/or uwe.

1-Bart-1

Very cool stuff, thanks for the contribution! 🚀 Left some comments, please address these.

src/yaml_geometry.jl

data/TUDELFT_V3_KITE/wing_geometry_CAD_CFD_polars_pchip_fitted.yaml

src/settings.jl

src/yaml_geometry.jl

src/solver.jl

jellepoland · 2025-08-07T07:08:20Z

Great comments!

My main takeaway is the struct--constructor interaction in Julia, that I am not used to in Python.The defining of a single struct, and multiple functions with the same name as that struct (e.g. Wing) all being able to take in different input types, and Julia then automatically picking the appropriate functions.
Pretty neat I have to say :)

1-Bart-1 · 2025-08-07T08:39:47Z

On which branch did you address my comments? I don't see it here...

jellepoland · 2025-08-07T09:08:13Z

I am still working on the changes!

I am changing and extending the test directory; to be more extensive, readable and logically structured.

jellepoland · 2025-08-07T09:55:09Z

Reorganized the testing suite and added some tests.
More could be added still, see #191.

1-Bart-1 · 2025-08-07T20:58:53Z

Getting a lot of these warnings in the tests, please fix these before we merge this branch @jellepoland

WARNING: Method definition test_data_path(Any, Any...) in module Main at /Users/runner/work/VortexStepMethod.jl/VortexStepMethod.jl/test/test_data_utils.jl:23 overwritten on the same line (check for duplicate calls to `include`).
WARNING: Method definition create_temp_wing_settings(Any, Any) in module Main at /Users/runner/work/VortexStepMethod.jl/VortexStepMethod.jl/test/test_data_utils.jl:46 overwritten on the same line (check for duplicate calls to `include`).
WARNING: Method definition kwcall(NamedTuple{names, T} where T<:Tuple where names, typeof(Main.create_temp_wing_settings), Any, Any) in module Main at /Users/runner/work/VortexStepMethod.jl/VortexStepMethod.jl/test/test_data_utils.jl:46 overwritten on the same line (check for duplicate calls to `include`).
WARNING: Method definition get_standard_wing_file(Any) in module Main at /Users/runner/work/VortexStepMethod.jl/VortexStepMethod.jl/test/test_data_utils.jl:103 overwritten on the same line (check for duplicate calls to `include`).
WARNING: Method definition get_complete_settings_file(Any) in module Main at /Users/runner/work/VortexStepMethod.jl/VortexStepMethod.jl/test/test_data_utils.jl:125 overwritten on the same line (check for duplicate calls to `include`).

ufechner7

Please, fix the failing tests on windows and the "method overwritten" warnings first.

Furthermore, add a description that explains what you changed.

Copilot

Pull Request Overview

This PR adds YAML-based wing geometry construction capabilities to VortexStepMethod.jl, enabling users to define wings through configuration files with embedded polar data references.

Key changes:

Implement yaml_geometry.jl module with Wing constructors that read YAML configuration files
Add support for loading aerodynamic polar data from CSV files referenced in YAML
Reorganize test suite into module-specific directories with comprehensive test coverage

Reviewed Changes

Copilot reviewed 73 out of 111 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/yaml_geometry.jl	Core YAML geometry parsing with Wing constructors and polar data loading
test/yaml_geometry/	Comprehensive test suite with sample YAML/CSV files for wing geometry
test/test_data_utils.jl	Shared utilities for test data management across modules
src/VortexStepMethod.jl	Export new YAML geometry functionality
examples/	Example scripts demonstrating YAML-based wing construction
data/	Sample configuration files for pyramid and V3 kite models

test/yaml_geometry/test_yaml_geometry.jl

src/yaml_geometry.jl

jellepoland · 2025-08-08T09:18:51Z

Summary of Key Changes from This Branch

1. Core New Functionality: YAML Geometry Support

New file: yaml_geometry.jl (290+ lines) - Complete YAML-based wing geometry loading
New structs: WingSectionData, WingAirfoilData, WingAirfoilInfo with @with_kw macros
New function: load_polar_data() - Robust CSV polar data loading with error handling
New constructor: Wing(geometry_file::String) - Creates wings from YAML files
New constructor: Wing(settings::VSMSettings) - Creates wings from settings

2. Enhanced Settings System

Renamed vs() to VSMSettings() constructor
Added convenience Solver(body_aero, settings) constructor
Improved settings structure and validation

3. Comprehensive Test Infrastructure

Split tests: Reorganized from monolithic files to modular structure (test/module_name/test_*.jl)
New test module: yaml_geometry with test_load_polar_data.jl and test_wing_constructor.jl
Test utilities: test_data_utils.jl with shared helper functions
Test data: Extensive YAML and CSV test files in data

4. Data and Examples

New data sets: Complete TUDELFT_V3_KITE with CFD polars and literature results
Enhanced examples: Updated examples to use YAML geometry (e.g., pyramid_model.jl, V3_kite.jl)
Real-world configs: Production-ready YAML geometry files for various kite configurations

5. Core Module Improvements

Path handling: Robust file path resolution for relative/absolute paths
Error handling: Comprehensive validation and graceful fallback to INVISCID mode
Memory management: Improved file I/O and cleanup in tests
Documentation: Added comprehensive docstrings and examples

jellepoland · 2025-08-08T10:01:47Z

Windows test passing

1-Bart-1

I think this can be merged now, @jellepoland can you update NEWS.md?

jellepoland · 2025-08-08T15:56:16Z

I updated the News.md

…xstepmethodjl-and-run-on-a-simple-wing' of github.com:OpenSourceAWE/VortexStepMethod.jl into 183-create-a-load_geometry_from_yaml-function-for-vortexstepmethodjl-and-run-on-a-simple-wing

ufechner7

While I approve it, please still find the time to answer my questions/ address my comments.

ufechner7 · 2025-08-08T16:38:56Z

data/TUDELFT_V3_KITE/literature_results/CFD_RANS_Rey_10e5_Poland2025_alpha_sweep_beta_0.csv

@@ -0,0 +1,9 @@
+alpha,beta,CL,CD,CS,CMy


What is CMy ?

ufechner7 · 2025-08-08T16:44:35Z

examples/pyramid_model.jl

+project_dir = dirname(dirname(pathof(VortexStepMethod)))  # Go up one level from src to project root
+
+# Load VSM vsm_settings from YAML configuration file
+vsm_settings = VSMSettings("pyramid_model/vsm_settings.yaml")


What is a pyramid model?

It is a model that has the shape of a pyramid :) You can run the example and it will plot it.

ufechner7 · 2025-08-08T16:50:27Z

src/yaml_geometry.jl

+end
+
+"""
+    load_polar_data(csv_file_path::String) -> Tuple{Union{Nothing, Tuple{Vector{Float64}, Vector{Float64}, Vector{Float64}, Vector{Float64}}}, Symbol}


If you return such a complicated structure, isn't it better to define a struct type for it and just document that you return a PolarData struct or how ever you call it?

…and run on a simple wing (#200) * adding a pyramid_model, initial commit * #183 testing commit * #185, this commit/issue number work? * #185 Create rectangular wing from yaml and plot, using csv polar input * #185 added yaml_geometry: enabling one to run VSM defined from a yaml file. * #185 V3 kite runs, but results are yet not accurate * #185 setting standard printing to false, adding literature results for V3 Kite, and adjusting plotting script to handle arbitrary column sorting of literature input * #185 non-italic subscripts in plotting * #185 , #186 : cleaned-up yaml_geometry, added a comparison to CFD - WindTunnel Data and Python * #155 V3_kite example now creates wing and solver from VSMSettings * #155 adjusted V3_kite, to be specified from a .yaml * #155 working, with Wing constructor * #155 #185 added StructMapping for yaml parsing * #185 #155 created ram_air_kite folder, all tests passing * #185 adding a working pyramid model example * #185, #186 added test_yaml_geometry * #186 working on test folder * #186 passing all tests now! * # 186 Adding random to toml * Update manifest * More versions * #186 test passing without errors/warnings * #186 attempt at resolving windows issues * Update docstring * Remove unused files * #186 updated NEWS.md * #196 adding aero_geometry yaml * Update Manifest-v1.11.toml.default Co-authored-by: Copilot <[email protected]> * Update Manifest-v1.11.toml.default Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: 1-Bart-1 <[email protected]> Co-authored-by: Copilot <[email protected]>

jellepoland added 6 commits August 4, 2025 11:24

adding a pyramid_model, initial commit

09119bc

#183 testing commit

a0d9977

#185, this commit/issue number work?

f9c7c80

#185 Create rectangular wing from yaml and plot, using csv polar input

1ba7681

#185

b08dd6e

added yaml_geometry: enabling one to run VSM defined from a yaml file.

#185 V3 kite runs, but results are yet not accurate

420017d

jellepoland added 8 commits August 5, 2025 08:54

#185 setting standard printing to false, adding literature results fo…

60ef204

…r V3 Kite, and adjusting plotting script to handle arbitrary column sorting of literature input

#185 non-italic subscripts in plotting

e4ffc41

#185 , #186 : cleaned-up yaml_geometry, added a comparison to CFD - W…

cffe014

…indTunnel Data and Python

#155 V3_kite example now creates wing and solver from VSMSettings

4d07971

#155 adjusted V3_kite, to be specified from a .yaml

dd659ca

#155 working, with Wing constructor

8942409

#155 #185 added StructMapping for yaml parsing

af11c40

#185 #155 created ram_air_kite folder, all tests passing

5e56cc3

#185 adding a working pyramid model example

29f372d

jellepoland mentioned this pull request Aug 6, 2025

Add yaml and csv files that describe the V3 LEI kite #145

Closed

#185, #186 added test_yaml_geometry

8da0fde

jellepoland marked this pull request as ready for review August 6, 2025 06:55

jellepoland requested a review from ufechner7 August 6, 2025 06:56

jellepoland mentioned this pull request Aug 6, 2025

Create a 'load_geometry_from_yaml` function for VortexStepMethod.jl, and run on a simple wing #185

Closed

5 tasks

1-Bart-1 commented Aug 6, 2025

View reviewed changes

#186 working on test folder

bcb06ff

jellepoland added 2 commits August 7, 2025 12:00

#186 passing all tests now!

a26ec1e

# 186 Adding random to toml

38f9105

1-Bart-1 added 2 commits August 7, 2025 15:12

Update manifest

c36f5e6

More versions

1510f6b

ufechner7 requested changes Aug 7, 2025

View reviewed changes

ufechner7 requested a review from Copilot August 7, 2025 21:56

Copilot AI reviewed Aug 7, 2025

View reviewed changes

test/yaml_geometry/test_yaml_geometry.jl Show resolved Hide resolved

src/yaml_geometry.jl Show resolved Hide resolved

src/yaml_geometry.jl Show resolved Hide resolved

src/yaml_geometry.jl Outdated Show resolved Hide resolved

#186 test passing without errors/warnings

90ff624

#186 attempt at resolving windows issues

298062d

jellepoland requested a review from ufechner7 August 8, 2025 10:04

1-Bart-1 added 2 commits August 8, 2025 14:42

Update docstring

6d2e64a

Remove unused files

3b1e431

1-Bart-1 commented Aug 8, 2025

View reviewed changes

jellepoland added 2 commits August 8, 2025 17:57

#186 updated NEWS.md

10e1d5d

Merge branch '183-create-a-load_geometry_from_yaml-function-for-vorte…

7e7ae86

…xstepmethodjl-and-run-on-a-simple-wing' of github.com:OpenSourceAWE/VortexStepMethod.jl into 183-create-a-load_geometry_from_yaml-function-for-vortexstepmethodjl-and-run-on-a-simple-wing

ufechner7 approved these changes Aug 8, 2025

View reviewed changes

1-Bart-1 merged commit 689aa84 into main Aug 11, 2025
8 checks passed

Add a geometry from yaml constructor for Wing #186

Add a geometry from yaml constructor for Wing #186

Uh oh!

Conversation

1-Bart-1 commented Aug 4, 2025

Uh oh!

codecov bot commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

1-Bart-1 commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

1-Bart-1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jellepoland commented Aug 7, 2025

Uh oh!

1-Bart-1 commented Aug 7, 2025

Uh oh!

jellepoland commented Aug 7, 2025

Uh oh!

jellepoland commented Aug 7, 2025

Uh oh!

1-Bart-1 commented Aug 7, 2025

Uh oh!

ufechner7 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jellepoland commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Key Changes from This Branch

1. Core New Functionality: YAML Geometry Support

2. Enhanced Settings System

3. Comprehensive Test Infrastructure

4. Data and Examples

5. Core Module Improvements

Uh oh!

jellepoland commented Aug 8, 2025

Uh oh!

1-Bart-1 left a comment

Choose a reason for hiding this comment

Uh oh!

jellepoland commented Aug 8, 2025

Uh oh!

ufechner7 left a comment

Choose a reason for hiding this comment

Uh oh!

ufechner7 Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

ufechner7 Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

1-Bart-1 Aug 9, 2025

Choose a reason for hiding this comment

Uh oh!

ufechner7 Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

codecov bot commented Aug 4, 2025 •

edited

Loading

1-Bart-1 commented Aug 5, 2025 •

edited

Loading

ufechner7 left a comment •

edited

Loading

jellepoland commented Aug 8, 2025 •

edited

Loading