kaLB = kaum ausgereiftes Lattice Boltzmann

Welcome, this is the documentation for kaLB, a fluid dynamics simulation software. It was developed as part of the course scientific software development at the Philipps University Marburg in the winter term 2017/18. It was created by:

• Sven Brieden
• Simon Schmitt

kaLB uses the lattice boltzmann method to compute a 2DQ9 fluid dynamics simulation. The user is able to specify a simulation using a .json inputfile. kaLB then processes this input, performs a simulation and returns a hdf5 file containing the macroscopic values density and velocity during simulation steps. In addition the user can use picture output and snapshots; all of them at required output frequencies.

One can choose from four different boundary conditions including bounce-back (a.k.a. no-slip) and Zou-He. furthermore the user can specify arbitrary obstacles and can even import pictures that kaLB will use as obstacles.

Besides this functionality kaLB provides an extra script to create short videos from generated hdf5 files.

• 1. Getting Started
  • 1.1. Virtual Environment
  • 1.2. Installation
  • 1.3. Documentation
  • 1.4. Run a Simulation
  • 1.5. Create a Video
  • 1.6. Tests
• 2. Manual: calf flies
  • 2.1. The command line parameter
  • 2.2. Parameters of a simulation: The JSON file
  • 2.3. Understand the output
  • 2.4. Test: does the code do what it should?
• 3. Conventions and Contributing
  • 3.1. Code Style
  • 3.2. Before you push something please test:
  • 3.3. The changelog file
• 4. Testing
  • 4.1. Unit tests
  • 4.2. System test
• 5. functions and routines of the code
  • 5.1. kaLB.py
  • 5.2. d2q9_simulation.py
  • 5.3. utilities.py
  • 5.4. hdf5_to_mpeg.py
  • 5.5. Unittests

Indices and tables

• Index
• Module Index
• Search Page