From b873a64bf3b45efd1b5de7642e54fccdca957ba8 Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Thu, 30 Jan 2025 16:20:30 +0100
Subject: [PATCH 1/6] update wing design documentation
---
.../sizing/wing_design/basic-concepts.md | 10 +-
.../sizing/wing_design/design-methods.md | 56 +++
.../sizing/wing_design/getting-started.md | 169 ++++-----
.../documentation/sizing/wing_design/index.md | 42 ++-
.../{dfw.md => run-your-first-wing-design.md} | 32 +-
mkdocs.yml | 353 +++++++++---------
6 files changed, 375 insertions(+), 287 deletions(-)
create mode 100644 docs/documentation/sizing/wing_design/design-methods.md
rename docs/documentation/sizing/wing_design/{dfw.md => run-your-first-wing-design.md} (92%)
diff --git a/docs/documentation/sizing/wing_design/basic-concepts.md b/docs/documentation/sizing/wing_design/basic-concepts.md
index f81d641..da8e3de 100644
--- a/docs/documentation/sizing/wing_design/basic-concepts.md
+++ b/docs/documentation/sizing/wing_design/basic-concepts.md
@@ -17,14 +17,14 @@ Here you can find available wing build methods from the _wing\_design_ tool insi
A-->D[Blended Wing body]
</pre>
-<dl class="section bug">
- <dt>Important</dt>
- <dd>Since the documentation might be delayed to the development progress - this graph might not have all information yet</dd>
-</dl>
+!!! danger "Important"
+ Since the documentation might be delayed to the development progress - this graph might not have all information yet.
+
___
### Wing Loading
Wing loading is the mass / weight of the aircraft distributed over its reference wing area.
+
- _Initial parameter to start design_
- _Wing Loading = M / S_ in (kg/m^2)
- _Wing Loading = M × g / S_ in (N/m^2)
@@ -35,6 +35,7 @@ Wing loading is the mass / weight of the aircraft distributed over its reference
### Wing Geometry
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_
@@ -61,6 +62,7 @@ Understanding the wing geometry is crucial for designing an efficient wing. Belo
### 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_
diff --git a/docs/documentation/sizing/wing_design/design-methods.md b/docs/documentation/sizing/wing_design/design-methods.md
new file mode 100644
index 0000000..30ac984
--- /dev/null
+++ b/docs/documentation/sizing/wing_design/design-methods.md
@@ -0,0 +1,56 @@
+# Design methods
+
+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).
+
+#### 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.
+
+#### 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.
+!!! 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
+ 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.
+
+??? 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:
+
+ - A: <15m
+ - B: 15m ... < 24m
+ - C: 24m ... < 36m
+ - D: 36m ... < 52m
+ - E: 52m ... < 65m
+ - F: 65m ... < 80m
+
+If the limits are exceeded, the user receives a warning and the aspect ratio as well as the span are set to the limit accordingly.
+
+#### Step 4: Taper ratio computation
+After computing the aspect ratio, the taper ratio can be user defined or determined by a method from Howe. Howe uses the aspect ration and the quarter chord sweep to compute the taper ratio.
+
+#### Step 5: Dihedral computation
+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.
+
+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.
+
+The unkinked geometry calculation is straight forward, however the kinked version has an root finding loop to compute the root by keeping the taper ratio, aspect ratio and wing area feasible. Afterwards certain conditions are checked like $LE_{inner} \ge LE_{outer}$ and $TE_{inner} \le TE_{outer}$.
+
+If those checks succeed, the geometry will be finalized, otherwise the tool throws an error here.
+
+#### Step 7: Determine spar position and control devices
+The spar positions and control devices can be set by user. For control devices, a basic set of control devices will be set consisting of an aileron, and a number of high lift devices and spoilers for air and ground.
+
+#### Step 8: Mass calculation
+With the wing finished, the mass of the wing will be computed by two different methods, one is the Flight Optimization System (Flops) method and the other is a Method from Chiozzotto (PhD Thesis). Both methods allow changes in material while Flops uses a factor from 0 to 1 to vary the ratio between aluminim and composite materials while Chiozzotto sets two materials - _AL_ for aluminium and _CFRP_ for carbon fibre reinforced plastics.
+
+For the determination of the center of gravity and the position, again empirical methods from Howe are used.
diff --git a/docs/documentation/sizing/wing_design/getting-started.md b/docs/documentation/sizing/wing_design/getting-started.md
index 6ad57ae..163464d 100644
--- a/docs/documentation/sizing/wing_design/getting-started.md
+++ b/docs/documentation/sizing/wing_design/getting-started.md
@@ -1,21 +1,21 @@
# Getting started {#getting-started}
-Welcome to the Wing Design Tool! This section will guide you through the initial steps to access and begin using the tool.
-This guide gives you a step-by-step overview of the parameters which affects the basic module behavior.
+Welcome to the Wing Design Tool! This section will guide you step-by-step through the initial steps to access and start using the tool, including an overview of the parameters which affects the basic module behavior.
## Method selection
-The main method selection, _which_ wing shall be designed comes from the _Aircraft Exchange File_. This is defined in the Block `requirements_and_specification` of the _Aircraft Exchange File_.
+The main method selection, _which_ wing shall be designed is part of the _Aircraft Exchange File_. This is defined in the Block `requirements_and_specification` of the _Aircraft Exchange File_.
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
+
+- `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)
+- `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`, gives you then more specified parameters to chose which will tailor the wing to your desire in the `program_settings` Block.
+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.
The file comes with mode selectors and associated parameters to set which can vary.
@@ -23,118 +23,115 @@ Parameters to chose:
- `wing_configuration`:
- `mode_0: cantilever`: sets wing type to cantilever wing.
-To select a tube and wing with a cantilever chose the following inside the aircraft exchange file
+To select a tube and wing with a cantilever, choose the following inside the aircraft exchange file
+
- `configuration_type` is set to `tube_and_wing`
- `wing_configuration` is set to `mode_0` which selects `cantilever`
- <pre class="mermaid">
+```mermaid
graph LR;
A[Wing Design] ==> B[Tube and Wing];
B==>C[Cantilever];
A-->D[Blended Wing body]
style B stroke-width:4px
style C stroke:#0f0, stroke-width:4px
- </pre>
+```
Each `wing_configuration`will have it's own block to chose parameters from.
-<dl class="section todo">
-<dt>Note</dt>
-<dd>
-For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file
-</dd>
-</dl>
-<dl class ="section invariant">
-<dt>Tip</dt>
-<dd>If you are missing some of the terms in here - take a look at [basic concepts](basic-concepts.md).</dd>
-</dl>
+!!! note
+ 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).
+
## Configuration parameters → Tube and Wing
In this section you find parameters for tube and wing methods.
### Cantilever calculation methods and parameters
_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
- -`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
- - `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
- - `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
- - `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)
- - `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.
- - `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
+
+- `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
+- `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
+- `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
+- `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
+- `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)
+- `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.
+- `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
_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
+
+- `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
_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
- - `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
+
+- `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
+- `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
_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
+- `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
## Configuration parameters → Blended Wing Body
In this section you find parameters for Blended Wing Body methods.
-<dl class="section todo">
-<dt>Note</dt>
-<dd>In the beta version of UNICADO, BWB methods are under development</dd>
-</dl>
+!!! note
+ In the beta version of UNICADO, BWB methods are under development.
## Additional configurations
Additionally, one has to define the common airfoil data paths inside the configuration file:
+
- `common_airfoil_data_paths`: Defines the path, where to look for airfoils - normally a database
## Additional information and requirements
The methods in the wing design tool also require additional information on the design mach number, and the ICAO aerodrome reference code (for determination of maximum allowed span) from the requirements and specification block of the _Aircraft Exchange File_.
-<dl class="section bug">
-<dt>Important</dt>
-<dd>
- Keep in mind that the _wing\_design_ tool generates a wing as a part of an aircraft. This lets it rely on specific values, e.g. for definining the area inside the fuselage etc. This leads to mandatory items at this point:
+!!! danger "Important"
+ Keep in mind that the _wing\_design_ tool generates a wing as a part of an aircraft. This lets it rely on specific values, e.g. for definining the area inside the fuselage etc. This leads to mandatory items at this point:
+
+ - A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
+ - Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
- - A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
- - Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
-</dd>
-Please keep in mind, that the module is still in beta phase and you can gratefully contribute to the
+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 [Design your first wing](dfw.md)
+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)
diff --git a/docs/documentation/sizing/wing_design/index.md b/docs/documentation/sizing/wing_design/index.md
index 69e61e1..d94fe37 100644
--- a/docs/documentation/sizing/wing_design/index.md
+++ b/docs/documentation/sizing/wing_design/index.md
@@ -1,13 +1,36 @@
# Introduction {#mainpage}
-The wing is an essential part of the aircraft. The _wing\_design_ tool is one of the core design tools in UNICADO and enables the workflow to design wings according to specified requirements and design specifications.
+The wing is an essential part of an aircraft, therefore the _wing\_design_ tool is one of the core design tools in UNICADO and enables the workflow to design wings according to specified requirements and design specifications.
+
+According to the workflow, the tool requires a valid _Aircraft Exchange File_ with inputs from the tools _initial\_sizing_ and _fuselage\_design_.
+
+```mermaid
+ flowchart LR
+ A@{ shape: sm-circ } --> B@{ shape: rounded, label: "Initial Sizing"}
+ B --> C@{ shape: rounded, label: "Fuselage Design"}
+ C --> D@{ shape: rounded, label: "Wing Design"} --> E["..."]
+
+ style E stroke: none, fill: none
+ style B stroke: #9e0f0f,fill: #9e0f0f
+ style C stroke: #9e0f0f,fill: #9e0f0f
+```
+
+## Summary of features
+Here is a quick overview of what the tool is currently capable of including a preview which is planned:
+
+| Configuration | Wing Type | Methods | Status |
+|-------------------|------------|---------|:---------------------------------:|
+| tube-and-wing | Cantilever | TUB | running :white_check_mark: |
+| blended-wing-body | ... | ... | under development :construction: |
## A User's Guide to Wing Design
The _wing\_design_ tool will help you design various wings for classical configurations to blended wing body confiugartions (in the future). This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to create a new wing from scratch.
+
The following pages will guide you through the process of generating your first wing within UNICADO:
-- [Basic Concepts](basic-concepts.md)
-- [Getting Started](getting-started.md)
-- [Design your first wing](dfw.md)
+[:octicons-arrow-right-16: Basic Concepts](basic-concepts.md)
+[:octicons-arrow-right-16: Getting Started](getting-started.md)
+[:octicons-arrow-right-16: Design Methods](design-methods.md)
+[:octicons-arrow-right-16: Design your first wing](run-your-first-wing-design.md)
So let's get started!
@@ -16,13 +39,12 @@ So let's get started!
If you are familiar with these concepts and want to contribute - head over to the developers guide to get your own method running in UNICADO!
-The following pages will help you understand the code structure:
+The following pages will help you understand the build process code structure:
-- [Prerequisites](prerequisites.md)
-- [Build the code](build-the-code.md)
-- [Wing module structure](wing-module-structure.md)
-- [Available methods](available-methods.md)
-- [Method template](method-template.md)
+[:octicons-arrow-right-16: Prerequisites](prerequisites.md)
+[:octicons-arrow-right-16: Build the code](build-the-code.md)
+[:octicons-arrow-right-16: Wing module structure](wing-module-structure.md)
+[:octicons-arrow-right-16: Method template](method-template.md)
We appreciate it!
diff --git a/docs/documentation/sizing/wing_design/dfw.md b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
similarity index 92%
rename from docs/documentation/sizing/wing_design/dfw.md
rename to docs/documentation/sizing/wing_design/run-your-first-wing-design.md
index 4b207fc..62043d2 100644
--- a/docs/documentation/sizing/wing_design/dfw.md
+++ b/docs/documentation/sizing/wing_design/run-your-first-wing-design.md
@@ -11,7 +11,18 @@ Let's dive into the fun part. In this guide we will create a wing for a classic
The wing will be part of a generic tube and wing aircraft which is a look-a-like A320.
## Requirements
-Therefor we use an _Aircraft Exchange File_ where the tools _initial\_sizing_ and _fuselage\_design_ already run.
+Running this tool requires an _Aircraft Exchange File_ where the tools _initial\_sizing_ and _fuselage\_design_ already run.
+
+```mermaid
+ flowchart LR
+ A@{ shape: sm-circ } --> B@{ shape: rounded, label: "Initial Sizing"}
+ B --> C@{ shape: rounded, label: "Fuselage Design"}
+ C --> D@{ shape: rounded, label: "Wing Design"} --> E["..."]
+
+ style E stroke: none, fill: none
+ style B stroke: #9e0f0f,fill: #9e0f0f
+ style C stroke: #9e0f0f,fill: #9e0f0f
+```
From the _Aircraft Exchange File_ we have the following information:
@@ -32,8 +43,9 @@ Parameter | Value
MTOM | 64232 kg
Wing loading | 619.8444 kg/m^2
-> [!NOTE]
-> Parameters of the fuselage are not listed - however, it has a length of ~37m and a width of ~4m
+!!! note
+ Parameters of the fuselage are not listed - however, it has a length of ~37m and a width of ~4m
+
## Design parameters
Wing Design tool parameters for cantilever method
@@ -52,7 +64,7 @@ Parameter | Value (parameter in order of occurence)
## Tool execution
-The tool can be executed from console directly if all paths are set (see [How to run a tool](howToRunATool.md)).
+The tool can be executed from console directly if all paths are set (see [:octicons-arrow-right-16: How to run a tool](howToRunATool.md)).
We go through the tool output step by step
```
@@ -225,7 +237,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.
@@ -253,14 +265,12 @@ The tool adapted the wing aspect ratio to the maximum possible aspect ratio sinc
Soo .... Now it is your turn!
-<dl class="section invariant">
-<dt>Tip</dt>
-<dd>
-Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!
-</dd>
+!!! tip
+ 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 [How to build a tool](howToBuildATool.md)
+ - 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 384e575..f0a7c7b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -61,96 +61,96 @@ 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.
@@ -196,28 +196,29 @@ nav: # Customizes the main navigation struc
- Aircraft Design:
- 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
- # - API Reference: # TODO define for Python
+ # - 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
- Getting Started: documentation/sizing/wing_design/getting-started.md
+ - Design Method: documentation/sizing/wing_design/design-methods.md
- Basic Concepts: documentation/sizing/wing_design/basic-concepts.md
- - Run your First Design: documentation/sizing/wing_design/dfw.md
+ - Run your First Design: documentation/sizing/wing_design/run-your-first-wing-design.md
- API Reference:
- wing_design/classes.md
- wing_design/namespaces.md
@@ -240,74 +241,74 @@ nav: # Customizes the main navigation struc
- 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
- # - 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
- # - 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
- # - 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.
+ # - 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
+ # # - 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
+ # # - 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.
- Get Involved:
- Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development.
- Build Instructions:
--
GitLab
From 91f89286ed857d557cb97fb2bdc68b876c6a3f40 Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Thu, 30 Jan 2025 17:24:49 +0100
Subject: [PATCH 2/6] update empennage_design documentation
---
.../sizing/empennage_design/design-methods.md | 29 +++
.../empennage_design/getting-started.md | 175 +++++++++---------
.../sizing/empennage_design/index.md | 39 +++-
....md => run-your-first-empennage-design.md} | 56 +++---
mkdocs.yml | 3 +-
5 files changed, 183 insertions(+), 119 deletions(-)
create mode 100644 docs/documentation/sizing/empennage_design/design-methods.md
rename docs/documentation/sizing/empennage_design/{dfe.md => run-your-first-empennage-design.md} (82%)
diff --git a/docs/documentation/sizing/empennage_design/design-methods.md b/docs/documentation/sizing/empennage_design/design-methods.md
new file mode 100644
index 0000000..fb55ffb
--- /dev/null
+++ b/docs/documentation/sizing/empennage_design/design-methods.md
@@ -0,0 +1,29 @@
+# Design methods
+On this page you get information about the methods used to design an empennage
+
+
+## Volume coefficient method
+The volume coefficient method which is used to generate the empennage. It is a classic method by selecting an appropriate Volumecoefficient where it creates a relation between the reference area and the empennage area.
+
+E.g. the volume coefficient for a conventional tail (vertical stabilizer ($vs$) and horizontal stabilizer ($hs$)) is given for the vertical stabilizer by:
+$$
+ C_{vs} = \frac{S_{ref}\cdot b}{S_{vs}\cdot l_{vs}} \qquad C_{hs} = \frac{S_{ref}\cdot \overline{c}}{S_{hs}\cdot l_{hs}}
+$$
+
+where:
+
+- $C_{vs}$: Volumecoefficient
+- $S_{ref}$: Wing Reference Area
+- $S_{vs}$: Area vertical stabilizer
+- $b$: Wing span
+- $\overline{c}$: Wing Mac
+- $l_{vs}$: Distance between neutral point of wing and neutral point of vertical stabilizer
+
+This equation is the starting point for determining the geometry of a vertical stabilizer. A crucial part is to determine the root chord and the position of the neutral point of the vertical stabilizer based on it's geometry. In this case to keep the surface of the vertical stabilizer small to reduce the drag of the stabilizer, the leverarm $l_{vs}$ must be maximized. This leads to an root finding problem, when aspect ratio, taper ratio and sweep are predefined based on delta values or factors of the main wing properties.
+
+In this case the root chord is found by a newton algorithm, which maximizes the leverarm $l_{vs}$. As a predefined parameter, the maximum distance from the end of the fuselage most backward point which can be varied by the `rear_x_offset` parameter.
+
+From this point on, the geometry is fixed and the mass is computed by a method from the Flight Optimization System (Flops) which are empirical calculation methods. The spar positions and control device(s) positions can be determined by user in a relative position frame from the configuration file.
+
+!!! note
+ For a conventional tail, empirical volume coefficients are calculated when the volume coefficient of a tail element is set to a value of zero.
diff --git a/docs/documentation/sizing/empennage_design/getting-started.md b/docs/documentation/sizing/empennage_design/getting-started.md
index 5fd9f73..f468358 100644
--- a/docs/documentation/sizing/empennage_design/getting-started.md
+++ b/docs/documentation/sizing/empennage_design/getting-started.md
@@ -6,13 +6,14 @@ This guide gives you a step-by-step overview of the parameters which affects the
The main method selection, _which_ empennage shall be designed comes from the _Aircraft Exchange File_. This is defined in the Block `requirements_and_specification` of the _Aircraft Exchange File_.
Here you have a main element which will affect the empennage design inside `design_specification/configuration`:
+
- `configuration_type`: This defines the aircraft configuration which the wing is build for
- - `tube_and_wing`
- - `blended_wing_body`
+ - `tube_and_wing`
+ - `blended_wing_body`
- `empennage_definition`: This defines what type of empennage shall be designed
- - for _Tube and Wing_: `conventional` or `t_tail`
- - for _Blended Wing Body_: `vertical_tails`
+ - for _Tube and Wing_: `conventional` or `t_tail`
+ - for _Blended Wing Body_: `vertical_tails`
The configuration file of the Empennage Design tool `empennage\_design_conf.xml`, gives you then more specified parameters to chose which will tailor the empennage to your desire in the `program_settings` Block.
@@ -20,16 +21,18 @@ The configuration file of the Empennage Design tool `empennage\_design_conf.xml`
The file comes with mode selectors and associated parameters to set which can vary.
Parameters to chose:
+
- `design_mode`:
- - `mode_0: design`: Designs an empennage from scratch
- - `mode_1: redesign`: Redesigns an existing empennage (not implemented - planned in a future release)
+ - `mode_0: design`: Designs an empennage from scratch
+ - `mode_1: redesign`: Redesigns an existing empennage (not implemented - planned in a future release)
As an example selection:
+
- `configuration_type` → `tube_and_wing`
- `empennage_type` → `conventional`
This selects a conventional tail for a tube and wing configuration.
-<pre class="mermaid">
+```mermaid
graph LR;
A[Empennage Design] ==> B[Tube and Wing];
B==>C[Conventional];
@@ -38,137 +41,131 @@ graph LR;
D-->F[Vertical Tails];
style B stroke-width:4px
style C stroke:#0f0, stroke-width:4px
-</pre>
+```
Each `empennage_type` will have it's own block to chose parameters from.
-<dl class="section todo">
-<dt>Note</dt>
-<dd>For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file</dd>
-</dl>
-<dl class="section invariant">
-<dt>Tip</dt>
-<dd>If you are missing some of the terms in here - take a look at [basic concepts](basic-concepts.md).</dd>
-</dl>
+!!! note
+ 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 [:octicons-arrow-right-16: basic concepts](basic-concepts.md).
+
## Configuration parameters → General
In this section you find parameters for an empennage. To keep it simple, a so called ID `tail_element` is part of each existing configuration. It defines basic parts for a classic volume coefficient method (low-fidelity).
### The Tail Elements parameters (ID Element)
Each tail element has the following parameter which may differ from empennage type
+
- `name`: Name of the element
- `parameter`:
- - `offset`: Offset in multiple directions (differs for empennage type)
- - `volume_coefficent`: Associated volume coefficient, if coefficient is set to 0 automatic values are used based on empirical data
- - `factor_aspect_ratio`: A factor on how to scale the aspect ratio of a part of the empennage according to the wing aspect ratio
- - `factor_taper_ratio`: A factor on how to scale the taper ratio of a part of the empennage according to the wing aspect ratio
- - `delta_sweep`: Additional sweep to a part of the empennage according to the wing sweep
+ - `offset`: Offset in multiple directions (differs for empennage type)
+ - `volume_coefficent`: Associated volume coefficient, if coefficient is set to 0 automatic values are used based on empirical data
+ - `factor_aspect_ratio`: A factor on how to scale the aspect ratio of a part of the empennage according to the wing aspect ratio
+ - `factor_taper_ratio`: A factor on how to scale the taper ratio of a part of the empennage according to the wing aspect ratio
+ - `delta_sweep`: Additional sweep to a part of the empennage according to the wing sweep
- `profiles`: Tail profile used (root and tip)
- - `profile`: Tail profile name - ID Element
+ - `profile`: Tail profile name - ID Element
- `spars`: Spar for a tail
- - `spar`: Spar Element - ID Element
- - `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
+ - `spar`: Spar Element - ID Element
+ - `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
- `control_devices`: Control devices for a tail
- - `control_device`: Control device Element - ID Element
- - `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
+ - `control_device`: Control device Element - ID Element
+ - `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
### Tube and Wing: The Conventional Tail (low fidelity &rarr Volume Coefficient Method)
For a conventional tail, two tail elements are required! Here specific parts should be mentioned:
- `tail_element ID="0"`:
- - `name`: vertical_stabilizer
- - `offset`: Offset of the vertical stabilizer
- - `rear_x_offset`: Set offset to between vertical stabilizer at root chord trailing edge to the fuselage end
- - `centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
- - `centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+ - `name`: vertical_stabilizer
+ - `offset`: Offset of the vertical stabilizer
+ - `rear_x_offset`: Set offset to between vertical stabilizer at root chord trailing edge to the fuselage end
+ - `centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
+ - `centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
- `tail_element ID="1"`:
- - `name`: horizontal_stabilizer
- - `offset`: Offset of the horizontal stabilizer
- - `rear_x_offset`: Set offset to between horizontal stabilizer at root chord trailing edge to the fuselage end
- - `centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
- - `centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
-
-<dl class="section todo">
-<dt>Note</dt>
-<dd>Control surfaces should be named here according to its usage e.g. horizontal stabilizer has an elevator and vertical stabilizer has a rudder.</dd>
-</dl>
-
-<dl class="section bug">
-<dt>Important</dt>
-<dd>The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_</dd>
-</dl>
+ - `name`: horizontal_stabilizer
+ - `offset`: Offset of the horizontal stabilizer
+ - `rear_x_offset`: Set offset to between horizontal stabilizer at root chord trailing edge to the fuselage end
+ - `centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
+ - `centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+
+!!! note
+ Control surfaces should be named here according to its usage e.g. horizontal stabilizer has an elevator and vertical stabilizer has a rudder.
+
+!!! danger "Important"
+ The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_
+
### Tube and Wing: The T-Tail (low fidelity &rarr Volume Coefficient Method)
For a T-tail, two tail elements are required! Here specific parts should be mentioned:
- `tail_element ID="0"`:
- - `name`: vertical_stabilizer
- - `offset`: Offset of the vertical stabilizer
- - `param: rear_x_offset`: Set offset between vertical stabilizer at root chord trailing edge to the fuselage end
- - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
- - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+ - `name`: vertical_stabilizer
+ - `offset`: Offset of the vertical stabilizer
+ - `param: rear_x_offset`: Set offset between vertical stabilizer at root chord trailing edge to the fuselage end
+ - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
+ - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
- `tail_element ID="1"`:
- - `name`: horizontal_stabilizer
- - `offset`: Offset of the horizontal stabilizer trailing
- - `param: rear_x_offset`: Set offset between horizontal stabilizer at root chord trailing edge to the tip chord of the vertical stabilizer trailing edge.
- - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
- - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+ - `name`: horizontal_stabilizer
+ - `offset`: Offset of the horizontal stabilizer trailing
+ - `param: rear_x_offset`: Set offset between horizontal stabilizer at root chord trailing edge to the tip chord of the vertical stabilizer trailing edge.
+ - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be zero
+ - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+
+!!! note
+ Control surfaces should be named here according to its usage e.g. horizontal stabilizer has an elevator and vertical stabilizer has a rudder.
+
-<dl class="section todo">
-<dt>Note</dt>
-<dd>Control surfaces should be named here according to its usage e.g. horizontal stabilizer has an elevator and vertical stabilizer has a rudder.</dd>
-</dl>
+!!! danger "Important"
+ The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_.
-<dl class="section bug">
-<dt>Important</dt>
-<dd>The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_</dd>
-</dl>
-### Blended Wing Body: The Vertical Tails method (low fidelity &rarr Volume Coefficient Method)
+### Blended Wing Body: The Vertical Tails method (low fidelity → Volume Coefficient Method)
For a blended wing body, only one tail element is required! This method is experimental and will only be applyable on the center body, so no checking of values is active to give you freedom to design!
It will create a tail and it's symmetric partner mirrored on the centerline of the Blended Wing Body. So keep in mind to keep the `offset` section correctly.
+
- `offset`:
- - `param: rear_x_offset`: Set offset between vertical stabilizer at root chord trailing edge to the end of the fuselage (center body wing) at specified y offset.
- - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be NONE zero
- - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
+ - `param: rear_x_offset`: Set offset between vertical stabilizer at root chord trailing edge to the end of the fuselage (center body wing) at specified y offset.
+ - `param: centerline_y_offset`: Set offset from the centerline of the fuselage in y direction - should be NONE zero
+ - `param: centerline_z_offset`: Set offset from the centerline of the fuselage in z direction - should be zero
A copied version will be generated automatically.
-<dl class="section warning">
-<dt>Warning</dt>
-<dd>Do not create a second element on the other side, it will be mirrored automatically.</dd>
-</dl>
+!!! warning
+ Do not create a second element on the other side, it will be mirrored automatically.
+
+!!! danger "Important"
+ The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_.
-<dl class="section bug">
-<dt>Important</dt>
-<dd>The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_</dd>
-</dl>
### Mass Calculation methods - general
_Mass Calculation Methods_
- - `mass`: How to calculate the mass methods
- - `mode_0: flops`: Calculate the empennage mass according to FLOPS (_NASA Flight Optimization System_)
- -
+
+ - `mass`: How to calculate the mass methods
+ - `mode_0: flops`: Calculate the empennage mass according to FLOPS (_NASA Flight Optimization System_)
+
## Additional configurations
Additionally, one has to define the common airfoil data paths inside the configuration file:
+
- `common_airfoil_data_paths`: Defines the path, where to look for airfoils - normally a database
## Additional information and requirements
The methods in the empennage design tool also require additional information on the wing and the fuselage from the requirements and specification block of the _Aircraft Exchange File_.
-<dl class="section bug">
-<dt>Important</dt>
-<dd>Keep in mind that the _empennage\_design_ tool generates an empennage as a part of an aircraft. This lets it rely on specific values, e.g. for defining the area inside the fuselage etc. This leads to mandatory items at this point:
-- A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
-- Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)</dd>
-</dl>
+!!! danger "Important"
+ Keep in mind that the _empennage\_design_ tool generates an empennage as a part of an aircraft. This lets it rely on specific values, e.g. for defining the area inside the fuselage etc. This leads to mandatory items at this point:
+
+ - A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
+ - Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
+
Please keep in mind, that the module is still in beta phase and you can gratefully contribute to the
## Next Steps
-The next step is to run the _empennage\_design_ tool. So let's get your wings from [Design your first empennage](dfe.md)
+The next step is to run the _empennage\_design_ tool. So let's get your empennage from [:octicons-arrow-right-16: Design your first empennage](run-your-first-empennage-design.md)
diff --git a/docs/documentation/sizing/empennage_design/index.md b/docs/documentation/sizing/empennage_design/index.md
index 461cacc..8615893 100644
--- a/docs/documentation/sizing/empennage_design/index.md
+++ b/docs/documentation/sizing/empennage_design/index.md
@@ -1,14 +1,38 @@
# Introduction {#mainpage}
The empennage is an essential part of the aircraft. The _empennage\_design_ tool is one of the core design tools in UNICADO and enables the workflow to design an empennage according to specified requirements and design specifications.
+According to the workflow, the tool requires a valid _Aircraft Exchange File_ with inputs from the tools _initial\_sizing_, _fuselage\_design_ and _wing\_design_.
+
+```mermaid
+ flowchart LR
+ A@{ shape: sm-circ } --> B["..."]
+ B --> D@{ shape: rounded, label: "Wing Design"}
+ D --> E@{ shape: rounded, label: "Empennage Design"} --> F["..."]
+
+ style F stroke: none, fill: none
+ style B stroke: none, fill: none
+ style D stroke: #9e0f0f,fill: #9e0f0f
+```
+
+
+## Summary of features
+Here is a quick overview of what the tool is currently capable of including a preview which is planned:
+
+| Configuration | Empennage Type | Method | Status |
+|-------------------|----------------|-------------------|:---------------------------------------:|
+| tube-and-wing | Conventional | Volumecoefficient | running :octicons-feed-issue-closed-16: |
+| tube-and-wing | T-Tail | Volumecoefficient | running :octicons-beaker-16: |
+| blended-wing-body | Vertical-Tails | Volumecoefficient | running (experimental) :octicons-beaker-16: |
+
## A User's Guide to Empennage Design
The _empennage\_design_ tool will help you design various empennages for classical configurations to blended wing body confiugartions. This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to create a new empennage from scratch.
The following pages will guide you through the process of generating your first empennage within UNICADO:
-- [Basic Concepts](basic-concepts.md)
-- [Getting Started](getting-started.md)
-- [Design your first empennage](dfe.md)
+[:octicons-arrow-right-16: Basic Concepts](basic-concepts.md)
+[:octicons-arrow-right-16: Getting Started](getting-started.md)
+[:octicons-arrow-right-16: Design Methods](design-methods.md)
+[:octicons-arrow-right-16: Design your first empennage](run-your-first-empennage-design.md)
So let's get started!
@@ -19,10 +43,9 @@ If you are familiar with these concepts and want to contribute - head over to th
The following pages will help you understand the code structure:
-- [Prerequisites](prerequisites.md)
-- [Build the code](build-the-code.md)
-- [Empennage module structure](wing-module-structure.md)
-- [Available methods](available-methods.md)
-- [Method template](method-template.md)
+[:octicons-arrow-right-16: Prerequisites](prerequisites.md)
+[:octicons-arrow-right-16: Build the code](build-the-code.md)
+[:octicons-arrow-right-16: Empennage module structure](empennage-module-structure.md)
+[:octicons-arrow-right-16: Method template](method-template.md)
We appreciate it!
diff --git a/docs/documentation/sizing/empennage_design/dfe.md b/docs/documentation/sizing/empennage_design/run-your-first-empennage-design.md
similarity index 82%
rename from docs/documentation/sizing/empennage_design/dfe.md
rename to docs/documentation/sizing/empennage_design/run-your-first-empennage-design.md
index 66dd141..df35fcc 100644
--- a/docs/documentation/sizing/empennage_design/dfe.md
+++ b/docs/documentation/sizing/empennage_design/run-your-first-empennage-design.md
@@ -1,23 +1,38 @@
# Design your first empennage {#design-your-first-empennage}
Let's dive into the fun part. In this guide we will create an empennage for a classic tube and wing configuration with a conventional empennage design method.
- - [Requirements:](#requirements) - Information on tool requirements
- - [Design parameters:](#design-parameters) - Information on design parameters
- - [Tool execution:](#tool-execution) - Tool execution information
- - [Reporting](#reporting) - Wing Design tool report information
- - [Changing parameters](#changing-parameters) - The fun part! Let's change parameters
- - [Troubleshooting](#troubleshooting) - Something went wrong? Maybe you are not the first one!
+[:octicons-arrow-right-16: Requirements:](#requirements) - Information on tool requirements
-The empennage will be part of a generic tube and wing aircraft which is a look-a-like A320.
+[:octicons-arrow-right-16: Design parameters:](#design-parameters) - Information on design parameters
+
+[:octicons-arrow-right-16: Tool execution:](#tool-execution) - Tool execution information
+
+[:octicons-arrow-right-16: Reporting](#reporting) - Wing Design tool report information
-The wing will be part of a generic tube and wing aircraft which is a look-a-like A320.
+[:octicons-arrow-right-16: Changing parameters](#changing-parameters) - The fun part! Let's change parameters
+
+[:octicons-arrow-right-16: Troubleshooting](#troubleshooting) - Something went wrong? Maybe you are not the first one!
+
+The empennage will be part of a generic tube and wing aircraft which is a look-a-like A320.
## Requirements
-Therefor we use an _Aircraft Exchange File_ where the tools _initial\_sizing_ and _fuselage\_design_ already run.
+Therefor we use an _Aircraft Exchange File_ where the tools _initial\_sizing_, _fuselage\_design_ and _wing\_design_ already run.
+
+```mermaid
+ flowchart LR
+ A@{ shape: sm-circ } --> B["..."]
+ B --> D@{ shape: rounded, label: "Wing Design"}
+ D --> E@{ shape: rounded, label: "Empennage Design"} --> F["..."]
+
+ style F stroke: none, fill: none
+ style B stroke: none, fill: none
+ style D stroke: #9e0f0f,fill: #9e0f0f
+```
From the _Aircraft Exchange File_ we have the following information:
From the Requirements block:
+
Parameter | Value
:--------------------|-------------:
A/C Type | CeraS
@@ -43,21 +58,22 @@ Taper Ratio | 0.17
Quarter-Chord Sweep | 27°
Dihedral | 5°
-<dl class="section todo">
-<dt>Note</dt>
-<dd>Parameters of the fuselage arenot listed - however, it has a length of ~37m and a width of ~4m.</dd>
-</dl>
+!!! note
+ Parameters of the fuselage are not listed - however, it has a length of ~37m and a width of ~4m.
+
## Design parameters
Empennage Design tool parameters for conventional low method
_Design and mass mode_
+
Parameter | Value
:-------------|------------------------:
`design_mode` | `mode_0` → `design`
`mass_mode` | `mode_0` → `flops`
_Tail Element `ID = 0`_
+
Parameter | Value
:-- | --:
`name` | `vertical_stabilizer`
@@ -73,6 +89,7 @@ Parameter | Value
`control_devices` | `((rudder, -25°, 25°,0.2,0.7,1.0,0.9,0.7,1.0))`
_Tail Element `ID = 1`_
+
Parameter | Value
:-- | --:
`name` | `horizontal_stabilizer`
@@ -88,7 +105,7 @@ Parameter | Value
`control_devices` | `((elevator, -25°, 25°,0.2,0.7,1.0,0.9,0.7,1.0))`
## Tool execution
-The tool can be executed from console directly if all paths are set (see [How to run a tool](howToRunATool.md)).
+The tool can be executed from console directly if all paths are set (see [:octicons-arrow-right-16: How to run a tool](howToRunATool.md)).
We go through the tool output step by step
```
@@ -169,15 +186,12 @@ The resulted output in the console will not change, however you see that the rud
Soo .... Now it is your turn!
-<dl class="section invariant">
-<dt>Tip</dt>
-<dd>Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!</dd>
-</dl>
+!!! tip
+ 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 [How to build a tool](howToBuildATool.md)
-
-
+ - You can build the tool directly from scratch - see therefor [:octicons-arrow-right-16: How to build a tool](howToBuildATool.md)
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index f0a7c7b..4c3e6c0 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -227,8 +227,9 @@ nav: # Customizes the main navigation struc
- Empennage Design:
- Introduction: documentation/sizing/empennage_design/index.md
- Getting Started: documentation/sizing/empennage_design/getting-started.md
+ - Design Method: documentation/sizing/empennage_design/design-methods.md
- Basic Concepts: documentation/sizing/empennage_design/basic-concepts.md
- - Run your First Design: documentation/sizing/empennage_design/dfe.md
+ - Run your First Design: documentation/sizing/empennage_design/run-your-first-empennage-design.md
- API Reference:
- empennage_design/classes.md
- empennage_design/namespaces.md
--
GitLab
From 7bfa8e5a8d1c2d0ffd660e514adccc3ecd4513ce Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@tu-berlin.de>
Date: Mon, 3 Feb 2025 09:23:05 +0100
Subject: [PATCH 3/6] Apply 1 suggestion(s) to 1 file(s)
Co-authored-by: Ellen Seabrooke <ellen.seabrooke@ifb.uni-stuttgart.de>
---
docs/documentation/sizing/empennage_design/getting-started.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/documentation/sizing/empennage_design/getting-started.md b/docs/documentation/sizing/empennage_design/getting-started.md
index f468358..81585f1 100644
--- a/docs/documentation/sizing/empennage_design/getting-started.md
+++ b/docs/documentation/sizing/empennage_design/getting-started.md
@@ -77,7 +77,7 @@ Each tail element has the following parameter which may differ from empennage ty
- `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
-### Tube and Wing: The Conventional Tail (low fidelity &rarr Volume Coefficient Method)
+### Tube and Wing: The Conventional Tail (low fidelity → Volume Coefficient Method)
For a conventional tail, two tail elements are required! Here specific parts should be mentioned:
- `tail_element ID="0"`:
--
GitLab
From dbdbaf6f63039eba0a6edd3bbc0b500ab4a080be Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@tu-berlin.de>
Date: Mon, 3 Feb 2025 09:23:18 +0100
Subject: [PATCH 4/6] Apply 1 suggestion(s) to 1 file(s)
Co-authored-by: Ellen Seabrooke <ellen.seabrooke@ifb.uni-stuttgart.de>
---
docs/documentation/sizing/empennage_design/getting-started.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/documentation/sizing/empennage_design/getting-started.md b/docs/documentation/sizing/empennage_design/getting-started.md
index 81585f1..f868487 100644
--- a/docs/documentation/sizing/empennage_design/getting-started.md
+++ b/docs/documentation/sizing/empennage_design/getting-started.md
@@ -100,7 +100,7 @@ For a conventional tail, two tail elements are required! Here specific parts sho
The user must be careful! You can choose values in a certain range, however always keep in mind _with great power comes great responsibility!_
-### Tube and Wing: The T-Tail (low fidelity &rarr Volume Coefficient Method)
+### Tube and Wing: The T-Tail (low fidelity → Volume Coefficient Method)
For a T-tail, two tail elements are required! Here specific parts should be mentioned:
- `tail_element ID="0"`:
--
GitLab
From 7d089e08757e4b1d0fb82640cfffe0584fa4473e Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@tu-berlin.de>
Date: Mon, 3 Feb 2025 09:23:34 +0100
Subject: [PATCH 5/6] Apply 1 suggestion(s) to 1 file(s)
Co-authored-by: Ellen Seabrooke <ellen.seabrooke@ifb.uni-stuttgart.de>
---
docs/documentation/sizing/empennage_design/getting-started.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/documentation/sizing/empennage_design/getting-started.md b/docs/documentation/sizing/empennage_design/getting-started.md
index f868487..508ec6c 100644
--- a/docs/documentation/sizing/empennage_design/getting-started.md
+++ b/docs/documentation/sizing/empennage_design/getting-started.md
@@ -147,8 +147,8 @@ A copied version will be generated automatically.
### Mass Calculation methods - general
_Mass Calculation Methods_
- - `mass`: How to calculate the mass methods
- - `mode_0: flops`: Calculate the empennage mass according to FLOPS (_NASA Flight Optimization System_)
+- `mass`: How to calculate the mass methods
+ - `mode_0: flops`: Calculate the empennage mass according to FLOPS (_NASA Flight Optimization System_)
## Additional configurations
Additionally, one has to define the common airfoil data paths inside the configuration file:
--
GitLab
From 3324d7043691251487621ae7e59760c060b02aff Mon Sep 17 00:00:00 2001
From: Christopher Ruwisch <christopher.ruwisch@gmail.com>
Date: Mon, 3 Feb 2025 09:56:03 +0100
Subject: [PATCH 6/6] fixed issues and update pages
---
.../sizing/empennage_design/basic-concepts.md | 19 +-
.../sizing/empennage_design/design-methods.md | 8 +-
.../empennage_design/getting-started.md | 4 +-
mkdocs.yml | 352 +++++++++---------
4 files changed, 193 insertions(+), 190 deletions(-)
diff --git a/docs/documentation/sizing/empennage_design/basic-concepts.md b/docs/documentation/sizing/empennage_design/basic-concepts.md
index 5a0ed6b..758980d 100644
--- a/docs/documentation/sizing/empennage_design/basic-concepts.md
+++ b/docs/documentation/sizing/empennage_design/basic-concepts.md
@@ -2,31 +2,32 @@
Designing an empennage for an aircraft is a challenging tasks. This topic provides basic information for empennages.
-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 empennage build methods from the _empennage\_design_ tool inside UNICADO.
+
- _UNICADO is shipped natively with a conventional method for a tube and wing configuration._
- _A basic Blended Wing body experimental method called vertical\_tails!_
-<pre class="mermaid">
+```mermaid
graph LR;
A[Empennage Design] -->B[Tube and Wing];
B-->C[Conventional]
B-->F[T-Tail]
A-->D[Blended Wing body]
D-->H[Vertical Tails]
-</pre>
+```
+
+!!! danger "Important"
+ Since the documentation might be delayed to the development progress - this graph might not have all information yet.
-<dl class="section bug">
-<dt>Important</dt>
-<dd>Since the documentation might be delayed to the development progress - this graph might not have all information yet</dd>
-</dl>
___
### Empennage Geometry
Understanding the empennage geometry is an essential part. Below are key terms and their meanings:
+
- Aspect Ratio (AR): The ratio of the span to the average chord length
- _AR = b² / S_
- _b : span_
@@ -49,6 +50,7 @@ Understanding the empennage geometry is an essential part. Below are key terms a
### Airfoil selection
An airfoil defines the cross-sectional shape of an aerodynamic surface. The key characteristics include:
+
- Camber: Airfoil curvature
- _High camber - generates more lift but comes with increased drag_
- _No camber (symmetrical) often used for empennages_
@@ -58,4 +60,5 @@ An airfoil defines the cross-sectional shape of an aerodynamic surface. The key
### Spar Placements
Spars are the one of the main structural elements inside the empennage to provide strength and rigidity
- - _Has effects on the control surface sizes_
+
+- _Has effects on the control surface sizes_
diff --git a/docs/documentation/sizing/empennage_design/design-methods.md b/docs/documentation/sizing/empennage_design/design-methods.md
index fb55ffb..c86854e 100644
--- a/docs/documentation/sizing/empennage_design/design-methods.md
+++ b/docs/documentation/sizing/empennage_design/design-methods.md
@@ -2,12 +2,12 @@
On this page you get information about the methods used to design an empennage
-## Volume coefficient method
+## Volume coefficient method
The volume coefficient method which is used to generate the empennage. It is a classic method by selecting an appropriate Volumecoefficient where it creates a relation between the reference area and the empennage area.
E.g. the volume coefficient for a conventional tail (vertical stabilizer ($vs$) and horizontal stabilizer ($hs$)) is given for the vertical stabilizer by:
$$
- C_{vs} = \frac{S_{ref}\cdot b}{S_{vs}\cdot l_{vs}} \qquad C_{hs} = \frac{S_{ref}\cdot \overline{c}}{S_{hs}\cdot l_{hs}}
+ C_{vs} = \frac{S_{vs}\cdot l_{vs}}{S_{ref}\cdot b} \qquad C_{hs} = \frac{S_{hs}\cdot l_{hs}}{S_{ref}\cdot \overline{c}}
$$
where:
@@ -19,11 +19,11 @@ where:
- $\overline{c}$: Wing Mac
- $l_{vs}$: Distance between neutral point of wing and neutral point of vertical stabilizer
-This equation is the starting point for determining the geometry of a vertical stabilizer. A crucial part is to determine the root chord and the position of the neutral point of the vertical stabilizer based on it's geometry. In this case to keep the surface of the vertical stabilizer small to reduce the drag of the stabilizer, the leverarm $l_{vs}$ must be maximized. This leads to an root finding problem, when aspect ratio, taper ratio and sweep are predefined based on delta values or factors of the main wing properties.
+This equation is the starting point for determining the geometry of a vertical stabilizer. A crucial part is to determine the root chord and the position of the neutral point of the vertical stabilizer based on it's geometry. In this case to keep the surface of the vertical stabilizer small to reduce the drag of the stabilizer, the leverarm $l_{vs}$ must be maximized. This leads to an root finding problem, when aspect ratio, taper ratio and sweep are predefined based on delta values or factors of the main wing properties.
In this case the root chord is found by a newton algorithm, which maximizes the leverarm $l_{vs}$. As a predefined parameter, the maximum distance from the end of the fuselage most backward point which can be varied by the `rear_x_offset` parameter.
From this point on, the geometry is fixed and the mass is computed by a method from the Flight Optimization System (Flops) which are empirical calculation methods. The spar positions and control device(s) positions can be determined by user in a relative position frame from the configuration file.
!!! note
- For a conventional tail, empirical volume coefficients are calculated when the volume coefficient of a tail element is set to a value of zero.
+ For a conventional tail or T-Tail, empirical volume coefficients are calculated when the volume coefficient of a tail element is set to a value of zero.
diff --git a/docs/documentation/sizing/empennage_design/getting-started.md b/docs/documentation/sizing/empennage_design/getting-started.md
index 508ec6c..5350943 100644
--- a/docs/documentation/sizing/empennage_design/getting-started.md
+++ b/docs/documentation/sizing/empennage_design/getting-started.md
@@ -160,7 +160,7 @@ The methods in the empennage design tool also require additional information on
!!! danger "Important"
Keep in mind that the _empennage\_design_ tool generates an empennage as a part of an aircraft. This lets it rely on specific values, e.g. for defining the area inside the fuselage etc. This leads to mandatory items at this point:
-
+
- A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
- Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
@@ -168,4 +168,4 @@ The methods in the empennage design tool also require additional information on
Please keep in mind, that the module is still in beta phase and you can gratefully contribute to the
## Next Steps
-The next step is to run the _empennage\_design_ tool. So let's get your empennage from [:octicons-arrow-right-16: Design your first empennage](run-your-first-empennage-design.md)
+The next step is to run the _empennage\_design_ tool. So let's get your empennage from [:octicons-arrow-right-16: Run your first design](run-your-first-empennage-design.md)
diff --git a/mkdocs.yml b/mkdocs.yml
index 4c3e6c0..19393fe 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
- Design Method: documentation/sizing/empennage_design/design-methods.md
@@ -235,84 +235,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