diff --git a/docs/documentation/sizing/tank_design/getting_started.md b/docs/documentation/sizing/tank_design/getting_started.md index 2613e74e23adedb7ae743f753ee4c910bdd2f405..e7cf0a150825e2bf1a77c16bd4fbdd7fde0199b1 100644 --- a/docs/documentation/sizing/tank_design/getting_started.md +++ b/docs/documentation/sizing/tank_design/getting_started.md @@ -47,9 +47,9 @@ To single execute the _tank\_design_ module, we need an _acXML_ file that alread <sup>*</sup> The _tank\_design_ execution is also possible without mission analysis data. Alternatively, the following assumption is used to calculate the mission fuel amount: -$ +$$ m_{fuel} = n_{PAX} \cdot R \cdot \frac{E}{100 \text{ km}} -$ +$$ In which @@ -80,6 +80,7 @@ The desired tank configuration is defined by the user in the aircraft exchange f ### The ID `tank_element` Each tank is configured in the _acXML_ as one element (ID element) with the following parameters: + - `energy_carrier_ID`: ID of energy carrier to obtain which fuel is to be stored in the tanks. - `location`: Aircraft component where the tank is located (valid options depend on the energy carrier). - `position`: Position at the desired location (valid options depend on location and energy carrier). @@ -107,6 +108,7 @@ For aircraft configurations with a kinked wing, the "wing tank configuration" co | 7 | Fuselage | Center | Also referred to as 'additional center tank'. | For example, to define a valid combination for the wing center tank, set the following parameters for the ID element `ID="0"`: + - `energy_carrier_ID` to `0` (it is assumed that `0` equals kerosene) - `location` to `wing` - `position` to `center` @@ -126,6 +128,7 @@ The following table provides an overview on possible tank configurations. As can | Wing | Fuselage - Center | - | wing_with_additional_center_tank | | Wing | Horizontal stabilizer - Total | Fuselage - Center | wing_with_additional_center_and_trim_tank| | Wing | Fuselage - Center | Horizontal stabilizer - Total | wing_with_additional_center_and_trim_tank| + Note: "Wing" always refers to either the combinations 1 to 5 of the table in the previous section ("wing tank configuration"). #### Possible tank configurations: Aircraft with singe trapezoidal wing @@ -138,6 +141,7 @@ The following table provides an overview on possible tank configurations. As can | Wing | Fuselage - Center | - | wing_with_additional_center_tank | | Wing | Horizontal stabilizer - Total | Fuselage - Center | wing_with_additional_center_and_trim_tank| | Wing | Fuselage - Center | Horizontal stabilizer - Total | wing_with_additional_center_and_trim_tank| + Note: "Wing" always refers to the combinations 1, 2, and 4 of the table in the previous section ("wing tank configuration"). #### Example: Minimum tank configuration @@ -258,6 +262,7 @@ tbd. :construction: The _configXML_ is structured into two blocks: the control and program settings. The control settings are standardized in UNICADO and will not be described in detail here. But to get started, you have to change at least + - the `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings, - the `console_output` at least to `mode_1`, and - the `plot_output` to false (or define `inkscape_path` and `gnuplot_path`).