From 89b844c6b7dfc6c304588d87c5cb3d4193aca22e Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@tu-berlin.de>
Date: Mon, 3 Feb 2025 09:26:13 +0100
Subject: [PATCH 1/4] Apply 1 suggestion(s) to 1 file(s)
Co-authored-by: Ellen Seabrooke <ellen.seabrooke@ifb.uni-stuttgart.de>
---
docs/documentation/sizing/wing_design/design-methods.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/documentation/sizing/wing_design/design-methods.md b/docs/documentation/sizing/wing_design/design-methods.md
index 30ac984..221618d 100644
--- a/docs/documentation/sizing/wing_design/design-methods.md
+++ b/docs/documentation/sizing/wing_design/design-methods.md
@@ -6,7 +6,7 @@ The task of the _wing\_design_ tool is to generate the wing geometry according t
The general method for a cantilever wing starts with the setup of the wanted quarter chord sweep. The quarter chord sweep is kept constant over the wing (not inside the fuselage).
#### Step 1: Sweep Computation
-The user is able to define the quarter chord sweep or let it compute by the usage of the korn equation which uses the desired design mach number and the delta to the drag divergence mach number. Additionally the maximum thickness to chord ratio, the wing loading, the airfoil profile as a factor and the design altitude will have an influence on the quarter chord sweep. This method is an iterative process.
+The user is able to define the quarter chord sweep or let it compute by the usage of the korn equation which uses the desired design mach number and the delta to the drag divergence mach number. Additionally, the maximum thickness to chord ratio, the wing loading, the airfoil profile as a factor and the design altitude will have an influence on the quarter chord sweep. This method is an iterative process.
#### Step 2: Wing area computation
After the computation of the sweep is done, the desired wing area is either defined by the user or it is computed by the wing loading (recommended). For calculating the wing area by the wing loading, the value for the maximum takeoff mass is used.
--
GitLab
From 36e433653fa83fb3132f9a15cf5fcf113d797faa Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Mon, 3 Feb 2025 09:33:56 +0100
Subject: [PATCH 2/4] fixed issues from review of e. seabrooke
---
.../wing_design/run-your-first-wing-design.md | 4 +-
mkdocs.yml | 352 +++++++++---------
2 files changed, 178 insertions(+), 178 deletions(-)
diff --git a/docs/documentation/sizing/wing_design/run-your-first-wing-design.md b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
index 62043d2..a493305 100644
--- a/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
+++ b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
@@ -27,6 +27,7 @@ Running this tool requires an _Aircraft Exchange File_ where the tools _initial\
From the _Aircraft Exchange File_ we have the following information:
From the Requirements block:
+
Parameter | Value
:--------------------------|-------------:
A/C Type | CeraS
@@ -266,11 +267,10 @@ The tool adapted the wing aspect ratio to the maximum possible aspect ratio sinc
Soo .... Now it is your turn!
!!! tip
- Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!
+ Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!
## Troubleshooting
- Tool does not run properly:
- Make sure you have all the paths set up correctly and the specified elements exist!
- Tool is not there:
- You can build the tool directly from scratch - see therefor [:octicons-arrow-right-16: How to build a tool](howToBuildATool.md)
-
diff --git a/mkdocs.yml b/mkdocs.yml
index f0a7c7b..862d983 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -61,97 +61,97 @@ extra_css:
# === Plugins ===
plugins:
- search
- # - mkdoxy:
- # projects:
- # propulsion_design:
- # src-dirs: ../aircraft-design/propulsion_design/
- # full-doc: True
- # output: docs/propulsion_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # initial_sizing:
- # src-dirs: ../aircraft-design/initial_sizing/
- # full-doc: true
- # output: docs/initial_sizing
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # create_mission_xml:
- # src-dirs: ../aircraft-design/create_mission_xml/
- # full-doc: True
- # output: docs/create_mission_xml
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # fuselage_design:
- # src-dirs: ../aircraft-design/fuselage_design/
- # full-doc: true
- # output: docs/fuselage_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # wing_design:
- # src-dirs: ../aircraft-design/wing_design/
- # full-doc: True
- # output: docs/wing_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # empennage_design:
- # src-dirs: ../aircraft-design/empennage_design/
- # full-doc: true
- # output: docs/empennage_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # tank_design:
- # src-dirs: ../aircraft-design/tank_design/
- # full-doc: true
- # output: docs/tank_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # landing_gear_design:
- # src-dirs: ../aircraft-design/landing_gear_design/
- # full-doc: true
- # output: docs/landing_gear_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # systems_design:
- # src-dirs: ../aircraft-design/systems_design/
- # full-doc: true
- # output: docs/systems_design
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # ecological_assessment:
- # src-dirs: ../aircraft-design/ecological_assessment/
- # full-doc: true
- # output: docs/ecological_assessment
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
- # aircraftGeometry2:
- # src-dirs: ../aircraft-design/libs/aircraftGeometry2/
- # full-doc: true
- # output: docs/aircraftGeometry2
- # doxy-cfg:
- # FILE_PATTERNS: "*.cpp *.h"
- # RECURSIVE: True
- # EXTRACT_ALL: YES
-
+ - mkdoxy:
+ projects:
+ propulsion_design:
+ src-dirs: ../aircraft-design/propulsion_design/
+ full-doc: True
+ output: docs/propulsion_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ initial_sizing:
+ src-dirs: ../aircraft-design/initial_sizing/
+ full-doc: true
+ output: docs/initial_sizing
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ create_mission_xml:
+ src-dirs: ../aircraft-design/create_mission_xml/
+ full-doc: True
+ output: docs/create_mission_xml
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ fuselage_design:
+ src-dirs: ../aircraft-design/fuselage_design/
+ full-doc: true
+ output: docs/fuselage_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ wing_design:
+ src-dirs: ../aircraft-design/wing_design/
+ full-doc: True
+ output: docs/wing_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ empennage_design:
+ src-dirs: ../aircraft-design/empennage_design/
+ full-doc: true
+ output: docs/empennage_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ tank_design:
+ src-dirs: ../aircraft-design/tank_design/
+ full-doc: true
+ output: docs/tank_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ landing_gear_design:
+ src-dirs: ../aircraft-design/landing_gear_design/
+ full-doc: true
+ output: docs/landing_gear_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ systems_design:
+ src-dirs: ../aircraft-design/systems_design/
+ full-doc: true
+ output: docs/systems_design
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ ecological_assessment:
+ src-dirs: ../aircraft-design/ecological_assessment/
+ full-doc: true
+ output: docs/ecological_assessment
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+ aircraftGeometry2:
+ src-dirs: ../aircraft-design/libs/aircraftGeometry2/
+ full-doc: true
+ output: docs/aircraftGeometry2
+ doxy-cfg:
+ FILE_PATTERNS: "*.cpp *.h"
+ RECURSIVE: True
+ EXTRACT_ALL: YES
+
- glightbox # Plugin for lightbox-style image and content viewing.
# === Theme configuration ===
@@ -194,24 +194,24 @@ nav: # Customizes the main navigation struc
- Documentation: # Top-level item for documentation.
- Overview: documentation/overview.md # Overview of modules.
- Aircraft Design:
- - Sizing:
+ - Sizing:
- Modules: documentation/sizing.md # Link to aircraft sizing documentation.
- # - Initial Sizing:
- # - Introduction: documentation/sizing/initial_sizing/index.md
- # - Getting Started: documentation/sizing/initial_sizing/getting-started.md
- # - Methods: documentation/sizing/initial_sizing/initialSizing.md
- # - Changelog: documentation/sizing/initial_sizing/changelog.md
- # - API Reference:
- # - initial_sizing/classes.md
- # - initial_sizing/namespaces.md
- # - initial_sizing/files.md
- # - initial_sizing/functions.md
- # - Fuselage Design:
- # - Introduction: documentation/sizing/fuselage_design/index.md
- # - Getting Started: documentation/sizing/fuselage_design/getting-started.md
- # - Design Method: documentation/sizing/fuselage_design/design_method.md
- # - Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md
- # - Software Architecture: documentation/sizing/fuselage_design/software_architecture.md
+ - Initial Sizing:
+ - Introduction: documentation/sizing/initial_sizing/index.md
+ - Getting Started: documentation/sizing/initial_sizing/getting-started.md
+ - Methods: documentation/sizing/initial_sizing/initialSizing.md
+ - Changelog: documentation/sizing/initial_sizing/changelog.md
+ - API Reference:
+ - initial_sizing/classes.md
+ - initial_sizing/namespaces.md
+ - initial_sizing/files.md
+ - initial_sizing/functions.md
+ - Fuselage Design:
+ - Introduction: documentation/sizing/fuselage_design/index.md
+ - Getting Started: documentation/sizing/fuselage_design/getting-started.md
+ - Design Method: documentation/sizing/fuselage_design/design_method.md
+ - Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md
+ - Software Architecture: documentation/sizing/fuselage_design/software_architecture.md
# # - API Reference: # TODO define for Python
- Wing Design:
- Introduction: documentation/sizing/wing_design/index.md
@@ -224,7 +224,7 @@ nav: # Customizes the main navigation struc
- wing_design/namespaces.md
- wing_design/files.md
- wing_design/functions.md
- - Empennage Design:
+ - Empennage Design:
- Introduction: documentation/sizing/empennage_design/index.md
- Getting Started: documentation/sizing/empennage_design/getting-started.md
- Basic Concepts: documentation/sizing/empennage_design/basic-concepts.md
@@ -234,84 +234,84 @@ nav: # Customizes the main navigation struc
- empennage_design/namespaces.md
- empennage_design/files.md
- empennage_design/functions.md
- - Tank Design:
+ - Tank Design:
- Introduction: documentation/sizing/tank_design/index.md
- Getting Started: documentation/sizing/tank_design/getting-started.md
- Design Method: documentation/sizing/tank_design/tank_design_method.md
- Run your First Design: documentation/sizing/tank_design/run_your_first_tank_design.md
- Software Architecture: documentation/sizing/tank_design/software_architecture.md
# - API Reference: # TODO define for Python
- # - Propulsion Design:
- # - Introduction: documentation/sizing/propulsion_design/index.md
- # - Getting Started: documentation/sizing/propulsion_design/getting-started.md
- # - Engineering Principles: documentation/sizing/propulsion_design/engineering_principles.md
- # - Software Architecture: documentation/sizing/propulsion_design/software_architecture.md
- # - Tutorial:
- # - Main: documentation/sizing/propulsion_design/tutorial.md
- # - Engine Extension: documentation/sizing/propulsion_design/tutorial_engine_extension.md
- # - Fidelity Extension: documentation/sizing/propulsion_design/tutorial_fidelity_extension.md
- # - Changelog: documentation/sizing/propulsion_design/changelog.md
- # - Additional Information: documentation/sizing/propulsion_design/additional.md
- # - API Reference:
- # - propulsion_design/classes.md
- # - propulsion_design/namespaces.md
- # - propulsion_design/files.md
- # - propulsion_design/functions.md
- # - Landing Gear Design:
- # - Introduction: documentation/sizing/landing_gear_design/index.md
- # - Getting Started: documentation/sizing/landing_gear_design/getting-started.md
- # - Design Method: documentation/sizing/landing_gear_design/design_method.md
- # - Run your First Design: documentation/sizing/landing_gear_design/run_your_first_design.md
- # - Software Architecture: documentation/sizing/landing_gear_design/software_architecture.md
+ - Propulsion Design:
+ - Introduction: documentation/sizing/propulsion_design/index.md
+ - Getting Started: documentation/sizing/propulsion_design/getting-started.md
+ - Engineering Principles: documentation/sizing/propulsion_design/engineering_principles.md
+ - Software Architecture: documentation/sizing/propulsion_design/software_architecture.md
+ - Tutorial:
+ - Main: documentation/sizing/propulsion_design/tutorial.md
+ - Engine Extension: documentation/sizing/propulsion_design/tutorial_engine_extension.md
+ - Fidelity Extension: documentation/sizing/propulsion_design/tutorial_fidelity_extension.md
+ - Changelog: documentation/sizing/propulsion_design/changelog.md
+ - Additional Information: documentation/sizing/propulsion_design/additional.md
+ - API Reference:
+ - propulsion_design/classes.md
+ - propulsion_design/namespaces.md
+ - propulsion_design/files.md
+ - propulsion_design/functions.md
+ - Landing Gear Design:
+ - Introduction: documentation/sizing/landing_gear_design/index.md
+ - Getting Started: documentation/sizing/landing_gear_design/getting-started.md
+ - Design Method: documentation/sizing/landing_gear_design/design_method.md
+ - Run your First Design: documentation/sizing/landing_gear_design/run_your_first_design.md
+ - Software Architecture: documentation/sizing/landing_gear_design/software_architecture.md
# # - API Reference: # TODO define for Python
- # - Systems Design:
- # - Introduction: documentation/sizing/systems_design/index.md
- # - Getting Started: documentation/sizing/systems_design/getting-started.md
- # - Implemented Models: documentation/sizing/systems_design/systems.md
- # - Software Architecture: documentation/sizing/systems_design/software_architecture.md
- # - API Reference:
- # - systems_design/classes.md
- # - systems_design/namespaces.md
- # - systems_design/files.md
- # - systems_design/functions.md
- # - Analysis:
- # - Modules: documentation/analysis.md # Link to analysis module page.
- # - Weight and Balance Analysis:
- # - Introduction: documentation/analysis/weight_and_balance_analysis/index.md
- # - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md
- # - Usage: documentation/analysis/weight_and_balance_analysis/usage.md
+ - Systems Design:
+ - Introduction: documentation/sizing/systems_design/index.md
+ - Getting Started: documentation/sizing/systems_design/getting-started.md
+ - Implemented Models: documentation/sizing/systems_design/systems.md
+ - Software Architecture: documentation/sizing/systems_design/software_architecture.md
+ - API Reference:
+ - systems_design/classes.md
+ - systems_design/namespaces.md
+ - systems_design/files.md
+ - systems_design/functions.md
+ - Analysis:
+ - Modules: documentation/analysis.md # Link to analysis module page.
+ - Weight and Balance Analysis:
+ - Introduction: documentation/analysis/weight_and_balance_analysis/index.md
+ - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md
+ - Usage: documentation/analysis/weight_and_balance_analysis/usage.md
# # - API Reference: # TODO define for Python
- # - Cost Estimation:
- # - Introduction: documentation/analysis/cost_estimation/index.md
- # - Getting Started: documentation/analysis/cost_estimation/getting-started.md
- # - Methods: documentation/analysis/cost_estimation/operating_cost_method.md
- # - Run your First Estimation: documentation/analysis/cost_estimation/run_your_first_cost_estimation.md
+ - Cost Estimation:
+ - Introduction: documentation/analysis/cost_estimation/index.md
+ - Getting Started: documentation/analysis/cost_estimation/getting-started.md
+ - Methods: documentation/analysis/cost_estimation/operating_cost_method.md
+ - Run your First Estimation: documentation/analysis/cost_estimation/run_your_first_cost_estimation.md
# # - API Reference: # TODO define for Python
- # - Ecological Assessment:
- # - Introduction: documentation/analysis/ecological_assessment/index.md
- # - Getting Started: documentation/analysis/ecological_assessment/getting-started.md
- # - Changelog: documentation/analysis/ecological_assessment/changelog.md
- # - API Reference:
- # - ecological_assessment/classes.md
- # - ecological_assessment/namespaces.md
- # - ecological_assessment/files.md
- # - ecological_assessment/functions.md
- # - Libraries:
- # - Overview: documentation/libraries.md # Link to libraries overview.
- # - AircraftGeometry2:
- # - Introduction: documentation/libraries/aircraftGeometry2/index.md
- # - Getting Started: documentation/libraries/aircraftGeometry2/getting-started.md
- # - Tutorial: documentation/libraries/aircraftGeometry2/tutorial.md
- # - API Reference:
- # - aircraftGeometry2/classes.md
- # - aircraftGeometry2/namespaces.md
- # - aircraftGeometry2/files.md
- # - aircraftGeometry2/functions.md
- # - Utilities: documentation/additional_software.md
- # - Workflow: 'workflow.md' # Link to the workflow page.
+ - Ecological Assessment:
+ - Introduction: documentation/analysis/ecological_assessment/index.md
+ - Getting Started: documentation/analysis/ecological_assessment/getting-started.md
+ - Changelog: documentation/analysis/ecological_assessment/changelog.md
+ - API Reference:
+ - ecological_assessment/classes.md
+ - ecological_assessment/namespaces.md
+ - ecological_assessment/files.md
+ - ecological_assessment/functions.md
+ - Libraries:
+ - Overview: documentation/libraries.md # Link to libraries overview.
+ - AircraftGeometry2:
+ - Introduction: documentation/libraries/aircraftGeometry2/index.md
+ - Getting Started: documentation/libraries/aircraftGeometry2/getting-started.md
+ - Tutorial: documentation/libraries/aircraftGeometry2/tutorial.md
+ - API Reference:
+ - aircraftGeometry2/classes.md
+ - aircraftGeometry2/namespaces.md
+ - aircraftGeometry2/files.md
+ - aircraftGeometry2/functions.md
+ - Utilities: documentation/additional_software.md
+ - Workflow: 'workflow.md' # Link to the workflow page.
- Get Involved:
- Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development.
- - Build Instructions:
+ - Build Instructions:
- Prerequisites:
- Windows: get-involved/build-environment/windows.md
- Linux: get-involved/build-environment/linux.md
--
GitLab
From 7de21f4940dbe49388de688961f56e738e24a526 Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Mon, 3 Feb 2025 13:12:24 +0100
Subject: [PATCH 3/4] fixed indentations (must be 1 tab equals 4 spaces)
---
.../sizing/wing_design/basic-concepts.md | 50 +++++----
.../sizing/wing_design/design-methods.md | 12 +-
.../sizing/wing_design/getting-started.md | 105 +++++++++---------
.../wing_design/run-your-first-wing-design.md | 2 +-
4 files changed, 86 insertions(+), 83 deletions(-)
diff --git a/docs/documentation/sizing/wing_design/basic-concepts.md b/docs/documentation/sizing/wing_design/basic-concepts.md
index da8e3de..57a6393 100644
--- a/docs/documentation/sizing/wing_design/basic-concepts.md
+++ b/docs/documentation/sizing/wing_design/basic-concepts.md
@@ -2,20 +2,20 @@
Designing a wing for an aircraft is by far one of the most challenging tasks. This topic provides basic information for wings.
-If you are already familiar with the basic concepts, you can move on to the [Getting Started](getting-started.md).
-
+If you are already familiar with the basic concepts, you can move on to the [:octicons-arrow-right-16: Getting Started](getting-started.md).
### Available configurations
Here you can find available wing build methods from the _wing\_design_ tool inside UNICADO.
+
- _UNICADO is shipped natively with the cantilever wing method for a tube and wing configuration._
- _A basic Blended Wing body method is planned!_
-<pre class='mermaid'>
+```mermaid
graph LR;
A[Wing Design]-->B[Tube and Wing];
B-->C[Cantilever];
A-->D[Blended Wing body]
-</pre>
+```
!!! danger "Important"
Since the documentation might be delayed to the development progress - this graph might not have all information yet.
@@ -37,45 +37,47 @@ Wing loading is the mass / weight of the aircraft distributed over its reference
Understanding the wing geometry is crucial for designing an efficient wing. Below are key terms and their meanings:
- Aspect Ratio (_AR_): The ratio of the wingspan to the average chord length
- - _AR= b² / S_
- - _b : Wingspan_
- - _S : Wing reference area (projected area on ground from top view)_
- - _High AR (e.g. gliders) → increased aerodynamic efficiency (higher drag) but slender and more flexible wing._
- - _Low AR (e.g., fighter jets) → decreased aerodynmic efficiency and stiffer._
+ - _AR= b² / S_
+ - _b : Wingspan_
+ - _S : Wing reference area (projected area on ground from top view)_
+ - _High AR (e.g. gliders) → increased aerodynamic efficiency (higher drag) but slender and more flexible wing._
+ - _Low AR (e.g., fighter jets) → decreased aerodynmic efficiency and stiffer._
- Taper Ratio (λ): The ratio of the tip chord to the root chord.
- - _λ_ = _c_<sub>_tip_</sub> / _c_<sub>_root_</sub>
- - _A taper ratio of one indicates a rectangular wing._
- - _Reduced taper ratio can improve aerodynamic efficiency and reduce structural weight._
+ - _λ_ = _c_<sub>_tip_</sub> / _c_<sub>_root_</sub>
+ - _A taper ratio of one indicates a rectangular wing._
+ - _Reduced taper ratio can improve aerodynamic efficiency and reduce structural weight._
- Sweep Angle (Φ): The angle between the chord at a given position and a line perpendicular to the chord
- - _Increased sweep leads to higher overall speeds due to reduction of the mach number normal to the leading edge_
- - _backward sweep: increased aerodynamic load at the outer wing part → bad behaviour at high angle of attack (AoA)_
- - _forward sweep: decreased aerodynamic load at the outer wing part but increased structural load due to wing torsion effects_
+ - _Increased sweep leads to higher overall speeds due to reduction of the mach number normal to the leading edge_
+ - _backward sweep: increased aerodynamic load at the outer wing part → bad behaviour at high angle of attack (AoA)_
+ - _forward sweep: decreased aerodynamic load at the outer wing part but increased structural load due to wing torsion effects_
- Dihedral / Anhedral Angle (ν): Effects wing clearance and roll stability due to sideslip
- - Common dihedral angle (positive) for low wing configuration
- - Common anhedral angle (negative) for shoulder or high wing configurations
+ - Common dihedral angle (positive) for low wing configuration
+ - Common anhedral angle (negative) for shoulder or high wing configurations
- Kink: Discontinuity in the wing trailing edge due to change in trailing edge sweep
- - mostly occurs on aircraft from inner to outer wing (low configuration) which is affected by the engine and landing gear vice versa
+ - mostly occurs on aircraft from inner to outer wing (low configuration) which is affected by the engine and landing gear vice versa
### Airfoil selection
An airfoil defines the cross-sectional shape of a wing. The key characteristics include:
- Camber: Airfoil curvature
- - _High camber - generates more lift but comes with increased drag_
- - _No camber (symmetrical) often used for aerobatic A/C_
- - _Chord: Defines the length of the line from leading to trailing edge_
- - _Thickness to Chord Ratio (t/c): maximum airfoil thickness in relation to its chord length_
- - _affects lift, drag and wing cross section_
+ - _High camber - generates more lift but comes with increased drag_
+ - _No camber (symmetrical) often used for aerobatic A/C_
+ - _Chord: Defines the length of the line from leading to trailing edge_
+ - _Thickness to Chord Ratio (t/c): maximum airfoil thickness in relation to its chord length_
+ - _affects lift, drag and wing cross section_
### Spar Placements
Spars are the one of the main structural elements inside the wing to provide strength and rigidity
- - _Has effects size of slats, flaps and integral tank size_
+
+- _Has effects size of slats, flaps and integral tank size_
### Winglet / Raked wingtip / Rakelet (not available yet):
Additional aerodynamic component at the tip of the main wing section
+
- _Used for induced drag reduction_
diff --git a/docs/documentation/sizing/wing_design/design-methods.md b/docs/documentation/sizing/wing_design/design-methods.md
index 221618d..def64a4 100644
--- a/docs/documentation/sizing/wing_design/design-methods.md
+++ b/docs/documentation/sizing/wing_design/design-methods.md
@@ -1,6 +1,6 @@
# Design methods
-The task of the _wing\_design_ tool is to generate the wing geometry according to parameters.
+The task of the _wing\_design_ tool is to generate the wing geometry according to parameters.
## Cantilever method
The general method for a cantilever wing starts with the setup of the wanted quarter chord sweep. The quarter chord sweep is kept constant over the wing (not inside the fuselage).
@@ -9,16 +9,16 @@ The general method for a cantilever wing starts with the setup of the wanted qua
The user is able to define the quarter chord sweep or let it compute by the usage of the korn equation which uses the desired design mach number and the delta to the drag divergence mach number. Additionally, the maximum thickness to chord ratio, the wing loading, the airfoil profile as a factor and the design altitude will have an influence on the quarter chord sweep. This method is an iterative process.
#### Step 2: Wing area computation
-After the computation of the sweep is done, the desired wing area is either defined by the user or it is computed by the wing loading (recommended). For calculating the wing area by the wing loading, the value for the maximum takeoff mass is used.
+After the computation of the sweep is done, the desired wing area is either defined by the user or it is computed by the wing loading (recommended). For calculating the wing area by the wing loading, the value for the maximum takeoff mass is used.
!!! danger "Important"
There are multiple definitions for the wing loading - here the one is used for wing loading with the unit $[kg/m^2]$
#### Step 3: Aspect ratio computation
-Again, the aspect ratio can be defined by the user or set via an empirical _pitch-up-limit_ function which requires the quarter chord sweep.
-!!! example
+Again, the aspect ratio can be defined by the user or set via an empirical _pitch-up-limit_ function which requires the quarter chord sweep.
+!!! example "Experimental"
Currently the _pitch-up-limit_ function is an empirical function which strongly relies on the airfoil. The parameter will vary from airfoil to airfoil. To this point - see this method as _"experimental"_.
-When the aspect ratio is calculated, the tool computes the span of the wing and uses the information from the ICAO aerodrome reference code as limitations to the span which sets a lower and an upper limit.
+When the aspect ratio is calculated, the tool computes the span of the wing and uses the information from the ICAO aerodrome reference code as limitations to the span which sets a lower and an upper limit.
??? info "ICAO Aerodrome Reference Code"
The ICAO Aerodrome reference code defines more than the allowed wing span - however the code for wing span is covered by a Code Letter:
@@ -39,7 +39,7 @@ After computing the aspect ratio, the taper ratio can be user defined or determi
The next step computes the dihedral which can be set by user or will be computed based on limits defined by Howe or Raymer. Since both, Howe and Raymer just give limitations, the dihedral as a mean value between the minimum and maximum values. Howe differentiates between sweept and unsweept while Raymer includes the mach state of the aircraft.
#### Step 6: Calculate geometry
-Based on the computed data and the information from the aircraft exchange file, it will be determined if the wing geometry will be calculated with a kink or not. The kink is enabled when the _landing gear_ is _wing mounted_ and the wing is mounted _low_. Otherwise it uses an unkinked geometry.
+Based on the computed data and the information from the aircraft exchange file, it will be determined if the wing geometry will be calculated with a kink or not. The kink is enabled when the _landing gear_ is _wing mounted_ and the wing is mounted _low_. Otherwise it uses an unkinked geometry.
The algorithm to determine the geometry differs in some points since the kinked geometry has an inner and an outer wing while in the unkinked version, no differentiation between inner and outer wing is done.
diff --git a/docs/documentation/sizing/wing_design/getting-started.md b/docs/documentation/sizing/wing_design/getting-started.md
index 163464d..7b035aa 100644
--- a/docs/documentation/sizing/wing_design/getting-started.md
+++ b/docs/documentation/sizing/wing_design/getting-started.md
@@ -6,13 +6,13 @@ The main method selection, _which_ wing shall be designed is part of the _Aircra
Here you have two main elements which will affect the wing design inside `design_specification/configuration`:
-- `configuration_type`: This defines the aircraft configuration which the wing is build for
- - `tube_and_wing`
- - `blended_wing_body`
+- `configuration_type`: This defines the aircraft configuration which the wing is build for
+ - `tube_and_wing`
+ - `blended_wing_body`
-- `wing_definition`: This defines where the wing shall be mounted (no effect during BWB design)
- - `low`
- - `high`
+- `wing_definition`: This defines where the wing shall be mounted (no effect during BWB design)
+ - `low`
+ - `high`
The configuration file of the Wing Design tool `wing\_design_conf.xml` enables more specified parameters to choose, which will tailor the wing to your desire in the `program_settings` block.
@@ -21,7 +21,7 @@ The file comes with mode selectors and associated parameters to set which can va
Parameters to chose:
- `wing_configuration`:
- - `mode_0: cantilever`: sets wing type to cantilever wing.
+ - `mode_0: cantilever`: sets wing type to cantilever wing.
To select a tube and wing with a cantilever, choose the following inside the aircraft exchange file
@@ -41,7 +41,7 @@ Each `wing_configuration`will have it's own block to chose parameters from.
For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file
!!! tip
- If you are missing some of the terms in here - take a look at [basic concepts](basic-concepts.md).
+ If you are missing some of the terms in here - take a look at [:octicons-arrow-right-16: Basic Concepts](basic-concepts.md).
## Configuration parameters → Tube and Wing
In this section you find parameters for tube and wing methods.
@@ -49,67 +49,68 @@ In this section you find parameters for tube and wing methods.
_Geometry calculation methods_
- `wing_area`: How to calculate the wing area
- - `mode_0: user_defined`: Set a wing area
- - `mode_1: by_loading_and_mtom`: Set wing area by wing loading
+ - `mode_0: user_defined`: Set a wing area
+ - `mode_1: by_loading_and_mtom`: Set wing area by wing loading
- `sweep`: How to calculate the wing quarter chord sweep (constant over wing from root to tip)
- - `mode_0: user_defined`: Set a user defined quarter chord sweep
- - `mode_1: drag_divergence`: Computes the wing sweep by the usage of Korn's equation
- - `param: korn_technology_factor`: Technology factor for korns method
- - `param: delta_drag_divergence_to_mach_design`: Set the difference between the design mach and the delta to the drag divergence mach number
+ - `mode_0: user_defined`: Set a user defined quarter chord sweep
+ - `mode_1: drag_divergence`: Computes the wing sweep by the usage of Korn's equation
+ - `param: korn_technology_factor`: Technology factor for korns method
+ - `param: delta_drag_divergence_to_mach_design`: Set the difference between the design mach and the delta to the drag divergence mach number
- `taper_ratio`: How to calculate the wings taper ratio
- - `mode_0: user_defined`: Set a taper ratio
- - `mode_1: howe`: Calculates the taper ratio by Howe's empirical method
+ - `mode_0: user_defined`: Set a taper ratio
+ - `mode_1: howe`: Calculates the taper ratio by Howe's empirical method
- `dihedral`: How to calculate the wings dihedral (root to tip; negative values → anhedral)
- - `mode_0: user_defined`: Set dihedral
- - `mode_1: by_wing_position_and_quarter_chord_sweep`: Calculates dihedral by vertical position (ref. to `wing_definition`) and the quarter chord sweep
- - `param: dihedral_limitation`: Chose from Raymer or How to set the dihedral limits
- - `mode_0: raymer`: Raymer's limits
- - `mode_1: howe`: Howe's limits
+ - `mode_0: user_defined`: Set dihedral
+ - `mode_1: by_wing_position_and_quarter_chord_sweep`: Calculates dihedral by vertical position (ref. to `wing_definition`) and the quarter chord sweep
+ - `param: dihedral_limitation`: Chose from Raymer or How to set the dihedral limits
+ - `mode_0: raymer`: Raymer's limits
+ - `mode_1: howe`: Howe's limits
- `aspect_ratio`: How to calculate aspect ratio
- - `mode_0: user_defined`: Set wing aspect ratio
- - `mode_1: by_pitch_up_limit_function`: Sets the aspect ratio by a predefined pitch up limit function (function parameters currently fix)
+ - `mode_0: user_defined`: Set wing aspect ratio
+ - `mode_1: by_pitch_up_limit_function`: Sets the aspect ratio by a predefined pitch up limit function (function parameters currently fix)
- `relative_kink_position`: How to calculate the relative kink position (takes effect only when `wing_definition` is `low`)
- - `mode_0: user_defined`: Set relative kink position as part of dimensionless half span
- - `param: relative_kink_position`: relative kink position
- - `param: maximum_inner_trailing_edge_sweep`: sets the maximum inner wing trailing edge sweep.
- - `mode_1: based_on_landing_gear_track`: Calculate kink position on landing gear track (no effect - future implementation)
- - `param: initial_relative_kink_position`: initial relative kink position (first iteration)
- - `param: maximum_inner_trailing_edge_sweep`: sets the maximum inner wing trailing edge sweep.
+ - `mode_0: user_defined`: Set relative kink position as part of dimensionless half span
+ - `param: relative_kink_position`: relative kink position
+ - `param: maximum_inner_trailing_edge_sweep`: sets the maximum inner wing trailing edge sweep.
+ - `mode_1: based_on_landing_gear_track`: Calculate kink position on landing gear track (no effect - future implementation)
+ - `param: initial_relative_kink_position`: initial relative kink position (first iteration)
+ - `param: maximum_inner_trailing_edge_sweep`: sets the maximum inner wing trailing edge sweep.
- `wing_profile_and_thickness_distribution`:
- - `mode_0: user_defined`: Sets user defined profiles with associated thickness to chord ratios (multiple ID Elements)
- - `param: wing_profile`: Name of desired airfoil
- - `param: thickness_to_chord/ratio`: thickness to chord ratio for the desired profile
- - `param: thickness_to_chord/at_half_span`: dimensionless half span position where to apply the airfoil
- - `mode_1: torenbeek_jenkinson`: Torenbeek-Jenkinson method to determine thickness distribution
- - `param: wing_profiel`: Name of desired airfoil
- - `param: max_thickness_to_chord_ratio`: Maximum thickness to chord ratio (at root / centerline)
- - `param: airfoil_critical_factor`: Sets technology level
+ - `mode_0: user_defined`: Sets user defined profiles with associated thickness to chord ratios (multiple ID Elements)
+ - `param: wing_profile`: Name of desired airfoil
+ - `param: thickness_to_chord/ratio`: thickness to chord ratio for the desired profile
+ - `param: thickness_to_chord/at_half_span`: dimensionless half span position where to apply the airfoil
+ - `mode_1: torenbeek_jenkinson`: Torenbeek-Jenkinson method to determine thickness distribution
+ - `param: wing_profiel`: Name of desired airfoil
+ - `param: max_thickness_to_chord_ratio`: Maximum thickness to chord ratio (at root / centerline)
+ - `param: airfoil_critical_factor`: Sets technology level
_Mass Calculation Methods_
- `mass`: How to calculate the mass methods
- - `mode_0: flops`: Calculate the wing mass according to FLOPS (_NASA Flight Optimization System_)
- - `param: fstrt`: Wing strut bracing factor
- - `param: faert`: Wing aeroelastic tailoring factor
- - `param: fcomp`: Wing composite utilization factor
- - `mode_1: chiozzotto_wer`: Calculate the wing mass according to Chiozzotto (WER)
- - `param: technology_factor`: Technology factor, scales effective weight
- - `param: material`: Material to chose between Aluminium or Carbo Fiber Reinforced Plastic
+ - `mode_0: flops`: Calculate the wing mass according to FLOPS (_NASA Flight Optimization System_)
+ - `param: fstrt`: Wing strut bracing factor
+ - `param: faert`: Wing aeroelastic tailoring factor
+ - `param: fcomp`: Wing composite utilization factor
+ - `mode_1: chiozzotto_wer`: Calculate the wing mass according to Chiozzotto (WER)
+ - `param: technology_factor`: Technology factor, scales effective weight
+ - `param: material`: Material to chose between Aluminium or Carbo Fiber Reinforced Plastic
_Control Design Methods_
- `mode_0: user_defined`: User defined control devices (multiple ID Elements)
- - `param: type`: Sets type of control device (e.g. aileron, rudder, elevator...)
- - `param: deflection`: Set positive and negative deflection limits
- - `param: position`: Set position parameters like chordwise and spanwise position for inner and outer dimension of a control device
+ - `param: type`: Sets type of control device (e.g. aileron, rudder, elevator...)
+ - `param: deflection`: Set positive and negative deflection limits
+ - `param: position`: Set position parameters like chordwise and spanwise position for inner and outer dimension of a control device
- `mode_1: empirical`: Sets control devices according to standard values
- - `param: high_lift_device_type_leading_edge`: Select high lift leading edge device type
- - `param: high_lift_device_type_trailing_edge`: Select high lift trailing edge device type
+ - `param: high_lift_device_type_leading_edge`: Select high lift leading edge device type
+ - `param: high_lift_device_type_trailing_edge`: Select high lift trailing edge device type
_Spars Methods_
+
- `mode_0: user_defined`: Sets spars directly (multiple ID Elements)
- - `param: name`: Set spar name (e.g. front spar, rear spar etc.)
- - `param: position`: Set position parameters like chordwise and spanwise position for inner and outer dimension of a spar
+ - `param: name`: Set spar name (e.g. front spar, rear spar etc.)
+ - `param: position`: Set position parameters like chordwise and spanwise position for inner and outer dimension of a spar
## Configuration parameters → Blended Wing Body
In this section you find parameters for Blended Wing Body methods.
@@ -134,4 +135,4 @@ The methods in the wing design tool also require additional information on the d
Please keep in mind, that the module is still in beta phase and you can gratefully contribute to the _wing\_design_ tool!
## Next Steps
-The next step is to run the _wing\_design_ tool. So let's get your wings from [:octicons-arrow-right-16: Design your first wing](run-your-first-wing-design.md)
+The next step is to run the _wing\_design_ tool. So let's get your wings from [:octicons-arrow-right-16: Run your first wing design](run-your-first-wing-design.md)
diff --git a/docs/documentation/sizing/wing_design/run-your-first-wing-design.md b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
index a493305..1b61818 100644
--- a/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
+++ b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
@@ -238,7 +238,7 @@ Let's have a look at it.
## Reporting
The HTML report is splitted - on the left half, one can see numerical information of the wing design. The right side contains plots and visual information.
-[:octicons-arrow-right-16: Report Page](figures/Report_page_wing_design.png)
+
It starts with general information followed by section parameters. Then you get information on spars and control devices. It concludes with mass information.
--
GitLab
From 78d0b0d94567aa953c676ee86b9316147eddc702 Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Mon, 3 Feb 2025 16:53:02 +0100
Subject: [PATCH 4/4] fixed getting-started.md
---
docs/documentation/sizing/wing_design/getting-started.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/docs/documentation/sizing/wing_design/getting-started.md b/docs/documentation/sizing/wing_design/getting-started.md
index 7b035aa..281f4a9 100644
--- a/docs/documentation/sizing/wing_design/getting-started.md
+++ b/docs/documentation/sizing/wing_design/getting-started.md
@@ -19,7 +19,8 @@ The configuration file of the Wing Design tool `wing\_design_conf.xml` enables m
The file comes with mode selectors and associated parameters to set which can vary.
-Parameters to chose:
+Parameters to choose:
+
- `wing_configuration`:
- `mode_0: cantilever`: sets wing type to cantilever wing.
@@ -36,7 +37,7 @@ To select a tube and wing with a cantilever, choose the following inside the air
style C stroke:#0f0, stroke-width:4px
```
-Each `wing_configuration`will have it's own block to chose parameters from.
+Each `wing_configuration`will have it's own block to choose parameters from.
!!! note
For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file
@@ -62,7 +63,7 @@ _Geometry calculation methods_
- `dihedral`: How to calculate the wings dihedral (root to tip; negative values → anhedral)
- `mode_0: user_defined`: Set dihedral
- `mode_1: by_wing_position_and_quarter_chord_sweep`: Calculates dihedral by vertical position (ref. to `wing_definition`) and the quarter chord sweep
- - `param: dihedral_limitation`: Chose from Raymer or How to set the dihedral limits
+ - `param: dihedral_limitation`: Choose from Raymer or How to set the dihedral limits
- `mode_0: raymer`: Raymer's limits
- `mode_1: howe`: Howe's limits
- `aspect_ratio`: How to calculate aspect ratio
@@ -94,7 +95,7 @@ _Mass Calculation Methods_
- `param: fcomp`: Wing composite utilization factor
- `mode_1: chiozzotto_wer`: Calculate the wing mass according to Chiozzotto (WER)
- `param: technology_factor`: Technology factor, scales effective weight
- - `param: material`: Material to chose between Aluminium or Carbo Fiber Reinforced Plastic
+ - `param: material`: Material to choose between Aluminium or Carbo Fiber Reinforced Plastic
_Control Design Methods_
--
GitLab