DOI: 10.17587/prin.17.345-352

On the Development of a Module for the shallowWaterFoam Solver of the OpenFOAM Platform

D. I. Chitalov, Junior Researcher, cdi9@yandex.ru, South Urals Federal ResearchCentre of Mineralogy and Geoecology of the UB RAS, Chelyabinsk region, Miass, Ilmen reserve, 456317, Russian Federation

Corresponding author: Dmitry I. Chitalov, Junior Researcher, South Urals Federal Research Centre of Mineralogy and Geoecology of the UB RAS, Chelyabinsk region, Miass, Ilmen reserve, 456317, Russian Federation E-mail: cdi9@yandex.ru

This paper presents mechanisms for implementing additional functionality in the graphical shell of OpenFOAM platform, in addition to existing functions. It analyzes the methodology for numerical modeling of continuum mechanics problems using the shallowWaterFoam solver and the structure of the corresponding computational case, including dictionary files with the problem's computational parameters. It describes the considerations for choosing technology stack of the project—the programming language, auxiliary frameworks, and DBMS required creating the software and graphical components of the software module responsible for generating the numerical model using the shallowWaterFoam solver. The problem statement and the stages of its solution are defined. Structural and process diagrams describing structure and operational logic of the application are provided, along with a brief overview of the diagrams' main content. Development of the module is summarized, with a demonstration of its operation using a fundamental continuum mechanics problem as an example. The main window of the graphical shell, the main screen forms, and the associated graphical controls are displayed. The aspects that distinguish the project from similar solutions and constitute the originality of the research are defined. A link to a public GitHub repository containing the structure of the application's packages and modules, as well as the executable source code, is provided.

Keywords: numerical simulation, graphical user interface, OpenFOAM, Python, open source software, shallow-WaterFoam, PyQt

pp. 345—352

For citation:
Chitalov D. I. On the Development of a Module for the shallowWaterFoam Solver of the OpenFOAM Platform, Programmnaya Ingeneria, 2026, vol. 17, no. 6, pp. 345—352. DOI: 10.17587/prin.17.345-352. (in Russian).

References:

1. Galindo-Lopez S., Salehi F., Cleary M. J. et al. A stochastic multiple mapping conditioning computational model in OpenFOAM for turbulent combustion, Computers and Fluids, 2018, vol. 172, pp. 410—425. DOI: 10.1016/j.compfluid.2018.03.083.
2. Kyriazis N., Koukouvinis P., Gavaises M. Modelling cavitation during drop impact on solid surfaces, Advances in Colloid and Interface Science, 2018, vol. 260, pp. 46—64. DOI: 10.1016/j.cis.2018.08.004.
3. Mohseni M., Esperanca P. T., Sphaier S. H. Numerical study of wave run-up on a fixed and vertical surface-piercing cylinder subjected to regular, non-breaking waves using OpenFOAM, Applied Ocean Research, 2018, vol. 79, pp. 228—252. DOI: 10.1016/j.apor.2018.08.003.
4. Chentsov P. A. On one approach to constructing console application interfaces: TextControlPages technology, Programmnaya ingeneria, 2016, vol. 7, no. 12, pp. 539—546. DOI: 10.17587/prin.7.539-546. (in Russian).
5. Chitalov D. I., Merkulov E. S., Kalashnikov S. T. Development of a graphical user interface for the OpenFOAM toolbox, Programmnaya ingeneria, 2016, vol. 7, no. 12, pp. 568—574. 10.17587/prin.7.568-574 (in Russian).
6. Chitalov D. I. Development of a module for the compressibleinterfoam solver of the openfoam package, Programmnaya ingeneria, 2025, vol. 16, no. 3, pp. 156—164. DOI: 10.17587/prin.16.156-164 (in Russian).
7. Chitalov D. I. Development of a module for managing the simulation of a system of two compressible liquid phases with one dispersed phase based on the OpenFoam platform, Applied computer science, 2024, vol. 19, no. 2, pp. 106—117. DOI: 10.37791/2687-0649-2024-19-2-106-117.
8. Degtyar V. G., Pegov V. I., Merkulov E. S. Numerical modeling of the evolution of the cavity boundary during torpedo launch, Bulletin of SUSU. Ser.: Math. modeling and programming, 2016, vol. 6, no. 1, pp. 5—12 (in Russian).
9. Kiryushina M. A. Numerical experiment in the problem of propagation of small disturbances in a round pipe, Preprints of the Keldysh Institute of Applied Mathematics, 2024, no. 48, 21 p. DOI: 10.20948/prepr-2024-48.
10. Longshaw S. M., Borg M. K., Ramisetti S. B. et al. md-Foam+: Advanced molecular dynamics in OpenFOAM, Computer Physics Communications. 2018, no. 224, pp. 1—21. DOI: 10.1016/j.cpc.2017.09.029.