[LbmBenchmarkKernelsPublic.git] / README

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/
Commit	Line	Data
0095f461 MW	1	Lattice Boltzmann Benchmark Kernels
	2	===================================
	3
712d0b8f MW	4	The lattice Boltzmann (LBM) benchmark kernels are a collection of LBM kernel
	5	implementations.
	6
	7	AS SUCH THE LBM BENCHMARK KERNELS ARE NO FULLY EQUIPPED CFD SOLVER AND SOLELY
	8	SERVE THE PURPOSE OF STUDYING POSSIBLE PERFORMANCE OPTIMIZATIONS AND/OR
	9	EXPERIMENTS.
	10
	11	The benchmark suite was created by the HPC group of Erlangen Regional Computing
	12	Center (RRZE/HPC) [1] and the Chair for System Simulation of FAU (LSS) [2].
0095f461	13
0fde6e45	14	See doc/main.rst or doc/main.html subdirectories for rudimentary
0095f461 MW	15	documentation.
	16
	17
	18
	19	LICENCE
	20	-------
712d0b8f	21
0095f461 MW	22	LBM benchmark kernels are licensed under GPLv3.
	23
	24	See licence of src/BoostJoin.h in the top of src/BoostJoin.h, which stems from
	25	the boost projects and is licenced under the Boost licence.
	26
8b9da565 MW	27	CITE US
	28	-------
	29
	30	If you use the benchmark kernels you can cite us:
	31
	32	M. Wittmann, V. Haag, T. Zeiser, H. Köstler, and G. Wellein: Lattice Boltzmann
	33	Benchmark Kernels as a Testbed for Performance Analysis, (2018), Computer &
	34	Fluids, Special Issue DSFD2017. doi:10.1016/j.compfluid.2018.03.030.
	35
	36	Bibtex entry:
0095f461	37
8b9da565 MW	38	@article{wittmann-2018,
	39	author = {M. Wittmann and V. Haag and T. Zeiser and H. K\"ostler and G. Wellein},
	40	title = {Lattice {B}oltzmann benchmark kernels as a testbed for performance analysis},
	41	journal = {Computers \& Fluids},
	42	year = {2018},
	43	issn = {0045-7930},
	44	doi = {10.1016/j.compfluid.2018.03.030},
	45	}
0095f461 MW	46
	47	ACKNOWLEDGEMENTS
	48	----------------
	49
	50	This work was funded by:
	51
	52	- BMBF, grant no. 01IH15003A (project SKAMPY)
	53	- KONWHIR project OMI4PAPS
	54
	55
	56	[1] https://hpc.fau.de/
	57	[2] https://www10.informatik.uni-erlangen.de/en/
	58
	59