Lattice Boltzmann Benchmark Kernels
===================================

The lattice Boltzmann (LBM) benchmark kernels are a collection of LBM kernel
implementations.

AS SUCH THE LBM BENCHMARK KERNELS ARE NO FULLY EQUIPPED CFD SOLVER AND SOLELY
SERVE THE PURPOSE OF STUDYING POSSIBLE PERFORMANCE OPTIMIZATIONS AND/OR
EXPERIMENTS.

The benchmark suite was created by the HPC group of Erlangen Regional Computing
Center (RRZE/HPC) [1] and the Chair for System Simulation of FAU (LSS) [2].

See doc/main.rst or doc/main.html subdirectories for rudimentary
documentation.



LICENCE
-------

LBM benchmark kernels are licensed under GPLv3.

See licence of src/BoostJoin.h in the top of src/BoostJoin.h, which stems from
the boost projects and is licenced under the Boost licence.

CITE US
-------

If you use the benchmark kernels you can cite us:

M. Wittmann, V. Haag, T. Zeiser, H. Köstler, and G. Wellein: Lattice Boltzmann
Benchmark Kernels as a Testbed for Performance Analysis, (2018), Computer &
Fluids, Special Issue DSFD2017. doi:10.1016/j.compfluid.2018.03.030. 

Bibtex entry:

@article{wittmann-2018,
    author  = {M. Wittmann and V. Haag and T. Zeiser and H. K\"ostler and G. Wellein},
    title   = {Lattice {B}oltzmann benchmark kernels as a testbed for performance analysis},
    journal = {Computers \& Fluids},
    year    = {2018},
    issn    = {0045-7930},
    doi     = {10.1016/j.compfluid.2018.03.030},
}

ACKNOWLEDGEMENTS
----------------

This work was funded by:

  - BMBF, grant no. 01IH15003A (project SKAMPY)
  - KONWHIR project OMI4PAPS


[1] https://hpc.fau.de/
[2] https://www10.informatik.uni-erlangen.de/en/