Installation guide

HiSA is developed using OpenFOAM® technology, and supports the OpenCFD distribution versions 2006 – 2312, and OpenFOAM Foundation distribution versions 9 – 11. Instructions for installation of OpenFOAM under Linux and Windows are given on the respective websites. The BlueCFD-Core project is also supported for compilation on Windows.

Note that the example cases work with the latest supported OpenFOAM versions and might need minor modifications to run with earlier versions.

Once OpenFOAM is successfully installed, the HiSA code can be cloned or downloaded from the gitlab project page and built using the Allwmake script, after sourcing the relevant OpenFOAM environment. See the OpenFOAM user guides for reference.

A customised version of the mesh generator cfMesh is also supplied. This makes it possible to run adaptive mesh refinement on meshes generated with the cartesianMesh utility and is required in order to run the AGARD 445.6 validation case. The code is available from its gitlab project page and is also built using the Allwmake script.

The FreeCAD CfdOF workbench can be used as a GUI for HiSA.

Testing and release

The code has been tested against the verification and validation archive described in the ARCHIVE section. This process consumes significant computing resources and was made possible by the Centre for High Performance Computing, South Africa. We gratefully acknowledge their support.

Centre for High Performance Computing

The testing history of the code is as follows:

Date OpenFOAM version HiSA version Git Tag
10 July 2021 20 12 1.4.6 validated-v2012
29 October 2021 21 06 1.4.8 validated-v2106
28 March 2022 21 12 1.6.4 validated-v2112
31 October 2022 22 06 1.7.6 validated-v2206
20 July 2023 10 1.9.5 validated-v10
31 July 2023 22 12 1.9.5 validated-v2212
23 September 2023 23 06 1.9.6 validated-v2306
9 February 2024 11 1.10.2 validated-v11
22 April 2024 23 12 1.11.2 validated-v2312

The code repository conforms to the following structure:

Branch master Contains the latest validated version of the code, together with simple bug fixes where there is little chance of a negative impact on code validation. This branch can be considered a 'rolling release'.
Branch devel Contains new developments, as well as bug fixes which might have unexpected side-effects. These are queued for testing during the next run of the validation test suite. As such this branch is not fully tested, but allows access to the newest updates.
Branch (others) Contain new features under development which may not be in a working state.
Tags validated-vXXXX or validated vXX When the code is successfully run through the validation database, the exact commit is tagged in the interests of reproducibility. Here, XXXX or XX contains the OpenFOAM version (OpenCFD vs OpenFOAM Foundation distribution respectively) that was used.

In addition, the HiSA version number is available by executing hisa -version


This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via, and owner of the OPENFOAM® and OpenCFD® trade marks.