diff --git a/docs/documentation/sizing/propulsion_design/index.md b/docs/documentation/sizing/propulsion_design/index.md index 113b211a06b2bddcac88a35a41703496fa89e662..85a53e5beb74eeb46ebce3ec57e6e0d52c1508ac 100644 --- a/docs/documentation/sizing/propulsion_design/index.md +++ b/docs/documentation/sizing/propulsion_design/index.md @@ -5,7 +5,7 @@ The tool _propulsion_design_ is one of the core design tools in UNICADO. The ove 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.🌍 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. - + The [getting started](getting_started.md) gives you a first insight in how to execute the tool and how it generally works. To understand how the tools works in more detail, the documentation is split into a [engineering principles](engineering_principles.md) and a [software architecture](software_architecture.md) section. @@ -18,6 +18,12 @@ Prior to that, let's summarize what the tool can currently do and what is planne |kerosene-powered turboprop | |strategy integrated, but methods missing | |hydrogen-powered turboprop | |strategy integrated, but methods missing | -(*) order: engine designer/ nacelle designer/ pylon designer/ propulsion integrator/ mass analyzer +Order: + + 1. engine designer + 2. nacelle designer + 3. pylon designer + 4. propulsion integrator + 5.S mass analyzer So let's get started! diff --git a/docs/documentation/sizing/propulsion_design/software_architecture.md b/docs/documentation/sizing/propulsion_design/software_architecture.md index a5a302ee49c7987f19ca5a7845d0077e68a58433..7cad8890a1e856f36bc200fb889dbaac73e31955 100644 --- a/docs/documentation/sizing/propulsion_design/software_architecture.md +++ b/docs/documentation/sizing/propulsion_design/software_architecture.md @@ -2,7 +2,7 @@ ## Software Architecture Overview -The software architecture is structured into various modules and packages, each handling specific task. Below is a description of the main components (some classes, interfaces etc. are left out to keep it understandable for now - for more information see the [class diagram](img/class_diagram.png) or the source code): +The software architecture is structured into various modules and packages, each handling specific task. Below is a description of the main components (some classes, interfaces etc. are left out to keep it understandable for now - for more information see the [class diagram](figure/class_diagram.png) or the source code): - classes: - **propulsionDesign** is like the "coordinator" responsible for the overall propulsion system design including _initialize_, _run_, _update_, _report_ and _save_ (inherits from `Module` class from **moduleBasics**). These include e.g. method selection function for each disciplines @@ -21,7 +21,8 @@ The software architecture is structured into various modules and packages, each Some additional words on the **propulsionStrategy**: -As you might also see in the [class diagram](img/class_diagram.png), the core of it is the function `operator()` for specific engine types to allow the `engine` object to be used as functions. This object is, depending on the user settings, based on the propulsion type classes (e.g. `Turbofan<Kerosene>`). As also shown in @ref propulsion.md, the type is combined with 3 "building blocks" +As you might also see in the [class diagram](figure/class_diagram.png), the core of it is the function `operator()` for specific engine types to allow the `engine` object to be used as functions. This object is, depending on the user settings, based on the propulsion type classes (e.g. `Turbofan<Kerosene>`). As also shown in @ref propulsion.md, the type is combined with 3 "building blocks" + - *powertrain*: Way the power is generated from the source: turbo, electric, fuel_cell - *type*: Type of main thrust generator: fan or prop - *energy_carrier*: kerosene, liquid_hydrogen, battery (handled over IDs) @@ -31,4 +32,4 @@ So, if you want to use different combinations in UNICADO, you need to make sure ## Class Diagram {#classdiagram} Here is an overview how the module is structured: -{html: width=1000} +{html: width=1000}