From 9116580e8a571da734ac5f37c5a11c1907eb52d3 Mon Sep 17 00:00:00 2001
From: tobi <tobias.weckenmann@tum.de>
Date: Mon, 10 Feb 2025 10:39:35 +0100
Subject: [PATCH 1/5] Furhter updates the propulsion documentation
---
.../figures/deck_example.PNG | 3 ++
.../figures/engine_sizing.png | 3 ++
.../figures/propulsion_design_flow.png | 3 ++
.../propulsion_design/figures/xml_output.PNG | 3 ++
.../sizing/propulsion_design/index.md | 7 ++--
.../sizing/propulsion_design/overview.md | 33 +++++++++++++++++++
6 files changed, 49 insertions(+), 3 deletions(-)
create mode 100644 docs/documentation/sizing/propulsion_design/figures/deck_example.PNG
create mode 100644 docs/documentation/sizing/propulsion_design/figures/engine_sizing.png
create mode 100644 docs/documentation/sizing/propulsion_design/figures/propulsion_design_flow.png
create mode 100644 docs/documentation/sizing/propulsion_design/figures/xml_output.PNG
create mode 100644 docs/documentation/sizing/propulsion_design/overview.md
diff --git a/docs/documentation/sizing/propulsion_design/figures/deck_example.PNG b/docs/documentation/sizing/propulsion_design/figures/deck_example.PNG
new file mode 100644
index 0000000..1d74dd7
--- /dev/null
+++ b/docs/documentation/sizing/propulsion_design/figures/deck_example.PNG
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4ff540fd124e3b1f05103206aee52cc46fe50bdce9d2d237d184e36332c89d37
+size 101219
diff --git a/docs/documentation/sizing/propulsion_design/figures/engine_sizing.png b/docs/documentation/sizing/propulsion_design/figures/engine_sizing.png
new file mode 100644
index 0000000..14717b1
--- /dev/null
+++ b/docs/documentation/sizing/propulsion_design/figures/engine_sizing.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d13c05a05f589a9d7d339e91ee9186da2edd6f667e92e39fd8413b124d7b9f46
+size 131823
diff --git a/docs/documentation/sizing/propulsion_design/figures/propulsion_design_flow.png b/docs/documentation/sizing/propulsion_design/figures/propulsion_design_flow.png
new file mode 100644
index 0000000..ddbf100
--- /dev/null
+++ b/docs/documentation/sizing/propulsion_design/figures/propulsion_design_flow.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:40488e9ef73109ffa6d52b0635104a4366655b4b9fb2bbbf1d50a0dfdbafa4b2
+size 157371
diff --git a/docs/documentation/sizing/propulsion_design/figures/xml_output.PNG b/docs/documentation/sizing/propulsion_design/figures/xml_output.PNG
new file mode 100644
index 0000000..c0a4774
--- /dev/null
+++ b/docs/documentation/sizing/propulsion_design/figures/xml_output.PNG
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ac1643468287a3ba1a8701c4d6de1c0c0a08f7abefaf1602abacf5fe4e69c9ac
+size 82271
diff --git a/docs/documentation/sizing/propulsion_design/index.md b/docs/documentation/sizing/propulsion_design/index.md
index a568bb8..e65323e 100644
--- a/docs/documentation/sizing/propulsion_design/index.md
+++ b/docs/documentation/sizing/propulsion_design/index.md
@@ -1,8 +1,9 @@
# Introduction {#mainpage}
-The tool _propulsion_design_ is one of the core design tools in UNICADO. The overall goal is the design the propulsion system based on...
+The tool _propulsion_design_ is one of the core design tools in UNICADO. The overall goal is the design the propulsion system based on...
+
- the architecture (e.g. 2 turbofan at rear fuselage, 4 fuel cell prop engine over the front wing) set by the user and,
- the total required thrust and system off-takes calculated within the aircraft design loop.
-This tool is exciting!🔥 because the propulsion is one of the critical components in the aircraft design loop. It provides the thrust or power, enabling powered flight of the aircraft letting it move through the skies.🌍
+The propulsion is one of the critical components in the aircraft design loop. It provides the thrust or power, enabling powered flight of the aircraft letting it move through the skies.
There are different propulsion architectures for the aircraft conceptual design process. To give you a general taste, here are a few illustrations of possible concepts.
@@ -11,7 +12,7 @@ The [getting started](getting_started.md) gives you a first insight in how to ex
Prior to that, let's summarize what the tool can currently do and what is planned (terms like _method_ or _strategy_ will be explained in the sections):
-| Engine type | Methods* | Status |
+| Engine type | Methods (engine design/ nacelle design/ pylon design/ integrator/ mass analysis ) | Status |
|------------------------------|------------------------------------------------------|------------|
|kerosene-powered turbofan |Rubber(V2527-A5)/ Default/ Default/ Default/ Default |running |
|hydrogen-powered turbofan |Rubber(V2527-H2)/ Default/ Default/ Default/ Default |to be tested|
diff --git a/docs/documentation/sizing/propulsion_design/overview.md b/docs/documentation/sizing/propulsion_design/overview.md
new file mode 100644
index 0000000..80cdf37
--- /dev/null
+++ b/docs/documentation/sizing/propulsion_design/overview.md
@@ -0,0 +1,33 @@
+# Overview {#mainpage}
+The propulsion_design tool provides the engine data and the engine integration on the aircraft. The steps are shown in the following figure:
+
+
+
+Required inputs for propulsion design are therefore:
+
+ - The thrust to weight ratio (First from initial_sizing sizing then from constraint_analysis).
+ - The MTOW of the aircraft.
+ - The type of propulsors and the according thrust share.
+
+With this the engines are designed one by one with the following approach:
+
+{html: width=600}
+
+The outputs are the engine xml file as well as the different deck values as csv files in projects as well as the following xml snippet for each engine:
+
+{html: width=1200}
+
+Readout of the engine data can and should only be done using the engine library!
+
+The csv files contain engine data that depends on the operating point. The operating point is defined as
+
+ - Flight Mach number
+ - Flight altitude
+ - Low pressure spool speed / power setting
+
+An example is shown in the following figure.
+
+
+
+The data is readout by the engine library which has an efficient parser for the deck values using a linear interpolation between two existing deck values. Penalties, like shaft power offtake or bleed air offtake, are also calculated using the engine library. The description of the engine library can be found here as well.
+The description of the engine library can be found [here](../../../libraries/engine/).
\ No newline at end of file
--
GitLab
From 41fd7a844abca5a16568ad3d149aab5e1aaf119d Mon Sep 17 00:00:00 2001
From: tobi <tobias.weckenmann@tum.de>
Date: Mon, 10 Feb 2025 10:39:56 +0100
Subject: [PATCH 2/5] Mk as well
---
mkdocs.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/mkdocs.yml b/mkdocs.yml
index 738b4c0..0fbc8b4 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -271,6 +271,7 @@ nav: # Customizes the main navigation struc
# - API Reference: # TODO define for Python
- Propulsion Design:
- Introduction: documentation/sizing/propulsion_design/index.md
+ - Overview: documentation/sizing/propulsion_design/overview.md
- Getting Started: documentation/sizing/propulsion_design/getting-started.md
- Engineering Principles: documentation/sizing/propulsion_design/engineering_principles.md
- Software Architecture: documentation/sizing/propulsion_design/software_architecture.md
--
GitLab
From 9fca640bb23a9cb207bc636c9b4831e4e8752072 Mon Sep 17 00:00:00 2001
From: tobi <tobias.weckenmann@tum.de>
Date: Mon, 10 Feb 2025 10:44:55 +0100
Subject: [PATCH 3/5] updates
---
docs/documentation/sizing/propulsion_design/overview.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/documentation/sizing/propulsion_design/overview.md b/docs/documentation/sizing/propulsion_design/overview.md
index 80cdf37..0020a55 100644
--- a/docs/documentation/sizing/propulsion_design/overview.md
+++ b/docs/documentation/sizing/propulsion_design/overview.md
@@ -29,5 +29,5 @@ An example is shown in the following figure.
-The data is readout by the engine library which has an efficient parser for the deck values using a linear interpolation between two existing deck values. Penalties, like shaft power offtake or bleed air offtake, are also calculated using the engine library. The description of the engine library can be found here as well.
+The data is readout by the engine library which has an efficient parser for the deck values using a linear interpolation between two existing deck values. Penalties, like shaft power offtake or bleed air offtake, are also calculated using the engine library. The scale factor is applied according to the exact scaling mechanism for the value needed.
The description of the engine library can be found [here](../../../libraries/engine/).
\ No newline at end of file
--
GitLab
From 9c601815ebc295c302fbcfc4c269ae6f67fc8e5b Mon Sep 17 00:00:00 2001
From: tobi <tobias.weckenmann@tum.de>
Date: Mon, 10 Feb 2025 11:09:51 +0100
Subject: [PATCH 4/5] ad
---
docs/documentation/sizing/propulsion_design/overview.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/documentation/sizing/propulsion_design/overview.md b/docs/documentation/sizing/propulsion_design/overview.md
index 0020a55..c42c484 100644
--- a/docs/documentation/sizing/propulsion_design/overview.md
+++ b/docs/documentation/sizing/propulsion_design/overview.md
@@ -13,7 +13,7 @@ With this the engines are designed one by one with the following approach:
{html: width=600}
-The outputs are the engine xml file as well as the different deck values as csv files in projects as well as the following xml snippet for each engine:
+The outputs are the engine xml file and the different deck values as csv files. They are saved in thr projects directory. Further output is saved in the aircraft xml because other tools of the UNICADO tool chain need it. An example of this output is shown below.
{html: width=1200}
@@ -29,5 +29,5 @@ An example is shown in the following figure.
-The data is readout by the engine library which has an efficient parser for the deck values using a linear interpolation between two existing deck values. Penalties, like shaft power offtake or bleed air offtake, are also calculated using the engine library. The scale factor is applied according to the exact scaling mechanism for the value needed.
-The description of the engine library can be found [here](../../../libraries/engine/).
\ No newline at end of file
+The data is readout by the engine library which has an efficient parser for the deck values using a linear interpolation between two existing deck values. Penalties, like shaft power offtake or bleed air offtake, are applied using the engine library. The scale factor is applied according to the exact scaling mechanism for the value needed.
+The description of the engine library can be found [here](../../../libraries/engine/).
--
GitLab
From 485f0a9b1cc5895afc960f5e3cffb154e147f2e0 Mon Sep 17 00:00:00 2001
From: tobi <tobias.weckenmann@tum.de>
Date: Mon, 10 Feb 2025 11:20:26 +0100
Subject: [PATCH 5/5] ccs
---
docs/assets/css/unicado.css | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/docs/assets/css/unicado.css b/docs/assets/css/unicado.css
index 8837256..8c612d4 100644
--- a/docs/assets/css/unicado.css
+++ b/docs/assets/css/unicado.css
@@ -37,6 +37,21 @@
font-size: 1.1em;
}
+/* Make all LaTeX-style math equations white */
+:root {
+ --math-color: #ffffff; /* Set the default color for equations */
+}
+
+/* MathJax equations */
+.MathJax, mjx-container, math {
+ color: var(--math-color) !important;
+}
+
+/* KaTeX equations */
+.katex, .katex-display {
+ color: var(--math-color) !important;
+}
+
/* Download button styling */
.download-button-container {
text-align: center;
--
GitLab