waLBerla - widely applicable lattice Boltzmann from Erlangen

Table of Contents

• Getting Started
• Further Ressources
• Contact Us
• Please cite us

Welcome to the waLBerla Framework, a widely applicable lattice Boltzmann simulation code from Erlangen. These are the documentation pages for the project's C++ code base.

Note

This is the documentation for the latest development revision of waLBerla. You can find the documentation of the last released version at https://walberla.net.

Getting Started

On the following pages, you can find instructions on downloading and setting up waLBerla both as a standalone project and as a library:

• Get and Build waLBerla
• Using waLBerla as a library in your CMake Project
• FAQ: Common Problems When Building waLBerla

After setting up waLBerla, you can browse our Tutorials and Example Apps to learn how to use the framework.

Further Ressources

Here are additional documentation, reference, and learning ressources related to waLBerla:

• SweepGen User Manual

Contact Us

To get in touch with the waLBerla team, you can:

• For bug reports and code-related issues: Create an issue at https://i10git.cs.fau.de/walberla/walberla and describe the bug as accurately as possible.
• For feature requests, collaboration inquiries, etc.: write to our developer's mailing list (cs10-.nosp@m.walb.nosp@m.erla@.nosp@m.fau..nosp@m.de).

Please cite us

If you use waLBerla in the preparation of a publication, please cite [11] and [4]. There are separate publications for some modules, which you should cite in addition if you use them.

• Grid refinement: [23]
• PE coupling: [21]
• Python interface: [2]
• pystencils code generation: [3]
• lbmpy LB model generation: [5] and [13]