diff --git a/docs/documentation/sizing/empennage_design/basic-concepts.md b/docs/documentation/sizing/empennage_design/basic-concepts.md
index 5a0ed6b867e405f4ee7a5fb5bfeb40c627752f75..758980d916ebb98bb93417087b2b0db4b2e3fd26 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
new file mode 100644
index 0000000000000000000000000000000000000000..c86854ef04bf06d018d8b3f60d09f33172dfb280
--- /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_{vs}\cdot l_{vs}}{S_{ref}\cdot b} \qquad C_{hs} = \frac{S_{hs}\cdot l_{hs}}{S_{ref}\cdot \overline{c}}
+$$
+
+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 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 5fd9f7357594881b06870b08fbccb3dbb4509f09..535094369465e2f42a9f54cd2d065651c8432ef6 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)
+### 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"`:
- - `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>
-
-### Tube and Wing: The T-Tail (low fidelity &rarr Volume Coefficient Method)
+ - `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 → 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
+
+- `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: Run your first design](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 461cacc0eb45cd13b6450919421b2d0ad0960ffe..8615893ab788767eb3a5418b68c39cc51316cd48 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 66dd141ebd3971954556691f056ac56e3abc02a6..df35fccacdcd593f6593d9a026371cf6f124348a 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/docs/documentation/sizing/systems_design/figures/architecture_definition.png b/docs/documentation/sizing/systems_design/figures/architecture_definition.png
new file mode 100644
index 0000000000000000000000000000000000000000..1d4cdee8bd627d5787e7906e7a2c6154b90a1e85
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/architecture_definition.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3687f3d702b3868c912308710ec8b8073dce13c91cba891f2cc5eb1a6ea0c93e
+size 358537
diff --git a/docs/documentation/sizing/systems_design/figures/flow-chart.jpg b/docs/documentation/sizing/systems_design/figures/flow-chart.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..0df96210e7c8fdcee6b0be8cbc5cbe7a9c795b64
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/flow-chart.jpg
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a86a864efa6b6c0d2470356b5a120a775c93846a18d836b2ba8192e8b8c499f7
+size 102740
diff --git a/docs/documentation/sizing/systems_design/figures/flow-chart.png b/docs/documentation/sizing/systems_design/figures/flow-chart.png
new file mode 100644
index 0000000000000000000000000000000000000000..1c41c0133f6c366ef85ab50604f6e1c6e1f82cdf
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/flow-chart.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0b85bb2ad751ce11c792d122003d517cda5fad9225c0853f98f75e0f8e70de12
+size 225796
diff --git a/docs/documentation/sizing/systems_design/figures/mission-power-ATA70.png b/docs/documentation/sizing/systems_design/figures/mission-power-ATA70.png
new file mode 100644
index 0000000000000000000000000000000000000000..6c2a21bfa6a2a4dbf6dfd6b2a797bb87dd99e747
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/mission-power-ATA70.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24539c7f351fc6500674d1ccf7344870c6fbd08fb373ce56be8f18c6791cfc28
+size 20578
diff --git a/docs/documentation/sizing/systems_design/figures/overall_structure.png b/docs/documentation/sizing/systems_design/figures/overall_structure.png
new file mode 100644
index 0000000000000000000000000000000000000000..71f3b86407448c275a34b587c71167b2942761db
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/overall_structure.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:398f273adfdba339b09c6c0065a14e73449c71875a74219ac447efcb76f9edb1
+size 88200
diff --git a/docs/documentation/sizing/systems_design/figures/power_summation.png b/docs/documentation/sizing/systems_design/figures/power_summation.png
new file mode 100644
index 0000000000000000000000000000000000000000..a9b56546555d66f9dddd7a17d2ef36e101b6d578
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/power_summation.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7297a649219b9a489d5c81663e5202e5a71c22b282ade9bef184328669a7416a
+size 40510
diff --git a/docs/documentation/sizing/systems_design/figures/system-masses.png b/docs/documentation/sizing/systems_design/figures/system-masses.png
new file mode 100644
index 0000000000000000000000000000000000000000..bec6e5747e1766ac205b09b7eb0b228309abf754
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/system-masses.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:26c86112cca64c0f9941b3768d16d1819b71689fd5d8a5013d15266a0398a05f
+size 61957
diff --git a/docs/documentation/sizing/systems_design/figures/system_class.png b/docs/documentation/sizing/systems_design/figures/system_class.png
new file mode 100644
index 0000000000000000000000000000000000000000..dcf23ed224cfd5d2ec6fa82a61c9fbf561c079a4
--- /dev/null
+++ b/docs/documentation/sizing/systems_design/figures/system_class.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f600b523e02851af0e9a7e8cb371cf87aaa54fe39bb810671a6bcdb942c8d3de
+size 55656
diff --git a/docs/documentation/sizing/systems_design/getting-started.md b/docs/documentation/sizing/systems_design/getting-started.md
index b83fb61f0bf8d423b8a9b440b03dccf254ed7461..6099db298cf73b1470539d83d4b3e27e28345dff 100644
--- a/docs/documentation/sizing/systems_design/getting-started.md
+++ b/docs/documentation/sizing/systems_design/getting-started.md
@@ -1,21 +1,55 @@
# Getting Started
-This guide will show you how to use **systems_design**, which requires you to define a [system architecture](\ref defining_architecture) and to define [specific parameters for each system](systems.md) in the the configuration file `systems_design_conf.xml` (also _configXML_). Since the required power of the systems is calculated for each mission step, **systems_design** requires a mission file (e.g. `design_mission.xml`). Additionally, input parameters from the aircraft exchange file (or _acXML_) from the following areas are required:
-* paths to mission files
-* overall masses (MTOM, OME, MME, wing loading)
-* performance data (maximum operating velocity, maximum operating mach number, maximum operating altitude, design range)
-* landing gear
-* wing
-* empennage
-* fuselage
-* nacelles
-* tank
-* propulsion
-* number of flight and cabin crew
-
-**systems_design** has three modes, which are explained [here](\ref modes) in more detail. The mode can be selected in `module_configuration_file/program_settings/mission_mode` and defines which mission file is used for the calculation of the required power (design, study or requirement mission). For the design mission the systems are also sized, i.e. their masses are calculated.
-
-\anchor defining_architecture
+This guide will show you how to use **systems_design**.
+
+## Step-by-step
+
+It is assumed that you have the `UNICADO Package` installed including the executables and the engine database. In case you are a developer, you need to build the tool first (see [build instructions on UNICADO website](../../../get-involved/build/cpp/)).
+
+1. Create a dummy `aircraft_exchange_file` (minimal required input see [here](#settings-and-outputs-settingsandoutputs))
+2. Fill out the configuration file - change at least:
+ - in `control_settings`
+ - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
+ - `console_output` at least to `mode_1`
+ - `plot_output` to false or make sure gnuplot can be found (`gnuplot_path`)
+3. Open terminal and run **systems_design**
+
+The following will happen:
+- you see output in the console window
+- a HTML report is created in the directory of `aircraft_exchange_file_directory` (no plots if they are turned off)
+- results are saved in the _acXML_ file
+
+## Settings and outputs
+
+Three input files are required for **systems_design**:
+
+- the aircraft exchange file (or _acXML_) with values for the following areas:
+ - paths to mission files
+ - overall masses (MTOM, OME, MME, wing loading)
+ - performance data (maximum operating velocity, maximum operating mach number, maximum operating altitude, design range)
+ - landing gear
+ - wing
+ - empennage
+ - fuselage
+ - nacelles
+ - tank
+ - propulsion
+ - number of flight and cabin crew
+- the configuration file `initial_sizing_conf.xml` (or _configXML_) includes
+ - control settings (e.g. enable/disable generating plots)
+ - program settings (e.g. define system architecture, set parameters for individual systems)
+- the mission file (`design_mission.xml`, `study_mission.xml` or `requirement_mission.xml`) is required since **systems_design** calculates the required system power for each mission step.
+
+!!! note
+ When the UNICADO workflow is executed the tool is run automatically. In this case, all the required data should be available anyway.
+
+!!! note
+ _acXML_ is an exchange file - we agreed on that only data will be saved as output which is needed by another tool!
+
+**systems_design** has three modes, which are explained [here](software_architecture.md#run) in more detail. The mode can be selected in `module_configuration_file/program_settings/mission_mode` and defines which mission file is used for the calculation of the required power (design, study or requirement mission). For the design mission the systems are also sized, i.e. their masses are calculated.
+
## Defining the System Architecture
+
+
The system architecture is defined in the _configXML_ of systemsDesign in the node `module_configuration_file/program_settings/aircraft_systems`. Here the systems are grouped into consumer (or sink) systems, conducting systems, and source systems. (This grouping is also used during calculation.) Energy sinks are systems that consume energy. The environmental control system is considered separately to iterate between the heat created by the systems and the sizing of the environmental control system. Energy sources provide energy. Energy conductors conduct electric or hydraulic energy or bleed air. Virtual systems are used for adding systems that will not be designed (for example if there are no sizing methods implemented for this system). For each group the number of systems in the group is defined, followed by the individual system description. A minimal example of the architecture definition is given below.
```xml
@@ -93,24 +127,25 @@ The system architecture is defined in the _configXML_ of systemsDesign in the no
```
By including or excluding these systems, you can choose which systems are implemented. By default the following systems are included in the architecture (name for configXML given in brackets):
-* energy sinks:
- * [conventional furnishing system](\ref ATA25-furnishing) (conventionalFurnishing)
- * [conventional fuel system](\ref ATA28-fuel) (conventionalFuel)
- * [conventional ice and rain protection system](\ref ATA30-ice-conventional) (conventionalIceRainProtection)
- * [conventional lighting system](\ref ATA33-lighting) (conventionalLighting)
- * [conventional fire protection system](\ref ATA26-fire) (conventionalFireProtection)
- * [conventional oxygen system](\ref ATA35-oxygen) (conventionalOxygenSystem)
- * [conventional landing gear system](\ref ATA32-gear) (conventionalGear)
- * [conventional flight control system](\ref ATA27-flight-control) (conventionalFlightControl)
- * [remaining consumer systems](\ref ATAXX-remaining) (reminingConsumers)
-* [environmental control system](\ref ATA21-ECS) (conventionalECS)
-* energy sources:
- * [conventional propulsion](\ref ATA70-engine) (conventionalPropulsion)
- * [conventional APU](\ref ATA49-APU) (conventionalAPU)
-* energy conductors:
- * [bleed air system](\ref ATA36-bleed) (BleedAirSystem)
- * [hydraulic system](\ref ATA29-hydraulic) (HydraulicSystem)
- * [electric system](\ref ATA24-electric) (ElectricSystem)
+
+- energy sinks:
+ - [conventional furnishing system](systems.md#ata-25-furnishing-system) (conventionalFurnishing)
+ - [conventional fuel system](systems.md#ata-28-fuel-system) (conventionalFuel)
+ - [conventional ice and rain protection system](systems.md#ata-30-ice-and-rain-protection-system) (conventionalIceRainProtection)
+ - [conventional lighting system](systems.md#ata-33-lighting-system) (conventionalLighting)
+ - [conventional fire protection system](systems.md#ata-26-fire-protectrion-system) (conventionalFireProtection)
+ - [conventional oxygen system](systems.md#ata-35-oxygen-system) (conventionalOxygenSystem)
+ - [conventional landing gear system](systems.md#ata-32-landing-gear-system) (conventionalGear)
+ - [conventional flight control system](systems.md#ata-27-flight-control-system) (conventionalFlightControl)
+ - [remaining consumer systems](systems.md#ata-xx-remaining-consumers) (reminingConsumers)
+- [environmental control system](systems.md#ata-21-environmental-control-system) (conventionalECS)
+- energy sources:
+ - [conventional propulsion](systems.md#ata-70-engine) (conventionalPropulsion)
+ - [conventional APU](systems.md#ata-49-auxiliary-power-unit-apu) (conventionalAPU)
+- energy conductors:
+ - [bleed air system](systems.md#ata-36-bleed-air-system) (BleedAirSystem)
+ - [hydraulic system](systems.md#ata-29-hydraulic-system) (HydraulicSystem)
+ - [electric system](systems.md#ata-24-electric-system) (ElectricSystem)
Some systems have several implementations (e.g. ATA30 has a conventional and an electric implementation). Which one is used is specified by the node `system_description`. Sticking to the ATA30 example, the conventional implementation would be set like this:
```xml
@@ -152,3 +187,14 @@ Additionally, [system-specific parameters](systems.md) can be set in the node `<
## Output
**systems_design** will generate a report containing system masses (if run in sizing mode) and the electric, hydraulic and bleed air power profile over the mission for each system. Additionally, the section `systems` of the component design in the _acXML_ is updated (if **systems_design** was run in design mode) and the bleed air and shaft power offtakes from the engine for each mission step are written to the mission file (for any mode).
+
+Here are some examples of what you can expect to see in the report:
+
+{width=500}
+
+The mission power shown here is for the propulsion unit. It is negative since the propulsion unit provides power instead of requiring it. Additionally to the plots displayed in the report, csv-files with the plot data can be found in the project folder: `reporting/plots/csv_files`.
+
+
+
+!!! note
+ Some systems will not show anything in these graphs. That means they do not require power (e.g. [oxygen system](systems.md#ata-35-oxygen-system)). The graph of the [APU](systems.md#ata-49-auxiliary-power-unit-apu) is also empty because it is only sized for ground operations and those are not considered in the mission shown in these graphs.
\ No newline at end of file
diff --git a/docs/documentation/sizing/systems_design/index.md b/docs/documentation/sizing/systems_design/index.md
index acf6a952cac598eb1c8fa77811ae4a02ce57beb7..9d3b462ddded50531969f11159478066307e588d 100644
--- a/docs/documentation/sizing/systems_design/index.md
+++ b/docs/documentation/sizing/systems_design/index.md
@@ -1,20 +1,24 @@
# Introduction {#mainpage}
-The systems design module calculates the mass and power requirement of the aircraft onboard systems. The systems are divided according to the ATA chapters. Models for the following systems exist:
+The systems design module calculates the mass and power requirement of the aircraft onboard systems. The current version supports a conventional power supply architecture shown in the picture below. An update that will allow other power sources is on its way :construction:.
-* [ATA 21: Environmental Control System](\ref ATA21-ECS)
-* [ATA 24: Electric System](\ref ATA24-electric)
-* [ATA 25: Furnishing System](\ref ATA25-furnishing)
-* [ATA 26: Fire Protectrion System](\ref ATA26-fire)
-* [ATA 27: Flight Control System](\ref ATA27-flight-control)
-* [ATA 28: Fuel System](\ref ATA28-fuel)
-* [ATA 29: Hydraulic System](\ref ATA29-hydraulic)
-* [ATA 30: Ice and Rain Protection System](\ref ATA30-ice-conventional)
-* [ATA 32: Landing Gear System](\ref ATA32-gear)
-* [ATA 33: Lighting System](\ref ATA33-lighting)
-* [ATA 35: Oxygen System](\ref ATA35-oxygen)
-* [ATA 36: Bleed Air System](\ref ATA36-bleed)
-* [ATA 49: Auxiliary Power Unit (APU)](\ref ATA49-APU)
-* [ATA 70: Engine (only used to account for power extraction efficiencies of the engine)](\ref ATA70-engine)
-* [ATA XX: Remaining Consumers](\ref ATAXX-remaining)
+
+
+ The systems are divided according to the ATA chapters. Models for the following systems exist:
+
+* [ATA 21: Environmental Control System](systems.md#ata-21-environmental-control-system)
+* [ATA 24: Electric System](systems.md#ata-24-electric-system)
+* [ATA 25: Furnishing System](systems.md#ata-25-furnishing-system)
+* [ATA 26: Fire Protectrion System](systems.md#ata-26-fire-protectrion-system)
+* [ATA 27: Flight Control System](systems.md#ata-27-flight-control-system)
+* [ATA 28: Fuel System](systems.md#ata-28-fuel-system)
+* [ATA 29: Hydraulic System](systems.md#ata-29-hydraulic-system)
+* [ATA 30: Ice and Rain Protection System](systems.md#ata-30-ice-and-rain-protection-system)
+* [ATA 32: Landing Gear System](systems.md#ata-32-landing-gear-system)
+* [ATA 33: Lighting System](systems.md#ata-33-lighting-system)
+* [ATA 35: Oxygen System](systems.md#ata-35-oxygen-system)
+* [ATA 36: Bleed Air System](systems.md#ata-36-bleed-air-system)
+* [ATA 49: Auxiliary Power Unit (APU)](systems.md#ata-49-auxiliary-power-unit-apu)
+* [ATA 70: Engine (only used to account for power extraction efficiencies of the engine)](systems.md#ata-70-engine)
+* [ATA XX: Remaining Consumers](systems.md#ata-xx-remaining-consumers)
[Getting Started](getting_started.md) will show you how to define the system architecture. The settings and calculation methods for the individual aircraft systems are explained in [Systems](systems.md) or you can follow one of the links above directly to the system. If you want to know how the systems design module works have a look at the [Software Architecture](software_architecture.md).
diff --git a/docs/documentation/sizing/systems_design/software_architecture.md b/docs/documentation/sizing/systems_design/software_architecture.md
index 814bcf2f901c449ea3772beabbd941c6dcc895ba..b223af1cf5d875c03e954366f355f68761bee543 100644
--- a/docs/documentation/sizing/systems_design/software_architecture.md
+++ b/docs/documentation/sizing/systems_design/software_architecture.md
@@ -1,25 +1,46 @@
# Systems Design Software Architecture
-If you are interested in how **systems_design** performs the system sizing and power requirment calculation, this page will give you an overview.
+If you are interested in how **systems_design** performs the system sizing and power requirment calculation, this page will give you an overview. The following UNICADO libraries are used:
+
+* atmosphere: determines atmospheric conditions at given altitudes
+* engine: access to engine data (max. available bleed air and shaft power)
+* aircraftGeometry2: used for geometry measurements
+* energyCarriers: accessing energy carrier information (e.g. densities)
+* aixml: handling of xml
+* moduleBasics: used for basic program functions
+* runtimeInfo: terminal outputs
+* unitConversion: converting units
+* standardFiles: file handling
+
## Module Structure
Currently **systems_design** only has one strategy - the `STANDARD` strategy implemented in `standardSystemsDesign.cpp`. In **systems_design** each system is represented by an instance of the class `aircraftSystem`. Its properties include the point mass and CoG of the system, the required power, and the heat load emitted by the system. Each aircraftSystem has functions for calculating these properties. The power of a system is not constant throughout the mission but calculated for each mission step. These values are stored in objects of the class `powerProfile`. This class stores the design power, used for system sizing, and the mission power. The mission power is further divided into the base load during this mission step and potential peak loads, e.g. resulting from the retraction or extension of the landing gear. Heat loads occurring due to energy losses in the systems are also calculated for each mission step and stored in a powerProfile.
+{width=500 style="display: block; margin: auto;"}
+
If a new aircraftSystem is implemented, its header file has to be included in `standardSystemsDesign.cpp` and an else-if-statement calling its constructor according to the system name has to be added to `standardSystemsDesign::initializeSystems()`.
## Calculation
+The calculation methodology is shown in this flow chart and explained in detail below.
+
+{width=400 style="display: block; margin: auto;"}
+
#### Initialize
The system design module starts with `standardSystemsDesign::initialize()` by initializing all aircraft systems using the user-provided data from the configuration file. The config file is read when the `data_` object is created. Additionally, required aircraft parameters from the aircraft exchange file are read. This includes geometry data (fuselage, nacelles, wing, empennage), propulsion data, mass and performance and accomodation data. This data are required for the power and mass calculations of specific systems. However, all data are read centrally by the `systemsIOData` class during initialization. Lastly checks for the user input and the geometry from the acxml are performed.
-**systems_design** considers the temperature offset to the International Standard Atmosphere (ISA) defined in the _acXML_. The resulting temperature changes in the atmospheric conditions are applied to the mission steps and affect the power demand and thus the mass properties of systems depending on atmospheric conditions ([environmental control system](\ref ATA21-ECS), [flight control system](\ref ATA27-flight-control), [ice and rain protection system](\ref ATA30-ice-conventional)).
+!!! note
+ **systems_design** considers the temperature offset to the International Standard Atmosphere (ISA) defined in the _acXML_. The resulting temperature changes in the atmospheric conditions are applied to the mission steps and affect the power demand and thus the mass properties of systems depending on atmospheric conditions ([environmental control system](systems.md#ata-21-environmental-control-system), [flight control system](systems.md#ata-27-flight-control-system), [ice and rain protection system](systems.md#ata-30-ice-and-rain-protection-system)).
#### Run
-\anchor modes
The strategy standard systems design contains three modes, which can be selected in the configuration file. The sizing mode calculates the required system power and based on that the system masses. The study and requirment mode can be used to calculate the required system power for different missions (either the study or requirments mission) and do not resize the systems (i.e., no mass calculation is performed).
**Sizing Mode**
First, the module calculates the performance profile of each system (with the function `standardSystemsDesign::calculatePerformanceProfile()`). This involves calling the respective power calculation function for each system in a specific order: consumer systems, the environmental control system (ECS), conducting systems, and source systems. The calculation order is crucial because the power requirements of consumer systems are necessary to calculate the conducting and source power. At first, the power profiles of all consumer systems are calculated (`standardSystemsDesign::getSinkEnergyConsumption()`) except for the ECS. It is treated separately because its power requirement depends on the heat loads generated by other systems, including conducting systems. Therefore, it is calculated later in the process.
-After each consumer system power calculation, the power is accumulated in a global power profile that stores the combined power requirement and heat loads of all consumer systems. Conductor systems can provide power to other conducting systems, e.g. through the conversion of electrical power to hydraulic power. The power used for these conversions is calculated next (with `transferElec2HydPower` (electric driven hydraulic pumps) and `transferHyd2ElecPower` (only for failure cases)) and stored in the global sink power profile.
+After each consumer system power calculation, the power is accumulated in a global power profile that stores the combined power requirement and heat loads of all consumer systems.
+
+{width=400 style="display: block; margin: auto;"}
+
+Conductor systems can provide power to other conducting systems, e.g. through the conversion of electrical power to hydraulic power. The power used for these conversions is calculated next (with `transferElec2HydPower` (electric driven hydraulic pumps) and `transferHyd2ElecPower` (only for failure cases)) and stored in the global sink power profile.
Next, an iteration loop is required because the ECS power requirement depends on the heat load of the sinks and conductors and the conducting power depends on the power requirement of the ECS. At the beginning of each loop the power profiles `data_->data.ECSConsumption` and `data_->data.conductorConsumption` are cleared from the values of the previous iteration loop and the global power profiles of the conductors are initialized (`data_->Systems.energyConductor`). In each iteration loop, the ECS power is calculated (`standardSystemsDesign::getECSEnergyConsumption()`) based on the heat loads of the consumer systems stored in the global sink power profile. The power requirements for conducting systems are then calculated or updated (`standardSystemsDesign::getConductorEnergyConsumption()`) to reflect the new ECS consumption, including any power transfers, such as from hydraulic to electrical power. The iteration continues until the average bleed load of the ECS converges. The convergence criterion is set to a difference of less than 10<sup>-4</sup> between iterations.
@@ -27,7 +48,8 @@ After achieving convergence, the module calculates the power the sources (`stand
Finally, with the power profiles established, the module calculates the mass of each system (`standardSystemsDesign::getSystemsMass()`) based on the design power requirements and specific characteristics of each system by calling the mass calculation method of each system. For virtual systems no method is called, rather the user definded values are copied from the configuration file. After the individual system masses are calculated, the function `weightsAndCGs::getWeights()` calculates the masses and CGs of system groups and the mass of some operator items. In UNICADO only the residual oil and fuel as well as water and toilet chemicals are considered part of the systems. Other operator items are calculated in fuselage design and mission analysis.
-**Note**: The currently implemented methods for the operator items (Torenbeek) do not calculate the residual oil mass!
+!!! note
+ The currently implemented methods for the operator items (Torenbeek) do not calculate the residual oil mass!
**Study Mode**
@@ -45,4 +67,4 @@ The function `systemsIOData::updateMissionXML()` updates all values calculated w
#### Report
This section is used to create the plots and html and tex report of the module.
-Plots are generated using matplot++. Additionally, csv files with the plot data are written.
+Plots are generated using matplot++. Additionally, csv files with the plot data are written. More information on the outputs can be found [here](getting-started.md#output).
diff --git a/docs/documentation/sizing/systems_design/systems.md b/docs/documentation/sizing/systems_design/systems.md
index a751cd8038fe09538b90c85608056fc40b1e57c9..4a83ccf3259465ce884a48a494152b8d1827678f 100644
--- a/docs/documentation/sizing/systems_design/systems.md
+++ b/docs/documentation/sizing/systems_design/systems.md
@@ -1,6 +1,5 @@
# Implemented Aircraft System Models
-\anchor ATA21-ECS
## ATA 21: Environmental Control System
The environmental control system model implemented is powered by electric power and bleed air from the engines.
@@ -8,7 +7,7 @@ The environmental control system model implemented is powered by electric power
The power required by the environmental control system is calculated based on the heat loads of all systems, the heat from the sun and from the passengers. The ECO-Mode allows to reduce the required bleed air by 25%. Air conditioning is switched off during takeoff.
-The mass of the ECS depends on the bleed air mass flow in the design point. Calculation method from LTH and Howe. The mass is broken down into the components ducts, air conditioning pack, outlet, ram inlet, vents, and misc. according to factors determined by Koeppen.
+The mass of the ECS depends on the bleed air mass flow in the design point. Calculation method from LTH and Howe. The mass is broken down into the components ducts, air conditioning pack, outlet, ram inlet, vents, and misc. according to factors determined by Koeppen[^1].
The CoG of the ECS is determined with the assumption that its located in the belly fairing.
@@ -27,7 +26,6 @@ The CoG of the ECS is determined with the assumption that its located in the bel
* Off Take Off: Switch to turn of ACP during take off
* ECO Mode: Switch for ECO Mode reduces bleed air requirement by 25%
-\anchor ATA24-electric
## ATA 24: Electric System
**Methods**
@@ -53,7 +51,6 @@ The mass calculation method from Steinke is based on the maximum required electr
* efficiency
* operation factor (share of total power in normal operation)
-\anchor ATA25-furnishing
## ATA 25: Furnishing System
Furnishing system includes the power required for the galleys and the inflight entertainment system (IFE). The mass of all furnishing is calculated in fuselage design and read from the aircraft exchange file.
@@ -65,22 +62,24 @@ Power calculation is done based on user inputs.
**Required Input Parameters**
* Galley Load Fraction during Takeoff [-]:
- Electric Load Analysis for A320 suggest a value of 0.2 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 0.2[^1]
+
+[^1]: Source documents are available in German and can be requested from the RWTH Aachen.
+
* Galley Load Fraction during Cruise [-]:
- Electric Load Analysis for A320 suggest a value of 0.7 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 0.7[^1]
* Galley Load Fraction during Descent [-]:
- Electric Load Analysis for A320 suggest a value of 0.2 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 0.2[^1]
* Galley Location [m]
* Non Personal IFE Power [W]: General power for IFE
* Personal IFE Power [W]: Power for IFE per PAX
* Personal IFE Load Fraction Climb [-]:
- Electric Load Analysis for A320 suggest a value of 0.58 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 0.58[^1]
* Personal IFE Load Fraction Cruise [-]:
- Electric Load Analysis for A320 suggest a value of 1 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 1[^1]
* Personal IFE Load Fraction Descent [-]:
- Electric Load Analysis for A320 suggest a value of 0.5 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 0.5[^1]
-\anchor ATA26-fire
## ATA 26: Fire Protectrion System
Does not require power!
@@ -93,7 +92,6 @@ Mass calculation is based on propulsion type and MTOM (Torenbeek Tab. 8-12).
None.
-\anchor ATA27-flight-control
## ATA 27: Flight Control System
The flight control system is modeled in great detail down to the individual actuators of the control surfaces. The calculation is devided into segments according to the control surfaces:
@@ -160,7 +158,6 @@ Acceptable control surface names are:
**Note**: not all of these devices are implemented. If they aren't implemented a default will be used and a warning issued.
-\anchor ATA28-fuel
## ATA 28: Fuel System
**The fuel system does not contain the tank mass!**
@@ -177,7 +174,6 @@ The CoG is assumed to be the same as that of the wing.
None
-\anchor ATA29-hydraulic
## ATA 29: Hydraulic System
**Methods**
@@ -186,7 +182,7 @@ None
The required power of the hydraulic system is the power lost through inefficiencies. The efficiency factor for the hydraulic system and for the pumps are considered.
-The mass calculation method from [Steinke](\ref additional_sources) is based on the maximum required hydraulic power, the OME, the fluid mass and the ducting length. The ducting length is composed of the lengths from the engines to the belly fairing, the front gear to the back gear, 2 * the length of the wing trailing edge, 2 * the trailing edges of the horizontal and vertical tail plane. The total length is then doubled to account for the backflow.
+The mass calculation method from Steinke[^1] is based on the maximum required hydraulic power, the OME, the fluid mass and the ducting length. The ducting length is composed of the lengths from the engines to the belly fairing, the front gear to the back gear, 2 * the length of the wing trailing edge, 2 * the trailing edges of the horizontal and vertical tail plane. The total length is then doubled to account for the backflow.
**Required Input Parameters**
@@ -210,7 +206,6 @@ The mass calculation method from [Steinke](\ref additional_sources) is based on
There are two implemented models for the ice and rain protection system - a conventional one powered by bleed air and an electric one.
-\anchor ATA30-ice-conventional
### Conventional ATA 30
**Methods**
@@ -230,7 +225,6 @@ Anti-Icing is typically applied from the kink of the wing and ends at the outer
* Drop Diameter [micro meter]
* Mass Percentage of OME [-]
-\anchor ATA30-ice-electric
### Electric ATA 30
Mass is calculated as a percentage of the OME defined by the user.
@@ -244,16 +238,15 @@ Same calculation for the external heat flux. From there the required electric po
Same as for conventional +
* Electric Power Consumption Departure [W]:
- Electric Load Analysis for A320 suggest a value of 14026.9 W [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 14026.9 W[^1]
* Electric Power Consumption Cruise [W]:
- Electric Load Analysis for A320 suggest a value of 13070.9 W [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 13070.9 W[^1]
* Electric Power Consumption Approach [W]:
- Electric Load Analysis for A320 suggest a value of 14026.9 W [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 14026.9 W[^1]
* Electric Power Consumption Land [W]
- Electric Load Analysis for A320 suggest a value of 7192.9 W [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 7192.9 W[^1]
* Efficiency Electro Thermic Anti-Icing [-]
-\anchor ATA32-gear
## ATA 32: Landing Gear System
**Methods**
@@ -269,7 +262,6 @@ The retraction and extension power are calculated based on the mass of the landi
* Extension Time [s]
* Power Source(s)
-\anchor ATA33-lighting
## ATA 33: Lighting System
**Methods**
@@ -297,14 +289,13 @@ The design electric power is calculated assuming all lights are on. For the miss
* Logo Light Power [W]
* Strobe Light Power [W]
* Specific Emergency Light Power [W/m^3]
- Electric Load Analysis for A320 suggest a value of 1.46 W/m^3 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 1.46 W/m^3[^1]
* Specific Cabin Light Power [W/m^3]
- Electric Load Analysis for A320 suggest a value of 18.04 W/m^3 [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 18.04 W/m^3[^1]
* Flight Deck Light Power [W]
- Electric Load Analysis for A320 suggest a value of 904.4 W [[1]](\ref additional_sources)
+ Electric Load Analysis for A320 suggest a value of 904.4 W[^1]
* Power Sources
-\anchor ATA35-oxygen
## ATA 35: Oxygen System
The oxygen system does not require power.
@@ -317,7 +308,6 @@ The mass is calculated according to Torenbeek based on the number of PAX and dep
None.
-\anchor ATA36-bleed
## ATA 36: Bleed Air System
**Methods**
@@ -334,7 +324,6 @@ Bleed air required by the bleed air system is based on the efficiency losses in
* Efficiency Factor [-]
* Specific Ducting Mass [kg/m]
-\anchor ATA49-APU
## ATA 49: Auxiliary Power Unit (APU)
The APU is the only power source sized within systems design. However, it is only operated on ground. Ground operations are not included in the mission analysis in UNICADO, thus, the kerosene required by the APU is neglected.
@@ -355,7 +344,6 @@ The power provided by the APU is calculated with the user defined percentages an
* Installation factor for attached parts such as fire protection, noise protection, etc. [-]
* Percentages of power provided by APU for design case (bleed air, electric power, hydraulic power) [-]
-\anchor ATA70-engine
## ATA 70: Engine
This model is only used to account for power extraction efficiencies of the engine. The engine is sized in the engine design module. The powere required by the systems from the engine is checked against the maximum power the engine can provide before updating the xml files. If at power peaks more power is required than available the less power over a longer amount of time will be written to the xml.
@@ -371,7 +359,6 @@ The efficiency factors for the shaft power extraction (electric + hydraulic powe
* Percentage of hydraulic power provided by the engine [-]
* Efficiency factor for the bleed air extraction [-]
-\anchor ATAXX-remaining
## ATA XX: Remaining Consumers
The remaining consumers are the avionics and their power requirement is derived as a percentage of the power required by all other sink systems.
@@ -394,6 +381,5 @@ The CoG is calculated assuming the instruments are placed at the end of the cock
* Mass percentage of ATA XX for navigation [-]
* Mass percentage of ATA XX for communication [-]
-\anchor additional_sources
### Additional Sources
-[1] Source documents are available in German and can be requested from the RWTH Aachen.
\ No newline at end of file
+[^1] Source documents are available in German and can be requested from the RWTH Aachen.
\ No newline at end of file
diff --git a/docs/documentation/sizing/wing_design/basic-concepts.md b/docs/documentation/sizing/wing_design/basic-concepts.md
index f81d641cbd48f7e266f1a0523a7f9515a4ffaf25..da8e3de3b2da587eb1d6fa5c9a6d2f9452f8737a 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 0000000000000000000000000000000000000000..30ac984a6000044434faf24fe43d70edb125d7f5
--- /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 6ad57aec6ac54b4a430da907954b20504119f6b7..163464d70cc911b24793cff0a31c0ca4fa75fb22 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 69e61e1b0dfd905de51547da933ffcc28ffb495a..d94fe37a6ace719f8dad6ea3b63d6c48997ebe1e 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 4b207fc820e66273048d7943bbba3879c4a5e264..62043d2c1d1bfe5f6bb3b20254a791e5c1e797c7 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 15aa652629a3a7d3b30fc971fa3cff5e1663913f..3fa61f853ea832729440f36bfeedf8ddb8a657fc 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -24,6 +24,7 @@ markdown_extensions:
- attr_list # Allows adding HTML attributes to Markdown elements (like classes).
- admonition # Enables note/warning/admonition boxes with custom styling.
- md_in_html # Allows writing Markdown inside HTML tags for flexibility.
+ - footnotes # Allows footnotes
- pymdownx.tabbed: # Enables tabbed content blocks, allowing content to be organized in tabs.
alternate_style: true # Uses an alternate style for tabbed blocks.
- pymdownx.emoji: # Adds support for emojis using the Material theme’s emoji set.
@@ -217,12 +218,13 @@ nav: # Customizes the main navigation struc
- 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
+ # # - 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
@@ -231,8 +233,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
@@ -271,7 +274,7 @@ nav: # Customizes the main navigation struc
- 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
+ - System Models: documentation/sizing/systems_design/systems.md
- Software Architecture: documentation/sizing/systems_design/software_architecture.md
- API Reference:
- systems_design/classes.md
@@ -284,13 +287,13 @@ nav: # Customizes the main navigation struc
- 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
+ # # - 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
+ # # - API Reference: # TODO define for Python
- Ecological Assessment:
- Introduction: documentation/analysis/ecological_assessment/index.md
- Getting Started: documentation/analysis/ecological_assessment/getting-started.md