HOHQMesh

Getting started

Obtaining the sources

You can download the latest HOHQMesh release from GitHub. Make sure to get the tarball named HOHQMesh-vVERSION.tar.gz, as it already contains the required sources for the FTObjectLibrary dependency, and unpack it with tar xf HOHQMesh-vVERSION.tar.gz. Alternatively, you can build HOHQMesh directly from the latest sources in the main branch. In this case, you need enter the clone directory and execute

./Utilities/bootstrap

before proceeding, which will download the FTObjectLibrary sources for you. This step is required only once.

Building

Enter the HOHQMesh directory and execute

make

This will build HOHQMesh using the gfortran compiler by default. The compiler choice can be overriden by passing FC=<pathToCompiler> to make. You can further pass the -jN option to make (with N being a non-negative integer), which will use N parallel processes.

For example, to build HOHQMesh specifically with the Fortran compiler gfortran-10 and with 4 parallel processes, execute

make -j 4 FC=gfortran-10

Testing

After building HOHQMesh, you can verify that everything works as expected by running the internal test suite. To execute the tests, type

./HOHQMesh -test -path <pathToBenchmarks>

where <pathToBenchmarks> is the path to the HOHQMesh directory. If you are inside the HOHQMesh directory, you can also omit the -path option, as it defaults to ..

Generating a mesh

To mesh a control file, type

./HOHQMesh -f <pathToControlFile>

where -f allows you to provide the path to the control file for which you want to create your mesh.

Authors

HOHQMesh was initiated by David A. Kopriva, who is also the principal developer. The full list of contributors can be found in AUTHORS.md.

License and contributing

HOHQMesh is licensed under the MIT license (see LICENSE.md).