#### Structure
-- AeroFrame :heavy_check_mark:
+- AeroFrame :x:
+
+#### Data Analysis and Storage
+
+- [Database](./ceasiompy/Database/README.md) :heavy_check_mark:
## Contributing
diff --git a/ceasiompy/.flake8 b/ceasiompy/.flake8
new file mode 100644
index 000000000..7abeeeb56
--- /dev/null
+++ b/ceasiompy/.flake8
@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+ignore = W503, F401, W605, E203
+
+exclude = test/*, doc/*, build/*, dist/* setup.py, ceasiompy/Stability*
+# Should be removed: ceasiompy/Stability* (too many things to refactor in those modules)
\ No newline at end of file
diff --git a/ceasiompy/.gitignore b/ceasiompy/.gitignore
new file mode 100644
index 000000000..979afbb6a
--- /dev/null
+++ b/ceasiompy/.gitignore
@@ -0,0 +1,183 @@
+# Mac files
+*.DS_Store
+
+# Vim temporary files
+*.swp
+
+# Sphinx
+build/
+doc/source/dev_doc/ceasiompy.*
+doc/source/user_guide/module_interfaces/*
+
+# Dolphin file manager
+.directory
+
+
+# See https://www.gitignore.io/
+# =============================
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyc
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+
+## Specific to CEASIOMpy
+
+# Install directory
+install_dir/
+
+# Ignore logfiles, temp file and errors
+*.log
+*.log.*
+/temp
+/tmp
+CrashInfo/
+failure.xml
+
+# CEASIOMpy settings and history
+.ceasiompy
+
+# Ignore all SU2 meshes (.su2)
+*.su2
+forces_breakdown.dat
+
+# Ignore temp folder and and temp files
+/INSTALLDIR
+/Results
+/WKDIR/*
+!/WKDIR/.keep
+
+# Ignore ToolInput and ToolOutput
+ToolInput.xml
+ToolInput*.xml
+/ToolOutput
+ToolOutput.xml
+
+aircraft_loads.csv
+*.out
+*MTOM_Prediction.png
+*Payload_vs_Range.png
+*_Cog.png
+**/ToolOutput/*.svg
+
+# Exceptions
+!/ceasiompy/ModuleTemplate/ToolInput/ToolInput.xml
+!/ceasiompy/utils/tests/tests_workflowfunctions/ToolInput/ToolInput.xml
+!/test_files/AeroMaps/*.csv
diff --git a/ceasiompy/AeroFrame/.gitignore b/ceasiompy/AeroFrame/.gitignore
deleted file mode 100644
index 3225cbe4e..000000000
--- a/ceasiompy/AeroFrame/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-log.txt
-ToolInput.cfg
diff --git a/ceasiompy/AeroFrame/ToolInput/.keep b/ceasiompy/AeroFrame/ToolInput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/AeroFrame/ToolInput/.keep
+++ b/ceasiompy/AeroFrame/ToolInput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/AeroFrame/ToolOutput/.keep b/ceasiompy/AeroFrame/ToolOutput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/AeroFrame/ToolOutput/.keep
+++ b/ceasiompy/AeroFrame/ToolOutput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/AeroFrame/__init__.py b/ceasiompy/AeroFrame/__init__.py
index e69de29bb..46d85e618 100644
--- a/ceasiompy/AeroFrame/__init__.py
+++ b/ceasiompy/AeroFrame/__init__.py
@@ -0,0 +1,46 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for AeroFrame module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+# True if the module is active.
+# False if the module is disabled (not working or not ready).
+module_status = False
+
+# ===== Include GUI =====
+# True if you want to add a GUI for this module.
+# False if module is desactivated or no GUI to be displayed.
+include_gui = False
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/AeroFrame/__specs__.py b/ceasiompy/AeroFrame/__specs__.py
index ea9e62ff6..69170937c 100644
--- a/ceasiompy/AeroFrame/__specs__.py
+++ b/ceasiompy/AeroFrame/__specs__.py
@@ -1,5 +1,6 @@
from ceasiompy.utils.moduleinterfaces import CPACSInOut
+from ceasiompy import log
# ===== Module Status =====
# True if the module is active
@@ -8,3 +9,11 @@
# ===== CPACS inputs and outputs =====
cpacs_inout = CPACSInOut()
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/AeroFrame/runaeroframe.py b/ceasiompy/AeroFrame/aeroframe.py
similarity index 79%
rename from ceasiompy/AeroFrame/runaeroframe.py
rename to ceasiompy/AeroFrame/aeroframe.py
index 39d651795..b70764de1 100644
--- a/ceasiompy/AeroFrame/runaeroframe.py
+++ b/ceasiompy/AeroFrame/aeroframe.py
@@ -16,14 +16,13 @@
* https://github.com/airinnova/aeroframe/issues
-Python version: >=3.8
| Author: Aaron Dettmann
| Creation: 2019-09-25
TODO:
- * Refactoring
+ * make working directories
"""
@@ -36,9 +35,11 @@
from pathlib import Path
import aeroframe.stdfun.run as af
-from ceasiompy.utils.ceasiomlogger import get_logger
+from ceasiompy import log
-log = get_logger()
+# =================================================================================================
+# CONSTANTS
+# =================================================================================================
MODULE_DIR = Path(__file__).parent
MODULE_NAME = MODULE_DIR.name
@@ -55,8 +56,10 @@
# =================================================================================================
if __name__ == "__main__":
- log.info("----- Start of " + MODULE_NAME + " -----")
+
+ module_name = MODULE_NAME
+ log.info("----- Start of " + module_name + " -----")
af.standard_run(args=af.StdRunArgs(dest=DIR_AEROFRAME_WKDIR, verbose=True))
- log.info("----- End of " + MODULE_NAME + " -----")
+ log.info("----- End of " + module_name + " -----")
diff --git a/ceasiompy/AeroFrame/wrappers/cfd/su2.py b/ceasiompy/AeroFrame/wrappers/cfd/su2.py
index 1c876e1f1..487db0942 100644
--- a/ceasiompy/AeroFrame/wrappers/cfd/su2.py
+++ b/ceasiompy/AeroFrame/wrappers/cfd/su2.py
@@ -97,7 +97,7 @@ def _write_su2_disp_file(self):
def run_analysis(self, turn_off_deform=False):
"""
- Run the PyTornado analysis
+ Run the PyAVL analysis
Args:
:turn_off_deform: Flag which can be used to turn off all deformations
diff --git a/ceasiompy/AeroFrame_new/ToolInput/.keep b/ceasiompy/AeroFrame_new/ToolInput/.keep
deleted file mode 100644
index 8d1c8b69c..000000000
--- a/ceasiompy/AeroFrame_new/ToolInput/.keep
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/ceasiompy/AeroFrame_new/ToolOutput/.keep b/ceasiompy/AeroFrame_new/ToolOutput/.keep
deleted file mode 100644
index 8d1c8b69c..000000000
--- a/ceasiompy/AeroFrame_new/ToolOutput/.keep
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/ceasiompy/AeroFrame_new/__init__.py b/ceasiompy/AeroFrame_new/__init__.py
index e69de29bb..92b46e607 100644
--- a/ceasiompy/AeroFrame_new/__init__.py
+++ b/ceasiompy/AeroFrame_new/__init__.py
@@ -0,0 +1,45 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for AeroFrame new module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = False
+
+# ===== Include GUI =====
+include_gui = False
+
+# ===== Add a Results Directory =====
+RES_DIR = True
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/AeroFrame_new/__specs__.py b/ceasiompy/AeroFrame_new/__specs__.py
index 87eb9496a..13088d639 100644
--- a/ceasiompy/AeroFrame_new/__specs__.py
+++ b/ceasiompy/AeroFrame_new/__specs__.py
@@ -1,9 +1,13 @@
from ceasiompy.utils.moduleinterfaces import CPACSInOut
-from ceasiompy.utils.commonxpath import (
- CEASIOMPY_XPATH,
+
+from ceasiompy import log
+from ceasiompy.PyAVL import (
AVL_PLOT_XPATH,
AVL_VORTEX_DISTR_XPATH,
AVL_AEROMAP_UID_XPATH,
+)
+from ceasiompy.utils.commonxpath import (
+ CEASIOMPY_XPATH,
AEROPERFORMANCE_XPATH,
FRAMAT_MATERIAL_XPATH,
FRAMAT_SECTION_XPATH,
@@ -12,6 +16,7 @@
)
from pathlib import Path
+import streamlit as st
# ===== Module Status =====
# True if the module is active
# False if the module is disabled (not working or not ready)
@@ -28,7 +33,7 @@
cpacs_inout.add_input(
var_name="aeromap_uid",
var_type=list,
- default_value=None,
+ default_value=st.session_state.cpacs.get_aeromap_uid_list(),
unit=None,
descr="Name of the aero map to calculate",
xpath=AVL_AEROMAP_UID_XPATH,
@@ -213,3 +218,10 @@
descr="aeroMap with aero coefficients calculated by AVL",
xpath=AEROPERFORMANCE_XPATH + "/aeroMap/aeroPerformanceMap",
)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/AeroFrame_new/aeroframe_run.py b/ceasiompy/AeroFrame_new/aeroframe_new.py
similarity index 90%
rename from ceasiompy/AeroFrame_new/aeroframe_run.py
rename to ceasiompy/AeroFrame_new/aeroframe_new.py
index 56c34093d..791630e1a 100644
--- a/ceasiompy/AeroFrame_new/aeroframe_run.py
+++ b/ceasiompy/AeroFrame_new/aeroframe_new.py
@@ -6,7 +6,6 @@
Script to run aeroelastic computations using AVL to compute
aerodynamic loads and FramAT for structural calculations.
-Python version: >=3.8
| Author: Romain Gauthier
| Creation: 2024-06-17
@@ -20,17 +19,17 @@
# ==============================================================================
# IMPORTS
# ==============================================================================
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.moduleinterfaces import get_toolinput_file_path, get_tooloutput_file_path
-from ceasiompy.utils.ceasiompyutils import get_results_directory
-from ceasiompy.PyAVL.avlrun import run_avl
-from ceasiompy.PyAVL.func.avlconfig import get_aeromap_conditions
+from ceasiompy import log
+
+from ceasiompy.utils.ceasiompyutils import call_main
+
+from ceasiompy.PyAVL.pyavl import main as run_avl
+from ceasiompy.utils.ceasiompyutils import get_aeromap_conditions
from cpacspy.cpacsfunctions import (
get_value_or_default,
create_branch,
- open_tixi
)
-from ceasiompy.PyAVL.func.avlresults import convert_ps_to_pdf
+from ceasiompy.PyAVL.func.plot import convert_ps_to_pdf
from ceasiompy.AeroFrame_new.func.aeroframe_config import (
read_AVL_fe_file,
create_framat_model,
@@ -42,19 +41,22 @@
write_deformed_command
)
-from ceasiompy.AeroFrame_new.func.aeroframe_results import (
+from ceasiompy.AeroFrame_new.func.results import (
compute_deformations,
plot_translations_rotations,
plot_convergence
)
-from ceasiompy.AeroFrame_new.func.aeroframe_debbug import (
+from ceasiompy.AeroFrame_new.func.plot import (
plot_fem_mesh,
plot_deformed_wing
)
-from ceasiompy.utils.commonxpath import (
+from ceasiompy.PyAVL import (
AVL_PLOT_XPATH,
+ AVL_AEROMAP_UID_XPATH,
+)
+from ceasiompy.utils.commonxpath import (
FRAMAT_RESULTS_XPATH,
FRAMAT_MESH_XPATH,
AEROFRAME_SETTINGS
@@ -69,9 +71,6 @@
import pandas as pd
import shutil
-
-log = get_logger()
-
MODULE_DIR = Path(__file__).parent
MODULE_NAME = MODULE_DIR.name
@@ -203,9 +202,9 @@ def aeroelastic_loop(cpacs_path, CASE_PATH, q, xyz, fxyz):
log.info("")
log.info(f"----- FramAT: Deformation {n_iter} -----")
- Path(CASE_PATH, f"Iteration_{n_iter+1}", "AVL").mkdir(parents=True, exist_ok=True)
+ Path(CASE_PATH, f"Iteration_{n_iter + 1}", "AVL").mkdir(parents=True, exist_ok=True)
Path(CASE_PATH, f"Iteration_{n_iter}", "FramAT").mkdir(parents=True, exist_ok=True)
- AVL_ITER_PATH = Path(CASE_PATH, f"Iteration_{n_iter+1}", "AVL")
+ AVL_ITER_PATH = Path(CASE_PATH, f"Iteration_{n_iter + 1}", "AVL")
FRAMAT_ITER_PATH = Path(CASE_PATH, f"Iteration_{n_iter}", "FramAT")
AVL_DEFORMED_PATH = Path(AVL_ITER_PATH, "deformed.avl")
AVL_DEFORMED_COMMAND = Path(AVL_ITER_PATH, "avl_commands.txt")
@@ -282,7 +281,7 @@ def aeroelastic_loop(cpacs_path, CASE_PATH, q, xyz, fxyz):
write_deformed_geometry(AVL_UNDEFORMED_PATH, AVL_DEFORMED_PATH, centerline_df, deformed_df)
write_deformed_command(AVL_UNDEFORMED_COMMAND, AVL_DEFORMED_COMMAND)
log.info("")
- log.info(f"----- AVL: Calculation {n_iter+1} -----")
+ log.info(f"----- AVL: Calculation {n_iter + 1} -----")
log.info("Running AVL ...")
subprocess.run(["xvfb-run", "avl"],
stdin=open(str(AVL_DEFORMED_COMMAND), "r"),
@@ -343,8 +342,10 @@ def compute_structural_work(row):
percentage = deflection / semi_span
log.info(f"Final tip deflection residual : {res[-1]:.3e}")
- log.info("Wing tip deflection : "
- f"{deflection:.3e} m ({percentage:.2%} of the semi-span length).")
+ log.info(
+ "Wing tip deflection : "
+ f"{deflection:.3e} m ({percentage:.2%} of the semi-span length)."
+ )
log.info(f"Wing tip twist : {tip_twist:.3e} degrees.")
log.info(f"Total aerodynamic work : {total_aero_work:.3e} J.")
log.info(f"Total structural work : {total_structural_work:.3e} J.")
@@ -356,7 +357,7 @@ def compute_structural_work(row):
return delta_tip, res
-def aeroframe_run(cpacs_path, cpacs_out_path, wkdir):
+def main(cpacs: CPACS, wkdir: Path) -> None:
"""Function to run aeroelastic calculations.
Function 'aeroframe_run' runs aeroelastic calculations
@@ -368,8 +369,12 @@ def aeroframe_run(cpacs_path, cpacs_out_path, wkdir):
cpacs_out_path (Path): path to the CPACS output file.
wkdir (Path): path to the working directory.
"""
- tixi = open_tixi(cpacs_path)
- alt_list, mach_list, aoa_list, aos_list = get_aeromap_conditions(cpacs_path)
+ cpacs_path = cpacs.cpacs_file
+ tixi = cpacs.tixi
+ alt_list, mach_list, aoa_list, aos_list = get_aeromap_conditions(
+ cpacs_path,
+ AVL_AEROMAP_UID_XPATH
+ )
log.info("FLIGHT CONDITIONS:")
log.info(f"\tAltitude : {', '.join(str(a) for a in alt_list)} meters")
log.info(f"\tMach number : {', '.join(str(m) for m in mach_list)}")
@@ -378,9 +383,11 @@ def aeroframe_run(cpacs_path, cpacs_out_path, wkdir):
# First AVL run
log.info("----- AVL: Calculation 1 -----")
- run_avl(cpacs_path, wkdir)
- for i_case in range(len(alt_list)):
+ # First AVL run
+ run_avl(cpacs, wkdir)
+
+ for i_case, _ in enumerate(alt_list):
alt = alt_list[i_case]
mach = mach_list[i_case]
aoa = aoa_list[i_case]
@@ -419,7 +426,6 @@ def aeroframe_run(cpacs_path, cpacs_out_path, wkdir):
# Write results in CPACS out
create_branch(tixi, FRAMAT_RESULTS_XPATH + "/TipDeflection")
tixi.updateDoubleElement(FRAMAT_RESULTS_XPATH + "/TipDeflection", tip_deflection[-1], "%g")
- tixi.save(str(cpacs_out_path))
plot_convergence(tip_deflection, residuals, wkdir=CASE_PATH)
@@ -428,18 +434,5 @@ def aeroframe_run(cpacs_path, cpacs_out_path, wkdir):
# MAIN
# =================================================================================================
-
-def main(cpacs_path, cpacs_out_path):
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- results_dir = get_results_directory("AeroFrame_new")
- aeroframe_run(cpacs_path, cpacs_out_path, wkdir=results_dir)
-
- log.info("----- End of " + MODULE_NAME + " -----")
-
-
if __name__ == "__main__":
- cpacs_path = get_toolinput_file_path(MODULE_NAME)
- cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
-
- main(cpacs_path, cpacs_out_path)
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/AeroFrame_new/func/aeroframe_config.py b/ceasiompy/AeroFrame_new/func/aeroframe_config.py
index 192f4f27e..5205fef18 100644
--- a/ceasiompy/AeroFrame_new/func/aeroframe_config.py
+++ b/ceasiompy/AeroFrame_new/func/aeroframe_config.py
@@ -6,7 +6,6 @@
Script to extract panel forces of a surface,
from AVL 'fe.txt' element force file
-Python version: >=3.8
| Author: Romain Gauthier
| Creation: 2024-06-17
@@ -31,7 +30,7 @@
from framat import Model
from cpacspy.cpacspy import CPACS
-from cpacspy.cpacsfunctions import get_value_or_default, get_value
+from cpacspy.cpacsfunctions import get_value_or_default
from cpacspy.cpacsfunctions import open_tixi
from ceasiompy.utils.commonxpath import (
@@ -39,17 +38,15 @@
FRAMAT_SECTION_XPATH,
WINGS_XPATH
)
-from ceasiompy.utils.ceasiomlogger import get_logger
+from ceasiompy import log
from ceasiompy.utils.generalclasses import SimpleNamespace, Transformation
-from ceasiompy.utils.mathfunctions import euler2fix
+from ceasiompy.utils.mathsfunctions import euler2fix, rotate_points
from ceasiompy.CPACS2SUMO.func.getprofile import get_profile_coord
-from ceasiompy.AeroFrame_new.func.aeroframe_utils import (
+from ceasiompy.AeroFrame_new.func.utils import (
PolyArea,
second_moments_of_area,
- rotate_3D_points
)
-log = get_logger()
# =================================================================================================
# FUNCTIONS
@@ -303,12 +300,14 @@ def create_framat_model(young_modulus, shear_modulus, material_density,
# Add orientation property to the beam
for i_node in range(len(centerline_df) - 1):
- up_x, up_y, up_z = rotate_3D_points(x=0,
- y=0,
- z=1,
- angle_x=centerline_df.iloc[i_node]["thx_new"],
- angle_y=centerline_df.iloc[i_node]["thy_new"],
- angle_z=centerline_df.iloc[i_node]["thz_new"])
+ up_x, up_y, up_z = rotate_points(
+ x=0,
+ y=0,
+ z=1,
+ RaX=centerline_df.iloc[i_node]["thx_new"],
+ RaY=-centerline_df.iloc[i_node]["thy_new"],
+ RaZ=centerline_df.iloc[i_node]["thz_new"],
+ )
beam.add('orientation', {'from': centerline_df.iloc[i_node]['node_uid'],
'to': centerline_df.iloc[i_node + 1]['node_uid'],
@@ -1069,5 +1068,4 @@ def interpolate_leading_edge_points(Xle_array, Yle_array, Zle_array, y_queries):
if __name__ == "__main__":
-
log.info("Nothing to execute!")
diff --git a/ceasiompy/AeroFrame_new/func/aeroframe_utils.py b/ceasiompy/AeroFrame_new/func/aeroframe_utils.py
deleted file mode 100644
index a28aacce9..000000000
--- a/ceasiompy/AeroFrame_new/func/aeroframe_utils.py
+++ /dev/null
@@ -1,119 +0,0 @@
-"""
-CEASIOMpy: Conceptual Aircraft Design Software
-
-Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-
-Script to ...
-
-Python version: >=3.8
-
-| Author: Romain Gauthier
-| Creation: 2024-06-17
-
-TODO:
-
- * Things to improve...
-
-"""
-
-# ==============================================================================
-# IMPORTS
-# ==============================================================================
-import numpy as np
-import math
-from shapely.geometry import Polygon
-from ceasiompy.utils.ceasiomlogger import get_logger
-
-log = get_logger()
-
-
-# =================================================================================================
-# FUNCTIONS
-# =================================================================================================
-
-def PolyArea(x, y):
- return 0.5 * np.abs(np.dot(x, np.roll(y, 1)) - np.dot(y, np.roll(x, 1)))
-
-
-def compute_centroid(x_coords, y_coords):
- polygon = Polygon(zip(x_coords, y_coords))
- centroid = polygon.centroid
- return centroid.x, centroid.y
-
-
-def second_moments_of_area(x, y):
- Ix = 0
- Iy = 0
- x_centr, y_centr = compute_centroid(x, y)
- x = [xi - x_centr for xi in x]
- y = [yi - y_centr for yi in y]
-
- n = len(x)
- for i in range(n):
- j = (i + 1) % n
- Ix += (y[i]**2 + y[i] * y[j] + y[j]**2) * (x[i] * y[j] - x[j] * y[i])
- Iy += (x[i]**2 + x[i] * x[j] + x[j]**2) * (x[i] * y[j] - x[j] * y[i])
-
- Ix /= 12
- Iy /= 12
-
- return Ix, Iy
-
-
-def rotate_3D_points(x, y, z, angle_x, angle_y, angle_z):
- """Function to apply a 3D rotation to the coordinates of a point
-
- Function 'rotate_3D_points' returns the rotated points after applying
- a 3D rotation matrix.
-
- Source:
- * https://en.wikipedia.org/wiki/Rotation_matrix
-
- Args:
- x (float): x coordinate of the initial point
- y (float): y coordinate of the initial point
- z (float): z coordinate of the initial point
- angle_x (float): rotation angle around x-axis [rad]
- angle_y (float): rotation angle around y-axis [rad]
- angle_z (float): rotation angle around z-axis [rad]
-
- Returns:
- x_rot (float): x coordinate of the rotated point
- y_rot (float): y coordinate of the rotated point
- z_rot (float): z coordinate of the rotated point
- """
- R11 = math.cos(angle_z) * math.cos(angle_y)
- R12 = math.cos(angle_z) * math.sin(angle_y) * math.sin(angle_x) - \
- math.sin(angle_z) * math.cos(angle_x)
- R13 = math.cos(angle_z) * math.sin(angle_y) * math.cos(angle_x) + \
- math.sin(angle_z) * math.sin(angle_x)
- R21 = math.sin(angle_z) * math.cos(angle_y)
- R22 = math.sin(angle_z) * math.sin(angle_y) * math.sin(angle_x) + \
- math.cos(angle_z) * math.cos(angle_x)
- R23 = math.sin(angle_z) * math.sin(angle_y) * math.cos(angle_x) - \
- math.cos(angle_z) * math.sin(angle_x)
- R31 = -math.sin(angle_y)
- R32 = math.cos(angle_y) * math.sin(angle_x)
- R33 = math.cos(angle_y) * math.cos(angle_x)
-
- rotation_matrix = np.array([[R11, R12, R13],
- [R21, R22, R23],
- [R31, R32, R33]])
-
- x_rot = x * rotation_matrix[0, 0] + y * \
- rotation_matrix[0, 1] + z * rotation_matrix[0, 2]
- y_rot = x * rotation_matrix[1, 0] + y * \
- rotation_matrix[1, 1] + z * rotation_matrix[1, 2]
- z_rot = x * rotation_matrix[2, 0] + y * \
- rotation_matrix[2, 1] + z * rotation_matrix[2, 2]
-
- return x_rot, y_rot, z_rot
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-if __name__ == "__main__":
-
- log.info("Nothing to execute!")
diff --git a/ceasiompy/AeroFrame_new/func/aeroframe_debbug.py b/ceasiompy/AeroFrame_new/func/plot.py
similarity index 81%
rename from ceasiompy/AeroFrame_new/func/aeroframe_debbug.py
rename to ceasiompy/AeroFrame_new/func/plot.py
index 3dddf2dae..56cc999c8 100644
--- a/ceasiompy/AeroFrame_new/func/aeroframe_debbug.py
+++ b/ceasiompy/AeroFrame_new/func/plot.py
@@ -7,27 +7,21 @@
and plot the shape of the deformed wing. It helps to see if the geometry was
accurately captured and if the meshes are fine.
-Python version: >=3.8
| Author: Romain Gauthier
| Creation: 2024-06-19
-TODO:
-
- * Things to improve...
-
"""
# ==============================================================================
# IMPORTS
# ==============================================================================
-import matplotlib.pyplot as plt
-from pathlib import Path
-from ceasiompy.utils.ceasiomlogger import get_logger
+import matplotlib.pyplot as plt
+from pathlib import Path
-log = get_logger()
+from ceasiompy import log
# =================================================================================================
# FUNCTIONS
@@ -35,10 +29,8 @@
def plot_fem_mesh(wing_df, centerline_df, wkdir):
- """Function to plot the VLM and FEM meshes.
-
- Function 'plot_fem_mesh' saves a plot of the
- VLM and FEM meshes in the x-y and y-z planes.
+ """
+ Saves a plot of the VLM and FEM meshes in the x-y and y-z planes.
Args:
wing_df (pandas dataframe): dataframe containing the VLM nodes.
@@ -69,15 +61,13 @@ def plot_fem_mesh(wing_df, centerline_df, wkdir):
def plot_deformed_wing(centerline_df, undeformed_df, wkdir):
- """Function to plot the deformed shape of the wing.
-
- Function 'plot_deformed_wing' saves a plot of the
- deformed and undeformed shapes of the wing.
+ """
+ Saves a plot of the deformed and undeformed shapes of the wing.
Args:
- centerline_df (pandas dataframe): dataframe containing the nodes of the deformed wing.
- undeformed_df (pandas dataframe): dataframe containing the nodes of the initial wing.
- wkdir (Path): path to the directory to save the plot.
+ centerline_df (DataFrame): Contains nodes of the deformed wing.
+ undeformed_df (DataFrame): Contains nodes of the initial wing.
+ wkdir (Path): Path to the directory to save the plot.
"""
fig, axs = plt.subplots()
axs.plot(centerline_df['y_new'],
@@ -108,5 +98,4 @@ def plot_deformed_wing(centerline_df, undeformed_df, wkdir):
# =================================================================================================
if __name__ == "__main__":
-
log.info("Nothing to execute!")
diff --git a/ceasiompy/AeroFrame_new/func/aeroframe_results.py b/ceasiompy/AeroFrame_new/func/results.py
similarity index 98%
rename from ceasiompy/AeroFrame_new/func/aeroframe_results.py
rename to ceasiompy/AeroFrame_new/func/results.py
index 1b4b5117c..4ee57fb14 100644
--- a/ceasiompy/AeroFrame_new/func/aeroframe_results.py
+++ b/ceasiompy/AeroFrame_new/func/results.py
@@ -6,7 +6,6 @@
Script to compute the wing deformation, plot the displacements and rotations,
and plot the convergence.
-Python version: >=3.8
| Author: Romain Gauthier
| Creation: 2024-06-17
@@ -27,9 +26,7 @@
from pathlib import Path
from scipy import interpolate
-from ceasiompy.utils.ceasiomlogger import get_logger
-
-log = get_logger()
+from ceasiompy import log
# =================================================================================================
# FUNCTIONS
diff --git a/ceasiompy/AeroFrame_new/func/utils.py b/ceasiompy/AeroFrame_new/func/utils.py
new file mode 100644
index 000000000..975fa6544
--- /dev/null
+++ b/ceasiompy/AeroFrame_new/func/utils.py
@@ -0,0 +1,63 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Script to ...
+
+
+| Author: Romain Gauthier
+| Creation: 2024-06-17
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+import numpy as np
+
+from shapely.geometry import Polygon
+
+from ceasiompy import log
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def PolyArea(x, y):
+ return 0.5 * np.abs(np.dot(x, np.roll(y, 1)) - np.dot(y, np.roll(x, 1)))
+
+
+def compute_centroid(x_coords, y_coords):
+ polygon = Polygon(zip(x_coords, y_coords))
+ centroid = polygon.centroid
+ return centroid.x, centroid.y
+
+
+def second_moments_of_area(x, y):
+ Ix = 0
+ Iy = 0
+ x_centr, y_centr = compute_centroid(x, y)
+ x = [xi - x_centr for xi in x]
+ y = [yi - y_centr for yi in y]
+
+ n = len(x)
+ for i in range(n):
+ j = (i + 1) % n
+ Ix += (y[i]**2 + y[i] * y[j] + y[j]**2) * (x[i] * y[j] - x[j] * y[i])
+ Iy += (x[i]**2 + x[i] * x[j] + x[j]**2) * (x[i] * y[j] - x[j] * y[i])
+
+ Ix /= 12
+ Iy /= 12
+
+ return Ix, Iy
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/AeroFrame_new/tests/ToolOutput/.keep b/ceasiompy/AeroFrame_new/tests/ToolOutput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/AeroFrame_new/tests/ToolOutput/.keep
+++ b/ceasiompy/AeroFrame_new/tests/ToolOutput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/BalanceConventional/ToolInput/.keep b/ceasiompy/BalanceConventional/ToolInput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/BalanceConventional/ToolInput/.keep
+++ b/ceasiompy/BalanceConventional/ToolInput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/BalanceConventional/ToolOutput/.keep b/ceasiompy/BalanceConventional/ToolOutput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/BalanceConventional/ToolOutput/.keep
+++ b/ceasiompy/BalanceConventional/ToolOutput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/BalanceConventional/__init__.py b/ceasiompy/BalanceConventional/__init__.py
index e69de29bb..ab1f319f5 100644
--- a/ceasiompy/BalanceConventional/__init__.py
+++ b/ceasiompy/BalanceConventional/__init__.py
@@ -0,0 +1,46 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for BalanceConventional module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+# True if the module is active.
+# False if the module is disabled (not working or not ready).
+module_status = False
+
+# ===== Include GUI =====
+# True if you want to add a GUI for this module.
+# False if module is desactivated or no GUI to be displayed.
+include_gui = False
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/BalanceConventional/__specs__.py b/ceasiompy/BalanceConventional/__specs__.py
index 820ea69e3..6e81644d6 100644
--- a/ceasiompy/BalanceConventional/__specs__.py
+++ b/ceasiompy/BalanceConventional/__specs__.py
@@ -1,5 +1,7 @@
from ceasiompy.utils.moduleinterfaces import CPACSInOut
+from ceasiompy import log
+
# ===== Module Status =====
# True if the module is active
# False if the module is disabled (not working or not ready)
@@ -80,3 +82,10 @@
# descr='Description of the output',
# xpath='/cpacs/toolspecific/CEASIOMpy/test/myOutput',
# )
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/BalanceConventional/balancemain.py b/ceasiompy/BalanceConventional/balanceconventional.py
similarity index 82%
rename from ceasiompy/BalanceConventional/balancemain.py
rename to ceasiompy/BalanceConventional/balanceconventional.py
index 74b2564ce..22a62f630 100644
--- a/ceasiompy/BalanceConventional/balancemain.py
+++ b/ceasiompy/BalanceConventional/balanceconventional.py
@@ -15,7 +15,6 @@
folder after copying it into the ToolOutput folder
as ToolOutput.xml
-Python version: >=3.8
| Author : Stefano Piccini
| Date of creation: 2018-09-27
@@ -31,7 +30,6 @@
import os
import shutil
-from pathlib import Path
import matplotlib.pyplot as plt
import numpy as np
@@ -39,28 +37,13 @@
from ceasiompy.BalanceConventional.func.AoutFunc import cpacsbalanceupdate, outputbalancegen
from ceasiompy.BalanceConventional.func.Cog.centerofgravity import center_of_gravity_evaluation
from ceasiompy.BalanceConventional.func.Inertia import lumpedmassesinertia
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.ceasiompyutils import aircraft_name
+from ceasiompy.utils.ceasiompyutils import aircraft_name, call_main
from ceasiompy.utils.InputClasses.Conventional import balanceconvclass
-from ceasiompy.utils.moduleinterfaces import (
- check_cpacs_input_requirements,
- get_toolinput_file_path,
- get_tooloutput_file_path,
-)
from ceasiompy.utils.WB.ConvGeometry import geometry
from cpacspy.cpacspy import CPACS
-log = get_logger()
-
-MODULE_DIR = Path(__file__).parent
-MODULE_NAME = MODULE_DIR.name
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
-
-# All classes are defined inside the InputClasses/Conventional
-
+from ceasiompy import log
+from ceasiompy.BalanceConventional import MODULE_NAME
# =================================================================================================
# FUNCTIONS
@@ -94,7 +77,11 @@ def check_rounding(I1, I2):
return rd
-def get_balance_estimations(cpacs_path, cpacs_out_path):
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+def main(cpacs: CPACS) -> None:
"""Function to estimate inertia value and CoF of an conventional aircraft.
Function 'get_balance_unc_estimations' ...
@@ -104,11 +91,10 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
Args:
cpacs_path (str): Path to CPACS file
- cpacs_out_path (str):Path to CPACS output file
+ cpacs_path (str):Path to CPACS output file
"""
-
- cpacs = CPACS(cpacs_path)
+ cpacs_path = cpacs.cpacs_file
# TODO: when refactor, use Pathlib and absolute path
# Removing and recreating the ToolOutput folder.
@@ -121,7 +107,7 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
name = aircraft_name(cpacs_path)
- shutil.copyfile(cpacs_path, cpacs_out_path) # TODO: shoud not be like that
+ # shutil.copyfile(cpacs_path, cpacs_path) # TODO: shoud not be like that
newpath = "ToolOutput/" + name
if not os.path.exists(newpath):
os.makedirs(newpath)
@@ -130,7 +116,7 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
bi = balanceconvclass.BalanceInputs()
out = balanceconvclass.BalanceOutputs()
mw = balanceconvclass.MassesWeights()
- (mw, bi) = getdatafromcpacs.get_data(mw, bi, cpacs_out_path)
+ (mw, bi) = getdatafromcpacs.get_data(mw, bi, cpacs_path)
# BALANCE ANALYSIS
@@ -139,7 +125,7 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
F_PERC_MAXPASS = (mw.mass_fuel_maxpass / mw.mass_fuel_max) * 100
# CENTER OF GRAVITY---------------------------------------------------------
- # ag = geometry.geometry_eval(cpacs_out_path, name)
+ # ag = geometry.geometry_eval(cpacs_path, name)
# TODO: get CPACS object
ag = geometry.AircraftGeometry()
ag.fuse_geom_eval(cpacs)
@@ -148,22 +134,22 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
log.info("------- Center of Gravity coordinates -------")
log.info("--------- Max Payload configuration ---------")
- (out.center_of_gravity, mass_seg_i, airplane_centers_segs) = center_of_gravity_evaluation(
+ (out.center_of_gravity, mass_seg_i, _) = center_of_gravity_evaluation(
F_PERC_MAXPASS, 100, ag.cabin_seg, ag, mw, bi.WING_MOUNTED
)
log.info("[x, y, z] = " + str(out.center_of_gravity))
log.info("---------- Zero Fuel configuration ----------")
- (out.cg_zfm, ms_zfm, airplane_centers_segs) = center_of_gravity_evaluation(
+ (out.cg_zfm, ms_zfm, _) = center_of_gravity_evaluation(
0, 100, ag.cabin_seg, ag, mw, bi.WING_MOUNTED
)
log.info("[x, y, z] = " + str(out.cg_zfm))
log.info("-------- Zero Payload configuration ---------")
- (out.cg_zpm, ms_zpm, airplane_centers_segs) = center_of_gravity_evaluation(
+ (out.cg_zpm, ms_zpm, _) = center_of_gravity_evaluation(
100, 0, ag.cabin_seg, ag, mw, bi.WING_MOUNTED
)
log.info("[x, y, z] = " + str(out.cg_zpm))
log.info("------------- OEM configuration -------------")
- (out.cg_oem, ms_oem, airplane_centers_segs) = center_of_gravity_evaluation(
+ (out.cg_oem, ms_oem, _) = center_of_gravity_evaluation(
0, 0, ag.cabin_seg, ag, mw, bi.WING_MOUNTED
)
log.info("[x, y, z] = " + str(out.cg_oem))
@@ -181,7 +167,7 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
bi.F_PERC = 1 + ((mw.mass_payload / mw.mass_fuel_maxpass) * (1 - (bi.P_PERC / 100.0)))
log.warning("FUEL percentage: " + str(bi.F_PERC))
log.info("------------- User configuration ------------")
- (out.cg_user, ms_user, airplane_centers_segs) = center_of_gravity_evaluation(
+ (out.cg_user, ms_user, _) = center_of_gravity_evaluation(
bi.F_PERC * 100, bi.P_PERC, ag.cabin_seg, ag, mw, bi.WING_MOUNTED
)
@@ -190,10 +176,10 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
log.info("------------ Lumped mass Inertia ------------")
log.info("--------- Max Payload configuration ---------")
(_, _, _, Ixxf, Iyyf, Izzf, Ixyf, Iyzf, Ixzf) = lumpedmassesinertia.fuselage_inertia(
- bi.SPACING_FUSE, out.center_of_gravity, mass_seg_i, ag, cpacs_out_path
+ bi.SPACING_FUSE, out.center_of_gravity, mass_seg_i, ag, cpacs_path
)
(_, _, _, Ixxw, Iyyw, Izzw, Ixyw, Iyzw, Ixzw) = lumpedmassesinertia.wing_inertia(
- bi.WPP, bi.SPACING_WING, out.center_of_gravity, mass_seg_i, ag, cpacs_out_path
+ bi.WPP, bi.SPACING_WING, out.center_of_gravity, mass_seg_i, ag, cpacs_path
)
rd = check_rounding(Ixxf + Ixxw, Iyzf + Iyzw)
@@ -206,10 +192,10 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
log.info("---------- Zero Fuel configuration ----------")
(_, _, _, Ixxf2, Iyyf2, Izzf2, Ixyf2, Iyzf2, Ixzf2) = lumpedmassesinertia.fuselage_inertia(
- bi.SPACING_FUSE, out.cg_zfm, ms_zfm, ag, cpacs_out_path
+ bi.SPACING_FUSE, out.cg_zfm, ms_zfm, ag, cpacs_path
)
(_, _, _, Ixxw2, Iyyw2, Izzw2, Ixyw2, Iyzw2, Ixzw2) = lumpedmassesinertia.wing_inertia(
- bi.WPP, bi.SPACING_WING, out.cg_zfm, ms_zfm, ag, cpacs_out_path
+ bi.WPP, bi.SPACING_WING, out.cg_zfm, ms_zfm, ag, cpacs_path
)
out.Ixx_lump_zfm = round(Ixxf2 + Ixxw2, rd)
@@ -221,10 +207,10 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
log.info("--------- Zero Payload configuration --------")
(_, _, _, Ixxf3, Iyyf3, Izzf3, Ixyf3, Iyzf3, Ixzf3) = lumpedmassesinertia.fuselage_inertia(
- bi.SPACING_FUSE, out.cg_zpm, ms_zpm, ag, cpacs_out_path
+ bi.SPACING_FUSE, out.cg_zpm, ms_zpm, ag, cpacs_path
)
(_, _, _, Ixxw3, Iyyw3, Izzw3, Ixyw3, Iyzw3, Ixzw3) = lumpedmassesinertia.wing_inertia(
- bi.WPP, bi.SPACING_WING, out.cg_zpm, ms_zpm, ag, cpacs_out_path
+ bi.WPP, bi.SPACING_WING, out.cg_zpm, ms_zpm, ag, cpacs_path
)
out.Ixx_lump_zpm = round(Ixxf3 + Ixxw3, rd)
@@ -235,11 +221,11 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
out.Ixz_lump_zpm = round(Ixzf3 + Ixzw3, rd)
log.info("------------- OEM configuration -------------")
- (fx, fy, fz, Ixxf4, Iyyf4, Izzf4, Ixyf4, Iyzf4, Ixzf4) = lumpedmassesinertia.fuselage_inertia(
- bi.SPACING_FUSE, out.cg_oem, ms_oem, ag, cpacs_out_path
+ (_, _, _, Ixxf4, Iyyf4, Izzf4, Ixyf4, Iyzf4, Ixzf4) = lumpedmassesinertia.fuselage_inertia(
+ bi.SPACING_FUSE, out.cg_oem, ms_oem, ag, cpacs_path
)
- (wx, wy, wz, Ixxw4, Iyyw4, Izzw4, Ixyw4, Iyzw4, Ixzw4) = lumpedmassesinertia.wing_inertia(
- bi.WPP, bi.SPACING_WING, out.cg_oem, ms_oem, ag, cpacs_out_path
+ (_, _, _, Ixxw4, Iyyw4, Izzw4, Ixyw4, Iyzw4, Ixzw4) = lumpedmassesinertia.wing_inertia(
+ bi.WPP, bi.SPACING_WING, out.cg_oem, ms_oem, ag, cpacs_path
)
out.Ixx_lump_oem = round(Ixxf4 + Ixxw4, rd)
@@ -252,9 +238,9 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
if bi.USER_CASE:
log.info("------------- User configuration ------------")
(
- fx,
- fy,
- fz,
+ _,
+ _,
+ _,
Ixxfu,
Iyyfu,
Izzfu,
@@ -262,10 +248,10 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
Iyzfu,
Ixzfu,
) = lumpedmassesinertia.fuselage_inertia(
- bi.SPACING_FUSE, out.cg_user, ms_user, ag, cpacs_out_path
+ bi.SPACING_FUSE, out.cg_user, ms_user, ag, cpacs_path
)
- (wx, wy, wz, Ixxwu, Iyywu, Izzwu, Ixywu, Iyzwu, Ixzwu) = lumpedmassesinertia.wing_inertia(
- bi.WPP, bi.SPACING_WING, out.cg_user, ms_user, ag, cpacs_out_path
+ (_, _, _, Ixxwu, Iyywu, Izzwu, Ixywu, Iyzwu, Ixzwu) = lumpedmassesinertia.wing_inertia(
+ bi.WPP, bi.SPACING_WING, out.cg_user, ms_user, ag, cpacs_path
)
out.Ixx_lump_user = round(Ixxfu + Ixxwu, rd)
@@ -281,7 +267,7 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
outputbalancegen.output_txt(out, mw, bi, name)
# CPACS WRITING
- cpacsbalanceupdate.cpacs_mbd_update(out, mw, bi, np.sum(ms_zpm), cpacs_out_path)
+ cpacsbalanceupdate.cpacs_mbd_update(out, mw, bi, np.sum(ms_zpm), cpacs_path)
# PLOTS
# Aircraft Cog Plot
@@ -363,24 +349,5 @@ def get_balance_estimations(cpacs_path, cpacs_out_path):
log.info("############## Balance estimation completed ##############")
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-
-def main(cpacs_path, cpacs_out_path):
-
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- check_cpacs_input_requirements(cpacs_path)
- get_balance_estimations(cpacs_path, cpacs_out_path)
-
- log.info("----- End of " + MODULE_NAME + " -----")
-
-
if __name__ == "__main__":
-
- cpacs_path = get_toolinput_file_path(MODULE_NAME)
- cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
-
- main(cpacs_path, cpacs_out_path)
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/BalanceConventional/func/AinFunc/getdatafromcpacs.py b/ceasiompy/BalanceConventional/func/AinFunc/getdatafromcpacs.py
index dbda3a251..a79ab5584 100644
--- a/ceasiompy/BalanceConventional/func/AinFunc/getdatafromcpacs.py
+++ b/ceasiompy/BalanceConventional/func/AinFunc/getdatafromcpacs.py
@@ -31,19 +31,10 @@
# IMPORTS
# =============================================================================
-from ceasiompy.utils.ceasiomlogger import get_logger
+from ceasiompy import log
from cpacspy.cpacsfunctions import create_branch, open_tixi
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-# All classes are defined inside the InputClasses/Conventional
-
# =============================================================================
# FUNCTIONS
diff --git a/ceasiompy/BalanceConventional/func/AoutFunc/cpacsbalanceupdate.py b/ceasiompy/BalanceConventional/func/AoutFunc/cpacsbalanceupdate.py
index 870d34e7d..fa12ee2c5 100644
--- a/ceasiompy/BalanceConventional/func/AoutFunc/cpacsbalanceupdate.py
+++ b/ceasiompy/BalanceConventional/func/AoutFunc/cpacsbalanceupdate.py
@@ -14,20 +14,9 @@
# =============================================================================
# IMPORTS
# =============================================================================
-
from cpacspy.cpacsfunctions import add_uid, create_branch, open_tixi
-from ceasiompy.utils.ceasiomlogger import get_logger
-
-
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-# All classes are defined inside the InputClasses/Conventional
+from ceasiompy import log
# =============================================================================
diff --git a/ceasiompy/BalanceConventional/func/AoutFunc/outputbalancegen.py b/ceasiompy/BalanceConventional/func/AoutFunc/outputbalancegen.py
index 871bf20ac..7c06e6184 100644
--- a/ceasiompy/BalanceConventional/func/AoutFunc/outputbalancegen.py
+++ b/ceasiompy/BalanceConventional/func/AoutFunc/outputbalancegen.py
@@ -20,13 +20,6 @@
import matplotlib.pyplot as plt
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-# All classes are defined inside the InputClasses/Conventional
-
-
# =============================================================================
# FUNCTIONS
# =============================================================================
diff --git a/ceasiompy/BalanceConventional/func/Cog/centerofgravity.py b/ceasiompy/BalanceConventional/func/Cog/centerofgravity.py
index 9b7253a70..64a612bee 100644
--- a/ceasiompy/BalanceConventional/func/Cog/centerofgravity.py
+++ b/ceasiompy/BalanceConventional/func/Cog/centerofgravity.py
@@ -24,9 +24,8 @@
import numpy as np
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
+from ceasiompy import log
# =============================================================================
@@ -157,6 +156,7 @@ def center_of_gravity_evaluation(F_PERC, P_PERC, cabin_seg, ag, mw, WING_MOUNTED
if htw != 0:
a = wg.index(htw)
else:
+ tw = 0
a = wg.index(tw)
else:
a = wg.index(ag.main_wing_index)
diff --git a/ceasiompy/BalanceConventional/func/Inertia/lumpedmassesinertia.py b/ceasiompy/BalanceConventional/func/Inertia/lumpedmassesinertia.py
index 8827000a2..c92487578 100644
--- a/ceasiompy/BalanceConventional/func/Inertia/lumpedmassesinertia.py
+++ b/ceasiompy/BalanceConventional/func/Inertia/lumpedmassesinertia.py
@@ -21,9 +21,8 @@
from cpacspy.cpacsfunctions import open_tigl, open_tixi
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
+from ceasiompy import log
# =============================================================================
@@ -151,9 +150,9 @@ def fuselage_inertia(SPACING, center_of_gravity, mass_seg_i, ag, cpacs_in):
fx_t = fx * symx
fy_t = fy * symy
fz_t = fz * symz
- [sfx.append(x) for x in fx_t]
- [sfx.append(y) for y in fy_t]
- [sfx.append(z) for z in fz_t]
+ # [sfx.append(x) for x in fx_t]
+ # [sfx.append(y) for y in fy_t]
+ # [sfx.append(z) for z in fz_t]
M = mass_seg_i[int(i) - 1, f + a - 1] / np.max(np.shape(fx))
fcx_t = fx_t - (np.zeros((np.shape(fx_t))) + center_of_gravity[0])
fcy_t = fy_t - (np.zeros((np.shape(fy_t))) + center_of_gravity[1])
diff --git a/ceasiompy/BalanceUnconventional/ToolOutput/.keep b/ceasiompy/BalanceUnconventional/ToolOutput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/BalanceUnconventional/ToolOutput/.keep
+++ b/ceasiompy/BalanceUnconventional/ToolOutput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/BalanceUnconventional/__init__.py b/ceasiompy/BalanceUnconventional/__init__.py
index e69de29bb..be8469721 100644
--- a/ceasiompy/BalanceUnconventional/__init__.py
+++ b/ceasiompy/BalanceUnconventional/__init__.py
@@ -0,0 +1,36 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for BalanceUnconventional module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+# True if the module is active.
+# False if the module is disabled (not working or not ready).
+module_status = False
+
+# ===== Include GUI =====
+# True if you want to add a GUI for this module.
+# False if module is desactivated or no GUI to be displayed.
+include_gui = False
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
diff --git a/ceasiompy/BalanceUnconventional/balanceuncmain.py b/ceasiompy/BalanceUnconventional/balanceunconventional.py
similarity index 90%
rename from ceasiompy/BalanceUnconventional/balanceuncmain.py
rename to ceasiompy/BalanceUnconventional/balanceunconventional.py
index 8b0923d64..b918ab59a 100644
--- a/ceasiompy/BalanceUnconventional/balanceuncmain.py
+++ b/ceasiompy/BalanceUnconventional/balanceunconventional.py
@@ -15,7 +15,6 @@
folder after copying it into the ToolOutput folder
as ToolOutput.xml
-Python version: >=3.8
| Author : Stefano Piccini
| Date of creation: 2018-09-27
@@ -42,7 +41,6 @@
unc_center_of_gravity,
)
from ceasiompy.BalanceUnconventional.func.Inertia import uncinertia
-from ceasiompy.utils.ceasiomlogger import get_logger
from ceasiompy.utils.ceasiompyutils import aircraft_name
from ceasiompy.utils.InputClasses.Unconventional import (
balanceuncclass,
@@ -56,17 +54,8 @@
)
from ceasiompy.utils.WB.UncGeometry import uncgeomanalysis
-log = get_logger()
-
-MODULE_DIR = Path(__file__).parent
-MODULE_NAME = MODULE_DIR.name
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
-
-"""All classes are defined inside the classes folder and into the
- InputClasses/Uconventional folder"""
+from ceasiompy import log
+from ceasiompy.BalanceUnconventional import MODULE_NAME
# =================================================================================================
@@ -123,7 +112,7 @@ def get_balance_unc_estimations(cpacs_path, cpacs_out_path):
log.warning("Aircraft does not have wings")
raise Exception("Aircraft does not have wings")
elif not fus_nb:
- (awg, wing_nodes) = uncgeomanalysis.no_fuse_geom_analysis(
+ (awg, _) = uncgeomanalysis.no_fuse_geom_analysis(
cpacs_path, ui.FLOORS_NB, w_nb, ui.H_LIM_CABIN, ui.FUEL_ON_CABIN, name, ed.turboprop
)
else:
@@ -146,16 +135,16 @@ def get_balance_unc_estimations(cpacs_path, cpacs_out_path):
# CENTER OF GRAVITY
if not fus_nb:
- (bout, airplane_centers_segs) = bwb_center_of_gravity(awg, bout, ui, bi, mw, ed)
+ (bout, _) = bwb_center_of_gravity(awg, bout, ui, bi, mw, ed)
else:
- (bout, airplane_centers_segs) = unc_center_of_gravity(awg, afg, bout, ui, bi, mw, ed)
+ (bout, _) = unc_center_of_gravity(awg, afg, bout, ui, bi, mw, ed)
# MOMENT OF INERTIA
if not fus_nb:
- (bout, wx, wy, wz) = uncinertia.bwb_inertia_eval(awg, bout, bi, mw, ed, cpacs_out_path)
+ (bout, _, _, _) = uncinertia.bwb_inertia_eval(awg, bout, bi, mw, ed, cpacs_out_path)
else:
- (bout, fx, fy, fz, wx, wy, wz) = uncinertia.unc_inertia_eval(
+ (bout, _, _, _, _, _, _) = uncinertia.unc_inertia_eval(
awg, afg, bout, bi, mw, ed, cpacs_out_path
)
@@ -275,20 +264,19 @@ def get_balance_unc_estimations(cpacs_path, cpacs_out_path):
# =================================================================================================
-def main(cpacs_path, cpacs_out_path):
-
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- check_cpacs_input_requirements(cpacs_path)
+def main(cpacs_path: Path, cpacs_out_path: Path) -> None:
+ module_name = MODULE_NAME
+ log.info("----- Start of " + module_name + " -----")
get_balance_unc_estimations(cpacs_path, cpacs_out_path)
- log.info("----- End of " + MODULE_NAME + " -----")
+ log.info("----- End of " + module_name + " -----")
if __name__ == "__main__":
cpacs_path = get_toolinput_file_path(MODULE_NAME)
cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
+ check_cpacs_input_requirements(cpacs_path)
main(cpacs_path, cpacs_out_path)
diff --git a/ceasiompy/BalanceUnconventional/func/AinFunc/getdatafromcpacs.py b/ceasiompy/BalanceUnconventional/func/AinFunc/getdatafromcpacs.py
index 52ccacbdd..59c5e1b94 100644
--- a/ceasiompy/BalanceUnconventional/func/AinFunc/getdatafromcpacs.py
+++ b/ceasiompy/BalanceUnconventional/func/AinFunc/getdatafromcpacs.py
@@ -34,18 +34,7 @@
from cpacspy.cpacsfunctions import create_branch, open_tixi
-from ceasiompy.utils.ceasiomlogger import get_logger
-
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes folder and into the
- InputClasses/Uconventional folder"""
-
+from ceasiompy import log
# =============================================================================
# FUNCTIONS
diff --git a/ceasiompy/BalanceUnconventional/func/AoutFunc/cpacsbalanceupdate.py b/ceasiompy/BalanceUnconventional/func/AoutFunc/cpacsbalanceupdate.py
index 0113f4df0..ea524b3d4 100644
--- a/ceasiompy/BalanceUnconventional/func/AoutFunc/cpacsbalanceupdate.py
+++ b/ceasiompy/BalanceUnconventional/func/AoutFunc/cpacsbalanceupdate.py
@@ -18,17 +18,8 @@
from cpacspy.cpacsfunctions import add_uid, create_branch, open_tixi
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes folder and into the
- InputClasses/Uconventional folder"""
+from ceasiompy import log
# =============================================================================
diff --git a/ceasiompy/BalanceUnconventional/func/AoutFunc/outputbalancegen.py b/ceasiompy/BalanceUnconventional/func/AoutFunc/outputbalancegen.py
index 5107f667e..cdc4bd2d7 100644
--- a/ceasiompy/BalanceUnconventional/func/AoutFunc/outputbalancegen.py
+++ b/ceasiompy/BalanceUnconventional/func/AoutFunc/outputbalancegen.py
@@ -20,15 +20,6 @@
import matplotlib as mpl
import matplotlib.pyplot as plt
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes folder and into the
- InputClasses/Uconventional folder"""
-
-
# =============================================================================
# FUNCTIONS
# =============================================================================
@@ -327,7 +318,6 @@ def aircraft_cog_unc_plot(cg, bi, ed, afg, awg, NAME):
def aircraft_cog_bwb_plot(cg, bi, ed, awg, NAME):
-
"""The function that generate the plot of the blended wing body
center of gravity and the nodes used to evaluate it.
diff --git a/ceasiompy/BalanceUnconventional/func/Cog/bwbcog.py b/ceasiompy/BalanceUnconventional/func/Cog/bwbcog.py
index 0c03152ac..acfae8136 100644
--- a/ceasiompy/BalanceUnconventional/func/Cog/bwbcog.py
+++ b/ceasiompy/BalanceUnconventional/func/Cog/bwbcog.py
@@ -19,18 +19,8 @@
import numpy as np
-from ceasiompy.utils.ceasiomlogger import get_logger
-
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes and into
- the InputClasses/Unconventional folder."""
+from ceasiompy import log
# =============================================================================
# FUNCTIONS
diff --git a/ceasiompy/BalanceUnconventional/func/Cog/fusecog.py b/ceasiompy/BalanceUnconventional/func/Cog/fusecog.py
index 7b8f249ce..429a061d5 100644
--- a/ceasiompy/BalanceUnconventional/func/Cog/fusecog.py
+++ b/ceasiompy/BalanceUnconventional/func/Cog/fusecog.py
@@ -20,17 +20,8 @@
import numpy as np
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes and into
- the InputClasses/Unconventional folder."""
+from ceasiompy import log
# =============================================================================
@@ -99,7 +90,8 @@ def center_of_gravity_evaluation(F_PERC, P_PERC, afg, awg, mw, ed, ui, bi):
x0 = x
mass_seg_i = np.zeros((max_seg_n, tot_nb))
- oem_vol = (awg.wing_tot_vol - awg.wing_fuel_vol) + (np.sum(afg.fuse_vol) - fuse_fuel_vol)
+ oem_vol = (awg.wing_tot_vol - awg.wing_fuel_vol) + \
+ (np.sum(afg.fuse_vol) - fuse_fuel_vol)
# Evaluating oem density, fuel density, passenger density
if bi.USER_EN_PLACEMENT:
@@ -111,7 +103,8 @@ def center_of_gravity_evaluation(F_PERC, P_PERC, afg, awg, mw, ed, ui, bi):
mpass_par = (mw.mass_payload * (P_PERC / 100.0)) / pass_vol
- mfuel_par = (mw.mass_fuel_tot * (F_PERC / 100.0)) / (awg.wing_fuel_vol + fuse_fuel_vol)
+ mfuel_par = (mw.mass_fuel_tot * (F_PERC / 100.0)) / \
+ (awg.wing_fuel_vol + fuse_fuel_vol)
mtom = (
mw.operating_empty_mass
@@ -136,7 +129,8 @@ def center_of_gravity_evaluation(F_PERC, P_PERC, afg, awg, mw, ed, ui, bi):
i - 1
]
else:
- mass_seg_i[j - 1][i - 1] = oem_par * afg.fuse_seg_vol[j - 1][i - 1]
+ mass_seg_i[j - 1][i - 1] = oem_par * \
+ afg.fuse_seg_vol[j - 1][i - 1]
w = 0
for i in range(afg.fus_nb + 1, t_nb + 1):
for j in range(1, awg.wing_seg_nb[i - 1 - afg.fus_nb] + 1):
@@ -194,13 +188,16 @@ def center_of_gravity_evaluation(F_PERC, P_PERC, afg, awg, mw, ed, ui, bi):
center_of_gravity = []
center_of_gravity.append(
- round((np.sum(airplane_centers_segs[:, :, 0] * mass_seg_i) + cog_enx) / mtom, 3)
+ round(
+ (np.sum(airplane_centers_segs[:, :, 0] * mass_seg_i) + cog_enx) / mtom, 3)
)
center_of_gravity.append(
- round((np.sum(airplane_centers_segs[:, :, 1] * mass_seg_i) + cog_eny) / mtom, 3)
+ round(
+ (np.sum(airplane_centers_segs[:, :, 1] * mass_seg_i) + cog_eny) / mtom, 3)
)
center_of_gravity.append(
- round((np.sum(airplane_centers_segs[:, :, 2] * mass_seg_i) + cog_enz) / mtom, 3)
+ round(
+ (np.sum(airplane_centers_segs[:, :, 2] * mass_seg_i) + cog_enz) / mtom, 3)
)
for i in range(1, 4):
diff --git a/ceasiompy/BalanceUnconventional/func/Cog/unccog.py b/ceasiompy/BalanceUnconventional/func/Cog/unccog.py
index a2678bf20..7d06a60bd 100644
--- a/ceasiompy/BalanceUnconventional/func/Cog/unccog.py
+++ b/ceasiompy/BalanceUnconventional/func/Cog/unccog.py
@@ -24,22 +24,15 @@
from .fusecog import center_of_gravity_evaluation
from .bwbcog import center_of_gravity_evaluation_bwb
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
+from ceasiompy import log
# =============================================================================
-# CLASSES
+# FUNCTIONS
# =============================================================================
-"""All classes are defined inside the classes and into
- the InputClasses/Unconventional folder."""
-
-# =============================================================================
-# FUNCTIONS
-# =============================================================================
def unc_center_of_gravity(awg, afg, bout, ui, bi, mw, ed):
"""Unconventional aircraft center of gravity analysis main function.
It dvides the cases defined and evaluates them calling the
@@ -106,7 +99,7 @@ def unc_center_of_gravity(awg, afg, bout, ui, bi, mw, ed):
if bi.USER_CASE:
if bi.P_PERC < 0 or bi.F_PERC < 0:
- raise Exception("Error, F_PERC and P_PERC can" + " not be negative.")
+ raise Exception("Error, F_PERC and P_PERC can not be negative.")
if (
mw.mass_fuel_maxpass * (bi.F_PERC / 100) + mw.mass_payload * (bi.P_PERC / 100)
) > mw.mass_fuel_maxpass + mw.mass_payload:
@@ -115,7 +108,8 @@ def unc_center_of_gravity(awg, afg, bout, ui, bi, mw, ed):
+ "chosen payload mass,"
+ "fuel mass automatically reduced"
)
- bi.F_PERC = 1 + ((mw.mass_payload / mw.mass_fuel_maxpass) * (1 - (bi.P_PERC / 100)))
+ bi.F_PERC = 1 + \
+ ((mw.mass_payload / mw.mass_fuel_maxpass) * (1 - (bi.P_PERC / 100)))
log.warning("FUEL percentage: " + str(bi.F_PERC * 100))
log.info("---------- User configuration ---------")
(bout.cg_user, mw.ms_user, airplane_centers_segs) = center_of_gravity_evaluation(
@@ -182,7 +176,7 @@ def bwb_center_of_gravity(awg, bout, ui, bi, mw, ed):
if bi.USER_CASE:
if bi.P_PERC < 0 or bi.F_PERC < 0:
- raise Exception("Error, F_PERC and P_PERC can" + " not be negative.")
+ raise Exception("Error, F_PERC and P_PERC can not be negative.")
if (
mw.mass_fuel_maxpass * (bi.F_PERC / 100) + mw.mass_payload * (bi.P_PERC / 100)
) > mw.mass_fuel_maxpass + mw.mass_payload:
@@ -191,7 +185,8 @@ def bwb_center_of_gravity(awg, bout, ui, bi, mw, ed):
+ "chosen payload mass,"
+ "fuel mass automatically reduced"
)
- bi.F_PERC = 1 + ((mw.mass_payload / mw.mass_fuel_maxpass) * (1 - bi.P_PERC / 100))
+ bi.F_PERC = 1 + \
+ ((mw.mass_payload / mw.mass_fuel_maxpass) * (1 - bi.P_PERC / 100))
log.warning("FUEL percentage: " + str(bi.F_PERC))
log.info("---------- User configuration ---------")
(bout.cg_user, mw.ms_user, airplane_centers_segs) = center_of_gravity_evaluation_bwb(
diff --git a/ceasiompy/BalanceUnconventional/func/Inertia/lumpedmassesinertia.py b/ceasiompy/BalanceUnconventional/func/Inertia/lumpedmassesinertia.py
index 12650280d..ddc367a73 100644
--- a/ceasiompy/BalanceUnconventional/func/Inertia/lumpedmassesinertia.py
+++ b/ceasiompy/BalanceUnconventional/func/Inertia/lumpedmassesinertia.py
@@ -22,22 +22,15 @@
from cpacspy.cpacsfunctions import open_tigl, open_tixi
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
+from ceasiompy import log
# =============================================================================
-# CLASSES
+# FUNCTIONS
# =============================================================================
-"""All classes are defined inside the classes and into
- the InputClasses/Unconventional folder."""
-
-# =============================================================================
-# FUNCTIONS
-# =============================================================================
def fuselage_inertia(SPACING, center_of_gravity, mass_seg_i, afg, cpacs_in):
"""Thefunction evaluates the inertia of the fuselage using the lumped
masses method.
@@ -81,11 +74,14 @@ def fuselage_inertia(SPACING, center_of_gravity, mass_seg_i, afg, cpacs_in):
fy = []
fz = []
# Number of subdivisions along the longitudinal axis
- subd_l = math.ceil((afg.fuse_seg_length[int(i) - 1][f - 1] / SPACING))
+ subd_l = math.ceil(
+ (afg.fuse_seg_length[int(i) - 1][f - 1] / SPACING))
# Number of subdivisions along the perimeter
- SUBD_C0 = math.ceil((afg.fuse_sec_per[int(i) - 1][f - 1] / SPACING))
+ SUBD_C0 = math.ceil(
+ (afg.fuse_sec_per[int(i) - 1][f - 1] / SPACING))
# Number of subdivisions along the radial axis
- subd_r = math.ceil(((afg.fuse_sec_width[int(i) - 1][f - 1] / 2) / SPACING))
+ subd_r = math.ceil(
+ ((afg.fuse_sec_width[int(i) - 1][f - 1] / 2) / SPACING))
if subd_l == 0:
subd_l = 1.0
if SUBD_C0 == 0:
@@ -193,7 +189,8 @@ def wing_inertia(subd_c, SPACING, fuse, center_of_gravity, mass_seg_i, awg, cpac
wy = []
wz = []
# Number of subdivisions along the longitudinal axis
- subd_l = math.ceil((awg.wing_seg_length[int(i) - 1][w + a - 1] / SPACING))
+ subd_l = math.ceil(
+ (awg.wing_seg_length[int(i) - 1][w + a - 1] / SPACING))
if subd_l == 0:
subd_l = 1
eta = 1.0 / subd_l
@@ -257,7 +254,8 @@ def wing_inertia(subd_c, SPACING, fuse, center_of_gravity, mass_seg_i, awg, cpac
[swx.append(x) for x in wx_t]
[swy.append(y) for y in wy_t]
[swz.append(z) for z in wz_t]
- M = mass_seg_i[int(i) - 1, fuse + w + a - 1] / np.max(np.shape(wx_t))
+ M = mass_seg_i[int(i) - 1, fuse + w + a - 1] / \
+ np.max(np.shape(wx_t))
wcx_t = wx_t - (np.zeros((np.shape(wx_t))) + center_of_gravity[0])
wcy_t = wy_t - (np.zeros((np.shape(wy_t))) + center_of_gravity[1])
wcz_t = wz_t - (np.zeros((np.shape(wz_t))) + center_of_gravity[2])
diff --git a/ceasiompy/BalanceUnconventional/func/Inertia/uncinertia.py b/ceasiompy/BalanceUnconventional/func/Inertia/uncinertia.py
index 67fb3a295..8746e2c74 100644
--- a/ceasiompy/BalanceUnconventional/func/Inertia/uncinertia.py
+++ b/ceasiompy/BalanceUnconventional/func/Inertia/uncinertia.py
@@ -24,17 +24,8 @@
from . import lumpedmassesinertia
-from ceasiompy.utils.ceasiomlogger import get_logger
-log = get_logger()
-
-
-# =============================================================================
-# CLASSES
-# =============================================================================
-
-"""All classes are defined inside the classes and into
- the InputClasses/Unconventional folder."""
+from ceasiompy import log
# =============================================================================
diff --git a/ceasiompy/CLCalculator/ToolInput/.directory b/ceasiompy/CLCalculator/ToolInput/.directory
deleted file mode 100644
index 1608020c1..000000000
--- a/ceasiompy/CLCalculator/ToolInput/.directory
+++ /dev/null
@@ -1,6 +0,0 @@
-[Dolphin]
-Timestamp=2019,8,7,11,24,16
-Version=3
-
-[Settings]
-HiddenFilesShown=true
diff --git a/ceasiompy/CLCalculator/ToolInput/.keep b/ceasiompy/CLCalculator/ToolInput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/CLCalculator/ToolInput/.keep
+++ b/ceasiompy/CLCalculator/ToolInput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/CLCalculator/ToolOutput/.directory b/ceasiompy/CLCalculator/ToolOutput/.directory
deleted file mode 100644
index 954a4f861..000000000
--- a/ceasiompy/CLCalculator/ToolOutput/.directory
+++ /dev/null
@@ -1,6 +0,0 @@
-[Dolphin]
-Timestamp=2019,8,7,11,24,33
-Version=3
-
-[Settings]
-HiddenFilesShown=true
diff --git a/ceasiompy/CLCalculator/ToolOutput/.keep b/ceasiompy/CLCalculator/ToolOutput/.keep
index 8d1c8b69c..8b1378917 100644
--- a/ceasiompy/CLCalculator/ToolOutput/.keep
+++ b/ceasiompy/CLCalculator/ToolOutput/.keep
@@ -1 +1 @@
-
+
diff --git a/ceasiompy/CLCalculator/__init__.py b/ceasiompy/CLCalculator/__init__.py
index e69de29bb..809825134 100644
--- a/ceasiompy/CLCalculator/__init__.py
+++ b/ceasiompy/CLCalculator/__init__.py
@@ -0,0 +1,45 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for CLCalculator module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = True
+
+# ===== Include GUI =====
+include_gui = True
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+# ===== Add a Results Directory =====
+RES_DIR = True
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/CLCalculator/__specs__.py b/ceasiompy/CLCalculator/__specs__.py
index e404ed19b..d135af4e9 100644
--- a/ceasiompy/CLCalculator/__specs__.py
+++ b/ceasiompy/CLCalculator/__specs__.py
@@ -1,5 +1,26 @@
-from pathlib import Path
+
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+GUI Interface of CLCalculator.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
from ceasiompy.utils.moduleinterfaces import CPACSInOut
+
+from ceasiompy import log
+from ceasiompy.CLCalculator import include_gui
+
from ceasiompy.utils.commonxpath import (
REF_XPATH,
CLCALC_XPATH,
@@ -7,29 +28,25 @@
SU2_TARGET_CL_XPATH,
)
-# ===== Module Status =====
-# True if the module is active
-# False if the module is disabled (not working or not ready)
-module_status = True
-
-# ===== Results directory path =====
-
-RESULTS_DIR = Path("Results", "CLCalculator")
-
-# ===== CPACS inputs and outputs =====
+# ==============================================================================
+# VARIABLE
+# ==============================================================================
cpacs_inout = CPACSInOut()
-# ===== Input =====
+# ==============================================================================
+# GUI INPUTS
+# ==============================================================================
cpacs_inout.add_input(
var_name="mass_type",
var_type=list,
- default_value=["mTOM", "mZFM", "Custom", "% fuel mass"],
+
+ default_value=["mTOM", "mZFM", "Custom", "%% fuel mass"],
unit=None,
descr="Type of mass to use for CL calculation",
xpath=CLCALC_XPATH + "/massType",
- gui=True,
+ gui=include_gui,
gui_name="Type",
gui_group="Mass",
)
@@ -41,7 +58,7 @@
unit="kg",
descr="Mass value if Custom is selected",
xpath=CLCALC_XPATH + "/customMass",
- gui=True,
+ gui=include_gui,
gui_name="Custom mass",
gui_group="Mass",
)
@@ -50,10 +67,10 @@
var_name="percent_fuel_mass",
var_type=float,
default_value=100,
- unit="-",
+ unit=None,
descr="Percentage of fuel mass between mTOM and mZFM, if % fuel mass is selected",
xpath=CLCALC_XPATH + "/percentFuelMass",
- gui=True,
+ gui=include_gui,
gui_name="Percent fuel mass",
gui_group="Mass",
)
@@ -62,10 +79,10 @@
var_name="cruise_mach",
var_type=float,
default_value=0.78,
- unit="1",
+ unit=None,
descr="Aircraft cruise Mach number",
xpath=CLCALC_XPATH + "/cruiseMach",
- gui=True,
+ gui=include_gui,
gui_name="Mach",
gui_group="Cruise",
)
@@ -74,10 +91,10 @@
var_name="cruise_alt",
var_type=float,
default_value=12000.0,
- unit="m",
+ unit="[m]",
descr="Aircraft cruise altitude",
xpath=CLCALC_XPATH + "/cruiseAltitude",
- gui=True,
+ gui=include_gui,
gui_name="Altitude",
gui_group="Cruise",
)
@@ -86,10 +103,10 @@
var_name="load_fact",
var_type=float,
default_value=1.05,
- unit="1",
+ unit=None,
descr="Aircraft cruise altitude",
xpath=CLCALC_XPATH + "/loadFactor",
- gui=True,
+ gui=include_gui,
gui_name="Load Factor",
gui_group="Cruise",
)
@@ -98,21 +115,22 @@
var_name="ref_area",
var_type=float,
default_value=None,
- unit="m^2",
+ unit="[m^2]",
descr="Aircraft reference area",
xpath=REF_XPATH + "/area",
gui=False,
gui_name=None,
- gui_group=None,
+ gui_group="Reference Area",
)
-
-# ===== Output =====
+# ==============================================================================
+# GUI OUTPUTS
+# ==============================================================================
cpacs_inout.add_output(
var_name="target_cl",
default_value=None,
- unit="1",
+ unit=None,
descr="Value of CL to achieve to have a level flight with the given conditions",
xpath=SU2_TARGET_CL_XPATH,
)
@@ -120,7 +138,14 @@
cpacs_inout.add_output(
var_name="fixed_cl",
default_value=None,
- unit="-",
+ unit=None,
descr="FIXED_CL_MODE parameter for SU2",
xpath=SU2_FIXED_CL_XPATH,
)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/CLCalculator/clcalculator.py b/ceasiompy/CLCalculator/clcalculator.py
index ae912048c..c56038029 100644
--- a/ceasiompy/CLCalculator/clcalculator.py
+++ b/ceasiompy/CLCalculator/clcalculator.py
@@ -5,13 +5,11 @@
Calculate lift coefficient required to fly at specific alt, mach, mass and LF
-Python version: >=3.8
| Author: Aidan Jungo
| Creation: 2018-11-28
TODO:
-
* Save CruiseCL somewhere
"""
@@ -20,147 +18,55 @@
# IMPORTS
# =================================================================================================
-from pathlib import Path
+from ceasiompy.utils.ceasiompyutils import call_main
+from ceasiompy.CLCalculator.func.calculatecl import calculate_cl
-from ambiance import Atmosphere
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.ceasiompyutils import get_results_directory
-from ceasiompy.utils.commonxpath import (
- CLCALC_XPATH,
- MASSBREAKDOWN_XPATH,
- REF_XPATH,
- SU2_FIXED_CL_XPATH,
- SU2_TARGET_CL_XPATH,
- SU2_XPATH,
-)
-from ceasiompy.utils.moduleinterfaces import (
- check_cpacs_input_requirements,
- get_toolinput_file_path,
- get_tooloutput_file_path,
+from ceasiompy.CLCalculator.func.utils import (
+ retrieve_gui,
+ save_for_su2,
+ deal_with_mass,
)
-from cpacspy.cpacsfunctions import create_branch, get_value, get_value_or_default
+
+from pathlib import Path
from cpacspy.cpacspy import CPACS
from markdownpy.markdownpy import MarkdownDoc
-log = get_logger()
+from ceasiompy import log
-MODULE_DIR = Path(__file__).parent
-MODULE_NAME = MODULE_DIR.name
+from ceasiompy.CLCalculator import MODULE_NAME
# =================================================================================================
-# CLASSES
-# =================================================================================================
-
-
-# =================================================================================================
-# FUNCTIONS
+# MAIN
# =================================================================================================
-def calculate_cl(ref_area, alt, mach, mass, load_fact=1.05):
- """Function to calculate the lif coefficient (cl)
-
- Function 'calculate_cl' return the lift coefficient value for the given
- input (Reference Area, Altitude, Mach Number, Mass and Load Factor)
-
- Source:
- * Demonstration can be found in:
- /CEASIOMpy/lib/CLCalculator/doc/Calculate_CL.pdf
-
- Args:
- ref_area (float): Reference area [m^2]
- alt (float): Altitude [m]
- mach (float): Mach number [-]
- mass (float): Aircraft mass [kg]
- load_fact (float): Load Factor [-] (1.05 by default)
-
- Returns:
- target_cl (float): Lift coefficient [unit]
+def main(cpacs: CPACS, wkdir: Path) -> None:
"""
-
- # Get atmosphere values at this altitude
- Atm = Atmosphere(alt)
-
- GAMMA = 1.401 # Air heat capacity ratio [-]
-
- # Calculate lift coefficient
- weight = mass * Atm.grav_accel[0]
- dyn_pres = 0.5 * GAMMA * Atm.pressure[0] * mach**2
- target_cl = weight * load_fact / (dyn_pres * ref_area)
-
- log.info(f"A lift coefficient (CL) of {target_cl} has been calculated")
-
- return target_cl
-
-
-def get_cl(cpacs_path, cpacs_out_path):
- """Function to calculate CL required as a function of the parameter found
- in the CPACS file.
-
- Function 'get_cl' find input value in the CPACS file, calculate the
- required CL (with function calculate_cl) and save the CL value in the
- CPACS file.
-
- Args:
- cpacs_path (Path): Path to CPACS file
- cpacs_out_path (Path): Path to CPACS output file
+ Computes required CL in function
+ of the parameters found in the CPACS file.
"""
- cpacs = CPACS(cpacs_path)
tixi = cpacs.tixi
- results_dir = get_results_directory("CLCalculator")
- md = MarkdownDoc(Path(results_dir, "CL_Calculator.md"))
- md.h2("CLCalculator")
+ ref_area, mass_type, cruise_alt, cruise_mach, load_fact = retrieve_gui(tixi)
- # XPath definition
- ref_area_xpath = REF_XPATH + "/area"
- mass_type_xpath = CLCALC_XPATH + "/massType"
- custom_mass_xpath = CLCALC_XPATH + "/customMass"
- percent_fuel_mass_xpath = CLCALC_XPATH + "/percentFuelMass"
- cruise_alt_xpath = CLCALC_XPATH + "/cruiseAltitude"
- cruise_mach_xpath = CLCALC_XPATH + "/cruiseMach"
- load_fact_xpath = CLCALC_XPATH + "/loadFactor"
+ # Create Markdown file
+ md = MarkdownDoc(Path(wkdir, "CL_Calculator.md"))
+ md.h2("CLCalculator")
# Required input data from CPACS
- ref_area = get_value(tixi, ref_area_xpath)
- log.info(f"Aircraft reference area is {ref_area} [m^2]")
- md.p(f"Aircraft reference area is {ref_area} [m^2]")
+ ref_msg = f"Aircraft reference area is {ref_area} [m^2]"
+ log.info(ref_msg)
+ md.p(ref_msg)
# Mass
- mass = None
- mass_type = get_value_or_default(tixi, mass_type_xpath, "mTOM")
- md.p(f"The mass used for the calculation is {mass_type}")
-
- if mass_type == "Custom":
- mass = get_value(tixi, custom_mass_xpath)
-
- elif mass_type == "% fuel mass":
- percent_fuel_mass = get_value(tixi, percent_fuel_mass_xpath)
- md.p(f"Percentage of fuel mass: {percent_fuel_mass}%")
- mtom = get_value(tixi, MASSBREAKDOWN_XPATH + "/designMasses/mTOM/mass")
- mzfm = get_value(tixi, MASSBREAKDOWN_XPATH + "/designMasses/mZFM/mass")
- if mzfm > mtom:
- raise ValueError("mZFM is bigger than mTOM!")
- mass = (mtom - mzfm) * percent_fuel_mass / 100 + mzfm
-
- else:
- mass_xpath = MASSBREAKDOWN_XPATH + f"/designMasses/{mass_type}/mass"
- mass = get_value(tixi, mass_xpath)
-
- if mass:
- log.info(f"Aircraft mass use for this analysis is {mass} [kg]")
- else:
- raise ValueError("The chosen aircraft mass has not been found!")
+ mass = deal_with_mass(md, tixi, mass_type)
md.p(f"Mass: {mass}[kg]")
# Required input data that could be replace by a default value if missing
md.h3("Flight condition")
- cruise_alt = get_value_or_default(tixi, cruise_alt_xpath, 12000.0)
md.p(f"Cruise altitude: {cruise_alt} [m]")
- cruise_mach = get_value_or_default(tixi, cruise_mach_xpath, 0.78)
md.p(f"Cruise Mach number: {cruise_mach} [-]")
- load_fact = get_value_or_default(tixi, load_fact_xpath, 1.05)
md.p(f"Cruise load factor: {load_fact} [-]")
# CL calculation
@@ -169,35 +75,10 @@ def get_cl(cpacs_path, cpacs_out_path):
md.p(f"CL: {target_cl:.4f} [-]")
# Save TargetCL and fixedCL option
- create_branch(tixi, SU2_XPATH)
- create_branch(tixi, SU2_TARGET_CL_XPATH)
- create_branch(tixi, SU2_FIXED_CL_XPATH)
- tixi.updateDoubleElement(SU2_TARGET_CL_XPATH, target_cl, "%g")
- tixi.updateTextElement(SU2_FIXED_CL_XPATH, "YES")
- log.info("Target CL has been saved in the CPACS file")
+ save_for_su2(tixi, target_cl)
md.save()
- cpacs.save_cpacs(cpacs_out_path, overwrite=True)
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-
-def main(cpacs_path, cpacs_out_path):
-
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- check_cpacs_input_requirements(cpacs_path)
- get_cl(cpacs_path, cpacs_out_path)
-
- log.info("----- End of " + MODULE_NAME + " -----")
if __name__ == "__main__":
-
- cpacs_path = get_toolinput_file_path(MODULE_NAME)
- cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
-
- main(cpacs_path, cpacs_out_path)
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/CLCalculator/doc/Calculate_CL.pdf b/ceasiompy/CLCalculator/doc/Calculate_CL.pdf
index 6fa06ffa6..c7e492564 100644
Binary files a/ceasiompy/CLCalculator/doc/Calculate_CL.pdf and b/ceasiompy/CLCalculator/doc/Calculate_CL.pdf differ
diff --git a/ceasiompy/CLCalculator/func/calculatecl.py b/ceasiompy/CLCalculator/func/calculatecl.py
new file mode 100644
index 000000000..047f95369
--- /dev/null
+++ b/ceasiompy/CLCalculator/func/calculatecl.py
@@ -0,0 +1,77 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Calculate CL script.
+
+
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ambiance import Atmosphere
+
+from ceasiompy import log
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def calculate_cl(
+ ref_area: float,
+ alt: float,
+ mach: float,
+ mass: float,
+ load_fact: float = 1.05,
+) -> float:
+ """
+ Computes the lift coefficient value for the given set of inputs:
+ - Reference Area,
+ - Altitude,
+ - Mach Number,
+ - Mass,
+ - Load Factor.
+
+ Source:
+ /CEASIOMpy/lib/CLCalculator/doc/Calculate_CL.pdf
+
+ Args:
+ ref_area (float): Reference area [m^2].
+ alt (float): Altitude [m].
+ mach (float): Mach number [-].
+ mass (float): Aircraft mass [kg].
+ load_fact (float = 1.05): Load Factor [-].
+
+ Returns:
+ (float): Lift coefficient [???].
+
+ """
+
+ # Get atmosphere values at this altitude
+ Atm = Atmosphere(alt)
+
+ GAMMA = 1.401 # Air heat capacity ratio [-]
+
+ # Calculate lift coefficient
+ weight = mass * Atm.grav_accel[0]
+ dyn_pres = 0.5 * GAMMA * Atm.pressure[0] * mach**2
+ target_cl = weight * load_fact / (dyn_pres * ref_area)
+
+ log.info(f"A lift coefficient (CL) of {target_cl} has been calculated.")
+
+ return float(target_cl)
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/CLCalculator/func/utils.py b/ceasiompy/CLCalculator/func/utils.py
new file mode 100644
index 000000000..879be8aa0
--- /dev/null
+++ b/ceasiompy/CLCalculator/func/utils.py
@@ -0,0 +1,109 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Utils for CLCalculator.
+
+
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from cpacspy.cpacsfunctions import (
+ get_value,
+ create_branch,
+)
+
+from tixi3.tixi3wrapper import Tixi3
+from markdownpy.markdownpy import MarkdownDoc
+
+from ceasiompy.utils.commonxpath import (
+ SU2_XPATH,
+ REF_XPATH,
+ CLCALC_XPATH,
+ SU2_FIXED_CL_XPATH,
+ SU2_TARGET_CL_XPATH,
+ MASSBREAKDOWN_XPATH,
+)
+
+from ceasiompy import log
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def save_for_su2(tixi: Tixi3, target_cl: float) -> None:
+ create_branch(tixi, SU2_XPATH)
+ create_branch(tixi, SU2_TARGET_CL_XPATH)
+ create_branch(tixi, SU2_FIXED_CL_XPATH)
+ tixi.updateDoubleElement(SU2_TARGET_CL_XPATH, target_cl, "%g")
+ tixi.updateTextElement(SU2_FIXED_CL_XPATH, "YES")
+ log.info("Target CL has been saved in the CPACS file")
+
+
+def retrieve_gui(tixi: Tixi3):
+ """
+ Retrieve values from CPACS file.
+ """
+ # XPath definition
+ # TODO: Put these xpaths in commonxpaths
+ ref_area_xpath = REF_XPATH + "/area"
+ mass_type_xpath = CLCALC_XPATH + "/massType"
+ cruise_alt_xpath = CLCALC_XPATH + "/cruiseAltitude"
+ cruise_mach_xpath = CLCALC_XPATH + "/cruiseMach"
+ load_fact_xpath = CLCALC_XPATH + "/loadFactor"
+
+ ref_area = get_value(tixi, ref_area_xpath)
+ mass_type = get_value(tixi, mass_type_xpath)
+
+ cruise_alt = get_value(tixi, cruise_alt_xpath)
+ cruise_mach = get_value(tixi, cruise_mach_xpath)
+ load_fact = get_value(tixi, load_fact_xpath)
+
+ return ref_area, mass_type, cruise_alt, cruise_mach, load_fact
+
+
+def deal_with_mass(md: MarkdownDoc, tixi: Tixi3, mass_type: str) -> float:
+ mass = None
+ md.p(f"The mass used for the calculation is {mass_type}")
+
+ percent_fuel_mass_xpath = CLCALC_XPATH + "/percentFuelMass"
+ custom_mass_xpath = CLCALC_XPATH + "/customMass"
+
+ if mass_type == "Custom":
+ mass = get_value(tixi, custom_mass_xpath)
+
+ elif mass_type == "% fuel mass":
+ percent_fuel_mass = get_value(tixi, percent_fuel_mass_xpath)
+ md.p(f"Percentage of fuel mass: {percent_fuel_mass}%")
+ mtom = get_value(tixi, MASSBREAKDOWN_XPATH + "/designMasses/mTOM/mass")
+ mzfm = get_value(tixi, MASSBREAKDOWN_XPATH + "/designMasses/mZFM/mass")
+ if mzfm > mtom:
+ raise ValueError("mZFM is bigger than mTOM!")
+ mass = (mtom - mzfm) * percent_fuel_mass / 100 + mzfm
+
+ else:
+ mass_xpath = MASSBREAKDOWN_XPATH + f"/designMasses/{mass_type}/mass"
+ mass = get_value(tixi, mass_xpath)
+
+ if mass:
+ log.info(f"Aircraft mass use for this analysis is {mass} [kg]")
+ else:
+ raise ValueError("The chosen aircraft mass has not been found!")
+
+ return mass
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/CLCalculator/tests/test_clcalculator.py b/ceasiompy/CLCalculator/tests/test_clcalculator.py
index e723a6ae1..afeea4177 100644
--- a/ceasiompy/CLCalculator/tests/test_clcalculator.py
+++ b/ceasiompy/CLCalculator/tests/test_clcalculator.py
@@ -5,25 +5,30 @@
Test functions for 'lib/CLCalculator/clcalculator.py'
-Python version: >=3.8
| Author : Aidan Jungo
| Creation: 2019-07-24
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
"""
# =================================================================================================
# IMPORTS
# =================================================================================================
+from ceasiompy.CLCalculator.clcalculator import calculate_cl
from pathlib import Path
-
-from ceasiompy.CLCalculator.clcalculator import calculate_cl, get_cl
-from ceasiompy.utils.commonxpath import SU2_TARGET_CL_XPATH
-from cpacspy.cpacsfunctions import open_tixi
from pytest import approx
-MODULE_DIR = Path(__file__).parent
+from ceasiompy.utils.decorators import log_test
+
+from unittest import main
+from ceasiompy.utils.ceasiompytest import CeasiompyTest
+
+from ceasiompy.CLCalculator import MODULE_DIR
+
CPACS_IN_PATH = Path(MODULE_DIR, "D150_simple.xml")
CPACS_OUT_PATH = Path(MODULE_DIR, "D150_simple_clcalulator_test.xml")
@@ -32,6 +37,16 @@
# =================================================================================================
+class TestModuleTemplate(CeasiompyTest):
+
+ @log_test
+ def test_calculate_cl(self):
+ self.assert_equal_function(
+ f=calculate_cl,
+ input_args=(122, 12_000, 0.78, 50_000, 1.0, ),
+ expected=(approx(0.48429196151547343), ),
+ )
+
# =================================================================================================
# FUNCTIONS
# =================================================================================================
@@ -50,27 +65,10 @@ def test_calculate_cl():
assert cl == approx(0.48429196151547343)
-
-def test_get_cl():
- """Test function 'get_cl'"""
-
- get_cl(CPACS_IN_PATH, CPACS_OUT_PATH)
-
- tixi = open_tixi(CPACS_OUT_PATH)
-
- cl_to_check = tixi.getDoubleElement(SU2_TARGET_CL_XPATH)
- assert cl_to_check == approx(0.791955)
-
- if CPACS_OUT_PATH.exists():
- CPACS_OUT_PATH.unlink()
-
-
# =================================================================================================
# MAIN
# =================================================================================================
-if __name__ == "__main__":
- print("Running Test CL Calulator")
- print("To run test use the following command:")
- print(">> pytest -v")
+if __name__ == "__main__":
+ main(verbosity=0)
diff --git a/ceasiompy/CPACS2GMSH/README.md b/ceasiompy/CPACS2GMSH/README.md
index 2480decb3..f440e602d 100644
--- a/ceasiompy/CPACS2GMSH/README.md
+++ b/ceasiompy/CPACS2GMSH/README.md
@@ -10,9 +10,9 @@
+
+
+ N2 Information
+
+
+
+
+
+ 
+
+# CPACSUpdater
+
+**Categories:** CPACS modifier
+
+**State**: :heavy_check_mark:
+
+This is a template module. Its purpose is to illustrate how other modules of CEASIOMpy should be structured, set up and documented.
+
+
+
+
+
+
+
+
+
+# Database
+
+**Categories:** Database, Data
+
+**State**: :heavy_check_mark:
+
+## Inputs
+
+Needs a workflow to be generated and done.
+
+## Analyses
+
+Analyses nothing. It stores automatically the "important" data in a preSQL database.
+
+## Outputs
+
+Outputs nothing.
+
+## Installation or requirements
+
+Database is a native CEASIOMpy module.
+
+## Limitations
+
+- Exists only one table per module data.
+- Not compatible with Weight and Balance modules of CEASIOMpy.
+
+## More information
+
+NA
\ No newline at end of file
diff --git a/ceasiompy/Database/__init__.py b/ceasiompy/Database/__init__.py
new file mode 100644
index 000000000..710c94df7
--- /dev/null
+++ b/ceasiompy/Database/__init__.py
@@ -0,0 +1,44 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for Database module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = True
+
+# ===== Include GUI =====
+include_gui = True
+
+# ===== Add a Results Directory =====
+RES_DIR = False
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/Database/__specs__.py b/ceasiompy/Database/__specs__.py
new file mode 100644
index 000000000..6ac584def
--- /dev/null
+++ b/ceasiompy/Database/__specs__.py
@@ -0,0 +1,51 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+GUI Interface of Database.
+
+
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.utils.moduleinterfaces import CPACSInOut
+
+from ceasiompy import log
+from ceasiompy.Database import include_gui
+from ceasiompy.utils.commonxpath import DATABASE_STOREDATA_XPATH
+
+# ==============================================================================
+# VARIABLE
+# ==============================================================================
+
+# ===== CPACS inputs and outputs =====
+cpacs_inout = CPACSInOut()
+
+# ==============================================================================
+# GUI INPUTS
+# ==============================================================================
+
+cpacs_inout.add_input(
+ var_name="store",
+ var_type=bool,
+ default_value=True,
+ unit=None,
+ xpath=DATABASE_STOREDATA_XPATH,
+ gui=include_gui,
+ gui_name="Store data",
+ gui_group="Storing Settings",
+)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/Database/database.py b/ceasiompy/Database/database.py
new file mode 100644
index 000000000..7b0627261
--- /dev/null
+++ b/ceasiompy/Database/database.py
@@ -0,0 +1,46 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Main scripts for Database module.
+
+
+| Author: Leon Deligny
+| Creation: 03-Mar-2025
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+from cpacspy.cpacsfunctions import get_value
+from ceasiompy.utils.ceasiompyutils import bool_
+from ceasiompy.Database.func.storing import store_data
+
+from cpacspy.cpacspy import CPACS
+
+from ceasiompy import log
+from ceasiompy.utils.commonxpath import DATABASE_STOREDATA_XPATH
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+def main(cpacs: CPACS) -> None:
+ tixi = cpacs.tixi
+
+ # Check if we store data
+ if bool_(get_value(tixi, DATABASE_STOREDATA_XPATH)):
+ store_data(tixi)
+ else:
+ log.info("Did not call database.")
+
+
+if __name__ == "__main__":
+ # If you want to test your new functions
+ # or classes go in the tests folder of this module.
+ # You will add data to ceasiompy.db if you run this module.
+ log.info("Nothing to execute.")
diff --git a/ceasiompy/Database/func/__init__.py b/ceasiompy/Database/func/__init__.py
new file mode 100644
index 000000000..0898aacf7
--- /dev/null
+++ b/ceasiompy/Database/func/__init__.py
@@ -0,0 +1,152 @@
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy import log
+from ceasiompy.PyAVL import MODULE_NAME as PYAVL_NAME
+# from ceasiompy.SU2Run import MODULE_NAME as SU2RUN_NAME
+from ceasiompy.CPACS2GMSH import MODULE_NAME as CPACS2GMSH_NAME
+from ceasiompy.DynamicStability import MODULE_NAME as DYNSTAB_NAME
+
+# ==============================================================================
+# CONSTANTS
+# ==============================================================================
+
+# Tables structure of ceasiompy.db
+TABLE_DICT = {
+ f"{PYAVL_NAME}": [
+ "avl_data",
+ """
+ aircraft TEXT,
+
+ alt REAL,
+ mach REAL,
+ alpha REAL,
+ beta REAL,
+
+ pb_2V REAL,
+ qc_2V REAL,
+ rb_2V REAL,
+
+ flap REAL,
+ aileron REAL,
+ elevator REAL,
+ rudder REAL,
+
+ xref REAL,
+ yref REAL,
+ zref REAL,
+
+ cd REAL,
+ cs REAL,
+ cl REAL,
+
+ cmd REAL,
+ cms REAL,
+ cml REAL,
+
+ cmd_a REAL,
+ cms_a REAL,
+ cml_a REAL,
+
+ cmd_b REAL,
+ cms_b REAL,
+ cml_b REAL,
+ """
+ ],
+ f"{CPACS2GMSH_NAME}": [
+ "gmsh_data",
+ """
+ aircraft TEXT,
+ deformation TEXT,
+ angle REAL,
+ su2_file_data BLOB,
+ """
+ ],
+ f"{DYNSTAB_NAME}": [
+ "derivatives_data",
+ """
+ aircraft TEXT,
+
+ method TEXT,
+
+ chord INT,
+ span INT,
+
+ mach REAL,
+
+ x_ref REAL,
+ y_ref REAL,
+ z_ref REAL,
+
+ cm_alphaprim REAL,
+ cz_alphaprim REAL,
+ cx_alphaprim REAL,
+
+ cy_betaprim REAL,
+ cl_betaprim REAL,
+ cn_betaprim REAL,
+ """
+ ],
+}
+
+ALLOWED_TABLES = [value[0] for value in TABLE_DICT.values()]
+
+TABLE_TO_MODULE = {item[0]: key for key, item in TABLE_DICT.items()}
+
+ALLOWED_COLUMNS = {
+ table: [
+ line.strip().split()[0] # Extract column names from the SQL-like definitions
+ for line in TABLE_DICT[TABLE_TO_MODULE[table]][1].splitlines()
+ if line.strip() and not line.strip().startswith("--") # Ignore empty lines and comments
+ ]
+ for table in ALLOWED_TABLES
+}
+
+# How to extract aerodynamic coefficients in st.txt
+PYAVL_ST = {
+ "Alpha": (1, "alpha"),
+ "Beta": (1, "beta"),
+ "Mach": (1, "mach"),
+
+ "pb/2V": (2, "pb_2V"),
+ "qc/2V": (2, "qc_2V"),
+ "rb/2V": (2, "rb_2V"),
+
+ "flap": (1, "flap"),
+ "aileron": (1, "aileron"),
+ "elevator": (1, "elevator"),
+ "rudder": (1, "rudder"),
+
+ "Xref": (1, "xref"),
+ "Yref": (2, "yref"),
+ "Zref": (3, "zref"),
+
+ "CDtot": (1, "cd"),
+ "CYtot": (1, "cs"),
+ "CLtot": (1, "cl"),
+
+ "Cltot": (2, "cmd"),
+ "Cmtot": (2, "cms"),
+ "Cntot": (2, "cml"),
+
+ "Cla": (1, "cmd_a"),
+ "Cma": (1, "cms_a"),
+ "Cna": (1, "cml_a"),
+
+ "Clb": (2, "cmd_b"),
+ "Cmb": (2, "cms_b"),
+ "Cnb": (2, "cml_b"),
+}
+
+# pyavl.py
+PYAVL_CTRLSURF = ["flap", "aileron", "elevator", "rudder"]
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/cpacs2gmsh.py b/ceasiompy/Database/func/cpacs2gmsh.py
new file mode 100644
index 000000000..fb7085849
--- /dev/null
+++ b/ceasiompy/Database/func/cpacs2gmsh.py
@@ -0,0 +1,86 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Store data from workflow modules.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Mar-03
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.Database.func.utils import data_to_db
+from ceasiompy.utils.ceasiompyutils import aircraft_name
+
+from pathlib import Path
+from sqlite3 import Cursor
+from tixi3.tixi3wrapper import Tixi3
+
+from ceasiompy import log
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def store_cpacs2gmsh_data(
+ cursor: Cursor,
+ wkdir: Path,
+ tixi: Tixi3,
+ table_name: str,
+) -> None:
+ """
+ Store data from Results/GMSH.
+
+ Args:
+ cursor (Cursor): gmsh_data table from 'ceasiompy.db' cursor.
+ wkdir (Path): Results/GMSH directory.
+ tixi (Tixi3): Tixi handle of CPACS file.
+
+ """
+ table_name = "gmsh_data"
+ files_list = list(wkdir.glob("*.su2"))
+
+ name = str(aircraft_name(tixi))
+
+ for file in sorted(files_list):
+ file_name = str(file.name)
+
+ if "_" in str(file_name):
+ deformation: str = file_name.split("_")[1]
+ angle = float(file_name.split("_")[2].replace(".su2", ""))
+ else:
+ deformation: str = "no_deformation"
+ angle: float = 0.0
+
+ log.info(
+ f"Storing file {file_name}, "
+ f"aircraft={name}, "
+ f"deformation={deformation}, "
+ f"angle={angle}."
+ )
+
+ with open(file, 'rb') as file:
+ file_data = file.read()
+ data = {
+ "su2_file_data": file_data,
+ "aircraft": name,
+ "deformation": deformation,
+ "angle": angle,
+ }
+
+ data_to_db(cursor, data, table_name)
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/dynamicstability.py b/ceasiompy/Database/func/dynamicstability.py
new file mode 100644
index 000000000..c00dfcd6b
--- /dev/null
+++ b/ceasiompy/Database/func/dynamicstability.py
@@ -0,0 +1,107 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Store data from workflow modules.
+
+
+| Author: Leon Deligny
+| Creation: 10-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+import pandas as pd
+
+from cpacspy.cpacsfunctions import get_value
+from ceasiompy.Database.func.utils import data_to_db
+from ceasiompy.utils.ceasiompyutils import aircraft_name
+
+from pathlib import Path
+from sqlite3 import Cursor
+from tixi3.tixi3wrapper import Tixi3
+
+from ceasiompy import log
+
+from ceasiompy.utils.commonxpath import (
+ DYNAMICSTABILITY_NSPANWISE_XPATH,
+ DYNAMICSTABILITY_NCHORDWISE_XPATH,
+)
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def store_dynstab_data(
+ cursor: Cursor,
+ wkdir: Path,
+ tixi: Tixi3,
+ table_name: str,
+) -> None:
+ """
+ Store data from Results/DynamicStability.
+
+ Args:
+ cursor (Cursor): avl_data table from 'ceasiompy.db' cursor.
+ wkdir (Path): Results/PyAVL directory.
+ tixi (Tixi3): Tixi handle of CPACS file.
+
+ Raises:
+ FileNotFoundError: If no Force files are found.
+
+ """
+ table_name = "derivatives_data"
+ name = str(aircraft_name(tixi))
+
+ # Append data to it
+ data = {}
+
+ # Add aircraft name
+ data["aircraft"] = name
+
+ # Define the path to the SDSA_input.xml file
+ csv = wkdir / "alpha_beta_dot_derivatives.csv"
+
+ # For sure is DLM Method
+ if csv.exists():
+ # Load the CSV file into a DataFrame
+ df = pd.read_csv(csv)
+
+ chord = get_value(tixi, DYNAMICSTABILITY_NCHORDWISE_XPATH)
+ span = get_value(tixi, DYNAMICSTABILITY_NSPANWISE_XPATH)
+ method = "DLM"
+
+ # Iterate over the rows of the DataFrame
+ for _, row in df.iterrows():
+ # Populate the data dictionary with the values from the DataFrame row
+ data = {
+ "aircraft": name,
+ "method": method,
+ "chord": chord,
+ "span": span,
+ "mach": row['mach'],
+ "x_ref": row['x_ref'],
+ "y_ref": row['y_ref'],
+ "z_ref": row['z_ref'],
+ "cm_alphaprim": row['cm_alphaprim'],
+ "cz_alphaprim": row['cz_alphaprim'],
+ "cx_alphaprim": row['cx_alphaprim'],
+ "cy_betaprim": row['cy_betaprim'],
+ "cl_betaprim": row['cl_betaprim'],
+ "cn_betaprim": row['cn_betaprim'],
+ }
+
+ data_to_db(cursor, data, table_name)
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/pyavl.py b/ceasiompy/Database/func/pyavl.py
new file mode 100644
index 000000000..810e3c079
--- /dev/null
+++ b/ceasiompy/Database/func/pyavl.py
@@ -0,0 +1,136 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Store data from workflow modules.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Mar-03
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.utils.ceasiompyutils import aircraft_name
+
+from ceasiompy.Database.func.utils import (
+ data_to_db,
+ split_line,
+)
+
+from typing import Dict
+from pathlib import Path
+from sqlite3 import Cursor
+from tixi3.tixi3wrapper import Tixi3
+
+from ceasiompy import log
+from ceasiompy.Database.func import (
+ PYAVL_ST,
+ PYAVL_CTRLSURF,
+)
+
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def store_results(
+ results: Dict,
+ key: str,
+ line: str,
+ index: int,
+ var_name: str,
+) -> None:
+ parts = line.split('=')
+
+ # Handle special case for keys like "Clb" and "Cnb"
+ if key in ["Clb", "Cnb"]:
+ if len(parts) > 2:
+ results[var_name] = split_line(line, index)
+
+ # Handle control surface keys or general case
+ elif key in PYAVL_CTRLSURF:
+ if len(parts) == 2:
+ results[var_name] = split_line(line, index)
+
+ # General case for other keys
+ else:
+ results[var_name] = split_line(line, index)
+
+
+def get_avl_data(force_file: Path) -> Dict:
+ """
+ Get aerodynamic coefficients and velocity
+ from AVL total forces file (sb.txt).
+ """
+
+ results = {var_name: None for _, var_name in PYAVL_ST.values()}
+
+ with open(force_file) as f:
+ for line in f.readlines():
+ for key, (index, var_name) in PYAVL_ST.items():
+ if key in line:
+ store_results(
+ results,
+ key,
+ line,
+ index,
+ var_name,
+ )
+ return results
+
+
+def store_pyavl_data(
+ cursor: Cursor,
+ wkdir: Path,
+ tixi: Tixi3,
+ table_name: str,
+) -> None:
+ """
+ Store data from Results/PyAVL.
+
+ Args:
+ cursor (Cursor): avl_data table from 'ceasiompy.db' cursor.
+ wkdir (Path): Results/PyAVL directory.
+ tixi (Tixi3): Tixi handle of CPACS file.
+
+ Raises:
+ FileNotFoundError: If no Force files are found.
+
+ """
+
+ case_dir_list = [case_dir for case_dir in wkdir.iterdir() if "Case" in case_dir.name]
+ txt_file_name = "st.txt"
+ name = str(aircraft_name(tixi))
+
+ for config_dir in sorted(case_dir_list):
+ # Checks if config_dir is a directory
+ if not config_dir.is_dir():
+ continue
+
+ alt = float(config_dir.name.split("_")[1].split("alt")[1])
+ file_path = Path(config_dir, txt_file_name)
+
+ if not file_path.exists():
+ raise FileNotFoundError(
+ f"No result total forces '{txt_file_name}' file have been found!")
+
+ # Append data to it
+ data = get_avl_data(file_path)
+ data["aircraft"] = name
+ data["alt"] = alt
+
+ data_to_db(cursor, data, table_name)
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/storing.py b/ceasiompy/Database/func/storing.py
new file mode 100644
index 000000000..5ed4b52ce
--- /dev/null
+++ b/ceasiompy/Database/func/storing.py
@@ -0,0 +1,216 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Store data from workflow modules.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Mar-03
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from sqlite3 import connect
+from ceasiompy.Database.func.utils import create_db
+from ceasiompy.Database.func.pyavl import store_pyavl_data
+from ceasiompy.Database.func.su2run import store_su2run_data
+from ceasiompy.utils.ceasiompyutils import get_results_directory
+from ceasiompy.Database.func.cpacs2gmsh import store_cpacs2gmsh_data
+from ceasiompy.Database.func.dynamicstability import store_dynstab_data
+
+from pathlib import Path
+from sqlite3 import Cursor
+from sqlite3 import Connection
+from tixi3.tixi3wrapper import Tixi3
+
+from typing import (
+ List,
+ Tuple,
+ Callable,
+)
+
+from ceasiompy import log
+from ceasiompy.PyAVL import MODULE_NAME as PYAVL_NAME
+from ceasiompy.SU2Run import MODULE_NAME as SU2RUN_NAME
+from ceasiompy.utils.commonpaths import CEASIOMPY_DB_PATH
+from ceasiompy.CPACS2GMSH import MODULE_NAME as CPACS2GMSH_NAME
+from ceasiompy.DynamicStability import MODULE_NAME as DYNSTAB_NAME
+
+from ceasiompy.Database.func import TABLE_DICT, ALLOWED_TABLES, ALLOWED_COLUMNS
+
+# ==============================================================================
+# CLASS
+# ==============================================================================
+
+
+class CeasiompyDb:
+ """ceasiompy.db class manager"""
+
+ # Load constants
+ table_dict = TABLE_DICT
+
+ def __init__(self: 'CeasiompyDb', db_path: Path = CEASIOMPY_DB_PATH) -> None:
+ # Initialize constants
+ self.db_path = db_path
+ self.db_name = self.db_path.name
+
+ # Create db if not exists
+ if not self.db_path.exists():
+ create_db(self.db_path)
+
+ self.connection: Connection = connect(self.db_path)
+ self.cursor: Cursor = self.connection.cursor()
+
+ log.info(
+ f"Connecting to database {self.db_name} at path {self.db_path}")
+
+ def connect_to_table(self, module_name: str) -> str:
+ table_name, table_schema = self.get_table_parameters(module_name)
+ # Codacy: Table and column names are strictly validated against whitelisted values.
+ # Table names are validated against ALLOWED_TABLES.
+
+ # Validate table name
+ if table_name not in ALLOWED_TABLES:
+ raise ValueError(f"Invalid table name: {table_name}")
+
+ create_table_query = f"""
+ CREATE TABLE IF NOT EXISTS {table_name} (
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
+ {table_schema}
+ timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+ )
+ """
+
+ self.cursor.execute(create_table_query)
+ self.commit()
+
+ return table_name
+
+ def get_table_name(self, module_name: str) -> str:
+ return self.table_dict[module_name][0]
+
+ def get_table_schema(self, module_name: str) -> str:
+ return self.table_dict[module_name][1]
+
+ def get_table_parameters(self, module_name: str) -> Tuple[str, str]:
+ return self.get_table_name(module_name), self.get_table_schema(module_name)
+
+ def commit(self) -> None:
+ self.connection.commit()
+
+ def close(self) -> None:
+ log.info(f"Closing connection to database {self.db_name}.")
+ self.connection.close()
+
+ def get_data(
+ self,
+ table_name: str,
+ columns: List[str],
+ db_close=False,
+ filters: List[str] = None,
+ ) -> List[Tuple]:
+ # Codacy: Table and column names are strictly validated against whitelisted values.
+ # Table and column names are validated against ALLOWED_TABLES and ALLOWED_COLUMNS.
+
+ # Validate table name
+ if table_name not in ALLOWED_TABLES:
+ raise ValueError(f"Invalid table name: {table_name}")
+
+ # Validate column names
+ if not all(col in ALLOWED_COLUMNS[table_name] for col in columns):
+ raise ValueError(f"Invalid column name(s): {columns}")
+
+ # Safely construct the query
+ columns_str = ", ".join([f"`{col}`" for col in columns]) # Escape column names
+ query = f"SELECT {columns_str} FROM `{table_name}`" # nosec
+
+ # Handle filters
+ params = []
+ if filters is not None:
+ filter_clauses = []
+ for column, value in filters:
+ if column not in ALLOWED_COLUMNS:
+ raise ValueError(f"Invalid column name in filter: {column}")
+ filter_clauses.append(f"`{column}` = ?") # Escape column names
+ params.append(value)
+ query += " WHERE " + " AND ".join(filter_clauses)
+
+ # Execute the query with parameters
+ self.cursor.execute(query, params)
+
+ data = self.cursor.fetchall()
+
+ if db_close:
+ self.close()
+
+ return data
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def call_store_data(
+ tixi: Tixi3,
+ store2db: Callable[[Cursor, Path, Tixi3, str], None],
+ wkdir: Path,
+ module_name: str,
+) -> None:
+ """
+ Stores data in correct table.
+ """
+
+ # Connect to db
+ ceasiompy_db = CeasiompyDb()
+ table_name = ceasiompy_db.connect_to_table(module_name)
+
+ # Store data
+ store2db(ceasiompy_db.cursor, wkdir, tixi, table_name)
+ log.info(f"Finished storing data in table {table_name}.")
+
+ # Commit changes and close the connection
+ ceasiompy_db.commit()
+ ceasiompy_db.close()
+
+
+def store_data(tixi: Tixi3) -> None:
+ """
+ Looks at the workflow and stores data.
+ Implemented for modules:
+ - 'PyAVL': Aerodynamic Coefficients.
+ - 'CPACS2GMSH': .su2 file.
+ - 'DynamicStability': Dot-derivatives coefficients from PanelAero.
+ - 'SU2Run': Forces, moments and dot-derivatives.
+ """
+
+ # You do not want to create a results directory "PyAVL"
+ # with get_results_dir("PyAVL") if it does not exist.
+ # Only access the path and then check if it exists.
+ avl_dir: Path = get_results_directory(PYAVL_NAME, create=False)
+ gmsh_dir: Path = get_results_directory(CPACS2GMSH_NAME, create=False)
+ dynstab_dir: Path = get_results_directory(DYNSTAB_NAME, create=False)
+ su2_dir: Path = get_results_directory(SU2RUN_NAME, create=False)
+
+ if avl_dir.is_dir():
+ call_store_data(tixi, store_pyavl_data, avl_dir, PYAVL_NAME)
+ if gmsh_dir.is_dir():
+ call_store_data(tixi, store_cpacs2gmsh_data, gmsh_dir, CPACS2GMSH_NAME)
+ if dynstab_dir.is_dir():
+ call_store_data(tixi, store_dynstab_data, dynstab_dir, DYNSTAB_NAME)
+ if su2_dir.is_dir():
+ call_store_data(tixi, store_su2run_data, su2_dir, SU2RUN_NAME)
+ log.warning("Not implemented yet.")
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/su2run.py b/ceasiompy/Database/func/su2run.py
new file mode 100644
index 000000000..2e9a10b42
--- /dev/null
+++ b/ceasiompy/Database/func/su2run.py
@@ -0,0 +1,53 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Store data from SU2Run results.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Mar-03
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+from sqlite3 import Cursor
+from tixi3.tixi3wrapper import Tixi3
+
+from ceasiompy import log
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def store_su2run_data(
+ cursor: Cursor,
+ wkdir: Path,
+ tixi: Tixi3,
+ table_name: str,
+) -> None:
+ """
+ Store data from Results/SU2.
+
+ Args:
+ cursor (Cursor): gmsh_data table from 'ceasiompy.db' cursor.
+ wkdir (Path): Results/SU2 directory.
+ tixi (Tixi3): Tixi handle of CPACS file.
+
+ """
+ raise NotImplementedError("store_su2run_data not implemented")
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/func/utils.py b/ceasiompy/Database/func/utils.py
new file mode 100644
index 000000000..3a554e25b
--- /dev/null
+++ b/ceasiompy/Database/func/utils.py
@@ -0,0 +1,132 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Utils for Database module.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Mar-03
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+import sqlite3
+
+from pathlib import Path
+from sqlite3 import Cursor
+
+from typing import (
+ List,
+ Dict,
+)
+
+from ceasiompy import log
+from ceasiompy.utils.commonpaths import CEASIOMPY_DB_PATH
+
+from ceasiompy.Database.func import (
+ ALLOWED_TABLES,
+ ALLOWED_COLUMNS,
+)
+
+# ==============================================================================
+# FUNCTIONS
+# ==============================================================================
+
+
+def split_line(line: str, index: int) -> float:
+ """
+ Splits a line with "=" sign and keeps only the value at specified index.
+ """
+ return float(line.split("=")[index].strip().split()[0])
+
+
+def create_db(path: Path = CEASIOMPY_DB_PATH) -> None:
+ """
+ Creates a database at specified path.
+ """
+
+ # Make sure parent directory exists
+ if not path.parent.is_dir():
+ log.info(f"Creating directory at {path.parent}")
+ path.parent.mkdir(parents=True, exist_ok=True)
+
+ # Create database if it does not exist
+ conn = sqlite3.connect(path)
+ conn.close()
+ log.info(f"Database created at {path}.")
+
+
+def check_in_table(cursor: Cursor, data: Dict, columns: List, table_name: str) -> bool:
+ """
+ Checks if data is already in the table using a raw cursor.
+ """
+ # Codacy: Table and column names are strictly validated against whitelisted values.
+ # Validate table name
+ if table_name not in ALLOWED_TABLES:
+ raise ValueError(f"Invalid table name: {table_name}")
+
+ # Validate column names
+ if not all(col in ALLOWED_COLUMNS[table_name] for col in columns):
+ raise ValueError(f"Invalid column name(s): {columns}")
+
+ # Build the WHERE clause dynamically
+ where_clause = " AND ".join([f"{col} = ?" for col in columns])
+ query = f"SELECT 1 FROM {table_name} WHERE {where_clause} LIMIT 1" # nosec
+ params = tuple(data[col] for col in columns)
+
+ cursor.execute(query, params)
+ return cursor.fetchone() is not None
+
+
+def data_to_db(cursor: Cursor, data: Dict, table_name: str) -> None:
+ """
+ Inserts one line at a time if not already in table.
+ """
+
+ # Table names are validated against ALLOWED_TABLES.
+ columns = list(data.keys())
+
+ # Validate table name
+ if table_name not in ALLOWED_TABLES:
+ raise ValueError(f"Invalid table name: {table_name}")
+
+ # Validate column names
+ invalid_columns = [col for col in columns if col not in ALLOWED_COLUMNS[table_name]]
+ if invalid_columns:
+ raise ValueError(f"Invalid column name(s): {invalid_columns}")
+
+ if check_in_table(cursor, data, columns, table_name):
+ log.info(f"{data.values()} already in {table_name}.")
+ else:
+ # Safely escape table and column names
+ escaped_table_name = f'"{table_name}"'
+ escaped_columns = ", ".join(f'"{col}"' for col in columns)
+
+ # Create the SQL statement dynamically
+ placeholders = ", ".join(["?" for _ in columns])
+
+ # Codacy: Table and column names are strictly validated against whitelisted values.
+ query = f"""
+ INSERT INTO {escaped_table_name} (
+ {escaped_columns}
+ ) VALUES (
+ {placeholders}
+ )
+ """ # nosec
+
+ # Execute the statement with values
+ cursor.execute(query, tuple(data.values()))
+
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/Database/tests/databases/testceasiompy.db b/ceasiompy/Database/tests/databases/testceasiompy.db
new file mode 100644
index 000000000..e043f825d
Binary files /dev/null and b/ceasiompy/Database/tests/databases/testceasiompy.db differ
diff --git a/ceasiompy/Database/tests/test_utils.py b/ceasiompy/Database/tests/test_utils.py
new file mode 100644
index 000000000..47972b1e3
--- /dev/null
+++ b/ceasiompy/Database/tests/test_utils.py
@@ -0,0 +1,85 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Test functions for Database module.
+
+
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+from ceasiompy.utils.decorators import log_test
+
+from ceasiompy.Database.func.utils import (
+ create_db,
+ data_to_db,
+)
+
+from pathlib import Path
+from unittest import main
+from ceasiompy.Database.func.storing import CeasiompyDb
+from ceasiompy.utils.ceasiompytest import CeasiompyTest
+
+from ceasiompy import log
+from ceasiompy.PyAVL import MODULE_NAME as PYAVL_NAME
+from ceasiompy.utils.commonpaths import TESTCEASIOMPY_DB_PATH
+
+# =================================================================================================
+# CLASSES
+# =================================================================================================
+
+
+class TestDatabase(CeasiompyTest):
+
+ @classmethod
+ def setUpClass(cls: 'TestDatabase') -> None:
+ cls.testceasiompy_db_path: Path = TESTCEASIOMPY_DB_PATH
+
+ @log_test
+ def test_create_db(self: 'TestDatabase') -> None:
+ create_db(path=self.testceasiompy_db_path)
+ self.assertTrue(self.testceasiompy_db_path.exists(), "Database file was not created")
+
+ # Remove if exists
+ if self.testceasiompy_db_path.exists():
+ self.testceasiompy_db_path.unlink()
+
+ @log_test
+ def test_data_to_db(self: 'TestDatabase') -> None:
+ # Define constants
+ module_name = PYAVL_NAME # test on AVL module
+ data = {
+ "aircraft": "test_aircraft",
+ "mach": 0.0, "alpha": 0.0, "beta": 0.0,
+ "pb_2V": 0.0, "qc_2V": 0.0, "rb_2V": 0.0,
+ "flap": 0.0, "aileron": 0.0, "elevator": 0.0, "rudder": 0.0,
+ "xref": 0.0, "yref": 0.0, "zref": 0.0,
+ "cd": 0.0, "cs": 0.0, "cl": 0.0,
+ "cmd": 0.0, "cms": 0.0, "cml": 0.0,
+ "cmd_a": 0.0, "cms_a": 0.0, "cml_a": 0.0,
+ "cmd_b": 0.0, "cms_b": 0.0, "cml_b": 0.0,
+ }
+
+ testceasiompy_db = CeasiompyDb(db_path=self.testceasiompy_db_path)
+ table_name = testceasiompy_db.connect_to_table(module_name)
+
+ data_to_db(testceasiompy_db.cursor, data, table_name)
+ log.info(f"Successfully stored data in table {table_name}.")
+
+ testceasiompy_db.commit()
+ testceasiompy_db.close()
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ main(verbosity=0)
diff --git a/ceasiompy/DynamicStability/README.md b/ceasiompy/DynamicStability/README.md
new file mode 100644
index 000000000..75d9574f5
--- /dev/null
+++ b/ceasiompy/DynamicStability/README.md
@@ -0,0 +1,46 @@
+
+
+# DynamicStability
+
+**Categories:** Aerodynamics, Dynamic, Stability
+
+**State**: :heavy_check_mark:
+
+## Inputs
+
+Before hand, you need to use the PyAVL module and store enough data into ceasiompy.db to use this module.
+
+Once you done that, you can:
+ 1. Choose the different mach numbers for your stability analysis.
+ 2. Choose the aircraft
+ 3. If you haven't computed any dot-derivatives 'DynamicStability' will use the Doublet Lattice Method in the frequency domain to compute those.
+
+## Analyses
+
+1. Computes unsteady derivatives through the Doublet Lattice Method (PanelAero).
+2. Opens SDSA with all the necessary computed aerodynamic coefficients.
+
+## Outputs
+
+Outputs SDSA_Input.xml, which is given as input to SDSA.
+
+## Installation or requirements
+
+Following the automatic installation procedure on the [CEASIOMpy installation page](../../installation/INSTALLATION.md) should install `DynamicStability` automatically along with the other tools.
+
+## Not implemented
+
+1. Landing gear configuration
+2. Collision points
+
+## Limitations
+
+1. Depends on SDSA software.
+2. Altitude fixed at 1000 meters.
+3. Pilot Eye is by default the tip of fuselage.
+
+## More information
+
+Dynamic Stability Software: [SDSA](https://www.meil.pw.edu.pl/add/ADD/Teaching/Software/SDSA)
+Doublet Lattice Solver: [PanelAero](https://github.com/DLR-AE/PanelAero)
+Dot derivatives algorithm: [DotDerivatives](https://fr.overleaf.com/read/qjffvmtrzzhb#8fc920)
\ No newline at end of file
diff --git a/ceasiompy/DynamicStability/__init__.py b/ceasiompy/DynamicStability/__init__.py
new file mode 100644
index 000000000..ba0ddd22d
--- /dev/null
+++ b/ceasiompy/DynamicStability/__init__.py
@@ -0,0 +1,50 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for DynamicStability module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = True
+
+# ===== Include GUI =====
+include_gui = True
+
+# ===== Include Module"s name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+# ===== Add a Results Directory =====
+RES_DIR = True
+
+# Name of SDSA Software
+SOFTWARE_NAME = "SDSA"
+
+# Fixed Altitude
+ALT = 1000.0
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/DynamicStability/__specs__.py b/ceasiompy/DynamicStability/__specs__.py
new file mode 100644
index 000000000..943c79761
--- /dev/null
+++ b/ceasiompy/DynamicStability/__specs__.py
@@ -0,0 +1,122 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+GUI Interface of DynamicStability.
+
+
+| Author: Leon Deligny
+| Creation: 25 March 2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.utils.moduleinterfaces import CPACSInOut
+
+from ceasiompy import log
+from ceasiompy.DynamicStability import include_gui
+from ceasiompy.PyAVL import SOFTWARE_NAME as AVL_SOFTWARE
+from ceasiompy.SU2Run import SOFTWARE_NAME as SU2_SOFTWARE
+from ceasiompy.DynamicStability import SOFTWARE_NAME as SDSA_SOFTWARE
+
+from ceasiompy.utils.commonxpath import (
+ DYNAMICSTABILITY_NCHORDWISE_XPATH,
+ DYNAMICSTABILITY_NSPANWISE_XPATH,
+ DYNAMICSTABILITY_VISUALIZATION_XPATH,
+ DYNAMICSTABILITY_CGRID_XPATH,
+ DYNAMICSTABILITY_SOFTWARE_XPATH,
+ DYNAMICSTABILITY_MACHLIST_XPATH,
+)
+
+# ==============================================================================
+# VARIABLE
+# ==============================================================================
+
+cpacs_inout = CPACSInOut()
+
+# ==============================================================================
+# GUI INPUTS
+# ==============================================================================
+
+cpacs_inout.add_input(
+ var_name="dynamic_stability_software_data",
+ var_type=list,
+ default_value=[f"{AVL_SOFTWARE}", f"{SU2_SOFTWARE}"],
+ unit=None,
+ descr="Which data from ceasiompy.db to use.",
+ xpath=DYNAMICSTABILITY_SOFTWARE_XPATH,
+ gui=include_gui,
+ gui_name="Use data from which software",
+ gui_group="Software Settings",
+)
+
+cpacs_inout.add_input(
+ var_name="mach_list",
+ var_type="multiselect",
+ default_value=[0.1], # [0.1, 0.2, 0.3, 0.4, 0.5, 0.6],
+ unit="mach",
+ descr=f"List of mach numbers used in {SDSA_SOFTWARE}",
+ xpath=DYNAMICSTABILITY_MACHLIST_XPATH,
+ gui=include_gui,
+ gui_name="Mach List",
+ gui_group="Mach Settings",
+)
+
+cpacs_inout.add_input(
+ var_name="chordwise_vort",
+ var_type=int,
+ default_value=12,
+ unit=None,
+ descr="Select the number of chordwise vortices",
+ xpath=DYNAMICSTABILITY_NCHORDWISE_XPATH,
+ gui=include_gui,
+ gui_name="Number of chordwise vortices",
+ gui_group="Chordwise Settings",
+)
+
+cpacs_inout.add_input(
+ var_name="spanwise_vort",
+ var_type=int,
+ default_value=20,
+ unit=None,
+ descr="Select the number of spanwise vortices",
+ xpath=DYNAMICSTABILITY_NSPANWISE_XPATH,
+ gui=include_gui,
+ gui_name="Number of spanwise vortices",
+ gui_group="Spanwise Settings",
+)
+
+cpacs_inout.add_input(
+ var_name="dlm_aerogrid_visualization",
+ var_type=bool,
+ default_value=False,
+ unit=None,
+ descr="Visualization of the aerogrid the DLM is going to use",
+ xpath=DYNAMICSTABILITY_VISUALIZATION_XPATH,
+ gui=include_gui,
+ gui_name="aerogrid visualization",
+ gui_group="Visualization",
+)
+
+cpacs_inout.add_input(
+ var_name="c_grid",
+ var_type=str,
+ default_value="C:/Program Files/SDSA/Grid/test.inp",
+ unit=None,
+ descr="Select the cGrid path",
+ xpath=DYNAMICSTABILITY_CGRID_XPATH,
+ gui=include_gui,
+ gui_name="cGrid path",
+ gui_group="cGrid Setting",
+)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/DynamicStability/dynamicstability.py b/ceasiompy/DynamicStability/dynamicstability.py
new file mode 100644
index 000000000..5d357ce0c
--- /dev/null
+++ b/ceasiompy/DynamicStability/dynamicstability.py
@@ -0,0 +1,61 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Dynamic Stability Module
+
+
+| Author: Leon Deligny
+| Creation: 2025-01-27
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+from ceasiompy.utils.ceasiompyutils import (
+ call_main,
+ run_software,
+)
+
+from pathlib import Path
+from cpacspy.cpacspy import CPACS
+from ceasiompy.DynamicStability.func.cpacs2sdsa import SDSAFile
+
+from ceasiompy import log
+
+from ceasiompy.DynamicStability import (
+ MODULE_NAME,
+ SOFTWARE_NAME,
+)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+def main(cpacs: CPACS, wkdir: Path) -> None:
+ """
+ Opens SDSA with CPACS file and ceasiompy.db's data.
+ """
+
+ # Create SDSAFile object from the CPACS file
+ sdsa_file = SDSAFile(cpacs, wkdir)
+
+ # Save the file in /Results/DynamicStability
+ input_xml: str = sdsa_file.generate_xml()
+
+ log.info("--- Calling SDSA ---")
+
+ run_software(
+ software_name=SOFTWARE_NAME,
+ arguments=["", f"{input_xml}", "1"],
+ wkdir=wkdir,
+ with_mpi=False,
+ )
+
+
+if __name__ == "__main__":
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/DynamicStability/func/SDSAEmpty.xml b/ceasiompy/DynamicStability/func/SDSAEmpty.xml
new file mode 100644
index 000000000..cdccccf31
--- /dev/null
+++ b/ceasiompy/DynamicStability/func/SDSAEmpty.xml
@@ -0,0 +1,236 @@
+
+
+
+# DynamicStability
+
+**Categories:** ExportCSV, Export data in CSV format
+
+**State**: :heavy_check_mark:
+
+## Inputs
+
+CPACS file with more then 1 aeromap.
+
+## Analyses
+
+Export the aircraft's aeromaps data in a .csv file.
+
+## Outputs
+
+Outputs a CSV file.
+
+## Installation or requirements
+
+No requirement. ExportCSV is a native module of CEASIOMpy.
+
+## Not implemented
+
+NA
+
+## Limitations
+
+NA
+
+## More information
+
+NA
\ No newline at end of file
diff --git a/ceasiompy/ExportCSV/ToolInput/.keep b/ceasiompy/ExportCSV/ToolInput/.keep
deleted file mode 100644
index 8d1c8b69c..000000000
--- a/ceasiompy/ExportCSV/ToolInput/.keep
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/ceasiompy/ExportCSV/ToolOutput/.keep b/ceasiompy/ExportCSV/ToolOutput/.keep
deleted file mode 100644
index 8d1c8b69c..000000000
--- a/ceasiompy/ExportCSV/ToolOutput/.keep
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/ceasiompy/ExportCSV/__init__.py b/ceasiompy/ExportCSV/__init__.py
index e69de29bb..43b77b6ef 100644
--- a/ceasiompy/ExportCSV/__init__.py
+++ b/ceasiompy/ExportCSV/__init__.py
@@ -0,0 +1,45 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for ExportCSV module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = True
+
+# ===== Include GUI =====
+include_gui = True
+
+# ===== Add a Results Directory =====
+RES_DIR = True
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/ExportCSV/__specs__.py b/ceasiompy/ExportCSV/__specs__.py
index 195af1ed8..608898b6a 100644
--- a/ceasiompy/ExportCSV/__specs__.py
+++ b/ceasiompy/ExportCSV/__specs__.py
@@ -1,24 +1,35 @@
-from pathlib import Path
-from ceasiompy.utils.moduleinterfaces import CPACSInOut
-from ceasiompy.utils.commonxpath import EXPORT_XPATH
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
-# ===== Module Status =====
-# True if the module is active
-# False if the module is disabled (not working or not ready)
-module_status = True
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-# ===== Results directory path =====
+GUI Interface of ExportCSV.
-RESULTS_DIR = Path("Results", "AeroCoefficients")
+| Author: Leon Deligny
+| Creation: 19-Mar-2025
-# ===== CPACS inputs and outputs =====
+"""
-cpacs_inout = CPACSInOut()
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.utils.moduleinterfaces import CPACSInOut
-include_gui = False
+from ceasiompy import log
+from ceasiompy.ExportCSV import include_gui
+from ceasiompy.utils.commonxpath import EXPORT_XPATH
+
+# ==============================================================================
+# VARIABLE
+# ==============================================================================
-# ----- Input -----
+cpacs_inout = CPACSInOut()
+
+# ==============================================================================
+# GUI INPUTS
+# ==============================================================================
cpacs_inout.add_input(
var_name="",
@@ -26,9 +37,14 @@
default_value=None,
descr="List of aeroMap to plot",
xpath=EXPORT_XPATH + "/aeroMapToExport",
- gui=True,
+ gui=include_gui,
gui_name="__AEROMAP_CHECKBOX",
gui_group="Aeromap settings",
)
-# ----- Output -----
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/ExportCSV/exportcsv.py b/ceasiompy/ExportCSV/exportcsv.py
index edd0bd999..6131ac785 100644
--- a/ceasiompy/ExportCSV/exportcsv.py
+++ b/ceasiompy/ExportCSV/exportcsv.py
@@ -5,15 +5,11 @@
Module to export Aeromap (or other data?) to CSV
-Python version: >=3.8
| Author: Aidan Jungo
| Creation: 2021-04-07
-
-TODO:
-
- * export other data...
- *
+| Modified: Leon Deligny
+| Date: 03 April 2025
"""
@@ -23,77 +19,41 @@
from pathlib import Path
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.ceasiompyutils import get_aeromap_list_from_xpath, get_results_directory
-from ceasiompy.utils.moduleinterfaces import (
- check_cpacs_input_requirements,
- get_toolinput_file_path,
- get_tooloutput_file_path,
-)
-from ceasiompy.utils.commonxpath import CEASIOMPY_XPATH
-from cpacspy.cpacspy import CPACS
from cpacspy.cpacsfunctions import get_value_or_default
+from ceasiompy.utils.ceasiompyutils import (
+ call_main,
+ get_aeromap_list_from_xpath,
+)
-log = get_logger()
-
-MODULE_DIR = Path(__file__).parent
-MODULE_NAME = MODULE_DIR.name
-
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
+from cpacspy.cpacspy import CPACS
+from cpacspy.aeromap import AeroMap
+from ceasiompy import log
+from ceasiompy.ExportCSV import MODULE_NAME
+from ceasiompy.utils.commonxpath import AEROMAP_TO_EXPORT_XPATH
# =================================================================================================
-# FUNCTIONS
+# MAIN
# =================================================================================================
-def export_aeromaps(cpacs_path, cpacs_out_path):
+def main(cpacs: CPACS, wkdir: Path) -> None:
+ tixi = cpacs.tixi
- cpacs = CPACS(cpacs_path)
-
- aeromap_to_export_xpath = CEASIOMPY_XPATH + "/export/aeroMapToExport"
- aeromap_uid_list = get_aeromap_list_from_xpath(cpacs, aeromap_to_export_xpath)
+ aeromap_uid_list = get_aeromap_list_from_xpath(cpacs, AEROMAP_TO_EXPORT_XPATH)
if not aeromap_uid_list:
aeromap_uid_list = get_value_or_default(
- cpacs.tixi, aeromap_to_export_xpath, "DefaultAeromap"
+ tixi, AEROMAP_TO_EXPORT_XPATH, "DefaultAeromap"
)
- results_dir = get_results_directory("ExportCSV")
-
for aeromap_uid in aeromap_uid_list:
- aeromap = cpacs.get_aeromap_by_uid(aeromap_uid)
-
- csv_path = Path(results_dir, f"{aeromap_uid}.csv")
+ aeromap: AeroMap = cpacs.get_aeromap_by_uid(aeromap_uid)
+ csv_path = Path(wkdir, f"{aeromap_uid}.csv")
aeromap.export_csv(csv_path)
- log.info(f"Aeromap(s) has been saved to {csv_path}")
-
- cpacs.save_cpacs(cpacs_out_path, overwrite=True)
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-
-def main(cpacs_path, cpacs_out_path):
-
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- export_aeromaps(cpacs_path, cpacs_out_path)
-
- log.info("----- End of " + MODULE_NAME + " -----")
+ log.info(f"Aeromap(s) have been saved to {csv_path}")
if __name__ == "__main__":
-
- cpacs_path = get_toolinput_file_path(MODULE_NAME)
- cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
-
- main(cpacs_path, cpacs_out_path)
-
- check_cpacs_input_requirements(cpacs_path)
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/ExportCSV/tests/test_exportcsv.py b/ceasiompy/ExportCSV/tests/test_exportcsv.py
index 47b9ab6fe..d4eba2dff 100644
--- a/ceasiompy/ExportCSV/tests/test_exportcsv.py
+++ b/ceasiompy/ExportCSV/tests/test_exportcsv.py
@@ -5,62 +5,55 @@
Test functions for 'ceasiompy/ExportCSV/exportcsv.py'
-Python version: >=3.8
| Author : Aidan Jungo
| Creation: 2021-12-09
+| Modified: Leon Deligny
+| Date: 25 March 2025
+
"""
# =================================================================================================
# IMPORTS
# =================================================================================================
-import shutil
-from pathlib import Path
-
-import pytest
-from ceasiompy.ExportCSV.exportcsv import export_aeromaps
-from ceasiompy.utils.ceasiompyutils import get_results_directory
-
-MODULE_DIR = Path(__file__).parent
-CPACS_IN_PATH = Path(MODULE_DIR, "D150_simple.xml")
+from ceasiompy.utils.decorators import log_test
+from ceasiompy.utils.ceasiompyutils import current_workflow_dir
+from ceasiompy.ExportCSV.exportcsv import main as export_aeromaps
+from pathlib import Path
+from unittest import main
+from ceasiompy.utils.ceasiompytest import CeasiompyTest
# =================================================================================================
-# FUNCTIONS
+# CLASS
# =================================================================================================
-@pytest.fixture(autouse=True)
-def change_test_dir(request, monkeypatch):
-
- monkeypatch.chdir(request.fspath.dirname)
+class TestExportCSV(CeasiompyTest):
+ @classmethod
+ def setUpClass(cls):
+ super().setUpClass()
+ cls.wkdir = current_workflow_dir()
+ cls.csv_path = Path(cls.wkdir, "test_apm.csv")
- global CSV_FILE_PATH
- results_dir = get_results_directory("ExportCSV")
- CSV_FILE_PATH = Path(results_dir, "test_apm.csv")
+ @log_test
+ def test_export_aeromaps(self):
+ """Test function 'exportcsv' function."""
- yield
+ export_aeromaps(self.test_cpacs, self.wkdir)
- # Clean up
- shutil.rmtree(CSV_FILE_PATH.parent.parent)
+ # Read and check csv file
+ with open(self.csv_path, "r") as csv_file:
+ lines = csv_file.readlines()
-
-def test_export_aeromaps():
- """Test function 'exportcsv' function."""
-
- export_aeromaps(CPACS_IN_PATH, CPACS_IN_PATH)
-
- # Read and check csv file
- with open(CSV_FILE_PATH, "r") as csv_file:
- lines = csv_file.readlines()
-
- assert lines[0] == "altitude,machNumber,angleOfSideslip,angleOfAttack,cd,cl,cs,cmd,cml,cms\n"
- assert lines[1] == "0,0.3,0,0,0.01,0.1,0.001,NaN,NaN,NaN\n"
- assert lines[2] == "0,0.3,0,10,0.01,0.1,0.001,NaN,NaN,NaN\n"
- assert lines[3] == "0,0.3,10,0,0.01,0.1,0.001,NaN,NaN,NaN\n"
- assert lines[4] == "0,0.3,10,10,0.01,0.1,0.001,NaN,NaN,NaN\n"
+ features_str = "altitude,machNumber,angleOfSideslip,angleOfAttack"
+ assert lines[0] == f"{features_str},cd,cl,cs,cmd,cml,cms\n"
+ assert lines[1] == "0,0.3,0,0,0.01,0.1,0.001,NaN,NaN,NaN\n"
+ assert lines[2] == "0,0.3,0,10,0.01,0.1,0.001,NaN,NaN,NaN\n"
+ assert lines[3] == "0,0.3,10,0,0.01,0.1,0.001,NaN,NaN,NaN\n"
+ assert lines[4] == "0,0.3,10,10,0.01,0.1,0.001,NaN,NaN,NaN\n"
# =================================================================================================
@@ -68,7 +61,4 @@ def test_export_aeromaps():
# =================================================================================================
if __name__ == "__main__":
-
- print("Running Test ExportCSV")
- print("To run test use the following command:")
- print(">> pytest -v")
+ main(verbosity=0)
diff --git a/ceasiompy/ModuleTemplate/README.md b/ceasiompy/ModuleTemplate/README.md
index f20754ecf..fa5ef1d90 100644
--- a/ceasiompy/ModuleTemplate/README.md
+++ b/ceasiompy/ModuleTemplate/README.md
@@ -37,4 +37,5 @@ ModuleTemplate is limited in every aspect.
## More information
+
* 
-`PyAVL` module is a launcher for the [Athena Vortex Lattice (AVL)](https://web.mit.edu/drela/Public/web/avl/) solver, developed by M. Drela and H. Youngren at MIT. It is a vortex lattice method (VLM) solver for low-fidelity aerodynamic computations.
+`PyAVL` module is a launcher for the [Athena Vortex Lattice (AVL)](https://web.mit.edu/drela/Public/web/avl/) solver, developed by M. Drela and H. Youngren at MIT. It is a vortex lattice method (VLM) solver for low-fidelity aerodynamic computations.
## Inputs
@@ -29,7 +29,7 @@ Example of AVL geometry model.
## Outputs
`PyAVL` outputs a CPACS file with the aerodynamic coefficients added in the aeromap. The settings of the simulation (number of chordwise/spanwise vortices, vortex distribution) are saved. The following force files are saved:
-- `ft.txt`: Total Forces.
+- `ft.txt`: Total Forces.
- `fn.txt`: Surface Forces.
- `fs.txt`: Strip Forces.
- `fe.txt`: Element Forces (vortex strength).
@@ -48,7 +48,7 @@ Example of aerodynamic loads computed by AVL.
## Installation or requirements
-Following the automatic installation procedure on the [CEASIOMpy installation page](../../installation/INSTALLATION.md) should install `PyAVL` automatically with the other tools.
+Following the automatic installation procedure on the [CEASIOMpy installation page](../../installation/INSTALLATION.md) should install `PyAVL` automatically along with the other tools.
## Limitations
diff --git a/ceasiompy/PyAVL/__init__.py b/ceasiompy/PyAVL/__init__.py
index e69de29bb..5264423b5 100644
--- a/ceasiompy/PyAVL/__init__.py
+++ b/ceasiompy/PyAVL/__init__.py
@@ -0,0 +1,81 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for PyAVL module.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pathlib import Path
+
+from ceasiompy import log
+from ceasiompy.utils.commonxpath import CEASIOMPY_XPATH
+
+# ==============================================================================
+# INITIALIZATION
+# ==============================================================================
+
+# ===== Module Status =====
+module_status = True
+
+# ===== Include GUI =====
+include_gui = True
+
+# ===== Include Module's name =====
+MODULE_DIR = Path(__file__).parent
+MODULE_NAME = MODULE_DIR.name
+
+# ===== Add a Results Directory =====
+RES_DIR = True
+
+# ===== Name of Software used =====
+SOFTWARE_NAME = "avl"
+
+# =================================================================================================
+# xPaths
+# =================================================================================================
+
+# Main branch
+AVL_XPATH = CEASIOMPY_XPATH + "/avl"
+
+# AeroMap settings
+AVL_AEROMAP_UID_XPATH = AVL_XPATH + "/aeroMapUID"
+AVL_ROTRATES_XPATH = AVL_XPATH + "/RotationRates"
+AVL_FREESTREAM_MACH_XPATH = AVL_XPATH + "/FreestreamMach"
+
+# Software setting
+AVL_NB_CPU_XPATH = AVL_XPATH + "NbCPU"
+
+# Geometry settings
+AVL_CTRLSURF_ANGLES_XPATH = AVL_XPATH + "/ControlSurfaceAngles"
+AVL_FUSELAGE_XPATH = AVL_XPATH + "/IntegrateFuselage"
+
+# Plot settings
+AVL_PLOT_XPATH = AVL_XPATH + "/SavePlots"
+AVL_PLOTLIFT_XPATH = AVL_XPATH + "/PlotLift"
+
+# Dynamic Stability
+AVL_TABLE_XPATH = AVL_XPATH + "/Table"
+AVL_CTRLTABLE_XPATH = AVL_XPATH + "/CtrlTable"
+
+# Vortex distribution
+AVL_VORTEX_DISTR_XPATH = AVL_XPATH + "/VortexDistribution"
+AVL_NCHORDWISE_XPATH = AVL_VORTEX_DISTR_XPATH + "/Nchordwise"
+AVL_NSPANWISE_XPATH = AVL_VORTEX_DISTR_XPATH + "/Nspanwise"
+AVL_DISTR_XPATH = AVL_VORTEX_DISTR_XPATH + "/Distribution"
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/PyAVL/__specs__.py b/ceasiompy/PyAVL/__specs__.py
index 3dc0f8093..b1fdf3b25 100644
--- a/ceasiompy/PyAVL/__specs__.py
+++ b/ceasiompy/PyAVL/__specs__.py
@@ -1,43 +1,89 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+GUI Interface of PyAVL.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+import streamlit as st
+
+from ceasiompy.utils.ceasiompyutils import get_reasonable_nb_cpu
+
from ceasiompy.utils.moduleinterfaces import CPACSInOut
-from ceasiompy.utils.commonxpath import (
- CEASIOMPY_XPATH,
+
+from ceasiompy import log
+from ceasiompy.PyAVL import include_gui
+
+from ceasiompy.PyAVL import (
AVL_PLOT_XPATH,
- AVL_VORTEX_DISTR_XPATH,
+ AVL_DISTR_XPATH,
+ AVL_NB_CPU_XPATH,
+ AVL_ROTRATES_XPATH,
+ AVL_PLOTLIFT_XPATH,
AVL_FUSELAGE_XPATH,
+ AVL_NSPANWISE_XPATH,
+ AVL_NCHORDWISE_XPATH,
AVL_AEROMAP_UID_XPATH,
- AEROPERFORMANCE_XPATH,
+ AVL_FREESTREAM_MACH_XPATH,
+ AVL_CTRLSURF_ANGLES_XPATH,
)
-from pathlib import Path
-
-# ===== Module Status =====
-# True if the module is active
-# False if the module is disabled (not working or not ready)
-module_status = True # Because it is just an example not a real module
-
-# ===== Results directory path =====
-RESULTS_DIR = Path("Results", "PyAVL")
-
-# ===== CPACS inputs and outputs =====
+# ==============================================================================
+# VARIABLE
+# ==============================================================================
cpacs_inout = CPACSInOut()
-# ----- Input -----
+# ==============================================================================
+# GUI INPUTS
+# ==============================================================================
-# * In the following example we add three (!) new entries to 'cpacs_inout'
-# * Try to use (readable) loops instead of copy-pasting three almost same entries :)
cpacs_inout.add_input(
var_name="aeromap_uid",
var_type=list,
- default_value=None,
+ default_value=st.session_state.cpacs.get_aeromap_uid_list(),
unit=None,
descr="Name of the aero map to calculate",
xpath=AVL_AEROMAP_UID_XPATH,
- gui=True,
+ gui=include_gui,
gui_name="__AEROMAP_SELECTION",
gui_group="Aeromap settings",
)
+cpacs_inout.add_input(
+ var_name="rates",
+ var_type="multiselect",
+ default_value=[0.0],
+ unit="[deg/s]",
+ descr="List of p, q, r rates",
+ xpath=AVL_ROTRATES_XPATH,
+ gui=include_gui,
+ gui_name="Rotation Rates",
+ gui_group="Rate settings",
+)
+
+cpacs_inout.add_input(
+ var_name="ctrl_surf_angles",
+ var_type="multiselect",
+ default_value=[0.0],
+ unit="[deg]",
+ descr="List of Aileron, Elevator, Rudder angles",
+ xpath=AVL_CTRLSURF_ANGLES_XPATH,
+ gui=include_gui,
+ gui_name="Aileron/Elevator/Rudder Angles",
+ gui_group="Control surface settings",
+)
+
cpacs_inout.add_input(
var_name="integrate_fuselage",
var_type=bool,
@@ -45,7 +91,7 @@
unit=None,
descr="Select to integrate the fuselage in the AVL model",
xpath=AVL_FUSELAGE_XPATH,
- gui=True,
+ gui=include_gui,
gui_name="Integrate fuselage",
gui_group="Fuselage",
)
@@ -56,8 +102,8 @@
default_value=["cosine", "sine", "equal"],
unit=None,
descr=("Select the type of distribution"),
- xpath=AVL_VORTEX_DISTR_XPATH + "/Distribution",
- gui=True,
+ xpath=AVL_DISTR_XPATH,
+ gui=include_gui,
gui_name="Choice of distribution",
gui_group="Vortex Lattice Spacing Distributions",
)
@@ -68,8 +114,8 @@
default_value=20,
unit=None,
descr="Select the number of chordwise vortices",
- xpath=AVL_VORTEX_DISTR_XPATH + "/Nchordwise",
- gui=True,
+ xpath=AVL_NCHORDWISE_XPATH,
+ gui=include_gui,
gui_name="Number of chordwise vortices",
gui_group="Vortex Lattice Spacing Distributions",
)
@@ -80,12 +126,48 @@
default_value=50,
unit=None,
descr="Select the number of spanwise vortices",
- xpath=AVL_VORTEX_DISTR_XPATH + "/Nspanwise",
- gui=True,
+ xpath=AVL_NSPANWISE_XPATH,
+ gui=include_gui,
gui_name="Number of spanwise vortices",
gui_group="Vortex Lattice Spacing Distributions",
)
+cpacs_inout.add_input(
+ var_name="nb_proc",
+ var_type=int,
+ default_value=get_reasonable_nb_cpu(),
+ unit=None,
+ descr="Number of proc to use to run SU2",
+ xpath=AVL_NB_CPU_XPATH,
+ gui=include_gui,
+ gui_name="Nb of processor",
+ gui_group="CPU",
+)
+
+cpacs_inout.add_input(
+ var_name="default_freestream_mach",
+ var_type=float,
+ default_value=0.6,
+ unit="[Mach]",
+ descr="Usually 0.2 < default value < 0.8",
+ xpath=AVL_FREESTREAM_MACH_XPATH,
+ gui=include_gui,
+ gui_name="Default freestream Mach for Prandtl-Glauert corrections",
+ gui_group="Default freestream Mach",
+)
+
+cpacs_inout.add_input(
+ var_name="plot_lift",
+ var_type=bool,
+ default_value=False,
+ unit=None,
+ descr="Select to plot lift along wing",
+ xpath=AVL_PLOTLIFT_XPATH,
+ gui=include_gui,
+ gui_name="Plot Lift",
+ gui_group="Plots Settings",
+)
+
cpacs_inout.add_input(
var_name="save_plots",
var_type=bool,
@@ -93,26 +175,14 @@
unit=None,
descr="Select to save geometry and results plots",
xpath=AVL_PLOT_XPATH,
- gui=True,
+ gui=include_gui,
gui_name="Save plots",
- gui_group="Plots",
+ gui_group="Plots Settings",
)
-# ----- Output -----
-
-cpacs_inout.add_output(
- var_name="output",
- default_value=None,
- unit="1",
- descr="Description of the output",
- xpath=CEASIOMPY_XPATH + "/test/myOutput",
-)
+# =================================================================================================
+# MAIN
+# =================================================================================================
-cpacs_inout.add_output(
- var_name="aeromap_avl", # name to change...
- # var_type=CPACS_aeroMap, # no type pour output, would it be useful?
- default_value=None,
- unit="-",
- descr="aeroMap with aero coefficients calculated by AVL",
- xpath=AEROPERFORMANCE_XPATH + "/aeroMap/aeroPerformanceMap",
-)
+if __name__ == "__main__":
+ log.info("Nothing to be executed.")
diff --git a/ceasiompy/PyAVL/avlrun.py b/ceasiompy/PyAVL/avlrun.py
deleted file mode 100644
index 8b642e8c4..000000000
--- a/ceasiompy/PyAVL/avlrun.py
+++ /dev/null
@@ -1,136 +0,0 @@
-"""
-CEASIOMpy: Conceptual Aircraft Design Software
-
-Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-
-Script to run AVL calculations in CEASIOMpy.
-AVL allows to perform aerodynamic analyses using
-the vortex-lattice method (VLM)
-
-Python version: >=3.8
-
-| Author: Romain Gauthier
-| Creation: 2024-03-14
-
-TODO:
-
- * Things to improve ...
-
-"""
-
-# ==============================================================================
-# IMPORTS
-# ==============================================================================
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.moduleinterfaces import get_toolinput_file_path, get_tooloutput_file_path
-from ceasiompy.PyAVL.func.cpacs2avl import convert_cpacs_to_avl
-from ceasiompy.PyAVL.func.avlconfig import (
- write_command_file,
- get_aeromap_conditions,
- get_option_settings,
-)
-from ceasiompy.PyAVL.func.avlresults import (
- get_avl_results,
- convert_ps_to_pdf
-)
-from ceasiompy.utils.ceasiompyutils import get_results_directory
-
-import subprocess
-from pathlib import Path
-from ambiance import Atmosphere
-
-
-log = get_logger()
-
-MODULE_DIR = Path(__file__).parent
-MODULE_NAME = MODULE_DIR.name
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
-
-
-# =================================================================================================
-# FUNCTIONS
-# =================================================================================================
-def run_avl(cpacs_path, wkdir):
- """Function to run AVL.
-
- Function 'run_avl' runs AVL calculations using a CPACS file
- as input.
-
- Args:
- cpacs_path (Path) : path to the CPACS input file
- wkdir (Path) : path to the working directory
- """
-
- alt_list, mach_list, aoa_list, aos_list = get_aeromap_conditions(cpacs_path)
- save_fig, _, _, _, _ = get_option_settings(cpacs_path)
-
- for i_case in range(len(alt_list)):
- alt = alt_list[i_case]
- mach = mach_list[i_case]
- aoa = aoa_list[i_case]
- aos = aos_list[i_case]
- Atm = Atmosphere(alt)
-
- density = Atm.density[0]
- velocity = Atm.speed_of_sound[0] * mach
- g = Atm.grav_accel[0]
-
- case_dir_name = (
- f"Case{str(i_case).zfill(2)}_alt{alt}_mach{round(mach, 2)}"
- f"_aoa{round(aoa, 1)}_aos{round(aos, 1)}"
- )
-
- Path(wkdir, case_dir_name).mkdir(exist_ok=True)
- case_dir_path = Path(wkdir, case_dir_name)
-
- avl_path = convert_cpacs_to_avl(cpacs_path, machnumber=mach, wkdir=case_dir_path)
-
- command_path = write_command_file(
- avl_path,
- case_dir_path,
- save_plots=save_fig,
- alpha=aoa,
- beta=aos,
- mach_number=mach,
- ref_velocity=velocity,
- ref_density=density,
- g_acceleration=g,
- )
- log.info("Running AVL ...")
- subprocess.run(
- ["xvfb-run", "avl"],
- stdin=open(str(command_path), "r"),
- cwd=case_dir_path,
- stdout=subprocess.DEVNULL
- )
- log.info("AVL Done!")
-
- Path(avl_path).rename(case_dir_path / Path(avl_path).name)
-
- if save_fig:
- convert_ps_to_pdf(wkdir=case_dir_path)
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-
-def main(cpacs_path, cpacs_out_path):
- log.info("----- Start of " + MODULE_NAME + " -----")
-
- results_dir = get_results_directory("PyAVL")
- run_avl(cpacs_path, results_dir)
- get_avl_results(cpacs_path, cpacs_out_path, results_dir)
-
- log.info("----- End of " + MODULE_NAME + " -----")
-
-
-if __name__ == "__main__":
- cpacs_path = get_toolinput_file_path(MODULE_NAME)
- cpacs_out_path = get_tooloutput_file_path(MODULE_NAME)
-
- main(cpacs_path, cpacs_out_path)
diff --git a/ceasiompy/PyAVL/files/avl_example.png b/ceasiompy/PyAVL/files/avl_example.png
index ee2134d02..a76d2a258 100644
Binary files a/ceasiompy/PyAVL/files/avl_example.png and b/ceasiompy/PyAVL/files/avl_example.png differ
diff --git a/ceasiompy/PyAVL/files/avl_example_loads.png b/ceasiompy/PyAVL/files/avl_example_loads.png
index 6fdc182b9..24955125e 100644
Binary files a/ceasiompy/PyAVL/files/avl_example_loads.png and b/ceasiompy/PyAVL/files/avl_example_loads.png differ
diff --git a/ceasiompy/PyAVL/files/avl_logo.png b/ceasiompy/PyAVL/files/avl_logo.png
index 0c1551049..013cb6962 100644
Binary files a/ceasiompy/PyAVL/files/avl_logo.png and b/ceasiompy/PyAVL/files/avl_logo.png differ
diff --git a/ceasiompy/PyAVL/files/template.mass b/ceasiompy/PyAVL/files/template.mass
index 9faeeb38e..fdab08e16 100644
--- a/ceasiompy/PyAVL/files/template.mass
+++ b/ceasiompy/PyAVL/files/template.mass
@@ -12,7 +12,7 @@ Lunit = 1.0 m
Munit = 1.0 kg
Tunit = 1.0 s
-#-------------------------
+#-------------------------
# Gravity and density to be used as default values in trim setup.
# Must be in the units given above.
g = 9.81
diff --git a/ceasiompy/PyAVL/func/__init__.py b/ceasiompy/PyAVL/func/__init__.py
new file mode 100644
index 000000000..3634752d5
--- /dev/null
+++ b/ceasiompy/PyAVL/func/__init__.py
@@ -0,0 +1,47 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Initialization for PyAVL.func functions.
+
+
+| Author: Leon Deligny
+| Creation: 18-Mar-2025
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+from ceasiompy import log
+
+# =================================================================================================
+# CONSTANTS
+# =================================================================================================
+
+# config.py
+FORCE_FILES = ["ft", "fn", "fs", "fe", "st", "sb"]
+
+# results.py
+AVL_COEFS = {
+ "CLtot": (1, "cl"),
+ "CDtot": (1, "cd"),
+ "CYtot": (1, "cs"),
+ "Cltot": (2, "cmd"),
+ "Cmtot": (2, "cms"),
+ "Cntot": (2, "cml"),
+ "Cma": (1, "cms_a"),
+ "Clb": (2, "cmd_b"),
+ "Cnb": (2, "cml_b"),
+}
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute.")
diff --git a/ceasiompy/PyAVL/func/avlconfig.py b/ceasiompy/PyAVL/func/avlconfig.py
deleted file mode 100644
index 7c7d64c3f..000000000
--- a/ceasiompy/PyAVL/func/avlconfig.py
+++ /dev/null
@@ -1,231 +0,0 @@
-"""
-CEASIOMpy: Conceptual Aircraft Design Software
-
-Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-
-Script to get the flight conditions (alt, aoa, mach...) from
-the input CPACS file, and write the command file for AVL.
-
-Python version: >=3.8
-
-| Author: Romain Gauthier
-| Creation: 2024-03-14
-
-TODO:
-
- * Things to improve...
-
-"""
-
-# ==============================================================================
-# IMPORTS
-# ==============================================================================
-
-from pathlib import Path
-
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.commonxpath import (
- RANGE_XPATH,
- AVL_AEROMAP_UID_XPATH,
- AVL_PLOT_XPATH,
- AVL_VORTEX_DISTR_XPATH,
- AVL_FUSELAGE_XPATH,
-)
-from cpacspy.cpacsfunctions import get_value_or_default
-from ceasiompy.utils.moduleinterfaces import get_module_path
-from cpacspy.cpacspy import CPACS
-
-log = get_logger()
-
-
-# =================================================================================================
-# FUNCTIONS
-# =================================================================================================
-def write_command_file(
- avl_path,
- case_dir_path,
- alpha,
- beta,
- mach_number,
- ref_velocity,
- ref_density,
- g_acceleration,
- save_plots,
-):
- """Function to write the command file for AVL.
-
- Function 'write_command_file' writes the command file to
- execute for AVL calculations.
-
- Args:
- avl_path (Path) : path to the AVL input file
- case_dir_path (Path) : path to the run case directory
- alpha (float) : angle of attack [deg]
- beta (float) : angle of attack [deg]
- mach_number (float) : Mach number
- ref_velocity (float) : reference upstream velocity [m/s]
- ref_density (float) : reference upstream density [kg/m^3]
- g_acceleration (float) : gravitational acceleration [m/s^2]
-
- Returns:
- avl_commands.txt : write the command AVL file.
- command_path (Path) : path to the command file.
- """
-
- command_path = str(case_dir_path) + "/avl_commands.txt"
- pyavl_dir = get_module_path("PyAVL")
- mass_path = Path(pyavl_dir, "files", "template.mass")
-
- if save_plots:
- with open(command_path, "w") as command_file:
- command_file.writelines(
- [
- "load " + str(avl_path) + "\n",
- "mass " + str(mass_path) + "\n",
- "oper\n",
- "g\n",
- "h\n\n",
- "a a " + str(alpha) + "\n",
- "b b " + str(beta) + "\n",
- "m\n",
- "mn " + str(mach_number) + "\n",
- "g " + str(g_acceleration) + "\n",
- "d " + str(ref_density) + "\n",
- "v " + str(ref_velocity) + "\n\n",
- ]
- )
- command_file.write("x\n")
- command_file.writelines(["t\n", "h\n\n"])
- command_file.writelines(["g\n", "lo\n", "h\n\n"])
- command_file.write("x\n")
- for force_file in ["ft", "fn", "fs", "fe", "st"]:
- command_file.write(force_file + "\n")
- command_file.write(force_file + ".txt\n")
- command_file.write("\n\n\n")
- command_file.write("quit")
-
- else: # same without lines saving figures
- with open(command_path, "w") as command_file:
- command_file.writelines(
- [
- "load " + str(avl_path) + "\n",
- "mass " + str(mass_path) + "\n",
- "oper\n",
- "a a " + str(alpha) + "\n",
- "b b " + str(beta) + "\n",
- "m\n",
- "mn " + str(mach_number) + "\n",
- "g " + str(g_acceleration) + "\n",
- "d " + str(ref_density) + "\n",
- "v " + str(ref_velocity) + "\n\n",
- ]
- )
- command_file.write("x\n")
- for force_file in ["ft", "fn", "fs", "fe", "st", "sb"]:
- command_file.write(force_file + "\n")
- command_file.write(force_file + ".txt\n")
- command_file.write("\n\n\n")
- command_file.write("quit")
-
- # Print the command file for debugging
- # with open(command_path, "r") as command_file:
- # for line in command_file:
- # print(line)
-
- return Path(command_path)
-
-
-def get_aeromap_conditions(cpacs_path):
- """Function read the flight conditions from the aeromap.
-
- Function 'get_aeromap_conditions' reads the flight conditions
- (angle of attack, mach number...) from the aeromap of CEASIOMpy.
-
- Args:
- cpacs_path (Path) : path to the cpacs input file
-
- Returns:
- alt_list (list) : altitude of the cases.
- mach_list (list) : mach number of the cases.
- aoa_list (list) : angle of attack of the cases.
- aos_list (list) : angle of sweep of the cases.
- """
- cpacs = CPACS(cpacs_path)
-
- # Get the first aeroMap as default one or create automatically one
- aeromap_list = cpacs.get_aeromap_uid_list()
-
- if aeromap_list:
- aeromap_default = aeromap_list[0]
- log.info(f"The aeromap is {aeromap_default}")
-
- aeromap_uid = get_value_or_default(cpacs.tixi, AVL_AEROMAP_UID_XPATH, aeromap_default)
-
- activate_aeromap = cpacs.get_aeromap_by_uid(aeromap_uid)
- alt_list = activate_aeromap.get("altitude").tolist()
- mach_list = activate_aeromap.get("machNumber").tolist()
- aoa_list = activate_aeromap.get("angleOfAttack").tolist()
- aos_list = activate_aeromap.get("angleOfSideslip").tolist()
-
- else:
- default_aeromap = cpacs.create_aeromap("DefaultAeromap")
- default_aeromap.description = "AeroMap created automatically"
-
- mach = get_value_or_default(cpacs.tixi, RANGE_XPATH + "/cruiseMach", 0.3)
- alt = get_value_or_default(cpacs.tixi, RANGE_XPATH + "/cruiseAltitude", 10000)
-
- default_aeromap.add_row(alt=alt, mach=mach, aos=0.0, aoa=0.0)
- default_aeromap.save()
-
- alt_list = [alt]
- mach_list = [mach]
- aoa_list = [0.0]
- aos_list = [0.0]
-
- aeromap_uid = get_value_or_default(cpacs.tixi, AVL_AEROMAP_UID_XPATH, "DefaultAeromap")
- log.info(f"{aeromap_uid} has been created")
-
- cpacs.save_cpacs(cpacs_path, overwrite=True)
- return alt_list, mach_list, aoa_list, aos_list
-
-
-def get_option_settings(cpacs_path):
- """Function read the setting of the graphical user interface.
-
- Function 'get_option_settings' reads the setting to use in AVL
- from the graphical user interface of CEASIOMpy.
-
- Args:
- cpacs_path (Path) : path to the cpacs input file
-
- Returns:
- save_plots (bool) : to save the geometry and results figures.
- vortex_distribution (float) : distribution of the vortices.
- Nchordwise (int) : number of chordwise vortices.
- Nspanwise (int) : number of spanwise vortices.
- """
- cpacs = CPACS(cpacs_path)
-
- save_plots = get_value_or_default(cpacs.tixi, AVL_PLOT_XPATH, False)
- vortex_distribution_gui = get_value_or_default(
- cpacs.tixi, AVL_VORTEX_DISTR_XPATH + "/Distribution", "equal"
- )
- if vortex_distribution_gui == "cosine":
- vortex_distribution = 1.0
- elif vortex_distribution_gui == "sine":
- vortex_distribution = 2.0
- else:
- vortex_distribution = 3.0
- Nchordwise = get_value_or_default(cpacs.tixi, AVL_VORTEX_DISTR_XPATH + "/Nchordwise", 5)
- Nspanwise = get_value_or_default(cpacs.tixi, AVL_VORTEX_DISTR_XPATH + "/Nspanwise", 20)
- integrate_fuselage = get_value_or_default(cpacs.tixi, AVL_FUSELAGE_XPATH, False)
-
- return save_plots, vortex_distribution, Nchordwise, Nspanwise, integrate_fuselage
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-if __name__ == "__main__":
- log.info("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/avlresults.py b/ceasiompy/PyAVL/func/avlresults.py
deleted file mode 100644
index daba425f2..000000000
--- a/ceasiompy/PyAVL/func/avlresults.py
+++ /dev/null
@@ -1,225 +0,0 @@
-"""
-CEASIOMpy: Conceptual Aircraft Design Software
-
-Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-
-Extract results from AVL calculations and save them in a CPACS file.
-Plot the lift distribution from AVL strip forces file 'fs.txt'.
-Convert AVL 'plot.ps' to 'plot.pdf'.
-
-Python version: >=3.8
-
-| Author: Romain Gauthier
-| Creation: 2024-03-18
-
-TODO:
-
- *
-
-"""
-
-# =================================================================================================
-# IMPORTS
-# =================================================================================================
-
-from pathlib import Path
-import pandas as pd
-import matplotlib.pyplot as plt
-import subprocess
-
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.commonxpath import AVL_AEROMAP_UID_XPATH
-
-from cpacspy.cpacsfunctions import get_value
-from cpacspy.cpacspy import CPACS
-
-log = get_logger()
-
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
-
-
-# =================================================================================================
-# FUNCTIONS
-# =================================================================================================
-
-
-def plot_lift_distribution(force_file_fs, aoa, aos, mach, alt, wkdir):
- """Plot the lift distribution from AVL strip forces file (fs.txt)
-
- Args:
- force_file_fs (Path): Path to the AVL strip forces file
- aoa (float): angle of attack [deg]
- aos (float): angle of sideslip [deg]
- mach (float): mach number
- alt (float): flight altitude [m]
- wkir (path): path to save the plot
-
- Returns:
- """
- y_list = []
- chord_list = []
- cl_list = []
- clnorm_list = []
-
- with open(force_file_fs, "r") as fs:
- for line in fs:
- if "Cref =" in line:
- cref = float(line.split()[5])
-
- elif "# Spanwise =" in line:
- # number_strips = int(line.split()[7])
- number_strips = int(line.split("=")[2].split("F")[0])
-
- elif "Xle" in line:
- number_data = 0
- for line in fs:
- data = line.split()
- y_list.append(float(data[2]))
- chord_list.append(float(data[4]))
- cl_list.append(float(data[9]))
- clnorm_list.append(float(data[8]))
- number_data += 1
-
- # break when every line has been extracted
- if number_data == number_strips:
- break
-
- data_df = pd.DataFrame(
- {"y": y_list, "chord": chord_list, "cl": cl_list, "cl_norm": clnorm_list}
- )
-
- data_df.sort_values(by="y", inplace=True)
- data_df.reset_index(drop=True, inplace=True)
- data_df["cl_cref"] = data_df["cl"] * data_df["chord"] / cref
-
- _, ax = plt.subplots(figsize=(10, 5))
- data_df.plot("y", "cl_norm", ax=ax, label="$c_{l\perp}$", linestyle="dashed", color="r")
- data_df.plot("y", "cl", label="$c_l$", ax=ax, linestyle="dashed", color="#FFA500")
- data_df.plot(
- "y", "cl_cref", ax=ax, label="$c_l \cdot C/C_{ref}$", linestyle="solid", color="#41EE33"
- )
-
- plt.title(
- (
- "Lift distribution along the wing span "
- "($\\alpha=%.1f^{\circ}$, $\\beta=%.1f^{\circ}$, "
- "$M=%.1f$, alt = %d m)"
- )
- % (aoa, aos, mach, alt),
- fontsize=14,
- )
-
- plt.ylabel("$C_l$", rotation=0, fontsize=12)
- plt.legend(fontsize=12)
- plt.grid()
- plt.savefig(Path(wkdir, "lift_distribution.png"))
-
-
-def get_avl_aerocoefs(force_file_ft):
- """Get aerodynamic coefficients and velocity from AVL total forces file (ft.txt)
-
- Args:
- force_file_ft (Path): Path to the AVL total forces file
-
- Returns:
- cl, cd, cs, cmd, cms, cml: Aerodynamic coefficients
- """
-
- if not force_file_ft.is_file():
- raise FileNotFoundError(f"The AVL forces file '{force_file_ft}' has not been found!")
-
- cl, cd = None, None
-
- with open(force_file_ft) as f:
- for line in f.readlines():
- if "CLtot" in line:
- cl = float(line.split("=")[1].strip())
- if "CDtot" in line:
- cd = float(line.split("=")[1].strip())
- if "Cmtot" in line:
- cm = float(line.split("=")[2].strip())
-
- return cl, cd, cm
-
-
-def get_avl_results(cpacs_path, cpacs_out_path, wkdir):
- """Function to write AVL results in a CPACS file.
-
- Function 'get_avl_results' gets available results from the latest AVL calculation and put them
- at the correct place in the CPACS file.
-
- '/cpacs/vehicles/aircraft/model/analyses/aeroPerformance/aeroMap[n]/aeroPerformanceMap'
-
- Args:
- cpacs_path (Path): Path to input CPACS file
- cpacs_out_path (Path): Path to output CPACS file
- wkdir (Path): Path to the working directory
-
- """
-
- cpacs = CPACS(cpacs_path)
- if not wkdir.exists():
- raise OSError(f"The working directory : {wkdir} does not exit!")
- aeromap_uid = get_value(cpacs.tixi, AVL_AEROMAP_UID_XPATH)
-
- log.info(f"The aeromap uid is: {aeromap_uid}")
- aeromap = cpacs.get_aeromap_by_uid(aeromap_uid)
-
- alt_list = aeromap.get("altitude").tolist()
- mach_list = aeromap.get("machNumber").tolist()
- aoa_list = aeromap.get("angleOfAttack").tolist()
- aos_list = aeromap.get("angleOfSideslip").tolist()
-
- case_dir_list = [case_dir for case_dir in wkdir.iterdir() if "Case" in case_dir.name]
-
- for config_dir in sorted(case_dir_list):
- if not config_dir.is_dir():
- continue
-
- ft_file_path = Path(config_dir, "ft.txt")
-
- if not ft_file_path.exists():
- raise FileNotFoundError("No result total forces 'ft.txt' file have been found!")
-
- fs_file_path = Path(config_dir, "fs.txt")
- if not fs_file_path.exists():
- raise FileNotFoundError("No result strip forces 'fs.txt' file have been found!")
-
- case_nb = int(config_dir.name.split("_")[0].split("Case")[1])
-
- aoa = aoa_list[case_nb]
- aos = aos_list[case_nb]
- mach = mach_list[case_nb]
- alt = alt_list[case_nb]
-
- cl, cd, cm = get_avl_aerocoefs(ft_file_path)
- plot_lift_distribution(fs_file_path, aoa, aos, mach, alt, wkdir=config_dir)
-
- aeromap.add_coefficients(alt=alt, mach=mach, aos=aos, aoa=aoa, cd=cd, cl=cl, cms=cm)
- aeromap.save()
- cpacs.save_cpacs(cpacs_out_path, overwrite=True)
-
-
-def convert_ps_to_pdf(wkdir):
- """Function to convert AVL 'plot.ps' to 'plot.pdf'.
-
- Args:
- wkdir (Path): Path to the working directory.
-
- """
- if not Path(wkdir, "plot.ps").exists():
- raise FileNotFoundError("File 'plot.ps' does not exist.")
-
- subprocess.run(["ps2pdf", "plot.ps", "plot.pdf"], cwd=wkdir)
- subprocess.run(["rm", "plot.ps"], cwd=wkdir)
-
-
-# =================================================================================================
-# MAIN
-# =================================================================================================
-
-if __name__ == "__main__":
- log.info("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/config.py b/ceasiompy/PyAVL/func/config.py
new file mode 100644
index 000000000..9c1342df0
--- /dev/null
+++ b/ceasiompy/PyAVL/func/config.py
@@ -0,0 +1,200 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Script to get the flight conditions (alt, aoa, mach...) from
+the input CPACS file, and write the command file for AVL.
+More details at: https://web.mit.edu/drela/Public/web/avl/AVL_User_Primer.pdf.
+
+
+| Author: Romain Gauthier
+| Creation: 2024-03-14
+| Modified: Leon Deligny
+| Date: 11-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from pydantic import validate_call
+from cpacspy.cpacsfunctions import get_value
+from ceasiompy.PyAVL.func.utils import get_atmospheric_cond
+from ceasiompy.utils.mathsfunctions import non_dimensionalize_rate
+from ceasiompy.utils.ceasiompyutils import (
+ bool_,
+ get_aeromap_conditions,
+)
+
+from pathlib import Path
+from cpacspy.cpacspy import CPACS
+from tixi3.tixi3wrapper import Tixi3
+from ceasiompy.PyAVL.func.cpacs2avl import Avl
+from typing import (
+ List,
+ Tuple,
+)
+
+from ceasiompy import log, ceasiompy_cfg
+from ceasiompy.PyAVL import MODULE_DIR
+from ceasiompy.PyAVL.func import FORCE_FILES
+from ceasiompy.utils.commonxpath import (
+ AREA_XPATH,
+ LENGTH_XPATH,
+)
+from ceasiompy.PyAVL import (
+ AVL_PLOT_XPATH,
+ AVL_NB_CPU_XPATH,
+ AVL_ROTRATES_XPATH,
+ AVL_AEROMAP_UID_XPATH,
+ AVL_CTRLSURF_ANGLES_XPATH,
+)
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+@validate_call(config=ceasiompy_cfg)
+def retrieve_gui_values(cpacs: CPACS, results_dir: Path) -> Tuple[
+ List, List, List, List,
+ List, List,
+ Path, bool,
+ int,
+]:
+ tixi = cpacs.tixi
+ alt_list, mach_list, aoa_list, aos_list = get_aeromap_conditions(cpacs, AVL_AEROMAP_UID_XPATH)
+
+ save_fig = bool_(get_value(tixi, AVL_PLOT_XPATH))
+ rotation_rates_float = get_value(tixi, AVL_ROTRATES_XPATH)
+ control_surface_float = get_value(tixi, AVL_CTRLSURF_ANGLES_XPATH)
+
+ # Convert to lists
+ rotation_rate_list = [float(x) for x in str(rotation_rates_float).split(';')]
+ control_surface_list = [float(x) for x in str(control_surface_float).split(';')]
+
+ avl_file = Avl(tixi, results_dir)
+ avl_path = avl_file.convert_cpacs_to_avl()
+
+ nb_cpu = int(get_value(tixi, AVL_NB_CPU_XPATH))
+
+ return (
+ alt_list, mach_list, aoa_list, aos_list,
+ rotation_rate_list, control_surface_list,
+ avl_path,
+ save_fig,
+ nb_cpu,
+ )
+
+
+def write_command_file(
+ tixi: Tixi3,
+ avl_path: Path,
+ case_dir_path: Path,
+ save_plots: bool,
+ alt: float,
+ mach_number: float,
+ alpha: float,
+ beta: float = 0.0,
+ pitch_rate: float = 0.0,
+ roll_rate: float = 0.0,
+ yaw_rate: float = 0.0,
+ aileron: float = 0.0,
+ elevator: float = 0.0,
+ rudder: float = 0.0,
+) -> Path:
+ """
+ Writes the command file for AVL.
+
+ Args:
+ tixi (handles): TIXI Handle of the CPACS file.
+ avl_path (Path): Path to the AVL input file.
+ case_dir_path (Path): path to the run case directory
+ alpha (float): angle of attack [deg]
+ beta (float): angle of attack [deg]
+ pitch_rate (float): pitch rate [deg/s]
+ roll_rate (float): roll rate [deg/s]
+ yaw_rate (float): yaw rate [deg/s]
+ mach_number (float): Mach number
+ alt (float): Altitude.
+ aileron (float): Aileron angle [deg].
+ elevator (float): Elevator angle [deg].
+ rudder (float): Rudder angle [deg].
+ save_plots (bool): Saving plots condition.
+
+ Returns:
+ (Path): Path to the command file.
+
+ """
+
+ ref_density, g_acceleration, ref_velocity = get_atmospheric_cond(alt, mach_number)
+
+ command_path = str(case_dir_path) + "/avl_commands.txt"
+
+ # Retrieve template file for mass
+ mass_path = Path(MODULE_DIR, "files", "template.mass")
+
+ # Get the reference dimensions
+ s = tixi.getDoubleElement(AREA_XPATH)
+ c = tixi.getDoubleElement(LENGTH_XPATH)
+ b = s / c
+
+ # See https://web.mit.edu/drela/Public/web/avl/AVL_User_Primer.pdf
+ # for how he non-dimensionalize the rates
+ roll_rate_star, pitch_rate_star, yaw_rate_star = non_dimensionalize_rate(
+ p=roll_rate,
+ q=pitch_rate,
+ r=yaw_rate,
+ v=ref_velocity,
+ b=b,
+ c=c,
+ )
+
+ command = [
+ "load " + str(avl_path) + "\n",
+ "mass " + str(mass_path) + "\n",
+ "oper\n",
+ "a a " + str(alpha) + "\n",
+ "b b " + str(beta) + "\n",
+ "r r " + str(roll_rate_star) + "\n",
+ "p p " + str(pitch_rate_star) + "\n",
+ "y y " + str(yaw_rate_star) + "\n",
+ "d2 d2 " + str(aileron) + "\n",
+ "d3 d3 " + str(elevator) + "\n",
+ "d4 d4 " + str(rudder) + "\n",
+ "m\n",
+ "mn " + str(mach_number) + "\n",
+ "g " + str(g_acceleration) + "\n",
+ "d " + str(ref_density) + "\n",
+ "v " + str(ref_velocity) + "\n\n",
+ ]
+
+ with open(command_path, "w") as command_file:
+ command_file.writelines(command)
+ command_file.write("x\n")
+
+ if save_plots:
+ command_file.writelines(["t\n", "h\n\n"])
+ command_file.writelines(["g\n", "lo\n", "h\n\n"])
+
+ command_file.write("x\n")
+
+ for force_file in FORCE_FILES:
+ command_file.write(force_file + "\n")
+ command_file.write(force_file + ".txt\n")
+
+ command_file.write("\n\n\n")
+ command_file.write("quit")
+
+ return Path(command_path)
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/cpacs2avl.py b/ceasiompy/PyAVL/func/cpacs2avl.py
index 69a8b935c..6df04c392 100644
--- a/ceasiompy/PyAVL/func/cpacs2avl.py
+++ b/ceasiompy/PyAVL/func/cpacs2avl.py
@@ -5,15 +5,12 @@
Script to convert CPACS file geometry into AVL geometry
-Python version: >=3.8
| Author: Romain Gauthier
| Adapted from : Aidan Jungo script cpacs2sumo.py
| Creation: 2024-03-14
-
-TODO:
-
- * Improve link between wings and fuselages parts
+| Modified: Leon Deligny
+| Date: 11-Mar-2025
"""
@@ -21,556 +18,471 @@
# IMPORTS
# ==============================================================================
-from ceasiompy.utils.ceasiompyutils import get_results_directory
import math
import numpy as np
+
+from cpacspy.cpacsfunctions import (
+ get_uid,
+ get_value,
+)
+from ceasiompy.utils.mathsfunctions import (
+ euler2fix,
+ rotate_points,
+)
+from ceasiompy.PyAVL.func.utils import (
+ write_control,
+ to_cpacs_format,
+ get_points_ref,
+ convert_dist_to_avl_format,
+)
+from ceasiompy.utils.geometryfunctions import (
+ sum_points,
+ prod_points,
+ get_profile_coord,
+ check_if_rotated,
+ get_chord_span,
+ elements_number,
+ get_positionings,
+ convert_fuselage_profiles,
+ corrects_airfoil_profile,
+)
+
from pathlib import Path
-from scipy import interpolate
+from numpy import ndarray
+from tixi3.tixi3wrapper import Tixi3
+from scipy.interpolate import interp1d
+from typing import (
+ List,
+ Tuple,
+)
+from ceasiompy.utils.generalclasses import (
+ Point,
+ Transformation,
+)
+
+from ceasiompy import log
+from ceasiompy.PyAVL import (
+ AVL_DISTR_XPATH,
+ AVL_FUSELAGE_XPATH,
+ AVL_NSPANWISE_XPATH,
+ AVL_NCHORDWISE_XPATH,
+ AVL_FREESTREAM_MACH_XPATH,
+)
+from ceasiompy.utils.commonxpath import (
+ AREA_XPATH,
+ WINGS_XPATH,
+ LENGTH_XPATH,
+ FUSELAGES_XPATH,
+ AIRCRAFT_NAME_XPATH,
+)
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def compute_fuselage_coords(
+ i_sec: int,
+ elem_transf: Transformation,
+ sec_transf: Transformation,
+ fus_transf: Transformation,
+ pos_x_list: List, pos_z_list: List,
+ prof_size_y, prof_size_z,
+ fus_radius_vec,
+ x_fuselage,
+ y_fuselage_top, y_fuselage_bottom,
+):
+ # Compute coordinates of the center of section
+ body_frm_center_x = (
+ elem_transf.translation.x
+ + sec_transf.translation.x + pos_x_list[i_sec]
+ ) * fus_transf.scaling.x
+
+ body_frm_center_z = (
+ elem_transf.translation.z * sec_transf.scaling.z
+ + sec_transf.translation.z
+ + pos_z_list[i_sec]
+ ) * fus_transf.scaling.z
+
+ # Compute height and width of the section
+ _, y, z = prod_points(elem_transf.scaling, sec_transf.scaling, fus_transf.scaling)
+ body_frm_width = 2 * prof_size_y * y
+ body_frm_height = 2 * prof_size_z * z
+
+ # Compute diameter of the section as the mean between height and width
+ # AVL assumes only circular cross section for fuselage
+ fus_radius = np.mean([body_frm_height, body_frm_width]) / 2
+ fus_radius_vec[i_sec] = (fus_radius)
+
+ # Save the coordinates of the fuselage
+ x_fuselage[i_sec] = body_frm_center_x
+ y_fuselage_top[i_sec] = body_frm_center_z + fus_radius
+ y_fuselage_bottom[i_sec] = body_frm_center_z - fus_radius
+
+ return body_frm_width, body_frm_height
+
+
+def leadingedge_coordinates(
+ tixi: Tixi3,
+ avl_path,
+ i_wing,
+ i_sec,
+ x_LE_rot,
+ y_LE_rot,
+ z_LE_rot,
+ wg_sec_chord,
+ wg_sec_rot,
+ wing_xpath,
+ c_ref,
+ s_ref,
+ foil_dat_path,
+) -> None:
+
+ # Write the leading edge coordinates and the airfoil file
+ with open(avl_path, 'a') as avl_file:
+ avl_file.write("#---------------\nSECTION\n")
+ avl_file.write("#Xle Yle Zle Chord Ainc\n")
+ avl_file.write(
+ f"{x_LE_rot:.3f} {y_LE_rot:.3f} {z_LE_rot:.3f} "
+ f"{(wg_sec_chord):.3f} {wg_sec_rot.y}\n"
+ )
+
+ edge_xpath = "/componentSegments/componentSegment"
+ bis_xpath = "/controlSurfaces/trailingEdgeDevices"
+ control_xpath_base = wing_xpath + edge_xpath + bis_xpath
+ num_devices = tixi.getNumberOfChilds(control_xpath_base)
+
+ for i in range(1, num_devices + 1):
+ control_xpath = f"{control_xpath_base}/trailingEdgeDevice[{i}]"
+ control_uid = tixi.getTextAttribute(control_xpath, "uID")
+ innerhingeXsi_xpath = control_xpath + "/path/innerHingePoint/hingeXsi"
+ outerhingeXsi_xpath = control_xpath + "/path/outerHingePoint/hingeXsi"
+ innerhingeXsi = float(get_value(tixi, innerhingeXsi_xpath))
+ outerhingeXsi = float(get_value(tixi, outerhingeXsi_xpath))
+
+ innerEta_xpath = control_xpath + "/outerShape/innerBorder/etaTE/eta"
+ outerEta_xpath = control_xpath + "/outerShape/outerBorder/etaTE/eta"
+
+ innerEta = float(get_value(tixi, innerEta_xpath))
+ outerEta = float(get_value(tixi, outerEta_xpath))
+
+ x_axis = (outerhingeXsi - innerhingeXsi) * c_ref
+ y_axis = (outerEta - innerEta) * s_ref
+ z_axis = 0.0
+
+ CONTROL_DICT = {
+ "InnerFlap": {
+ "i_sec": [0, 1],
+ "type": "flap",
+ "axis": f"{x_axis} {y_axis} {z_axis}",
+ "bool": [1.0, 1.0],
+ },
+ "OuterFlap": {
+ "i_sec": [1, 2],
+ "type": "flap",
+ "axis": f"{x_axis} {y_axis} {z_axis}",
+ "bool": [1.0, 1.0],
+ },
+ "Aileron": {
+ "i_sec": [2, 3],
+ "type": "aileron",
+ "axis": f"{x_axis} {y_axis} {z_axis}",
+ "bool": [-1.0, -1.0],
+ },
+ "Elevator": {
+ "i_sec": [0, 1],
+ "type": "elevator",
+ "axis": f"{x_axis} {y_axis} {z_axis}",
+ "bool": [1.0, 1.0],
+ },
+ "Rudder": {
+ "i_sec": [0, 1],
+ "type": "rudder",
+ "axis": f"{x_axis} {z_axis} {y_axis}",
+ "bool": [-1.0, -1.0],
+ },
+ }
+ control_type = CONTROL_DICT[control_uid]["type"]
+
+ if i_sec == CONTROL_DICT[control_uid]["i_sec"][0]:
+ write_control(
+ avl_file,
+ control_type,
+ innerhingeXsi,
+ CONTROL_DICT[control_uid]["axis"],
+ CONTROL_DICT[control_uid]["bool"][0],
+ )
+ elif i_sec == CONTROL_DICT[control_uid]["i_sec"][1]:
+ write_control(
+ avl_file,
+ control_type,
+ outerhingeXsi,
+ CONTROL_DICT[control_uid]["axis"],
+ CONTROL_DICT[control_uid]["bool"][1],
+ )
+ else:
+ log.warning(
+ f"Issue with {control_uid} control surface "
+ f"at section {i_sec} of wing number {i_wing}."
+ )
-from ceasiompy.CPACS2SUMO.func.getprofile import get_profile_coord
+ avl_file.write("AFILE\n")
+ avl_file.write(foil_dat_path + "\n\n")
-from ceasiompy.utils.ceasiomlogger import get_logger
-from ceasiompy.utils.commonxpath import WINGS_XPATH, FUSELAGES_XPATH, REF_XPATH
-from ceasiompy.utils.generalclasses import SimpleNamespace, Transformation
-from ceasiompy.utils.mathfunctions import euler2fix
-from cpacspy.cpacsfunctions import open_tixi
+def write_airfoil_coords(
+ foil_dat_path: Path,
+ prof_uid: str,
+ prof_vect_x: ndarray,
+ prof_vect_z: ndarray,
+) -> None:
+ """
+ No need to add in Avl class.
+ """
+ with open(foil_dat_path, 'w') as dat_file:
+ dat_file.write(prof_uid + "\n")
-from ceasiompy.PyAVL.func.rotation3D import rotate_3D_points
-from ceasiompy.PyAVL.func.avlconfig import get_option_settings
+ prof_x_len = len(prof_vect_x)
-log = get_logger()
+ # Limit the number of points to 100 (otherwise AVL error)
+ if prof_x_len >= 100:
+ log.warning("Limiting the number of points.")
+ step = round(prof_x_len / 100)
+ prof_vect_x = prof_vect_x[0:prof_x_len:step]
+ prof_vect_z = prof_vect_z[0:prof_x_len:step]
+
+ for coord_x, coord_z in zip(prof_vect_x, prof_vect_z):
+ dat_file.write(f"{coord_x}\t{coord_z}\n")
# =================================================================================================
-# FUNCTIONS
+# CLASS
# =================================================================================================
-def convert_cpacs_to_avl(cpacs_path, machnumber, wkdir):
- """Function to convert a CPACS file geometry into an AVL file geometry.
+class Avl:
+ def __init__(
+ self: "Avl",
+ tixi: Tixi3,
+ results_dir: Path,
+ ) -> None:
- Function 'convert_cpacs_to_avl' opens an input CPACS file with TIXI handle
- and converts every element (as much as possible) in the AVL (.avl) format.
+ # Store input variables
+ self.tixi = tixi
+ self.results_dir = results_dir
- Source:
- * https://github.com/cfsengineering/CEASIOMpy/blob/main/ceasiompy/CPACS2SUMO/cpacs2sumo.py
+ # Retrieve GUI values
+ self.vortex_dist: int = convert_dist_to_avl_format(get_value(tixi, AVL_DISTR_XPATH))
+ self.nchordwise: int = get_value(tixi, AVL_NCHORDWISE_XPATH)
+ self.nspanwise: int = get_value(tixi, AVL_NSPANWISE_XPATH)
+ self.add_fuselage: bool = get_value(tixi, AVL_FUSELAGE_XPATH)
- Args:
- cpacs_path (Path) : path to the CPACS input file
+ self.area_ref: float = tixi.getDoubleElement(AREA_XPATH)
+ self.chord_ref: float = tixi.getDoubleElement(LENGTH_XPATH)
+ self.span_ref: float = self.area_ref / self.chord_ref
+ self.points_ref: ndarray = get_points_ref(tixi)
+
+ # .avl file type
+ self.name_aircraft = self.tixi.getTextElement(AIRCRAFT_NAME_XPATH)
+ self.avl_path = str(self.results_dir) + "/" + self.name_aircraft + ".avl"
+
+ def initialize_avl_command_file(self) -> Path:
+ with open(self.avl_path, 'w') as avl_file:
+ avl_file.write(self.name_aircraft + "\n\n")
+
+ def convert_cpacs_to_avl(self) -> Path:
+ """
+ Convert a CPACS file geometry into an AVL file geometry.
+
+ Source:
+ * https://github.com/cfsengineering/CEASIOMpy/blob/main/ceasiompy/CPACS2SUMO/cpacs2sumo.py
+
+ Workflow:
+ 1. Initialize command file .avl
+ 2. Convert fuselage (if included)
+ 3. Convert wings
+
+ Returns:
+ (Path): Path to the AVL input file.
+
+ """
+
+ # 1. Initialize command file .avl
+ self.initialize_avl_command_file()
+
+ mach = get_value(self.tixi, AVL_FREESTREAM_MACH_XPATH)
+ with open(self.avl_path, 'a') as avl_file:
+ # Default freestream mach number
+ avl_file.write('#Mach\n')
+ avl_file.write(f"{mach}\n\n")
+
+ # No Symmetry assumed
+ avl_file.write("#IYsym IZsym Zsym\n")
+ avl_file.write("0\t0\t0\n\n")
+
+ self.write_ref_values()
+
+ # 2. Convert fuselage (if included)
+ fus_z_profile, fus_radius_profile, body_transf = None, None, None
+ if self.add_fuselage:
+ fus_z_profile, fus_radius_profile, body_transf = self.convert_fuselage()
+
+ # 3. Convert wings
+ self.convert_wings(
+ fus_radius_profile,
+ fus_z_profile,
+ body_transf,
+ )
+
+ return Path(self.avl_path)
+
+ def convert_fuselage(
+ self: "Avl",
+ ) -> Tuple[interp1d, interp1d, Transformation]:
+ """
+ Convert fuselages from CPACS to avl format.
+
+ Workflow:
+ For each fuselage
+ 1. Write fuselage settings
+ For each sections
+ 2. Write the fuselage coordinates
+
+ """
+
+ fus_cnt = elements_number(self.tixi, FUSELAGES_XPATH, "fuselage")
- Returns:
- aircraft.avl : write the input AVL file
- avl_path (Path) : path to the AVL input file
- """
- tixi = open_tixi(cpacs_path)
-
- # Get the aircraft name
- name_aircraft = tixi.getTextElement("/cpacs/header/name")
-
- results_dir = get_results_directory("PyAVL")
- results_path = str(results_dir)
- avl_path = str(results_dir) + "/" + name_aircraft + ".avl"
-
- with open(avl_path, 'w') as avl_file:
- # Aircraft name
- avl_file.write(name_aircraft + "\n\n")
- # Mach number
- avl_file.write('#Mach\n')
- avl_file.write(str(machnumber) + "\n\n")
- # Symmetry
- avl_file.write("#IYsym IZsym Zsym\n")
- avl_file.write("0\t0\t0\n\n")
-
- _, vortex_distribution, Nchordwise, Nspanwise, integrate_fuselage = get_option_settings(
- cpacs_path)
-
- # Get the reference dimensions
- area_ref = tixi.getDoubleElement(REF_XPATH + '/area')
- chord_ref = tixi.getDoubleElement(REF_XPATH + '/length')
- span_ref = area_ref / chord_ref
- points_ref = np.array([tixi.getDoubleElement(REF_XPATH + '/point/x'),
- tixi.getDoubleElement(REF_XPATH + '/point/y'),
- tixi.getDoubleElement(REF_XPATH + '/point/z')])
- with open(avl_path, 'a') as avl_file:
- # Reference dimensions
- avl_file.write("#Sref Cref Bref\n")
- avl_file.write(f"{area_ref:.3f}\t{chord_ref:.3f}\t{span_ref:.3f}\n\n")
- # Reference location for moments/rotations
- avl_file.write("#Xref Yref Zref\n")
- for i_points in range(3):
- avl_file.write(f"{points_ref[i_points]:.3f}\t")
- avl_file.write("\n\n")
-
- # Fuselage(s) ---------------------------------------------------------------
-
- if tixi.checkElement(FUSELAGES_XPATH):
- fus_cnt = tixi.getNamedChildrenCount(FUSELAGES_XPATH, "fuselage")
- log.info(str(fus_cnt) + " fuselage has been found.")
- else:
- fus_cnt = 0
- log.warning("No fuselage has been found in this CPACS file!")
-
- if integrate_fuselage:
for i_fus in reversed(range(fus_cnt)):
fus_xpath = FUSELAGES_XPATH + "/fuselage[" + str(i_fus + 1) + "]"
- fus_uid = tixi.getTextAttribute(fus_xpath, "uID")
+ fus_uid = get_uid(self.tixi, fus_xpath)
+ fus_dat_path = str(self.results_dir) + "/" + fus_uid + ".dat"
+
fus_transf = Transformation()
- fus_transf.get_cpacs_transf(tixi, fus_xpath)
+ fus_transf.get_cpacs_transf(self.tixi, fus_xpath)
body_transf = Transformation()
body_transf.translation = fus_transf.translation
-
- # Convert angles
body_transf.rotation = euler2fix(fus_transf.rotation)
- # Add body origin
- body_ori_str = (
- str(body_transf.translation.x)
- + "\t"
- + str(body_transf.translation.y)
- + "\t"
- + str(body_transf.translation.z)
- )
+ # 1. Write fuselage settings
+ self.write_fuselage_settings(fus_transf.scaling, body_transf.translation)
- # Write fuselage settings
- with open(avl_path, 'a') as avl_file:
- avl_file.write("#--------------------------------------------------\n")
- avl_file.write("BODY\n")
- avl_file.write("Fuselage\n\n")
- avl_file.write("!Nbody Bspace\n")
- avl_file.write("100\t1.0\n\n")
-
- # Scaling
- avl_file.write("SCALE\n")
- avl_file.write(str(fus_transf.scaling.x)
- + "\t"
- + str(fus_transf.scaling.y)
- + "\t"
- + str(fus_transf.scaling.z)
- + "\n\n")
-
- # Translation
- avl_file.write("TRANSLATE\n")
- avl_file.write(body_ori_str + "\n\n")
-
- avl_file.write("NOWAKE\n\n")
-
- # Positionings
- if tixi.checkElement(fus_xpath + "/positionings"):
- pos_cnt = tixi.getNamedChildrenCount(fus_xpath + "/positionings", "positioning")
- log.info(str(fus_cnt) + ' "Positioning" has been found : ')
-
- pos_x_list = []
- pos_y_list = []
- pos_z_list = []
- from_sec_list = []
- to_sec_list = []
-
- for i_pos in range(pos_cnt):
- pos_xpath = fus_xpath + "/positionings/positioning[" + str(i_pos + 1) + "]"
-
- length = tixi.getDoubleElement(pos_xpath + "/length")
- sweep_deg = tixi.getDoubleElement(pos_xpath + "/sweepAngle")
- sweep = math.radians(sweep_deg)
- dihedral_deg = tixi.getDoubleElement(pos_xpath + "/dihedralAngle")
- dihedral = math.radians(dihedral_deg)
-
- # Get the corresponding translation of each positioning
- pos_x_list.append(length * math.sin(sweep))
- pos_y_list.append(length * math.cos(dihedral) * math.cos(sweep))
- pos_z_list.append(length * math.sin(dihedral) * math.cos(sweep))
-
- # Get which section are connected by the positioning
- if tixi.checkElement(pos_xpath + "/fromSectionUID"):
- from_sec = tixi.getTextElement(pos_xpath + "/fromSectionUID")
- else:
- from_sec = ""
- from_sec_list.append(from_sec)
-
- if tixi.checkElement(pos_xpath + "/toSectionUID"):
- to_sec = tixi.getTextElement(pos_xpath + "/toSectionUID")
- else:
- to_sec = ""
- to_sec_list.append(to_sec)
-
- # Re-loop though the positioning to re-order them
- for j_pos in range(pos_cnt):
- if from_sec_list[j_pos] == "":
- prev_pos_x = 0
- prev_pos_y = 0
- prev_pos_z = 0
-
- elif from_sec_list[j_pos] == to_sec_list[j_pos - 1]:
- prev_pos_x = pos_x_list[j_pos - 1]
- prev_pos_y = pos_y_list[j_pos - 1]
- prev_pos_z = pos_z_list[j_pos - 1]
-
- else:
- index_prev = to_sec_list.index(from_sec_list[j_pos])
- prev_pos_x = pos_x_list[index_prev]
- prev_pos_y = pos_y_list[index_prev]
- prev_pos_z = pos_z_list[index_prev]
-
- pos_x_list[j_pos] += prev_pos_x
- pos_y_list[j_pos] += prev_pos_y
- pos_z_list[j_pos] += prev_pos_z
+ sec_cnt, pos_x_list, pos_y_list, pos_z_list = get_positionings(
+ self.tixi, fus_xpath, "fuselage")
- else:
- log.warning('No "positionings" have been found!')
- pos_cnt = 0
-
- # Sections
- sec_cnt = tixi.getNamedChildrenCount(fus_xpath + "/sections", "section")
- log.info(" -" + str(sec_cnt) + " fuselage sections have been found")
- x_fuselage = np.zeros(sec_cnt)
- y_fuselage_top = np.zeros(sec_cnt)
- y_fuselage_bottom = np.zeros(sec_cnt)
- fus_radius_vec = np.zeros(sec_cnt)
- body_width_vec = np.zeros(sec_cnt)
- body_height_vec = np.zeros(sec_cnt)
-
- if pos_cnt == 0:
- pos_x_list = [0.0] * sec_cnt
- pos_y_list = [0.0] * sec_cnt
- pos_z_list = [0.0] * sec_cnt
+ # Initialize to null array of size [sec_cnt]
+ (
+ x_fuselage, y_fuselage_top, y_fuselage_bottom,
+ fus_radius_vec, body_width_vec, body_height_vec
+
+ ) = (np.zeros(sec_cnt) for _ in range(6))
for i_sec in range(sec_cnt):
sec_xpath = fus_xpath + "/sections/section[" + str(i_sec + 1) + "]"
- sec_uid = tixi.getTextAttribute(sec_xpath, "uID")
-
+ sec_uid = self.tixi.getTextAttribute(sec_xpath, "uID")
sec_transf = Transformation()
- sec_transf.get_cpacs_transf(tixi, sec_xpath)
+ sec_transf.get_cpacs_transf(self.tixi, sec_xpath)
+ check_if_rotated(sec_transf.rotation, sec_uid)
- if sec_transf.rotation.x or sec_transf.rotation.y or sec_transf.rotation.z:
- log.warning(
- f"Sections '{sec_uid}' is rotated, it is"
- "not possible to take that into account in SUMO !"
- )
-
- # Elements
- elem_cnt = tixi.getNamedChildrenCount(sec_xpath + "/elements", "element")
+ elem_cnt = self.tixi.getNamedChildrenCount(sec_xpath + "/elements", "element")
- if elem_cnt > 1:
- log.warning(
- "Sections "
- + sec_uid
- + " contains multiple \
- element, it could be an issue for the conversion \
- to SUMO!"
+ for i_elem in range(elem_cnt):
+ elem_transf, prof_size_y, prof_size_z, _, _ = convert_fuselage_profiles(
+ self.tixi, sec_xpath, i_sec, i_elem, pos_y_list, pos_z_list
)
- for i_elem in range(elem_cnt):
- elem_xpath = sec_xpath + "/elements/element[" + str(i_elem + 1) + "]"
- elem_uid = tixi.getTextAttribute(elem_xpath, "uID")
-
- elem_transf = Transformation()
- elem_transf.get_cpacs_transf(tixi, elem_xpath)
-
- if elem_transf.rotation.x or elem_transf.rotation.y or elem_transf.rotation.z:
- log.warning(
- f"Element '{elem_uid}' is rotated, it is"
- "not possible to take that into account in SUMO !"
- )
-
- # Fuselage profiles
- prof_uid = tixi.getTextElement(elem_xpath + "/profileUID")
- prof_vect_x, prof_vect_y, prof_vect_z = get_profile_coord(tixi, prof_uid)
-
- prof_size_y = (max(prof_vect_y) - min(prof_vect_y)) / 2
- prof_size_z = (max(prof_vect_z) - min(prof_vect_z)) / 2
-
- prof_vect_y[:] = [y / prof_size_y for y in prof_vect_y]
- prof_vect_z[:] = [z / prof_size_z for z in prof_vect_z]
-
- prof_min_y = min(prof_vect_y)
- prof_min_z = min(prof_vect_z)
-
- prof_vect_y[:] = [y - 1 - prof_min_y for y in prof_vect_y]
- prof_vect_z[:] = [z - 1 - prof_min_z for z in prof_vect_z]
-
- # Could be a problem if they are less positionings than sections
- # TODO: solve that!
- pos_y_list[i_sec] += ((1 + prof_min_y) * prof_size_y) * elem_transf.scaling.y
- pos_z_list[i_sec] += ((1 + prof_min_z) * prof_size_z) * elem_transf.scaling.z
-
- # Compute coordinates of the center of section
- body_frm_center_x = (
- elem_transf.translation.x + sec_transf.translation.x + pos_x_list[i_sec]
- ) * fus_transf.scaling.x
-
- body_frm_center_z = (
- elem_transf.translation.z * sec_transf.scaling.z
- + sec_transf.translation.z
- + pos_z_list[i_sec]
- ) * fus_transf.scaling.z
-
- # Compute height and width of the section
- body_frm_height = (
- prof_size_z
- * 2
- * elem_transf.scaling.z
- * sec_transf.scaling.z
- * fus_transf.scaling.z
+ body_frm_width, body_frm_height = compute_fuselage_coords(
+ i_sec,
+ elem_transf,
+ sec_transf,
+ fus_transf,
+ pos_x_list, pos_z_list,
+ prof_size_y, prof_size_z,
+ fus_radius_vec,
+ x_fuselage,
+ y_fuselage_top, y_fuselage_bottom,
)
- body_frm_width = (
- prof_size_y
- * 2
- * elem_transf.scaling.y
- * sec_transf.scaling.y
- * fus_transf.scaling.y
+
+ body_width_vec[i_sec] = body_frm_width
+ body_height_vec[i_sec] = body_frm_height
+
+ body_transf_x = x_fuselage + body_transf.translation.x
+ fus_z_profile = interp1d(body_transf_x, y_fuselage_top - fus_radius_vec)
+ fus_radius_profile = interp1d(body_transf_x, fus_radius_vec)
+
+ self.write_fuselage_coords(
+ fus_dat_path, i_fus,
+ x_fuselage, y_fuselage_bottom, y_fuselage_top,
)
- # Compute diameter of the section as the mean between height and width
- # AVL assumes only circular cross section for fuselage
- fus_radius = np.mean([body_frm_height, body_frm_width]) / 2
- fus_radius_vec[i_sec] = (fus_radius)
+ return fus_z_profile, fus_radius_profile, body_transf
- # Save the coordinates of the fuselage
- x_fuselage[i_sec] = body_frm_center_x
- y_fuselage_top[i_sec] = body_frm_center_z + fus_radius
- y_fuselage_bottom[i_sec] = body_frm_center_z - fus_radius
+ def convert_wings(
+ self: "Avl",
+ fus_radius_profile: interp1d,
+ fus_z_profile: interp1d,
+ body_transf: Transformation,
+ ) -> None:
+ wing_cnt = elements_number(self.tixi, WINGS_XPATH, "wing")
- body_width_vec[i_sec] = body_frm_width
- body_height_vec[i_sec] = body_frm_height
+ for i_wing in range(wing_cnt):
+ root_defined = False
+ wing_xpath = WINGS_XPATH + "/wing[" + str(i_wing + 1) + "]"
- fus_z_profile = interpolate.interp1d(
- x_fuselage + body_transf.translation.x, y_fuselage_top - fus_radius_vec)
- fus_radius_profile = interpolate.interp1d(
- x_fuselage + body_transf.translation.x, fus_radius_vec)
-
- fuselage_dir = Path(results_path) / "Fuselage_files"
- fuselage_dir.mkdir(exist_ok=True)
- fuselage_dat_path = fuselage_dir / f"{fus_uid}.dat"
-
- with open(fuselage_dat_path, 'w') as fus_file:
- fus_file.write("fuselage" + str(i_fus + 1) + "\n")
-
- # Write coordinates of the top surface
- for x_fus, y_fus in reversed(list(zip(x_fuselage[1:], y_fuselage_top[1:]))):
- fus_file.write(f"{x_fus:.3f}\t{y_fus:.3f}\n")
-
- # Write coordinates of the nose of the fuselage
- y_nose = np.mean([y_fuselage_top[0], y_fuselage_bottom[0]])
- fus_file.write(f"{x_fuselage[0]:.3f}\t{y_nose:.3f}\n")
-
- # Write coordinates of the bottom surface
- for x_fus, y_fus in zip(x_fuselage[1:], y_fuselage_bottom[1:]):
- fus_file.write(f"{x_fus:.3f}\t{y_fus:.3f}\n")
-
- with open(avl_path, 'a') as avl_file:
- avl_file.write("BFILE\n")
- avl_file.write(str(fuselage_dat_path) + "\n\n")
-
- # Wing(s) ------------------------------------------------------------------
- if tixi.checkElement(WINGS_XPATH):
- wing_cnt = tixi.getNamedChildrenCount(WINGS_XPATH, "wing")
- log.info(str(wing_cnt) + " wings has been found.")
- else:
- wing_cnt = 0
- log.warning("No wings has been found in this CPACS file!")
-
- if vortex_distribution > 3 or vortex_distribution < -3:
- log.warning(
- "The vortex distribution is not in the range [-3 ; 3]. "
- + "Default value of 1 will be used.")
- vortex_distribution = 1
-
- for i_wing in range(wing_cnt):
- root_defined = False
- wing_xpath = WINGS_XPATH + "/wing[" + str(i_wing + 1) + "]"
- wing_transf = Transformation()
- wing_transf.get_cpacs_transf(tixi, wing_xpath)
-
- # Create a class for the transformation of the WingSkeleton
- wg_sk_transf = Transformation()
-
- # Convert WingSkeleton rotation
- wg_sk_transf.rotation = euler2fix(wing_transf.rotation)
-
- # Add WingSkeleton origin
- wg_sk_transf.translation = wing_transf.translation
- wg_sk_ori_str = (
- str(round(wg_sk_transf.translation.x, 3))
- + "\t"
- + str(round(wg_sk_transf.translation.y, 3))
- + "\t"
- + str(round(wg_sk_transf.translation.z, 3))
- )
+ # Retrieve chord and span length of specific wing
+ c_ref, s_ref = get_chord_span(self.tixi, wing_xpath)
- # Write wing settings
- with open(avl_path, 'a') as avl_file:
- avl_file.write("#--------------------------------------------------\n")
- avl_file.write("SURFACE\n")
- avl_file.write("Wing\n\n")
- avl_file.write("!Nchordwise Cspace Nspanwise Sspace\n")
- avl_file.write(
- f"{Nchordwise} {vortex_distribution} {Nspanwise} {vortex_distribution}\n\n")
- avl_file.write('COMPONENT\n')
- avl_file.write("1\n\n")
+ wing_transf = Transformation()
+ wing_transf.get_cpacs_transf(self.tixi, wing_xpath)
- # Symmetry
- if tixi.checkAttribute(wing_xpath, "symmetry"):
- if tixi.getTextAttribute(wing_xpath, "symmetry") == "x-z-plane":
- avl_file.write('YDUPLICATE\n')
- avl_file.write("0\n\n")
-
- # Angle
- avl_file.write('ANGLE\n')
- avl_file.write("0\n\n")
-
- # Scaling
- avl_file.write("SCALE\n")
- avl_file.write(str(wing_transf.scaling.x)
- + "\t"
- + str(wing_transf.scaling.y)
- + "\t"
- + str(wing_transf.scaling.z)
- + "\n\n")
-
- # Translation
- avl_file.write("TRANSLATE\n")
- avl_file.write(wg_sk_ori_str + "\n\n")
-
- # Positionings
- if tixi.checkElement(wing_xpath + "/positionings"):
- pos_cnt = tixi.getNamedChildrenCount(wing_xpath + "/positionings", "positioning")
- log.info(str(pos_cnt) + ' "positioning" has been found : ')
-
- pos_x_list = []
- pos_y_list = []
- pos_z_list = []
- from_sec_list = []
- to_sec_list = []
-
- for i_pos in range(pos_cnt):
- pos_xpath = wing_xpath + "/positionings/positioning[" + str(i_pos + 1) + "]"
-
- length = tixi.getDoubleElement(pos_xpath + "/length")
- sweep_deg = tixi.getDoubleElement(pos_xpath + "/sweepAngle")
- sweep = math.radians(sweep_deg)
- dihedral_deg = tixi.getDoubleElement(pos_xpath + "/dihedralAngle")
- dihedral = math.radians(dihedral_deg)
-
- # Get the corresponding translation of each positioning
- pos_x_list.append(length * math.sin(sweep))
- pos_y_list.append(length * math.cos(dihedral) * math.cos(sweep))
- pos_z_list.append(length * math.sin(dihedral) * math.cos(sweep))
-
- # Get which section are connected by the positioning
- if tixi.checkElement(pos_xpath + "/fromSectionUID"):
- from_sec = tixi.getTextElement(pos_xpath + "/fromSectionUID")
- else:
- from_sec = ""
- from_sec_list.append(from_sec)
+ # Create a class for the transformation of the WingSkeleton
+ wg_sk_transf = Transformation()
+ wg_sk_transf.rotation = euler2fix(wing_transf.rotation)
+ wg_sk_transf.translation = wing_transf.translation
- if tixi.checkElement(pos_xpath + "/toSectionUID"):
- to_sec = tixi.getTextElement(pos_xpath + "/toSectionUID")
- else:
- to_sec = ""
- to_sec_list.append(to_sec)
-
- # Re-loop though the positioning to re-order them
- for j_pos in range(pos_cnt):
- if from_sec_list[j_pos] == "":
- prev_pos_x = 0
- prev_pos_y = 0
- prev_pos_z = 0
- elif from_sec_list[j_pos] == to_sec_list[j_pos - 1]:
- prev_pos_x = pos_x_list[j_pos - 1]
- prev_pos_y = pos_y_list[j_pos - 1]
- prev_pos_z = pos_z_list[j_pos - 1]
- else:
- index_prev = to_sec_list.index(from_sec_list[j_pos])
- prev_pos_x = pos_x_list[index_prev]
- prev_pos_y = pos_y_list[index_prev]
- prev_pos_z = pos_z_list[index_prev]
-
- pos_x_list[j_pos] += prev_pos_x
- pos_y_list[j_pos] += prev_pos_y
- pos_z_list[j_pos] += prev_pos_z
-
- else:
- log.warning('No "positionings" have been found!')
- pos_cnt = 0
-
- # Sections
- sec_cnt = tixi.getNamedChildrenCount(wing_xpath + "/sections", "section")
- log.info(" -" + str(sec_cnt) + " wing sections have been found")
-
- if pos_cnt == 0:
- pos_x_list = [0.0] * sec_cnt
- pos_y_list = [0.0] * sec_cnt
- pos_z_list = [0.0] * sec_cnt
-
- for i_sec in range(sec_cnt):
- sec_xpath = wing_xpath + "/sections/section[" + str(i_sec + 1) + "]"
- sec_uid = tixi.getTextAttribute(sec_xpath, "uID")
- sec_transf = Transformation()
- sec_transf.get_cpacs_transf(tixi, sec_xpath)
-
- # Elements
- elem_cnt = tixi.getNamedChildrenCount(sec_xpath + "/elements", "element")
-
- if elem_cnt > 1:
- log.warning(
- f"Sections {sec_uid} contains multiple element,"
- " it could be an issue for the conversion to SUMO!"
- )
+ self.write_wing_settings(
+ wing_xpath,
+ wing_transf.scaling,
+ wg_sk_transf.translation,
+ )
- for i_elem in range(elem_cnt):
- elem_xpath = sec_xpath + "/elements/element[" + str(i_elem + 1) + "]"
- elem_transf = Transformation()
- elem_transf.get_cpacs_transf(tixi, elem_xpath)
+ sec_cnt, pos_x_list, pos_y_list, pos_z_list = get_positionings(
+ self.tixi, wing_xpath, "wing")
- # Get wing profile (airfoil)
- prof_uid = tixi.getTextElement(elem_xpath + "/airfoilUID")
- prof_vect_x, prof_vect_y, prof_vect_z = get_profile_coord(tixi, prof_uid)
- airfoil_dir = Path(results_path) / "Airfoil_files"
- airfoil_dir.mkdir(exist_ok=True)
- airfoil_dat_path = airfoil_dir / f"{prof_uid}.dat"
-
- with open(airfoil_dat_path, 'w') as dat_file:
- dat_file.write(prof_uid + "\n")
- # Limit the number of points to 100 (otherwise AVL error)
- if len(prof_vect_x) < 100:
- for coord_x, coord_z in zip(prof_vect_x, prof_vect_z):
- dat_file.write(str(coord_x) + '\t' + str(coord_z) + "\n")
- else:
- step = round(len(prof_vect_x) / 100)
- for coord_x, coord_z in zip(prof_vect_x[0:len(prof_vect_x):step],
- prof_vect_z[0:len(prof_vect_x):step]):
- dat_file.write(str(coord_x) + '\t' + str(coord_z) + "\n")
+ for i_sec in range(sec_cnt):
+ sec_xpath = wing_xpath + "/sections/section[" + str(i_sec + 1) + "]"
+ sec_transf = Transformation()
+ sec_transf.get_cpacs_transf(self.tixi, sec_xpath)
- # Apply scaling
- for i, item in enumerate(prof_vect_x):
- # wing_transf.scaling removed
- prof_vect_x[i] = (item * elem_transf.scaling.x * sec_transf.scaling.x)
+ elem_xpath = sec_xpath + "/elements/element[1]"
+ elem_transf = Transformation()
+ elem_transf.get_cpacs_transf(self.tixi, elem_xpath)
- for i, item in enumerate(prof_vect_y):
- prof_vect_y[i] = (item * elem_transf.scaling.y * sec_transf.scaling.y)
+ # Get wing profile (airfoil)
+ prof_uid, prof_vect_x, prof_vect_y, prof_vect_z = get_profile_coord(
+ self.tixi, elem_xpath + "/airfoilUID")
- for i, item in enumerate(prof_vect_z):
- prof_vect_z[i] = (item * elem_transf.scaling.z * sec_transf.scaling.z)
+ airfoil_dir = Path(self.results_dir) / "Airfoil_files"
+ airfoil_dir.mkdir(exist_ok=True)
+ foil_dat_path = str(airfoil_dir / f"{prof_uid}.dat")
- prof_size_x = max(prof_vect_x) - min(prof_vect_x)
- prof_size_y = max(prof_vect_y) - min(prof_vect_y)
+ write_airfoil_coords(foil_dat_path, prof_uid, prof_vect_x, prof_vect_z)
- if prof_size_y == 0:
- prof_vect_x[:] = [x / prof_size_x for x in prof_vect_x]
- prof_vect_z[:] = [z / prof_size_x for z in prof_vect_z]
- # Is it correct to divide by prof_size_x ????
+ # Apply scaling
+ x, y, z = prod_points(elem_transf.scaling, sec_transf.scaling)
+ prof_vect_x *= x
+ prof_vect_y *= y
+ prof_vect_z *= z
- wg_sec_chord = prof_size_x
- else:
- log.error("An airfoil profile is not define correctly")
+ wg_sec_chord = corrects_airfoil_profile(prof_vect_x, prof_vect_y, prof_vect_z)
# Add rotation from element and sections
# Adding the two angles: Maybe not work in every case!!!
- add_rotation = SimpleNamespace()
- add_rotation.x = sec_transf.rotation.x + wg_sk_transf.rotation.x
- add_rotation.y = elem_transf.rotation.y + \
- sec_transf.rotation.y + wg_sk_transf.rotation.y
- add_rotation.z = sec_transf.rotation.z + wg_sk_transf.rotation.z
+ x, y, z = sum_points(
+ elem_transf.rotation,
+ sec_transf.rotation,
+ wg_sk_transf.rotation,
+ )
+ add_rotation = Point(x=x, y=y, z=z)
# Get Section rotation
wg_sec_rot = euler2fix(add_rotation)
@@ -578,59 +490,133 @@ def convert_cpacs_to_avl(cpacs_path, machnumber, wkdir):
wg_sec_twist = math.radians(wg_sec_rot.y)
wg_sec_yaw = math.radians(wg_sec_rot.z)
- # Define the leading edge position from translation/scaling
- x_LE = elem_transf.translation.x + \
- sec_transf.translation.x * sec_transf.scaling.x + pos_x_list[i_sec]
-
- y_LE = elem_transf.translation.y * elem_transf.scaling.y + \
- sec_transf.translation.y * sec_transf.scaling.y + pos_y_list[i_sec]
-
- z_LE = elem_transf.translation.z * elem_transf.scaling.z + \
- sec_transf.translation.z * sec_transf.scaling.z + pos_z_list[i_sec]
-
- x_LE_rot, y_LE_rot, z_LE_rot = rotate_3D_points(
- x_LE, y_LE, z_LE, wg_sec_dihed, wg_sec_twist, wg_sec_yaw)
+ if all(abs(value) < 1e-6 for value in pos_y_list):
+ # Define the leading edge position from translations
+ x_LE, y_LE, z_LE = sum_points(sec_transf.translation, elem_transf.translation)
+ x_LE_rot, y_LE_rot, z_LE_rot = rotate_points(
+ x_LE, y_LE, z_LE, wg_sec_dihed, wg_sec_twist, wg_sec_yaw)
+ else:
+ x_LE_rot, y_LE_rot, z_LE_rot = rotate_points(
+ pos_x_list[i_sec], pos_y_list[i_sec], pos_z_list[i_sec],
+ wg_sec_dihed, wg_sec_twist, wg_sec_yaw)
# Compute the absolute location of the leading edge
x_LE_abs = x_LE_rot + wg_sk_transf.translation.x
y_LE_abs = y_LE_rot + wg_sk_transf.translation.y
z_LE_abs = z_LE_rot + wg_sk_transf.translation.z
- if integrate_fuselage:
+ if self.add_fuselage:
# Compute the radius of the fuselage and the height difference ...
# between fuselage center and leading edge
radius_fus = fus_radius_profile(x_LE_abs + wg_sec_chord / 2)
fus_z_center = fus_z_profile(x_LE_abs + wg_sec_chord / 2)
- delta_z = np.abs(fus_z_center + body_transf.translation.z - z_LE_abs)
-
- # If the root wing section is inside the fuselage, translate it to...
- # the fuselage border
- # To make sure there is no wing part inside the fuselage
- if integrate_fuselage and np.sqrt((y_LE_abs)**2 + (delta_z)**2) < radius_fus and \
- wg_sec_dihed < math.pi / 2 and root_defined is False:
-
- y_LE_abs += np.sqrt(radius_fus**2 - delta_z**2) - y_LE_abs
- y_LE_rot = y_LE_abs - wg_sk_transf.translation.y
- root_defined = True
-
- with open(avl_path, 'a') as avl_file:
- avl_file.writelines([
- "#---------------\n",
- "SECTION\n",
- "#Xle Yle Zle Chord Ainc\n"
- ])
- avl_file.write(f"{x_LE_rot:.3f} {y_LE_rot:.3f} {z_LE_rot:.3f} "
- f"{(wg_sec_chord):.3f} {wg_sec_rot.y}\n\n")
-
- avl_file.writelines(["AFILE\n", str(airfoil_dat_path) + "\n\n"])
+ delta_z = np.abs(
+ fus_z_center + body_transf.translation.z - z_LE_abs)
+
+ # If the root wing section is inside the fuselage, translate it to...
+ # the fuselage border
+ # To make sure there is no wing part inside the fuselage
+ if np.sqrt((y_LE_abs)**2 + (delta_z)**2) < radius_fus and \
+ wg_sec_dihed < math.pi / 2 and root_defined is False:
+
+ y_LE_abs += np.sqrt(radius_fus**2 - delta_z**2) - y_LE_abs
+ y_LE_rot = y_LE_abs - wg_sk_transf.translation.y
+ root_defined = True
+
+ leadingedge_coordinates(
+ self.tixi,
+ self.avl_path,
+ i_wing,
+ i_sec,
+ x_LE_rot,
+ y_LE_rot,
+ z_LE_rot,
+ wg_sec_chord,
+ wg_sec_rot,
+ wing_xpath,
+ c_ref,
+ s_ref,
+ foil_dat_path,
+ )
- return Path(avl_path)
+ def write_wing_settings(
+ self,
+ wing_xpath,
+ scaling,
+ translation,
+ ) -> None:
+ # Write wing settings
+ with open(self.avl_path, 'a') as avl_file:
+ avl_file.write("#--------------------------------------------------\n")
+ avl_file.write("SURFACE\nWing\n\n")
+ avl_file.write("!Nchordwise Cspace Nspanwise Sspace\n")
+ avl_file.write(
+ f"{self.nchordwise} {self.vortex_dist} {self.nspanwise} {self.vortex_dist}\n\n"
+ )
+ avl_file.write("COMPONENT\n1\n\n")
+ # Symmetry
+ if (
+ self.tixi.checkAttribute(wing_xpath, "symmetry")
+ and self.tixi.getTextAttribute(wing_xpath, "symmetry") == "x-z-plane"
+ ):
+ avl_file.write("YDUPLICATE\n0\n\n")
+
+ # Angle, scaling and translation
+ avl_file.write("ANGLE\n0\n\n")
+ avl_file.write(f"SCALE\n{to_cpacs_format(scaling)}\n\n")
+ avl_file.write(f"TRANSLATE\n{to_cpacs_format(translation)}\n\n")
+
+ def write_ref_values(self) -> None:
+ with open(self.avl_path, 'a') as avl_file:
+ # Reference dimensions
+ avl_file.write("#Sref Cref Bref\n")
+ avl_file.write(f"{self.area_ref:.3f}\t{self.chord_ref:.3f}\t{self.span_ref:.3f}\n\n")
+
+ # Reference location for moments/rotations
+ avl_file.write("#Xref Yref Zref\n")
+ for i_points in range(3):
+ avl_file.write(f"{self.points_ref[i_points]:.3f}\t")
+ avl_file.write("\n\n")
+
+ def write_fuselage_coords(
+ self: "Avl",
+ fus_dat_path: Path,
+ i_fus: int,
+ x_fuselage, y_fuselage_bottom, y_fuselage_top
+ ) -> None:
+ with open(fus_dat_path, 'w') as fus_file:
+ fus_file.write("fuselage" + str(i_fus + 1) + "\n")
+
+ # Write coordinates of the top surface
+ for x_fus, y_fus in reversed(
+ list(zip(x_fuselage[1:], y_fuselage_top[1:]))):
+ fus_file.write(f"{x_fus:.3f}\t{y_fus:.3f}\n")
+
+ # Write coordinates of the nose of the fuselage
+ y_nose = np.mean([y_fuselage_top[0], y_fuselage_bottom[0]])
+ fus_file.write(f"{x_fuselage[0]:.3f}\t{y_nose:.3f}\n")
+
+ # Write coordinates of the bottom surface
+ for x_fus, y_fus in zip(x_fuselage[1:], y_fuselage_bottom[1:]):
+ fus_file.write(f"{x_fus:.3f}\t{y_fus:.3f}\n")
+
+ with open(self.avl_path, 'a') as avl_file:
+ avl_file.write("BFILE\n")
+ avl_file.write(fus_dat_path + "\n\n")
+
+ def write_fuselage_settings(self, scaling: Point, translation: Point) -> None:
+ with open(self.avl_path, 'a') as avl_file:
+ avl_file.write("#--------------------------------------------------\n")
+ avl_file.write("BODY\nFuselage\n\n")
+ avl_file.write("!Nbody Bspace\n100\t1.0\n\n")
+ avl_file.write(f"SCALE\n{to_cpacs_format(scaling)}\n\n")
+ avl_file.write(f"TRANSLATE\n{to_cpacs_format(translation)}\n\n")
# =================================================================================================
# MAIN
-# =================================================================================================
+# ================================================================================================
-if __name__ == "__main__":
+if __name__ == "__main__":
log.info("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/plot.py b/ceasiompy/PyAVL/func/plot.py
new file mode 100644
index 000000000..29470ccaa
--- /dev/null
+++ b/ceasiompy/PyAVL/func/plot.py
@@ -0,0 +1,134 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Extract results from AVL calculations and save them in a CPACS file.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Feb-14
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+import subprocess
+
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from pathlib import Path
+
+from ceasiompy import log
+
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def convert_ps_to_pdf(wkdir: Path) -> None:
+ """
+ Function to convert AVL 'plot.ps' to 'plot.pdf'.
+
+ Args:
+ wkdir (Path): Path to the working directory.
+
+ """
+ if not Path(wkdir, "plot.ps").exists():
+ log.warning("File 'plot.ps' does not exist. Nothing to convert.")
+ else:
+ subprocess.run(["ps2pdf", "plot.ps", "plot.pdf"], cwd=wkdir)
+ subprocess.run(["rm", "plot.ps"], cwd=wkdir)
+
+
+def plot_lift_distribution(
+ force_file_fs: Path,
+ aoa: float,
+ aos: float,
+ mach: float,
+ alt: float,
+ wkdir: Path
+) -> None:
+ """
+ Plot the lift distribution from AVL strip forces file (fs.txt)
+
+ Args:
+ force_file_fs (Path): Path to the AVL strip forces file.
+ aoa (float): Angle of attack [deg].
+ aos (float): Angle of sideslip [deg].
+ mach (float): Mach number.
+ alt (float): Flight altitude [m].
+ wkir (Path): Path to the directory on where to save the plot.
+
+ """
+ y_list = []
+ chord_list = []
+ cl_list = []
+ clnorm_list = []
+
+ with open(force_file_fs, "r") as fs:
+ for line in fs:
+ if "Cref =" in line:
+ cref = float(line.split()[5])
+
+ elif "# Spanwise =" in line:
+ number_strips = int(line.split()[7])
+
+ elif "Xle" in line:
+ number_data = 0
+ for line in fs:
+ data = line.split()
+ y_list.append(float(data[2]))
+ chord_list.append(float(data[4]))
+ cl_list.append(float(data[9]))
+ clnorm_list.append(float(data[8]))
+ number_data += 1
+
+ # break when every line has been extracted
+ if number_data == number_strips:
+ break
+
+ data_df = pd.DataFrame({
+ "y": y_list,
+ "chord": chord_list,
+ "cl": cl_list,
+ "cl_norm": clnorm_list
+ })
+
+ data_df.sort_values(by="y", inplace=True)
+ data_df.reset_index(drop=True, inplace=True)
+ data_df["cl_cref"] = data_df["cl"] * data_df["chord"] / cref
+
+ _, ax = plt.subplots(figsize=(10, 5))
+ data_df.plot("y", "cl_norm", ax=ax, label=r"$c_{l\perp}$", linestyle="dashed", color="r")
+ data_df.plot("y", "cl", label=r"$c_l$", ax=ax, linestyle="dashed", color="#FFA500")
+ data_df.plot(
+ "y", "cl_cref", ax=ax, label=r"$c_l \cdot C/C_{ref}$", linestyle="solid", color="#41EE33"
+ )
+
+ plt.title(
+ (
+ "Lift distribution along the wing span "
+ r"($\alpha=%.1f^{\circ}$, $\beta=%.1f^{\circ}$, "
+ r"$M=%.1f$, alt = %d m)"
+ )
+ % (aoa, aos, mach, alt),
+ fontsize=14,
+ )
+
+ plt.ylabel(r"$C_l$", rotation=0, fontsize=12)
+ plt.legend(fontsize=12)
+ plt.grid()
+ plt.savefig(Path(wkdir, "lift_distribution.png"))
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute.")
diff --git a/ceasiompy/PyAVL/func/results.py b/ceasiompy/PyAVL/func/results.py
new file mode 100644
index 000000000..fb48d41cf
--- /dev/null
+++ b/ceasiompy/PyAVL/func/results.py
@@ -0,0 +1,356 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Extract results from AVL calculations and save them in a CPACS file.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Feb-14
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+from cpacspy.aeromap import get_filter
+from cpacspy.cpacsfunctions import get_value
+from ceasiompy.PyAVL.func.plot import plot_lift_distribution
+from ceasiompy.PyAVL.func.utils import (
+ split_dir,
+ split_line,
+)
+from ceasiompy.utils.ceasiompyutils import (
+ bool_,
+ ensure_and_append_text_element,
+)
+
+from typing import Tuple
+from pathlib import Path
+from cpacspy.cpacspy import CPACS, AeroMap
+from tixi3.tixi3wrapper import Tixi3
+
+from ceasiompy import log
+from ceasiompy.PyAVL.func import AVL_COEFS
+from ceasiompy.PyAVL import (
+ AVL_XPATH,
+ AVL_TABLE_XPATH,
+ AVL_PLOTLIFT_XPATH,
+ AVL_CTRLTABLE_XPATH,
+ AVL_AEROMAP_UID_XPATH,
+)
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def get_avl_aerocoefs(force_file: Path) -> Tuple[
+ float, float, float,
+ float, float, float,
+ float, float, float,
+]:
+ """
+ Get aerodynamic coefficients and velocity from AVL total forces file (sb.txt).
+
+ Args:
+ force_file_ft (Path): Path to the AVL total forces file.
+
+ Returns:
+ cl (float): Lift coefficient.
+ cd (float): Drag coefficient.
+ cs (float): Side force coefficient.
+ cmd (float): Rolling moment.
+ cml (float): Yawing moment.
+ cms (float): Pitching moment.
+ cms_a (float): Derivative of Pitching moment with respect to the angle of attack.
+ cml_b (float): Derivative of Yawing moment with respect to the sidesplip angle.
+ cmd_b (float): Derivative of Rolling moment with respect to the sidesplip angle.
+
+ """
+
+ results = {key: None for key in AVL_COEFS.values()}
+
+ with open(force_file) as f:
+ for line in f.readlines():
+ for key, (index, var_name) in AVL_COEFS.items():
+ if key in line:
+ # Exception as they appear twice in .txt file
+ if key in ["Clb", "Cnb"]:
+ parts = line.split('=')
+ if len(parts) > 2:
+ results[var_name] = split_line(line, index)
+ else:
+ results[var_name] = split_line(line, index)
+
+ return (
+ results["cd"], results["cs"], results["cl"],
+ results["cmd"], results["cms"], results["cml"],
+ results["cmd_b"], results["cms_a"], results["cml_b"],
+ )
+
+
+def add_coefficients_in_aeromap(
+ cpacs: CPACS,
+ alt: float,
+ mach: float,
+ aos: float,
+ aoa: float,
+ fs_file_path: Path,
+ st_file_path: Path,
+ config_dir: Path,
+) -> None:
+ """
+ Add aerodynamic coefficients from PyAVL in chosen aeromap.
+
+ Args:
+ cpacs (CPACS): CPACS file.
+ alt (float): Altitude.
+ mach (float): Mach Number.
+ aos (float): SideSlip angle.
+ aoa (float): Angle of attack.
+ fs_file_path (Path): Path to force coefficients for plot.
+ st_file_path (Path): Path to moment coefficients.
+ config_dir (Path): Configuration Directory for plot.
+
+ """
+
+ tixi = cpacs.tixi
+
+ cl, cd, cs, cmd, cml, cms, cms_a, cml_b, cmd_b = get_avl_aerocoefs(st_file_path)
+
+ plot = bool_(get_value(tixi, AVL_PLOTLIFT_XPATH))
+
+ if plot:
+ plot_lift_distribution(fs_file_path, aoa, aos, mach, alt, wkdir=config_dir)
+
+ aeromap_uid = get_value(tixi, AVL_AEROMAP_UID_XPATH)
+ aeromap: AeroMap = cpacs.get_aeromap_by_uid(aeromap_uid)
+
+ filt = get_filter(aeromap.df, [alt], [mach], [aos], [aoa])
+ if aeromap.df.loc[filt].empty:
+ aeromap.add_row(
+ alt=alt,
+ mach=mach,
+ aos=aos,
+ aoa=aoa,
+ )
+
+ # Add coefficients to the aeromap
+ aeromap.add_coefficients(
+ alt=alt,
+ mach=mach,
+ aos=aos,
+ aoa=aoa,
+ cd=cd,
+ cl=cl,
+ cs=cs,
+ cmd=cmd,
+ cml=cml,
+ cms=cms
+ )
+
+ increment_maps_xpath = f"{aeromap.xpath}/incrementMaps"
+ increment_map_xpath = f"{increment_maps_xpath}/incrementMap"
+
+ # Ensure the incrementMaps and incrementMap elements exist
+ if not tixi.checkElement(increment_maps_xpath):
+ tixi.createElement(aeromap.xpath, "incrementMaps")
+ if not tixi.checkElement(increment_map_xpath):
+ tixi.createElement(increment_maps_xpath, "incrementMap")
+
+ # Add text elements for the coefficients
+ ensure_and_append_text_element(tixi, increment_map_xpath, "dcmd", str(cmd_b))
+ ensure_and_append_text_element(tixi, increment_map_xpath, "dcms", str(cms_a))
+ ensure_and_append_text_element(tixi, increment_map_xpath, "dcml", str(cml_b))
+
+ aeromap.save()
+
+
+def add_coefficients(
+ tixi: Tixi3,
+ xpath: str,
+ table_name: str,
+ coefficients: dict,
+) -> None:
+ """
+ Adds aerodynamic coefficients to a specified table.
+ """
+
+ if not tixi.checkElement(xpath):
+ tixi.createElement(AVL_XPATH, table_name)
+
+ # Add text elements for the coefficients
+ for name, value in coefficients.items():
+ ensure_and_append_text_element(tixi, xpath, name, str(value))
+
+
+def add_coefficients_in_table(
+ tixi: Tixi3,
+ mach: float,
+ aos: float,
+ aoa: float,
+ p: float,
+ q: float,
+ r: float,
+ st_file_path: Path,
+) -> None:
+ """
+ Add aerodynamic coefficients from PyAVL in specific table.
+ xPath of Table: AVL_TABLE_XPATH.
+
+ Args:
+ cpacs (CPACS): CPACS file.
+ mach (float): Mach Number.
+ aos (float): SideSlip angle.
+ aoa (float): Angle of attack.
+ p (float): Roll rate.
+ q (float): Pitch rate.
+ r (float): Yaw rate.
+ st_file_path (Path): Path to moment coefficients.
+
+ """
+
+ cd, cs, cl, cmd, cms, cml, _, _, _ = get_avl_aerocoefs(st_file_path)
+
+ coefficients = {
+ "mach": mach,
+ "aoa": aoa, "aos": aos,
+ "p": p, "q": q, "r": r,
+ "cd": cd, "cs": cs, "cl": cl,
+ "cmd": cmd, "cms": cms, "cml": cml,
+ }
+
+ add_coefficients(tixi, AVL_TABLE_XPATH, "Table", coefficients)
+
+
+def add_coefficients_in_ctrltable(
+ tixi: Tixi3,
+ mach: float,
+ aoa: float,
+ aileron: float,
+ elevator: float,
+ rudder: float,
+ st_file_path: Path,
+) -> None:
+ """
+ Add aerodynamic coefficients from PyAVL in specific ctrltable.
+ xPath of Table: AVL_CTRLTABLE_XPATH.
+
+ Args:
+ cpacs (CPACS): CPACS file.
+ mach (float): Mach Number.
+ aos (float): SideSlip angle.
+ aoa (float): Angle of attack.
+ aileron (float): Aileron rate.
+ elevator (float): Elevator rate.
+ rudder (float): Rudder rate.
+ st_file_path (Path): Path to moment coefficients.
+
+ """
+
+ cd, cs, cl, cmd, cms, cml, _, _, _ = get_avl_aerocoefs(st_file_path)
+
+ coefficients = {
+ "mach": mach,
+ "aoa": aoa,
+ "aileron": aileron, "elevator": elevator, "rudder": rudder,
+ "cd": cd, "cs": cs, "cl": cl,
+ "cmd": cmd, "cms": cms, "cml": cml,
+ }
+
+ add_coefficients(tixi, AVL_CTRLTABLE_XPATH, "CtrlTable", coefficients)
+
+
+def get_force_files(config_dir: Path) -> Tuple[Path, Path]:
+ st_file_path = Path(config_dir, "st.txt")
+ if not st_file_path.exists():
+ raise FileNotFoundError(
+ f"No result total forces 'st.txt' file have been found at {st_file_path}. "
+ )
+
+ fs_file_path = Path(config_dir, "fs.txt")
+ if not fs_file_path.exists():
+ raise FileNotFoundError(
+ f"No result strip forces 'fs.txt' file have been found {fs_file_path}"
+ )
+
+ return st_file_path, fs_file_path
+
+
+def get_avl_results(cpacs: CPACS, results_dir: Path) -> None:
+ """
+ Write AVL results in a CPACS file at xPath:
+ '/cpacs/vehicles/aircraft/model/analyses/aeroPerformance/aeroMap[n]/aeroPerformanceMap'
+ """
+
+ tixi = cpacs.tixi
+ case_dir_list = [
+ case_dir
+ for case_dir in results_dir.iterdir()
+ if ("Case" in case_dir.name) and (case_dir.is_dir())
+ ]
+
+ for config_dir in sorted(case_dir_list):
+ dir_name = config_dir.name
+ st_file_path, fs_file_path = get_force_files(config_dir)
+
+ # Extract common parameters
+ alt = split_dir(dir_name, 1, "alt")
+ mach = split_dir(dir_name, 2, "mach")
+ aoa = split_dir(dir_name, 3, "aoa" if "p" in dir_name else "alt")
+
+ if "p" in dir_name: # Standard aeromap or dynamic stability
+ aos = split_dir(dir_name, 4, "aos")
+ q = split_dir(dir_name, 5, "q")
+ p = split_dir(dir_name, 6, "p")
+ r = split_dir(dir_name, 7, "r")
+
+ if (p == 0.0) and (q == 0.0) and (r == 0.0):
+ add_coefficients_in_aeromap(
+ cpacs,
+ alt,
+ mach,
+ aos,
+ aoa,
+ fs_file_path,
+ st_file_path,
+ config_dir,
+ )
+
+ # Add coefficients for dynamic stability
+ add_coefficients_in_table(
+ tixi,
+ mach,
+ aos,
+ aoa,
+ p,
+ q,
+ r,
+ st_file_path,
+ )
+ else: # Control surface deflections for dynamic stability
+ aileron = split_dir(dir_name, 4, "aileron")
+ elevator = split_dir(dir_name, 5, "elevator")
+ rudder = split_dir(dir_name, 6, "rudder")
+
+ # Add coefficients for control surface deflections
+ add_coefficients_in_ctrltable(
+ tixi,
+ mach,
+ aoa,
+ aileron,
+ elevator,
+ rudder,
+ st_file_path,
+ )
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/rotation3D.py b/ceasiompy/PyAVL/func/rotation3D.py
deleted file mode 100644
index 9b4c3deb0..000000000
--- a/ceasiompy/PyAVL/func/rotation3D.py
+++ /dev/null
@@ -1,88 +0,0 @@
-"""
-CEASIOMpy: Conceptual Aircraft Design Software
-
-Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
-
-Function to apply a 3D rotation to the coordinates of a point.
-
-Python version: >=3.8
-
-| Author: Romain Gauthier
-| Creation: 2024-03-13
-
-"""
-
-
-# ==============================================================================
-# IMPORTS
-# ==============================================================================
-
-from ceasiompy.utils.ceasiomlogger import get_logger
-import numpy as np
-import math
-
-log = get_logger()
-
-
-# ==============================================================================
-# FUNCTIONS
-# ==============================================================================
-
-
-def rotate_3D_points(x, y, z, angle_x, angle_y, angle_z):
- """Function to apply a 3D rotation to the coordinates of a point
-
- Function 'rotate_3D_points' returns the rotated points after applying
- a 3D rotation matrix.
-
- Source:
- * https://en.wikipedia.org/wiki/Rotation_matrix
-
- Args:
- x (float): x coordinate of the initial point
- y (float): y coordinate of the initial point
- z (float): z coordinate of the initial point
- angle_x (float): rotation angle around x-axis [rad]
- angle_y (float): rotation angle around y-axis [rad]
- angle_z (float): rotation angle around z-axis [rad]
-
- Returns:
- x_rot (float): x coordinate of the rotated point
- y_rot (float): y coordinate of the rotated point
- z_rot (float): z coordinate of the rotated point
- """
- R11 = math.cos(angle_z) * math.cos(angle_y)
- R12 = math.cos(angle_z) * math.sin(angle_y) * math.sin(angle_x) - \
- math.sin(angle_z) * math.cos(angle_x)
- R13 = math.cos(angle_z) * math.sin(angle_y) * math.cos(angle_x) + \
- math.sin(angle_z) * math.sin(angle_x)
- R21 = math.sin(angle_z) * math.cos(angle_y)
- R22 = math.sin(angle_z) * math.sin(angle_y) * math.sin(angle_x) + \
- math.cos(angle_z) * math.cos(angle_x)
- R23 = math.sin(angle_z) * math.sin(angle_y) * math.cos(angle_x) - \
- math.cos(angle_z) * math.sin(angle_x)
- R31 = -math.sin(angle_y)
- R32 = math.cos(angle_y) * math.sin(angle_x)
- R33 = math.cos(angle_y) * math.cos(angle_x)
-
- rotation_matrix = np.array([[R11, R12, R13],
- [R21, R22, R23],
- [R31, R32, R33]])
-
- x_rot = x * rotation_matrix[0, 0] + y * \
- rotation_matrix[0, 1] + z * rotation_matrix[0, 2]
- y_rot = x * rotation_matrix[1, 0] + y * \
- rotation_matrix[1, 1] + z * rotation_matrix[1, 2]
- z_rot = x * rotation_matrix[2, 0] + y * \
- rotation_matrix[2, 1] + z * rotation_matrix[2, 2]
-
- return x_rot, y_rot, z_rot
-
-
-# ==============================================================================
-# MAIN
-# ==============================================================================
-
-if __name__ == "__main__":
-
- print("Nothing to execute!")
diff --git a/ceasiompy/PyAVL/func/utils.py b/ceasiompy/PyAVL/func/utils.py
new file mode 100644
index 000000000..8314b5857
--- /dev/null
+++ b/ceasiompy/PyAVL/func/utils.py
@@ -0,0 +1,167 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Utils for PyAVL module.
+
+
+| Author: Leon Deligny
+| Creation: 2025-Feb-28
+
+"""
+
+# =================================================================================================
+# IMPORTS
+# =================================================================================================
+
+import numpy as np
+
+from pydantic import validate_call
+
+from pathlib import Path
+from numpy import ndarray
+from itertools import product
+from ambiance import Atmosphere
+from tixi3.tixi3wrapper import Tixi3
+from ceasiompy.utils.generalclasses import Point
+from typing import (
+ List,
+ Tuple,
+ TextIO,
+)
+
+from ceasiompy.utils.commonxpath import REF_XPATH
+from ceasiompy import (
+ log,
+ ceasiompy_cfg,
+)
+
+# =================================================================================================
+# FUNCTIONS
+# =================================================================================================
+
+
+def get_points_ref(tixi: Tixi3) -> ndarray:
+ return np.array([
+ tixi.getDoubleElement(REF_XPATH + "/point/x"),
+ tixi.getDoubleElement(REF_XPATH + "/point/y"),
+ tixi.getDoubleElement(REF_XPATH + "/point/z"),
+ ])
+
+
+def write_control(
+ avl_file: TextIO,
+ control_type: str,
+ hinge_xsi: float,
+ axis: str,
+ control_bool: float
+) -> None:
+ """Helper function to write CONTROL section."""
+ avl_file.write("CONTROL\n")
+ avl_file.write(f"{control_type} {0.0} {hinge_xsi} {axis} {control_bool}\n\n")
+
+
+def split_dir(dir_name: str, index: int, param: str) -> float:
+ return float(dir_name.split("_")[index].split(param)[1])
+
+
+def split_line(line: str, index: int):
+ return float(line.split("=")[index].strip().split()[0])
+
+
+def get_atmospheric_cond(alt: float, mach: float) -> Tuple[float, float, float]:
+ Atm = Atmosphere(alt)
+ density = Atm.density[0]
+ g = Atm.grav_accel[0]
+ velocity = Atm.speed_of_sound[0] * mach
+
+ return density, g, velocity
+
+
+def create_case_dir(results_dir: Path, i_case: int, alt: float, **params: float) -> Path:
+ # Log the parameters
+ param_log = ", ".join(f"{key}: {value}" for key, value in params.items())
+ log.info(f"--- alt: {alt}, {param_log} ---")
+
+ # Create the case directory name dynamically
+ case_dir_name = f"Case{str(i_case).zfill(2)}_alt{alt}" + "".join(
+ f"_{key}{round(value, 2) if isinstance(value, float) else value}"
+ for key, value in params.items()
+ )
+
+ # Create the directory
+ case_dir_path = Path(results_dir, case_dir_name)
+ case_dir_path.mkdir(exist_ok=True)
+
+ return case_dir_path
+
+
+def convert_dist_to_avl_format(vortex_dist: str) -> int:
+ if vortex_dist == "cosine":
+ return 1
+ elif vortex_dist == "sine":
+ return 2
+ else:
+ return 3
+
+
+def to_cpacs_format(point: Point) -> str:
+ return str(point.x) + "\t" + str(point.y) + "\t" + str(point.z)
+
+
+@validate_call(config=ceasiompy_cfg)
+def duplicate_elements(*lists: List) -> Tuple[List, ...]:
+ """
+ Duplicates lists such that there is a unique combination of them
+ and the last three lists are zero-independent.
+
+ zero-independent: For a unique combination of elements, you will have,
+ (elem1, ..., elemn) (value, 0.0, 0.0)
+ (elem1, ..., elemn) (0.0, value, 0.0)
+ (elem1, ..., elemn) (0.0, 0.0, value)
+
+ Objective:
+ SDSA requires data of the specified type.
+
+ Returns:
+ (Tuple[List, ...]): Number of *lists + 2, where the 3 last lists are zero-independent.
+
+ """
+ if len(lists) < 2:
+ return tuple(lists)
+
+ *initial_lists, last_list = lists
+ combinations = list(product(*initial_lists))
+
+ n = len(initial_lists)
+ new_lists = [[] for _ in initial_lists] + [[] for _ in range(3)]
+
+ def append_combination(combination: List, values: List) -> None:
+ """Appends a combination with specific values."""
+ for i, entry in enumerate(combination):
+ new_lists[i].append(entry)
+ for j, value in enumerate(values):
+ new_lists[n + j].append(value)
+
+ for value in last_list:
+ if value == 0.0:
+ for combination in combinations:
+ append_combination(combination, [0.0, 0.0, 0.0])
+ else:
+ for combination in combinations:
+ append_combination(combination, [value, 0.0, 0.0])
+ for combination in combinations:
+ append_combination(combination, [0.0, value, 0.0])
+ for combination in combinations:
+ append_combination(combination, [0.0, 0.0, value])
+
+ return tuple(new_lists)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute.")
diff --git a/ceasiompy/PyAVL/pyavl.py b/ceasiompy/PyAVL/pyavl.py
new file mode 100644
index 000000000..c25b4d9a3
--- /dev/null
+++ b/ceasiompy/PyAVL/pyavl.py
@@ -0,0 +1,203 @@
+"""
+CEASIOMpy: Conceptual Aircraft Design Software
+
+Developed by CFS ENGINEERING, 1015 Lausanne, Switzerland
+
+Script to run AVL calculations in CEASIOMpy.
+AVL allows to perform aerodynamic analyses using
+the vortex-lattice method (VLM)
+
+
+| Author: Romain Gauthier
+| Creation: 2024-03-14
+| Modified: Leon Deligny
+| Date: 11-Mar-2025
+
+"""
+
+# ==============================================================================
+# IMPORTS
+# ==============================================================================
+
+from ceasiompy.PyAVL.func.plot import convert_ps_to_pdf
+from ceasiompy.PyAVL.func.results import get_avl_results
+from ceasiompy.PyAVL.func.utils import (
+ create_case_dir,
+ duplicate_elements,
+)
+from ceasiompy.PyAVL.func.config import (
+ write_command_file,
+ retrieve_gui_values,
+)
+from ceasiompy.utils.ceasiompyutils import (
+ call_main,
+ run_software,
+)
+
+from pathlib import Path
+from cpacspy.cpacspy import CPACS
+
+from ceasiompy.PyAVL import (
+ MODULE_NAME,
+ SOFTWARE_NAME,
+)
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+def main(cpacs: CPACS, results_dir: Path) -> None:
+ """
+ Run AVL calculations on specified CPACS file.
+ 1. Load the necessary data.
+ 2. Run avl with p, q, r rate deflections.
+ 3. Run avl with control surfaces deflections.
+ """
+
+ # 1. Load the necessary data
+ tixi = cpacs.tixi
+
+ (
+ alt_list, mach_list, aoa_list, aos_list,
+ rotation_rate_list, control_surface_list,
+ avl_path,
+ save_fig,
+ nb_cpu,
+
+ ) = retrieve_gui_values(cpacs, results_dir)
+
+ #
+ # 2. p, q, r
+ (
+ new_alt_list,
+ new_mach_list,
+ new_aoa_list,
+ new_aos_list,
+ new_pitch_rate_list,
+ new_roll_rate_list,
+ new_yaw_rate_list
+ ) = duplicate_elements(
+ list(set(alt_list)),
+ list(set(mach_list)),
+ list(set(aoa_list)),
+ list(set(aos_list)),
+ list(set(rotation_rate_list)),
+ )
+ first_cases = len(new_alt_list)
+
+ for i_case, alt in enumerate(new_alt_list):
+ mach = new_mach_list[i_case]
+ aoa = new_aoa_list[i_case]
+ aos = new_aos_list[i_case]
+
+ q = new_pitch_rate_list[i_case]
+ p = new_roll_rate_list[i_case]
+ r = new_yaw_rate_list[i_case]
+
+ case_dir_path = create_case_dir(
+ results_dir,
+ i_case,
+ alt,
+ mach=mach,
+ aoa=aoa,
+ aos=aos,
+ q=q,
+ p=p,
+ r=r,
+ )
+
+ command_path = write_command_file(
+ tixi=tixi,
+ avl_path=avl_path,
+ case_dir_path=case_dir_path,
+ save_plots=save_fig,
+ alpha=aoa,
+ beta=aos,
+ pitch_rate=q,
+ roll_rate=p,
+ yaw_rate=r,
+ mach_number=mach,
+ alt=alt,
+ )
+
+ run_software(
+ software_name=SOFTWARE_NAME,
+ arguments=[""],
+ wkdir=case_dir_path,
+ with_mpi=False,
+ nb_cpu=nb_cpu,
+ stdin=open(str(command_path), "r"),
+ )
+
+ if save_fig:
+ convert_ps_to_pdf(case_dir_path)
+
+ if control_surface_list != [0.0]:
+
+ #
+ # 3. aileron, elevator, rudder
+ (
+ new_alt_list,
+ new_mach_list,
+ new_aoa_list,
+ new_aileron_list,
+ new_elevator_list,
+ new_rudder_list
+ ) = duplicate_elements(
+ list(set(alt_list)),
+ list(set(mach_list)),
+ list(set(aoa_list)),
+ list(set(control_surface_list)),
+ )
+
+ # Iterate through each case
+ for i_case, alt in enumerate(new_alt_list):
+ mach = new_mach_list[i_case]
+ aoa = new_aoa_list[i_case]
+
+ aileron = new_aileron_list[i_case]
+ elevator = new_elevator_list[i_case]
+ rudder = new_rudder_list[i_case]
+
+ case_dir_path = create_case_dir(
+ results_dir,
+ i_case + first_cases,
+ alt,
+ mach=mach,
+ aoa=aoa,
+ aileron=aileron,
+ elevator=elevator,
+ rudder=rudder,
+ )
+
+ command_path = write_command_file(
+ tixi=tixi,
+ avl_path=avl_path,
+ case_dir_path=case_dir_path,
+ save_plots=save_fig,
+ alpha=aoa,
+ mach_number=mach,
+ alt=alt,
+ aileron=aileron,
+ rudder=rudder,
+ elevator=elevator,
+ )
+
+ run_software(
+ software_name=SOFTWARE_NAME,
+ arguments=[""],
+ wkdir=case_dir_path,
+ with_mpi=False,
+ nb_cpu=nb_cpu,
+ stdin=open(str(command_path), "r"),
+ )
+
+ if save_fig:
+ convert_ps_to_pdf(case_dir_path)
+
+ get_avl_results(cpacs, results_dir)
+
+
+if __name__ == "__main__":
+ call_main(main, MODULE_NAME)
diff --git a/ceasiompy/PyAVL/tests/aircraft.avl b/ceasiompy/PyAVL/tests/aircraft.avl
new file mode 100644
index 000000000..c0471ec6c
--- /dev/null
+++ b/ceasiompy/PyAVL/tests/aircraft.avl
@@ -0,0 +1,162 @@
+D150
+
+#Mach
+0.3
+
+#IYsym IZsym Zsym
+0 0 0
+
+#Sref Cref Bref
+122.400 4.193 29.192
+
+#Xref Yref Zref
+0.000 0.000 0.000
+
+#--------------------------------------------------
+SURFACE
+Wing
+
+!Nchordwise Cspace Nspanwise Sspace
+20.0 1.0 50.0 1.0
+
+COMPONENT
+1
+
+YDUPLICATE
+0
+
+ANGLE
+0
+
+SCALE
+1.0 1.0 1.0
+
+TRANSLATE
+12.746 0.0 -1.136
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+0.000 0.000 0.000 6.076 2.0
+CONTROL
+flap 0.0 0.812922 -0.56760591384 0.0 0.0 1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_W_SupCritProf1.dat
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+0.000 1.856 0.000 6.076 2.0
+CONTROL
+flap 0.0 0.7195 -0.56760591384 0.0 0.0 1.0
+
+CONTROL
+flap 0.0 0.7195 -0.08731417212000013 0.0 0.0 1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_W_SupCritProf1.dat
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+2.335 6.333 0.310 3.758 2.0
+CONTROL
+flap 0.0 0.705129 -0.05401254124000008 0.0 0.0 1.0
+
+CONTROL
+aileron 0.0 0.702209 0.03679888603999998 0.0 0.0 -1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_W_SupCritProf1.dat
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+7.875 16.956 1.047 1.496 2.0
+CONTROL
+aileron 0.0 0.712 0.014645769439999992 0.0 0.0 -1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_W_SupCritProf1.dat
+
+#--------------------------------------------------
+SURFACE
+Wing
+
+!Nchordwise Cspace Nspanwise Sspace
+20.0 1.0 50.0 1.0
+
+COMPONENT
+1
+
+YDUPLICATE
+0
+
+ANGLE
+0
+
+SCALE
+1.0 1.0 1.0
+
+TRANSLATE
+31.466 0.0 0.697
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+0.000 0.000 0.000 3.744 -0.0
+CONTROL
+elevator 0.0 0.577506 0.2339981590200002 0.0 0.0 1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_HL_NACA0000Prof1.dat
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+3.937 6.225 0.545 1.236 -0.0
+CONTROL
+elevator 0.0 0.64 0.07721946122000006 0.0 0.0 1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_HL_NACA0000Prof1.dat
+
+#--------------------------------------------------
+SURFACE
+Wing
+
+!Nchordwise Cspace Nspanwise Sspace
+20.0 1.0 50.0 1.0
+
+COMPONENT
+1
+
+ANGLE
+0
+
+SCALE
+1.0 1.0 1.0
+
+TRANSLATE
+29.838 -0.002 1.891
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+0.000 0.000 0.000 5.435 0.0
+CONTROL
+rudder 0.0 0.6875 0.14402007999999983 0.0 0.0 -1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_SL_NACA0000Prof1.dat
+
+#---------------
+SECTION
+#Xle Yle Zle Chord Ainc
+4.988 0.192 5.865 1.897 0.0
+CONTROL
+rudder 0.0 0.714 0.05026307999999994 0.0 0.0 -1.0
+
+AFILE
+/users/disk12/cfse2/Leon/CEASIOMpy_Leon/CEASIOMpy/WKDIR/Workflow_105/Results/PyAVL/D150_VAMP_SL_NACA0000Prof1.dat
diff --git a/ceasiompy/PyAVL/tests/fs_template.txt b/ceasiompy/PyAVL/tests/fs_template.txt
index 25bc3c4ec..04e4713b0 100644
--- a/ceasiompy/PyAVL/tests/fs_template.txt
+++ b/ceasiompy/PyAVL/tests/fs_template.txt
@@ -1,21 +1,21 @@
---------------------------------------------------------------
Surface and Strip Forces by surface
- Sref = 0.27000E-01 Cref = 0.70000E-01 Bref = 0.39200
- Xref = 0.19200 Yref = 0.0000 Zref = 0.0000
+ Sref = 0.27000E-01 Cref = 0.70000E-01 Bref = 0.39200
+ Xref = 0.19200 Yref = 0.0000 Zref = 0.0000
- Surface # 1 Wing
+ Surface # 1 Wing
# Chordwise = 5 # Spanwise = 20 First strip = 1
Surface area Ssurf = 0.013703 Ave. chord Cave = 0.067500
Forces referred to Sref, Cref, Bref about Xref, Yref, Zref
- Standard axis orientation, X fwd, Z down
+ Standard axis orientation, X fwd, Z down
CLsurf = 0.17532 Clsurf = -0.04113
CYsurf = 0.00714 Cmsurf = -0.00681
CDsurf = 0.00312 Cnsurf = -0.00444
CDisurf = 0.00312 CDvsurf = 0.00000
- Forces referred to Ssurf, Cave
+ Forces referred to Ssurf, Cave
CLsurf = 0.34545 CDsurf = 0.00614
Strip Forces referred to Strip Area, Chord
@@ -41,18 +41,18 @@
19 0.2546 0.1878 0.0000 0.0484 0.0005 0.0150 0.0659 0.4877 0.3113 -0.0013 0.0000 0.0162 -0.0475 0.198
20 0.2629 0.1979 0.0000 0.0461 0.0005 0.0106 0.0727 0.3610 0.2304 -0.0027 0.0000 0.0203 -0.0288 0.162
- Surface # 2 Wing (YDUP)
+ Surface # 2 Wing (YDUP)
# Chordwise = 5 # Spanwise = 20 First strip = 21
Surface area Ssurf = 0.013703 Ave. chord Cave = 0.067500
Forces referred to Sref, Cref, Bref about Xref, Yref, Zref
- Standard axis orientation, X fwd, Z down
+ Standard axis orientation, X fwd, Z down
CLsurf = 0.17532 Clsurf = 0.04113
CYsurf = -0.00714 Cmsurf = -0.00681
CDsurf = 0.00312 Cnsurf = 0.00444
CDisurf = 0.00312 CDvsurf = 0.00000
- Forces referred to Ssurf, Cave
+ Forces referred to Ssurf, Cave
CLsurf = 0.34545 CDsurf = 0.00614
Strip Forces referred to Strip Area, Chord
diff --git a/ceasiompy/PyAVL/tests/ft_template.txt b/ceasiompy/PyAVL/tests/ft_template.txt
index 1b2939b90..6d063dc0e 100644
--- a/ceasiompy/PyAVL/tests/ft_template.txt
+++ b/ceasiompy/PyAVL/tests/ft_template.txt
@@ -1,17 +1,17 @@
---------------------------------------------------------------
Vortex Lattice Output -- Total Forces
- Configuration: labARscaled
+ Configuration: labARscaled
# Surfaces = 2
# Strips = 40
# Vortices = 200
- Sref = 0.27000E-01 Cref = 0.70000E-01 Bref = 0.39200
- Xref = 0.19200 Yref = 0.0000 Zref = 0.0000
+ Sref = 0.27000E-01 Cref = 0.70000E-01 Bref = 0.39200
+ Xref = 0.19200 Yref = 0.0000 Zref = 0.0000
- Standard axis orientation, X fwd, Z down
+ Standard axis orientation, X fwd, Z down
- Run case: -unnamed-
+ Run case: -unnamed-
Alpha = 5.00000 pb/2V = -0.00000 p'b/2V = -0.00000
Beta = 0.00000 qc/2V = 0.00000
@@ -25,7 +25,7 @@
CDtot = 0.00624
CDvis = 0.00000 CDind = 0.0062360
CLff = 0.35118 CDff = 0.0064539 | Trefftz
- CYff = 0.00000 e = 1.0688 | Plane
+ CYff = 0.00000 e = 1.0688 | Plane
---------------------------------------------------------------
\ No newline at end of file
diff --git a/ceasiompy/PyAVL/tests/st_template.txt b/ceasiompy/PyAVL/tests/st_template.txt
new file mode 100644
index 000000000..ab1c0bb8c
--- /dev/null
+++ b/ceasiompy/PyAVL/tests/st_template.txt
@@ -0,0 +1,69 @@
+ ---------------------------------------------------------------
+ Vortex Lattice Output -- Total Forces
+
+ Configuration: D150
+ # Surfaces = 5
+ # Strips = 250
+ # Vortices =5000
+
+ Sref = 122.40 Cref = 4.1930 Bref = 29.192
+ Xref = 0.0000 Yref = 0.0000 Zref = 0.0000
+
+ Standard axis orientation, X fwd, Z down
+
+ Run case: -unnamed-
+
+ Alpha = 0.00000 pb/2V = -0.00000 p'b/2V = -0.00000
+ Beta = 0.00000 qc/2V = 0.00000
+ Mach = 0.300 rb/2V = -0.00000 r'b/2V = -0.00000
+
+ CXtot = -0.00119 Cltot = 0.00001 Cl'tot = 0.00001
+ CYtot = 0.00008 Cmtot = -0.66525
+ CZtot = -0.18118 Cntot = -0.00009 Cn'tot = -0.00009
+
+ CLtot = 0.18118
+ CDtot = 0.00119
+ CDvis = 0.00000 CDind = 0.0011880
+ CLff = 0.18107 CDff = 0.0011865 | Trefftz
+ CYff = 0.00008 e = 1.2634 | Plane
+
+ flap = 5.00000
+ aileron = 5.00000
+ elevator = 0.00000
+ rudder = 0.00000
+
+ ---------------------------------------------------------------
+
+ Stability-axis derivativeMODULE_DIRs...
+
+ alpha beta
+ ---------------- ----------------
+ z' force CL | CLa = 5.504637 CLb = 0.010030
+ y force CY | CYa = -0.008115 CYb = -0.371049
+ x' mom. Cl'| Cla = -0.001342 Clb = -0.156791
+ y mom. Cm | Cma = -24.343220 Cmb = -0.077647
+ z' mom. Cn'| Cna = 0.009207 Cnb = 0.410176
+
+ roll rate p' pitch rate q' yaw rate r'
+ ---------------- ---------------- ----------------
+ z' force CL | CLp = 0.001886 CLq = 57.244704 CLr = -0.024502
+ y force CY | CYp = -0.136885 CYq = -0.153675 CYr = 0.897168
+ x' mom. Cl'| Clp = -0.629023 Clq = -0.023587 Clr = 0.325843
+ y mom. Cm | Cmp = -0.014871 Cmq =-285.068674 Cmr = 0.190199
+ z' mom. Cn'| Cnp = 0.099537 Cnq = 0.174763 Cnr = -1.001663
+
+ flap d01 aileron d02 elevator d03 rudder d04
+ ---------------- ---------------- ---------------- ----------------
+ z' force CL | CLd01 = 0.000000 CLd02 = 0.000000 CLd03 = 0.000000 CLd04 = 0.000000
+ y force CY | CYd01 = 0.000000 CYd02 = 0.000000 CYd03 = 0.000000 CYd04 = 0.000000
+ x' mom. Cl'| Cld01 = -0.000000 Cld02 = -0.000000 Cld03 = -0.000000 Cld04 = -0.000000
+ y mom. Cm | Cmd01 = 0.000000 Cmd02 = 0.000000 Cmd03 = 0.000000 Cmd04 = 0.000000
+ z' mom. Cn'| Cnd01 = -0.000000 Cnd02 = -0.000000 Cnd03 = -0.000000 Cnd04 = -0.000000
+ Trefftz drag| CDffd01 = 0.000000 CDffd02 = 0.000000 CDffd03 = 0.000000 CDffd04 = 0.000000
+ span eff. | ed01 = 0.000000 ed02 = 0.000000 ed03 = 0.000000 ed04 = 0.000000
+
+
+
+ Neutral point Xnp = 18.542752
+
+ Clb Cnr / Clr Cnb = 1.175071 ( > 1 if spirally stable )
\ No newline at end of file
diff --git a/ceasiompy/PyAVL/tests/test_avlconfig.py b/ceasiompy/PyAVL/tests/test_avlconfig.py
index acf31e749..0c1d0f82c 100644
--- a/ceasiompy/PyAVL/tests/test_avlconfig.py
+++ b/ceasiompy/PyAVL/tests/test_avlconfig.py
@@ -5,10 +5,11 @@
Test functions of 'ceasiompy/PyAVL/func/avlconfig.py'
-Python version: >=3.8
| Author : Romain Gauthier
| Creation: 2024-06-06
+| Modified: Leon Deligny
+| Date: 21 March 2025
"""
@@ -16,82 +17,80 @@
# IMPORTS
# =================================================================================================
+import unittest
+
from pathlib import Path
-from ceasiompy.PyAVL.func.avlconfig import (
+from ceasiompy.utils.decorators import log_test
+from ceasiompy.PyAVL.func.config import write_command_file
+
+from ceasiompy.utils.ceasiompyutils import (
+ current_workflow_dir,
get_aeromap_conditions,
- get_option_settings,
- write_command_file,
)
-from ceasiompy.utils.commonpaths import CPACS_FILES_PATH
-CPACS_IN_PATH = Path(CPACS_FILES_PATH, "labARscaled.xml")
+from cpacspy.cpacspy import CPACS
+from ceasiompy.utils.ceasiompytest import CeasiompyTest
-MODULE_DIR = Path(__file__).parent
-CASE_DIR = Path(MODULE_DIR, "AVLpytest")
-COMMAND_TEM_DIR = Path(MODULE_DIR, "avl_command_template.txt")
-
-# =================================================================================================
-# CLASSES
-# =================================================================================================
+from ceasiompy.PyAVL import MODULE_DIR, AVL_AEROMAP_UID_XPATH
+from ceasiompy.utils.commonpaths import CPACS_FILES_PATH
# =================================================================================================
-# FUNCTIONS
+# CLASSES
# =================================================================================================
-def test_write_command_file(tmp_path):
- test_path = Path("/path", "to", "avl", "input", "file", "aircraft.avl")
-
- write_command_file(
- avl_path=test_path,
- case_dir_path=tmp_path,
- alpha=5.0,
- beta=0.0,
- mach_number=0.3,
- ref_velocity=100.93037463067732,
- ref_density=1.1116596736996904,
- g_acceleration=9.803565306802405,
- save_plots=True,
- )
-
- file_exists = Path(tmp_path, "avl_commands.txt").exists()
- assert file_exists, "File 'avl_commands.txt' not found."
-
- if file_exists:
- COMMAND_DIR = Path(tmp_path, "avl_commands.txt")
- with open(COMMAND_TEM_DIR, "r") as file1, open(COMMAND_DIR, "r") as file2:
- for line1, line2 in zip(file1, file2):
- if "mass" not in line1:
- assert line1 == line2, "File 'avl_commands.txt' not correct."
-
- # Check for any remaining lines in either file
- assert not file1.read() or not file2.read(), "File 'avl_commands.txt' not correct."
-
-
-def test_get_aeromap_conditions():
- alt_list, mach_list, aoa_list, aos_list = get_aeromap_conditions(CPACS_IN_PATH)
- assert alt_list[0] == 1000.0, "Altitude from aeromap not correct, should be 1000.0 meters."
- assert mach_list[0] == 0.3, "Mach number from aeromap not correct, should be 0.3."
- assert aoa_list[0] == 5.0, "Aoa from aeromap not correct, should be 5.0 degrees."
- assert aos_list[0] == 0.0, "Altitude from aeromap not correct, should be 0.0 degrees"
-
-
-def test_get_option_settings():
- (
- save_plots,
- vortex_distribution,
- Nchordwise,
- Nspanwise,
- integrate_fuselage,
- ) = get_option_settings(CPACS_IN_PATH)
-
- assert not save_plots, "Option 'save_plots' should be 'False'."
- assert vortex_distribution == 3.0, "Option 'vortex_distribution' should be '3.0'."
- assert Nchordwise == 5, "Option 'Nchordwise' should be '5'."
- assert Nspanwise == 20, "Option 'Nspanwise' should be '20'."
- assert not integrate_fuselage, "Option 'integrate_fuselage' should be 'False'."
+class TestModuleTemplate(CeasiompyTest):
+
+ @classmethod
+ def setUpClass(cls):
+ cpacs_path = Path(CPACS_FILES_PATH, "labARscaled.xml")
+ cls.cpacs = CPACS(cpacs_path)
+ cls.wkdir = current_workflow_dir()
+ cls.command_dir = Path(MODULE_DIR, "tests", "avl_command_template.txt")
+ cls.avl_path = Path(MODULE_DIR, "tests", "aircraft.avl")
+
+ @log_test
+ def test_get_aeromap_conditions(self) -> None:
+ self.assert_equal_function(
+ f=get_aeromap_conditions,
+ input_args=(self.cpacs, AVL_AEROMAP_UID_XPATH),
+ expected=([1000.0], [0.3], [5.0], [0.0]),
+ )
+
+ @log_test
+ def test_write_command_file(self):
+
+ write_command_file(
+ tixi=self.cpacs.tixi,
+ avl_path=self.avl_path,
+ case_dir_path=self.wkdir,
+ alpha=5.0,
+ beta=0.0,
+ pitch_rate=0.0,
+ roll_rate=0.0,
+ yaw_rate=0.0,
+ mach_number=0.3,
+ alt=1000.0,
+ aileron=0.0,
+ elevator=0.0,
+ rudder=0.0,
+ save_plots=True,
+ )
+
+ file_exists = Path(self.wkdir, "avl_commands.txt").exists()
+ assert file_exists, "File 'avl_commands.txt' not found."
+
+ if file_exists:
+ self.command_dir = Path(self.wkdir, "avl_commands.txt")
+ with open(self.command_dir, "r") as file1, open(self.command_dir, "r") as file2:
+ for line1, line2 in zip(file1, file2):
+ if "mass" not in line1:
+ assert line1 == line2, "File 'avl_commands.txt' not correct."
+
+ # Check for any remaining lines in either file
+ assert not file1.read() or not file2.read(), "File 'avl_commands.txt' not correct."
# =================================================================================================
@@ -100,6 +99,4 @@ def test_get_option_settings():
if __name__ == "__main__":
- print("Test avlconfig.py")
- print("To run test use the following command:")
- print(">> pytest -v")
+ unittest.main(verbosity=0)
diff --git a/ceasiompy/PyAVL/tests/test_avlresults.py b/ceasiompy/PyAVL/tests/test_avlresults.py
index 4b1909b80..3352ebbb6 100644
--- a/ceasiompy/PyAVL/tests/test_avlresults.py
+++ b/ceasiompy/PyAVL/tests/test_avlresults.py
@@ -5,65 +5,78 @@
Test functions of 'ceasiompy/PyAVL/func/avlresults.py'
-Python version: >=3.8
| Author : Romain Gauthier
| Creation: 2024-06-07
+| Modified: Leon Deligny
+| Date: 21 March 2025
"""
# =================================================================================================
# IMPORTS
# =================================================================================================
-from pathlib import Path
-import pytest
-from ceasiompy.PyAVL.func.avlresults import get_avl_aerocoefs, plot_lift_distribution
-
-from ceasiompy.utils.commonpaths import CPACS_FILES_PATH
-MODULE_DIR = Path(__file__).parent
+import unittest
-CPACS_IN_PATH = Path(CPACS_FILES_PATH, "labARscaled.xml")
-FT_TEMPLATE = Path(MODULE_DIR, "ft_template.txt")
+from ceasiompy.utils.decorators import log_test
+from ceasiompy.PyAVL.func.results import get_avl_aerocoefs
+from ceasiompy.PyAVL.func.plot import plot_lift_distribution
+from ceasiompy.utils.ceasiompyutils import current_workflow_dir
-# =================================================================================================
-# CLASSES
-# =================================================================================================
+from pathlib import Path
+from ceasiompy.utils.ceasiompytest import CeasiompyTest
+from ceasiompy.PyAVL import MODULE_DIR
# =================================================================================================
-# FUNCTIONS
+# CLASSES
# =================================================================================================
-def test_plot_lift_distribution(tmp_path):
- plot_lift_distribution(
- force_file_fs=Path(MODULE_DIR, "fs_template.txt"),
- aoa=5,
- aos=0,
- mach=0.3,
- alt=1000,
- wkdir=tmp_path,
- )
-
- assert Path(
- tmp_path, "lift_distribution.png"
- ).exists(), "Plot 'lift_distribution.png' does not exist."
-
-
-def test_get_avl_aerocoefs():
- assert FT_TEMPLATE.exists(), "Result file 'ft.txt' not found!"
- cl, cd, cm = get_avl_aerocoefs(FT_TEMPLATE)
- assert cl == pytest.approx(0.35063, rel=1e-4), "CLtot is not correct!"
- assert cd == pytest.approx(0.00624, rel=1e-4), "CDtot is not correct!"
- assert cm == pytest.approx(-0.01362, rel=1e-4), "Cmtot is not correct!"
-
+class TestAvlResults(CeasiompyTest):
+
+ @classmethod
+ def setUpClass(cls):
+ cls.force_file_fs = Path(MODULE_DIR, "tests", "fs_template.txt")
+ cls.wkdir = current_workflow_dir()
+ cls.ft_template = Path(MODULE_DIR, "tests", "st_template.txt")
+
+ @log_test
+ def test_template(self) -> None:
+ assert self.ft_template.exists(), "Result file 'ft.txt' not found!"
+
+ @log_test
+ def test_get_avl_aerocoefs(self) -> None:
+ self.assert_equal_function(
+ f=get_avl_aerocoefs,
+ input_args=(self.ft_template,),
+ expected=(
+ 0.00119, 0.00008, 0.18118,
+ 0.00001, -0.66525, -0.00009,
+ -0.156791, -24.343220, 0.410176,
+ ),
+ )
+
+ @log_test
+ def test_plot_lift_distribution(self):
+ plot_lift_distribution(
+ force_file_fs=self.force_file_fs,
+ aoa=5,
+ aos=0,
+ mach=0.3,
+ alt=1000,
+ wkdir=self.wkdir,
+ )
+
+ assert Path(
+ self.wkdir, "lift_distribution.png"
+ ).exists(), "Plot 'lift_distribution.png' does not exist."
# =================================================================================================
# MAIN
# =================================================================================================
+
if __name__ == "__main__":
- print("Test avlconfig.py")
- print("To run test use the following command:")
- print(">> pytest -v")
+ unittest.main(verbosity=0)
diff --git a/ceasiompy/PyTornado/.gitignore b/ceasiompy/PyTornado/.gitignore
deleted file mode 100644
index 28ac87668..000000000
--- a/ceasiompy/PyTornado/.gitignore
+++ /dev/null
@@ -1,4 +0,0 @@
-# Ignore PyTornado working dir
-wkdir*
-
-log*
diff --git a/ceasiompy/PyTornado/README.md b/ceasiompy/PyTornado/README.md
deleted file mode 100644
index 525b11b5e..000000000
--- a/ceasiompy/PyTornado/README.md
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-# PyTornado
-
-**Categories:** Aerodynamics, CFD, aeromaps
-
-**State**: :heavy_check_mark:
-
-
-
-`PyTornado` module is a launcher for the software [PyTornado](https://github.com/airinnova/pytornado) which has been developed by [Airinnova](https://airinnova.se/) based on the Matlab version of [Tornado](https://tornado.redhammer.se/index.php). It is a Vortex Lattice Method (VLM) solver for low-fidelity aerodynamic analysis of wings.
-
-- -## Inputs - -`PyTornado` takes as input a CPACS file, the aircraft geometry will be use to create the mesh required by the VLM solver. To define the flight conditions an aeromap on which the calculation will be done is also required. - -## Analyses - -`PyTornado` calculates aerodynamic coefficients of an aircraft for a given aeromap and write back results in a CPACS file. - -Optionally, `PyTornado` can also plot some results. - -
-
-
-Example of PyTornado results. -
- -## Outputs - -`PyTornado` outputs a CPACS files with the calculated aerodynamic coefficients added into the aeromap. - -## Installation or requirements - -`PyTornado` can be installed by first cloning the [PyTornado repository](https://github.com/airinnova/pytornado.git) and then use pip to install it. The command should be the following: - -```bash -git clone https://github.com/airinnova/pytornado.git -cd pytornado -pip install -e . -``` - -If you follow an automatic installation procedure on the [CEASIOMpy installation page](../../installation/INSTALLATION.md), PyTornado should be installed automatically with the other tools. - -## Limitations - -`PyTornado` is a Vortex Lattice Method (VLM) solver and the assumption are the following: - -* The flow field is incompressible (Ma < 0.5), inviscid and irrotational. - -* The lifting surfaces are thin. The influence of the thickness on aerodynamic forces are neglected. -* The angle of attack and the angle of sideslip are both small (small angle approximation) - -:warning: No fuselage is modelled by `PyTornado` so the drag coefficient is not correct, generally underestimated. - -## More information - -* [PyTornado Github repository](ttps://github.com/airinnova/pytornado) - -* [PyTornado Documentation](https://pytornado.readthedocs.io/en/latest/) - -* [Original Matlab version of Tornado](https://tornado.redhammer.se/index.php) - -* [Flight Vehicle Aerodynamics](https://mitpress.mit.edu/books/flight-vehicle-aerodynamics) by Mark Drela - -*", unsafe_allow_html=True)
st.markdown("No subdir", unsafe_allow_html=True)
+ st.markdown("
", unsafe_allow_html=True)
with col3:
if subdirectroies:
- st.markdown("#")
+ st.markdown("", unsafe_allow_html=True)
return st.session_state.path
+
+
+def section_edit_aeromap():
+ st.markdown("#### Available aeromaps")
+
+ for i, aeromap in enumerate(st.session_state.cpacs.get_aeromap_uid_list()):
+ col1, col2, col3, _ = st.columns([6, 1, 1, 5])
+
+ with col1:
+ st.markdown(f"**{aeromap}**")
+
+ with col2:
+ if st.button("⬆️", key=f"export{i}", help="Export aeromap") and i != 0:
+ csv_file_name = aeromap.replace(" ", "_") + ".csv"
+ st.session_state.cpacs.get_aeromap_by_uid(aeromap).export_csv(csv_file_name)
+ with open(csv_file_name) as f:
+ st.download_button("Download", f, file_name=csv_file_name)
+
+ with col3:
+ if st.button("❌", key=f"del{i}", help="Delete this aeromap"):
+ st.session_state.cpacs.delete_aeromap(aeromap)
+ st.rerun()
+
+ st.markdown("#### Add a point")
+
+ selected_aeromap = st.selectbox(
+ "in",
+ st.session_state.cpacs.get_aeromap_uid_list(),
+ help="Choose in which aeromap you want to add the point"
+ )
+
+ col1, col2, col3, col4, col5 = st.columns([2, 2, 2, 2, 1])
+
+ with col1:
+ alt = st.number_input("Alt", value=1000, min_value=0, step=100)
+ with col2:
+ mach = st.number_input("Mach", value=0.3, min_value=0.0, step=0.1)
+ with col3:
+ aoa = st.number_input("AoA", value=0, min_value=-90, max_value=90, step=1)
+ with col4:
+ aos = st.number_input("AoS", value=0, min_value=-90, max_value=90, step=1)
+ with col5:
+ st.markdown("")
+ st.markdown("")
+ if st.button("➕"):
+ st.session_state.cpacs.get_aeromap_by_uid(
+ selected_aeromap).add_row(mach=mach, alt=alt, aos=aos, aoa=aoa)
+ st.session_state.cpacs.get_aeromap_by_uid(selected_aeromap).save()
+ save_cpacs_file()
+
+ if selected_aeromap:
+ st.dataframe(st.session_state.cpacs.get_aeromap_by_uid(selected_aeromap).df)
+
+ st.markdown("#### Create new aeromap")
+
+ form = st.form("create_new_aeromap_form")
+
+ help_aeromap_uid = "The aeromap will contain 1 point corresponding to the value above, then \
+ you can add more point to it."
+ new_aeromap_uid = form.text_input(
+ "Aeromap uid",
+ help=help_aeromap_uid,
+ )
+ default_description = "Created with CEASIOMpy Graphical user interface"
+ new_aeromap_description = form.text_input(
+ "Aeromap description", value=default_description, help="optional"
+ )
+
+ if form.form_submit_button("Create new"):
+ if new_aeromap_uid not in st.session_state.cpacs.get_aeromap_uid_list():
+ new_aeromap = st.session_state.cpacs.create_aeromap(new_aeromap_uid)
+ new_aeromap.description = new_aeromap_description
+ new_aeromap.add_row(mach=mach, alt=alt, aos=aos, aoa=aoa)
+ new_aeromap.save()
+ log.info(f"Creating new aeromap {new_aeromap_uid}.")
+ st.rerun()
+ else:
+ st.error("There is already an aeromap with this name!")
+
+ st.markdown("#### Import aeromap from CSV")
+
+ uploaded_csv = st.file_uploader("Choose a CSV file")
+ if uploaded_csv:
+ uploaded_aeromap_uid = uploaded_csv.name.split(".csv")[0]
+
+ if st.button("Add this aeromap"):
+ if uploaded_aeromap_uid in st.session_state.cpacs.get_aeromap_uid_list():
+ st.error("There is already an aeromap with this name!")
+ return
+
+ new_aeromap = st.session_state.cpacs.create_aeromap(uploaded_aeromap_uid)
+ new_aeromap.df = pd.read_csv(uploaded_csv, keep_default_na=False)
+ new_aeromap.save()
+ st.rerun()
+
+
+# =================================================================================================
+# MAIN
+# =================================================================================================
+
+
+if __name__ == "__main__":
+ log.info("Nothing to execute!")
diff --git a/test_cases/test_case_1/README.md b/test_cases/test_case_1/README.md
index f23e83d34..cb336bbc7 100644
--- a/test_cases/test_case_1/README.md
+++ b/test_cases/test_case_1/README.md
@@ -23,12 +23,12 @@ conda activate ceasiompy
ceasiompy_run --testcase 1
```
-This workflow will take as input the CPACS file of the aircraft (D150_simple.xml), it will run the PyTornado module, and it will export the aerodynamic coefficients in a CSV file.
+This workflow will take as input the CPACS file of the aircraft (D150_simple.xml), it will run the PyAVL module, and it will export the aerodynamic coefficients in a CSV file.
```mermaid
graph LR;
- D150([D150 CPACS file])-->PyTornado;
- PyTornado-->ExportCSV;
+ D150([D150 CPACS file])-->PyAVL;
+ PyAVL-->ExportCSV;
```
You can find the exported CSV file in the results dir: `/Workflow_001/Results/Aeromaps/test_apm.csv` and it should look like this:
@@ -41,7 +41,7 @@ altitude,machNumber,angleOfSideslip,angleOfAttack,cd,cl,cs,cmd,cml,cms
0,0.3,10,10,0.0545719,1.08554,-0.100854,0.249796,-0.84655,-4.65115
```
-You can see than PyTornado ran four calculations with different angles of attack and sideslip, but at the same altitude and Mach number. On the next test case, you will learn how to define your own flight parameters.
+You can see than PyAVL ran four calculations with different angles of attack and sideslip, but at the same altitude and Mach number. On the next test case, you will learn how to define your own flight parameters.
These results have also been written in the last output CPACS file that you can find at : `/Workflow_001/02_ExportCSV/ToolOutput.xml`. It is a big file, because it contains all the geometric description of the aircraft. However, if you open it in a text editor and look for `test_apm`, you should find the following:
@@ -66,6 +66,6 @@ These results have also been written in the last output CPACS file that you can
```
-You can see that parameters `altitude`, `machNumber`, `angleOfSideslip`, `angleOfAttack` and coefficients `cl`, `cd`, `cs`, `cml`, `cms` and `cmd` are defined as lists of four values, representing the four calculations made by PyTornado.
+You can see that parameters `altitude`, `machNumber`, `angleOfSideslip`, `angleOfAttack` and coefficients `cl`, `cd`, `cs`, `cml`, `cms` and `cmd` are defined as lists of four values, representing the four calculations made by PyAVL.
| [Home](../../README.md#test-cases) | Next test case [**>>**](../test_case_2/README.md)
diff --git a/test_cases/test_case_1/testcase1.cfg b/test_cases/test_case_1/testcase1.cfg
index f68359c94..b33f2c17a 100644
--- a/test_cases/test_case_1/testcase1.cfg
+++ b/test_cases/test_case_1/testcase1.cfg
@@ -3,4 +3,4 @@
% Test Case 1
%--------------------------------------------------------------------------
CPACS_TOOLINPUT = ../../test_files/CPACSfiles/D150_simple.xml
-MODULE_TO_RUN = ( PyTornado, ExportCSV )
+MODULE_TO_RUN = ( PyAVL, ExportCSV )
diff --git a/test_cases/test_case_4/README.md b/test_cases/test_case_4/README.md
index d1e53221b..f53be6c79 100644
--- a/test_cases/test_case_4/README.md
+++ b/test_cases/test_case_4/README.md
@@ -16,15 +16,15 @@ conda activate ceasiompy
cd WKDIR
# To run the test case 4
-ceasiompy_run -m ../test_files/CPACSfiles/D150_simple.xml PyTornado SkinFriction SaveAeroCoefficients
+ceasiompy_run -m ../test_files/CPACSfiles/D150_simple.xml PyAVL SkinFriction SaveAeroCoefficients
```
The following workflow will be executed:
```mermaid
graph LR;
- D150([D150 CPACS file])-->PyTornado;
- PyTornado-->SkinFriction;
+ D150([D150 CPACS file])-->PyAVL;
+ PyAVL-->SkinFriction;
SkinFriction-->SaveAeroCoefficients:
```
diff --git a/test_cases/test_case_5/README.md b/test_cases/test_case_5/README.md
index 1624de813..cb52a7bf1 100644
--- a/test_cases/test_case_5/README.md
+++ b/test_cases/test_case_5/README.md
@@ -11,7 +11,7 @@ For the test case you must first create and save a file named `my_ceasiompy_conf
```text
% This is an example of config file for ceasiompy
CPACS_TOOLINPUT = ../test_files/CPACSfiles/D150_simple.xml
-MODULE_TO_RUN = ( PyTornado, SkinFriction, SaveAeroCoefficients )
+MODULE_TO_RUN = ( PyAVL, SkinFriction, SaveAeroCoefficients )
```
You can now run it with the following command:
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_config_template.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_config_template.cfg
index 7f0b4d733..07f5f7d47 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_config_template.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_config_template.cfg
@@ -42,7 +42,7 @@ CPACS_TOOLOUTPUT = ./ToolOutput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
@@ -56,8 +56,8 @@ CPACS_TOOLOUTPUT = ./ToolOutput.xml
% SMTrain
% SMUse
%
-MODULE_PRE = (PyTornado)
-MODULE_OPTIM = (PyTornado)
+MODULE_PRE = (PyAVL)
+MODULE_OPTIM = (PyAVL)
MODULE_POST = (SaveAeroCoefficients)
%
% ------------------------ OPTIMISATION OPTIONS -------------------------------%
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyTornado.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyAVL.cfg
similarity index 97%
rename from test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyTornado.cfg
rename to test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyAVL.cfg
index fe4d5a0a5..61341193e 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyTornado.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_optim_gui_pyAVL.cfg
@@ -36,7 +36,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
@@ -51,7 +51,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
% SMUse
%
MODULE_PRE = NONE
-MODULE_OPTIM = (PyTornado)
+MODULE_OPTIM = (PyAVL)
MODULE_POST = NONE
%
% ------------------------ OPTIMISATION OPTIONS -------------------------------%
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyTornado.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyAVL.cfg
similarity index 97%
rename from test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyTornado.cfg
rename to test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyAVL.cfg
index c853277c4..39ac7e563 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyTornado.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_pyAVL.cfg
@@ -36,7 +36,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
@@ -50,7 +50,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
% SMTrain
% SMUse
%
-MODULE_PRE = ( PyTornado )
+MODULE_PRE = ( PyAVL )
MODULE_OPTIM = None
MODULE_POST = None
%
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_su2.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_su2.cfg
index bae911697..0ee5b4b70 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_su2.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_simple_gui_su2.cfg
@@ -36,7 +36,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_default.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_default.cfg
index 0fe9977b0..5e88c66f3 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_default.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_default.cfg
@@ -36,7 +36,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
@@ -50,7 +50,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
% SMTrain
% SMUse
%
-MODULE_PRE = (PyTornado)
+MODULE_PRE = (PyAVL)
MODULE_OPTIM = NONE
MODULE_POST = NONE
%
diff --git a/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_test.cfg b/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_test.cfg
index 0fe9977b0..5e88c66f3 100644
--- a/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_test.cfg
+++ b/test_files/CEASIOMpy_config_template/CEASIOMpy_workflow_test.cfg
@@ -36,7 +36,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
%
% Aerodynamics
% CLCalculator
-% PyTornado
+% PyAVL
% SU2MeshDef
% SU2Run
% SkinFriction
@@ -50,7 +50,7 @@ CPACS_TOOLINPUT = ./ToolInput/ToolInput.xml
% SMTrain
% SMUse
%
-MODULE_PRE = (PyTornado)
+MODULE_PRE = (PyAVL)
MODULE_OPTIM = NONE
MODULE_POST = NONE
%
diff --git a/test_files/CPACSfiles/D150_simple.xml b/test_files/CPACSfiles/D150_simple.xml
index d30ba3ef8..4010f8cc4 100644
--- a/test_files/CPACSfiles/D150_simple.xml
+++ b/test_files/CPACSfiles/D150_simple.xml
@@ -3,48 +3,59 @@
xsi_noNamespaceSchemaLocation="CPACS_21_Schema.xsd">
+
+
+
+
+
diff --git a/test_thermodata_out/reports/n2.html b/test_thermodata_out/reports/n2.html
new file mode 100644
index 000000000..54b5e9ed0
--- /dev/null
+++ b/test_thermodata_out/reports/n2.html
@@ -0,0 +1,14805 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tests/Test_input2.xml b/tests/Test_input2.xml
deleted file mode 100644
index 155150841..000000000
--- a/tests/Test_input2.xml
+++ /dev/null
@@ -1,1396 +0,0 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Systems & Variables
+
+
+
+
+ N2
Symbols
+
+
+
+
+
+
+ Scalar
+
+
+
+
+
+ Vector
+
+
+
+
+
+ Collapsed Variables
+
+
+
+
+
+ Linear Solvers
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+ Left-click on a node in the model hierarchy to navigate to that node.
+ Right-click on a node to collapse/expand it.
+ Alt-right-click on a node with variables to select which ones to hide.
+ Note: Right-click in Firefox displays a browser menu. To disable that,
+ visit about:config and set dom.event.contextmenu.enabled
+ to true.
+ Hover over any cell in the matrix to display its connections
+ as arrows. Click that cell to make those arrows persistent.
+
Toolbar Help
+
+ 
+
+
+
+
+
+
+
+
+| ▲Variable Name▼ | +Visible | ++ |
|---|
+
+
+
+
+
+ Search
+ ✕➤
+
+
+