diff --git a/docs/documentation/sizing/propulsion_design/engineering_principles.md b/docs/documentation/sizing/propulsion_design/engineering_principles.md index 0a8220b1c8dfc9371302c3dfc4c24898c4497a26..30972d41a62535177b1b231c938a1f55a0ed0b48 100644 --- a/docs/documentation/sizing/propulsion_design/engineering_principles.md +++ b/docs/documentation/sizing/propulsion_design/engineering_principles.md @@ -10,6 +10,7 @@ Designing the propulsion with this tool includes different engineering disciplin - [Mass analyzer](#massanalyzer): calculates the mass properties (center of gravity, mass, and inertia) of engine, nacelle, and pylon. For these five disciplines, you can choose different **methods** (or fidelities) of calculating their output. Here is an overview of the current implemented methods (details see sections): + | Discipline | Methods | |---------------------|-------------------------------------------------------------------| |Engine designer | *Rubber* (*Empirical* and *PropulsionSystem* are in preparation) | @@ -18,9 +19,9 @@ For these five disciplines, you can choose different **methods** (or fidelities) |Pylon designer | *Default* | |Mass analyzer | *Default* | -If you want to learn more about how to configure methods or generally the settings and outputs, go to the [getting started](getting_started.md). +If you want to learn more about how to configure methods or generally the settings and outputs, go to the [getting started](getting-started.md). -@important These disciplines are executed sequentially for EACH engine. That means that the engines are not aware of each other within the designing and analyzing. More information, see the [software architecture](software_architecture.md) section. +***important*** These disciplines are executed sequentially for EACH engine. That means that the engines are not aware of each other within the designing and analyzing. More information, see the [software architecture](software_architecture.md) section. ## Engine designer {#enginedesigner} @@ -37,13 +38,13 @@ The _dataset_ (also called _EngineXML_) includes parameter which are independent The three-dimensional _engine deck_ contain engine performance data for different values of altitude $h$, Mach number $Ma$ and low-pressure engine spool speed $N1$. The most important performance parameter are thrust and fuel/energy flow. In UNICADO, the deck is split into multiple CSV files. The figure shows an example with values for thrust in kilo newton. The first block contains data for $N1=1$ for $Ma=0...0.9$ and $h=0...14000$. The second block below is for $N1=0.95$.  -!!! note - Detailed information on required dataset and deck data will be updated in near future. + +> Detailed information on required dataset and deck data will be updated in near future. The _scale factor_ is necessary because (as conceptual aircraft designer), we use the concept of a so-called _rubber engine_. That means that (depending on the method, see later) we create or assume an engine deck and provide one _scale factor_ to obtain all engine data acc. to the required thrust the engine shall provide. The figure visualized the concept:  -@attention → **As mentioned and highlighted in the figure**, there is ONE _scale factor_ **BUT** multiple exponents which differ depending on which property you want to use. E.g. for the diameter, the exponent is $0.5$ and for the mass its $0.4$. **So important to remember** that whenever you want to use engine data, you need to access it via the `engine` library. In the following, a brief explanation of the scaling concept will be given - however details are given in the library documentation. +***attention*** → **As mentioned and highlighted in the figure**, there is ONE _scale factor_ **BUT** multiple exponents which differ depending on which property you want to use. E.g. for the diameter, the exponent is $0.5$ and for the mass its $0.4$. **So important to remember** that whenever you want to use engine data, you need to access it via the `engine` library. In the following, a brief explanation of the scaling concept will be given - however details are given in the library documentation. So, the scaling is based on continuity principle assuming that the operating condition is constant (commonly known station numbering; assuming no pressure drop). @@ -61,8 +62,8 @@ An exemplary simplified calculation (data from the V2527-A5): the current engine So, again, always access the engine data via the `engine` library to ensure that you have the correctly scaled data 🙂 -!!! note - Actually, the sea level static thrust is not at $N1=1$ if you compare the dataset for this engine (for 110.31kN around $N1=0.95$). So the scaling factor will be slightly lower. + +> Actually, the sea level static thrust is not at $N1=1$ if you compare the dataset for this engine (for 110.31kN around $N1=0.95$). So the scaling factor will be slightly lower. ### Methods description The **engine designer** includes different methods which create/use this deck in various ways. @@ -71,8 +72,8 @@ The **engine designer** includes different methods which create/use this deck in - *rubber*: (most common approach) based on an existing deck (usually created with GasTurb), the deck is "rubberized" - *propulsionsystem*: with the help of the library `propulsionsystem`, different architecture can be defined and a deck created (for more information see documentation of the library) -!!! note - *empirical* and *propulsionsystem* is in preparation - not implemented yet! + +> *empirical* and *propulsionsystem* is in preparation - not implemented yet! For all these methods, the approach of using the _scale factor_ is the same (see explaination [here](#generalprinciples)). A deck is either first created or assumed and then data is drawn with the `engine` library with the scaling approach. @@ -89,6 +90,7 @@ Here, currently only one method is implemented: - *default* is based on a thesis of RWTH Aachen \cite{Ata10} This method includes multiple empirical functions for different propulsion integration. These are the options that are currently implemented: + | Parent | Lateral | Longitudinal | Vertical | |-----------|---------|--------------|----------| | Wing | Right | Front | Under | @@ -118,8 +120,8 @@ In the current implemented method, there is no differentiation between short and Keep in mind that the library defines a surface without a thickness. For more information, it is referred to the library. -!!!note - The implementation include currently Turbofan Kerosene only + +> The implementation include currently Turbofan Kerosene only ## Pylon designer {#pylondesigner} The pylon is the structural component to connect the engine to the aircraft. @@ -135,8 +137,8 @@ In the current method, the mounting is attached to the beginning to the nacelle  -!!!note - the implementation include currently Turbofan Kerosene only + +> the implementation include currently Turbofan Kerosene only ## Mass analyzer {#massanalyzer} Lastly, the mass properties for engine, nacelle and pylon are calculated separate for center of gravity, mass and inertia. @@ -155,6 +157,6 @@ Here, only one method is implemented: - mass: empirical estimation - inertia: wrt. CG with `aircraftGeometry2`lib -!!!note - the implementation include currently Turbofan Kerosene only + +> the implementation include currently Turbofan Kerosene only diff --git a/docs/documentation/sizing/propulsion_design/index.md b/docs/documentation/sizing/propulsion_design/index.md index 9caaff81ee51c1e3563458a952533ae99313abc9..1ced99f697e223270bbfbd518348482263400224 100644 --- a/docs/documentation/sizing/propulsion_design/index.md +++ b/docs/documentation/sizing/propulsion_design/index.md @@ -8,7 +8,7 @@ This tool is exciting!🔥 because the propulsion is THE critical component prov 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 detail, the documentation is split into a [engineering principles](engineering_principles.md) and a [software architecture](software_architecture.md) section. +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 detail, the documentation is split into a [engineering principles](engineering_principles.md) and a [software architecture](software_architecture.md) section. 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): diff --git a/docs/index.md b/docs/index.md index 7467305bb9ee9350d823e62b1b234774d03de76a..f527d9ba4839cefbf295454cc7a37bf3fd0ca349 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,7 +31,7 @@ hide: Learn how to set it up & install the prerequisites. -[:octicons-arrow-right-24: Download](download/getting_started.md) +[:octicons-arrow-right-24: Download](download/getting-started.md) </div> <div class="grid-item card" markdown="1">