Lattice Boltzmann code built on AMReX

From the home directory create a build directory and cd to it -- for example mkdir build followed by cd build. Then simply run cmake .., and make. liblambrex.a can be found in build/src, the binaries for the example calculation and tests can be found in build/example and build/tests. You can also just run make test to run all tests. If using conan for Catch2, please run conan install .. before cmake.

AMReX is a C++ adaptive mesh refinement library. The source can be downloaded from the AMReX GitHub.

Important: It is recommended to build AMReX with cmake for compatibility with LAMBReX. AMReX is updated regularly. LAMBReX is attempting to move with it, so minimum version 19.08 is REQUIRED, but it is recommended to use the current release.

To build the static AMReX library with cmake in way that is compatible with the current version of LAMBReX, one can follow the commands given in (or run) amrex_cmake.sh.

The C++ Automated Tests in a Header (Catch2) test framework is used for testing LAMBReX. It can be found at Catch2. System-wide installation using cmake is recommended, as described here. Alternatively, it can be installed with Conan (see below), a conanfile is provided.

Conan is a C/C++ package manager. The recommended way to install it is with pip, simply using pip install conan. If you don't have and don't want pip installed, alternatives can be found here.

At present there is only one example code, a simple simulation of a "pulse" of enhanced density on a single plane, with fully periodic boundary conditions. This calculation was chosen for its simplicity, and the output was compared against the original code on which the Lattice Boltzmann calculation part of LAMBReX is based. This example is run as part of the tests run by make test.