Stratiflow is a package for the direct numerical simulation (DNS) of stratified shear flows.
- CMake, for building
- A C++ compiler supporting C++14
- FFTW
- Eigen 3
- Python with matplotlib for figures
Stratiflow has only been tested on Linux, but it should be straightforward to port to Windows and hopefully works out-of-the-box on macOS.
To build Stratiflow in any directory, run:
cmake -DCMAKE_BUILD_TYPE=Release <path to stratiflow git repository>
make
The fourier transforms in Stratiflow are the bottleneck, and then can be accelerated in two ways:
- With MKL and an Intel CPU (may also work on AMD)
After installing MKL - which requires a license - and loading the environment, run cmake with the -DMKL=On option, and then build. Even if using CUDA too, this will still accelerate some linear algebra.
- With CUDA and an Nvidia GPU
After installing the CUDA toolkit, run cmake with the -DCUDA=On option, and then build.
By default, Stratiflow uses single precision floating point numbers, as increasing to double was not found to affect results but does impose a performance cost.
If for your problem, you require double precision, this case be enabled by using the -DDOUBLE=On flag when configuring with cmake.