Settings file¶
To run any PyTornado analysis, a settings file is required. All settings are defined in a JSON file which must be located in the settings folder of your project directory (see Project directory). An example settings file is shown below.
{
"aircraft": "template_aircraft.json",
"state": "template.json",
"deformation": null,
"vlm_autopanels_c": 5,
"vlm_autopanels_s": 20,
"save_results": {
"global": false,
"panelwise": false,
"aeroperformance": false,
"matrix_system": false
},
"plot": {
"geometry": {
"opt": [],
"show": false,
"save": false
},
"lattice": {
"opt": [],
"show": false,
"save": false
},
"matrix_downwash": {
"opt": [],
"show": false,
"save": false
},
"results": {
"opt": [
"cp"
],
"show": false,
"save": true
}
}
}
The project file structure corresponding to this settings file will look as follows. Notice where the aircraft and the state file are located.
.
├── aircraft
│ └── template_aircraft.json
├── airfoils
├── deformation
├── log.txt
├── _plots
├── _results
├── settings
│ └── template.json
└── state
└── template.json
Explanation of expected inputs¶
aircraftThe aircraft key must be followed by the name of the aircraft file which is to be loaded. The corresponding aircraft file must be located in the aircraft folder of the project directory. The referenced aircraft file may be a JSON file (native format) or a CPACS file. PyTornado will automatically detect the aircraft file type.stateThe state key must be followed by the name of the state file which is to be loaded. The corresponding state file must be located in the state folder of the project directory.
Hint
PyTornado can perform analyses based on the aero-performance map provided in a CPACS file. To load and evaluate a CPACS aero-performance map, the state field must be followed by the special keyword __CPACS.
"state": "__CPACS",
Note that the aircraft must be provided in CPACS format. For more information of CPACS aero-performance map analyses see TODO
deformationTODOvlm_autopanels_cTODOvlm_autopanels_sTODOsave_resultsAnalysis results can be written to files for later review and processing. All result files will be saved in the folder _results. There are different result files that can be generated. You have to explicitly turn on save operations which is done by writingtrueaccording to the format shown above. The following “sub-keywords” (cf. example above) are available:globalSaves a file with global results (global loads and coefficients).panelwiseSaves a file with “panelwise” results (for instance local panel forces).aeroperformanceSaves a file summarising the results of the aero-performance map analysis.
Note
- If settings
globalandpanelwiseare true, a new file each is created for every iteration of the aero-performance map analysis. - With option
aeroperformanceonly a single file is created after the entire aero-performance map has been evaluated.
plotDifferent kind of plots can be generated during program execution. Plots can either be shown in an interactive window during runtime of PyTornado or saved as files. Notice that the program execution is paused when plots are being shown interactively. When files are being saved, they are written to the _plots folder. Theplotkeyword is followed by “sub-keywords” with the following form:
"sub-key-name": {
"opt": ["some_optional_setting", "another_optional_setting"],
"show": true,
"save": false
},
Here, opt defines some optional setting(s) as a list of strings. The keywords show and save are followed by true or false to show or save the corresponding plot. Available plots and optional settings:
geometryBasic geometry plot showing segments and control surfaces.- None
latticeLattice plot showing the VLM mesh.- None
resultsColour plot showing panelwise results.- Panelwise keys (see TODO), example [“cp”, “fmag”]
matrix_downwashPlot of the VLM downwash matrix.- None