@@ -3,6 +3,7 @@ Let's dive into the fun part and design some tanks!
## Tool single execution
The tool can be executed from the console directly if all paths are set. The following will happen:
-[Console output](#console-output)
-[Generation of reports and plots](#reporting)
-[Writing output to aircraft exchange file](#acxml)
...
...
@@ -46,11 +47,11 @@ The tool continues with the calculation of the wing tank entities - in this exam
2024-12-10 13:05:45,847 - PRINT - Energy check: Wing center tank necessary to store required energy amount.
2024-12-10 13:05:45,847 - PRINT - Energy check: Energy demand covered.
```
After the wing tank design there is an energy check to review whether the required mission energy can be stored in the tanks. If the energy demand would not be covered up until this point, an energy check would be occur after the calculation of every subsequent tank.
After the wing tank design there is an energy check to review whether the required mission energy can be stored in the tanks. If the energy demand would not be covered up until this point, an energy check would be carried out after the calculation of every subsequent tank.
```
2024-12-10 13:05:45,848 - PRINT - Additional center tank design started...
2024-12-10 13:05:45,848 - PRINT - Additional center tank (tank_5) calculated. Volume (energy) available: 3,068.50 L (99,189.26 MJ)
2024-12-10 13:05:45,848 - PRINT - Additional center tank (tank_5) calculated. Volume (energy) available: 3,068.50 L (103,818.10 MJ)
2024-12-10 13:05:45,849 - PRINT - Additional center tank design completed.
2024-12-10 13:05:45,849 - PRINT - Additional center tank is generated but unnecessary to store required energy amount.
```
...
...
@@ -78,15 +79,14 @@ Finally, you receive information about the reports and plots created (depending
### Reporting {#reporting}
In the following, a short overview is given on the generated reports:
- A `tank_design.log` file is written within the directory of the executable
- Depending on your settings, the following output is generated and saved in the `reporting` folder, located in the directory of the aircraft exchange file:
- an HTML report in the `report_html` folder (not implemented yet)
- an HTML report in the `report_html` folder
- a TeX report in the `report_tex` folder (not implemented yet)
- an XML file with additional output data in the `report_xml` folder (not written since no more data output necessary)
- an XML file with additional output data in the `report_xml` folder (currently, only a rough output file is generated with the routing information but without any additional data)
- plots in the `plots` folder (not implemented yet)
@warning Steffi: Check if additional output written
### Write data to the aircraft exchange file {#acxml}
!!! note
The _acXML_ is an exchange file - we agreed on that only data will be saved as output that is needed by another tool!
...
...
@@ -96,33 +96,22 @@ Results are saved in the aircraft exchange file at the `/aircraft_exchange_file/
Aircraft exchange file
|- Component design
| |- Tank
| | |- Position
| | | |- x
| | | |- y
| | | |- z
| | |- Mass properties
| | | |- ...
| | |- Position*
| | |- Mass properties**
| | |- Specific
| | | |- Additional fuselage length
| | | |- Tank (ID="0")
| | | | |- Name
| | | | |- Designator
| | | | |- Position
| | | | | |- x
| | | | | |- y
| | | | | |- z
| | | | |- Direction
| | | | |- Mass properties
| | | | | |- ...
| | | | |- Position*
| | | | |- Direction*
| | | | |- Mass properties**
| | | | |- Maximum energy capacity
| | | | |- Energy required for mission energy
| | | | |- Energy capacity required for mission
| | | | |- Geometry
| | | | | |- Cross section (ID="0")
| | | | | | |- Name
| | | | | | |- Position
| | | | | | | |- x
| | | | | | | |- y
| | | | | | | |- z
| | | | | | |- Position*
| | | | | | |- Shape
| | | | | | |- Height
| | | | | | |- Width
...
...
@@ -133,5 +122,9 @@ Aircraft exchange file
| | | | |- ...
```
<sup>*</sup> Node has been shortened. It contains the following sub-nodes: x, y, z
<sup>**</sup> Node has been shortened. It contains information on the mass, inertia, and center of gravity.
## Troubleshooting {#troubleshooting}
- The tool does not run properly? *Make sure you have all the paths set up correctly and the specified elements exist.*
