How ucns3d-team/ucns3d works
Project type and purpose
• UCNS3D is a high-performance, MPI+OpenMP hybrid parallel, command-line Computational Fluid Dynamics (CFD) solver written in Fortran. It is not a typical client-server or web app but a scientific HPC application designed to run on Linux, macOS, Windows/WSL, or inside Docker, and to be submitted to batch schedulers (PBS, SLURM) on supercomputers.
• The README makes clear that UCNS3D ingests unstructured meshes and parameter files, runs compressible flow simulations, and writes output for post-processing in Tecplot/ParaView/Visit.
File structure
• Top-level:
• bin/ – pre-built compiler toolchains and static libraries (metis, parmetis, tecplot)
• src/ – Fortran source modules and Makefiles
• scripts/ – HPC submission scripts (PBS/SLURM), translators for mesh formats
• tests/ – sample cases (input meshes & DAT files) and test runners
• Dockerfile – container recipe including dependencies
• docs/ – manuals, whitepaper, API docs
• .github/ – issue templates
• Build system:
• src/Makefile_common & Makefile_docker
• bin/<compiler>/Makefile
• Deployment:
• Docker image
• HPC scheduler scripts in scripts/submission-script/
README for additional insights
• Dependencies: MPI (e.g., mpirun), OpenMP, Fortran compiler (GNU or Intel), BLAS (MKL/OpenBLAS), METIS for mesh partition.
• Execution: set OMP_NUM_THREADS, then mpirun ‑np M ./ucns3d_p
• Visualization: writes outputs compatible with Tecplot, ParaView, Visit
• Examples and tests: tests/ directory and scripts/run-docker-test.sh, execute-tests.sh