README.md 4.35 KB
Newer Older
1
2
# waLBerla

3
4
5
6
waLBerla (widely applicable Lattice Boltzmann from Erlangen) is a massively parallel framework for multi physics applications. Besides its
original objective, Lattice Boltzmann solvers for hydrodynamics, it now contains modules for other applications like Multigrid and rigid
body dynamics as well. Great emphasis is placed on the interoperability between the modules in particular the fluid-particle coupling. It
scales from laptops to current and future supercomputers while maintaining near-perfect efficiency.
7

8
See https://www.walberla.net/ for more information and a showcase of applications.
9
10
11
12

## Documentation and Tutorials

Documentation for the C++ framework is available in
13
14
[Doxygen](http://walberla.net/doxygen/index.html), while the Python interface is documented
in [Sphinx](http://walberla.net/sphinx/index.html).
15
16
17

## Getting started

18
19
The minimum requirements are a C++17-compliant compiler (e.g. GCC or Clang)
and the [CMake](http://www.cmake.org)
20
build system. Furthermore, you need an MPI library (like
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
[Open MPI](http://www.open-mpi.org)) if you want to make use of parallel processing capabilities. All of these dependencies are typically
available in your operating system's package manager.

### CMake

The typical steps, assuming your are in the waLBerla source directory, are:

- `mkdir build; cd build` create a build directory and change into it
- `cmake ..` call CMake with the waLBerla source directory as a argument
- `make` build waLBerla

To specify a CMake option you need to use `-D(Option)=(Value)`. For example to set the C++ compiler one can use:
`cmake -DCMAKE_CXX_COMILER=clang++`

To list and modify the CMake options the `ccmake` tool can be used. Just call `ccmake .` in your **build** directory to see and change the
CMake options and variables.

Some important CMake variables:

- `WALBERLA_BUILD_WITH_CODEGEN` Enable pystencils code generation"
- `Python_ROOT_DIR` Define the root directory of a Python installation.
- `MPI_HOME` Specify the base directory of the MPI installation.`
- `WALBERLA_BUILD_WITH_PYTHON` Support for embedding Python
- `WALBERLA_BUILD_WITH_CUDA` Enable CUDA support

For a full list of CMake Option see the [CMakeLists.txt](CMakeLists.txt) file or use `ccmake as described above.`

### Codegen and Python

To use the `lbmpy`/`pystencils` code generation please install the packages with e.g. `pip install lbmpy` and specify the correct python
environment when calling CMake.

In previous versions of CMake one could use `PYTHON_EXECUTABLE` or `PYTHON_ROOT_DIR` (all upper case) to specify the python executable or
the directory. This does **NOT** work anymore. Please use `Python_ROOT_DIR`.
55
56
57
58
59
60

## Get involved

### Contributing

Please submit all code contributions on our
61
62
[GitLab](https://i10git.cs.fau.de/walberla/walberla). To get an account, please sign and submit
the [contributor license agreement](CONTRIBUTING.txt).
63
64
65
66
67
68
69
70
71
72
73
74

### Support

While we currently do not have a mailing list, any questions can be asked via
the [Issue Tracker](https://i10git.cs.fau.de/walberla/walberla/issues).

## Authors

Many thanks go to waLBerla's [contributors](AUTHORS.txt)

### Please cite us

Michael Kuron's avatar
Michael Kuron committed
75
If you use waLBerla in a publication, please cite the following articles:
76

77
Overview:
78
79
80
81

- M. Bauer et al, *waLBerla: A block-structured high-performance framework for multiphysics simulations*. Computers & Mathematics with
  Applications, 2020.
  https://doi.org/10.1016/j.camwa.2020.01.007.
Christoph Rettinger's avatar
Christoph Rettinger committed
82

83
Grid Refinement:
84
85
86
87

- F. Schornbaum and U. Rüde, *Massively parallel algorithms for the lattice boltzmann method on nonuniform grids*. SIAM Journal on
  Scientific Computing, 2016.
  https://doi.org/10.1137/15M1035240
Christoph Rettinger's avatar
Christoph Rettinger committed
88
89

LBM - Particle Coupling:
90
91
92
93

- C. Rettinger and U. Rüde, *A comparative study of fluid-particle coupling methods for fully resolved lattice Boltzmann simulations*.
  Computers & Fluids, 2017.
  https://doi.org/10.1016/j.compfluid.2017.05.033
Christoph Rettinger's avatar
Christoph Rettinger committed
94

95
MESA-PD:
96
97
98
99

- S. Eibl and U. Rüde, *A Modular and Extensible Software Architecture for Particle Dynamics*. Proceedings Of The 8Th International
  Conference On Discrete Element Methods.
  https://mercurylab.co.uk/dem8/full-papers/#page-content
Christoph Rettinger's avatar
Christoph Rettinger committed
100

101
Carbon Nanotubes:
102
103
104
105

- G. Drozdov et al, *Densification of single-walled carbon nanotube films:
  Mesoscopic distinct element method simulations and experimental validation*. Journal of Applied Physics,
  2020. https://doi.org/10.1063/5.0025505
106
107
108
109

## License

waLBerla is licensed under [GPLv3](COPYING.txt).