TCLB

KO | EN

gitlite — search

#javascript #python #golang #go #deep-learning #docker #macos #windows #awesome #cli #kubernetes #vue #openai #mcp

(★ 206)

TCLB - Templated MPI+CUDA/CPU Lattice Boltzmann code

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- - cpu_test.yml
  - gpu_comp.yml
  - hip_comp.yml
  - other_tests.yml
  - rinside.yaml
  - storage_test.yml
- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- elements.yaml
- - ahmed.stl
  - chipset_radiator.png
  - chipset_radiator.stl
  - japan.png
  - pipe2x1.stl
  - plane1x1.stl
  - Plate_128x2x128.stl
  - wave.stl
- - npe_guo.xml
  - npe_guo_nonuniform.xml
  - npe_guo_zeta_zero.xml
  - poison_boltzmann.xml
- - cylinder_XYplane_D10_Z9.stl
  - d2q9q9_Hot_Karman_Re100_Pr5.xml
  - d2q9q9_lid_driven_cavity.xml
  - d3q27q27_Hot_Karman_Re100_Pr5.xml
  - d3q27q7_Hot_Karman_Re100_Pr5.xml
- - flapping1.xml
  - sin.csv
- - Alternate_PressureIn.csv
  - kl_cyl_test.xml
  - pressureProfile_alternate.py
  - viscoplastic_sphere_test.xml
  - viscoplastic_tunnel_test.xml
  - viscoplastic_tunnel_test_oscillatory.xml
- - advection_diffusion.xml
  - diffusion2D.xml
  - wave2D.xml
- - karman_vtk.xml
- - d2q9_AllenCahn_SourceTerm_SOI.xml
  - d2q9_AllenCahn_SourceTerm_SOI_runr.xml
- - advection_diffusion_fields.xml
  - karman.xml
  - spheres.xml
- - water.xml
- - 1d.xml
  - box.xml
  - box_s.xml
  - Bump.csv
  - cavity.xml
  - cavity2.xml
  - chan.xml
  - chan2.xml
  - contact-angle-phase-field.xml
  - couetteFlow.xml
  - cross_flux.xml
  - d2q9_adj_drag.xml
  - drop.xml
  - drop3d.xml
  - entropic.xml
  - example.xml
  - feslicescript.py
  - gravity.drop.xml
  - heat_adj.xml
  - heater_50.xml
  - karman.two.xml
  - kuper.xml
  - kuper_Bretherton
  - lid.xml
  - moving.channel.xml
  - optimalMixing.xml
  - pile.xml
  - random_circles.xml
  - spit.xml
  - spit1.xml
  - spit2.xml
  - spit3.xml
  - spit_catalyst.xml
  - sqr.xml
  - test2p.xml
  - tex1.txt
  - tex2.txt
  - tex3.txt
  - tex4.txt
  - wave.xml
  - write_vti.py
- - cfd-go-logo.png
  - conf.doxygen
  - README.md
- - acAndersen.cpp
  - acAndersen.h
  - acContainer.cpp
  - acContainer.h
  - acESYSParticle.cpp
  - acESYSParticle.h
  - acFDTest.cpp
  - acFDTest.h
  - acGeometry.cpp
  - acGeometry.h
  - acInit.cpp
  - acInit.h
  - acLoadBinary.cpp
  - acLoadBinary.h
  - acLoadMemoryDump.cpp
  - acLoadMemoryDump.h
  - acModel.cpp
  - acModel.h
  - acObjective.cpp
  - acObjective.h
  - acOptimize.cpp.Rt
  - acOptimize.h
  - acOptSolve.cpp
  - acOptSolve.h
  - acParam.cpp
  - acParam.h
  - acRemoteForceInterface.cpp
  - acRemoteForceInterface.h
  - acRepeat.cpp
  - acRepeat.h
  - acRunAction.cpp
  - acRunAction.h
  - acSAdjoint.cpp
  - acSAdjoint.h
  - acSolve.cpp
  - acSolve.h
  - acSyntheticTurbulence.cpp
  - acSyntheticTurbulence.h
  - acThreshold.cpp
  - acThreshold.h
  - acThresholdNow.cpp
  - acThresholdNow.h
  - Action.cpp
  - Action.h
  - acUSAdjoint.cpp
  - acUSAdjoint.h
  - BSpline.cpp
  - BSpline.h
  - Callback.cpp
  - Callback.h
  - cbAveraging.cpp
  - cbAveraging.h
  - cbBIN.cpp
  - cbBIN.h
  - cbCatalyst.cpp
  - cbCatalyst.h
  - cbDumpSettings.cpp
  - cbDumpSettings.h
  - cbFailcheck.cpp
  - cbFailcheck.h
  - cbHDF5.cpp
  - cbHDF5.h
  - cbKeep.cpp
  - cbKeep.h
  - cbLog.cpp
  - cbLog.h
  - cbPID.cpp
  - cbPID.h
  - cbRunR.cpp
  - cbRunR.h
  - cbSample.cpp
  - cbSample.h
  - cbSaveBinary.cpp
  - cbSaveBinary.h
  - cbSaveCheckpoint.cpp
  - cbSaveCheckpoint.h
  - cbSaveMemoryDump.cpp
  - cbSaveMemoryDump.h
  - cbStop.cpp
  - cbStop.h
  - cbTXT.cpp
  - cbTXT.h
  - cbVTK.cpp
  - cbVTK.h
  - conControl.cpp
  - conControl.h
  - conControlParameter.cpp
  - conControlParameter.h
  - conExtrude.cpp
  - conExtrude.h
  - conFieldParameter.cpp
  - conFieldParameter.h
  - Design.cpp
  - Design.h
  - Fourier.cpp
  - Fourier.h
  - GenericAction.cpp
  - GenericAction.h
  - GenericContainer.cpp
  - GenericContainer.h
  - GenericOptimizer.cpp
  - GenericOptimizer.h
  - IfContainer.cpp
  - IfContainer.h
  - InternalTopology.cpp
  - InternalTopology.h
  - MainContainer.cpp
  - MainContainer.h
  - NullHandler.cpp
  - NullHandler.h
  - OptimalControl.cpp
  - OptimalControl.h
  - OptimalControlSecond.cpp
  - OptimalControlSecond.h
  - RepeatControl.cpp
  - RepeatControl.h
  - vHandler.cpp
  - vHandler.h
- - boundary.R
  - cumulant.R
  - d3q19.R
  - feq.R
  - FMT.R
  - lattice.R
  - utils.R
- ADpost.sed.Rt
- ADpre.h.Rt
- ADpre_b.h.Rt
- ADset.sh.Rt
- ADTools.cu
- catalog.xml.Rt
- Catalyst.cpp.Rt
- Catalyst.h
- CommonHandler.h
- compare.cpp
- conf.R
- config.h.in
- config.main.mk.in
- config.mk.in
- config.R.in
- configure.ac
- Consts.h.Rt
- cross.cu
- cross.h
- cross.hpp
- cuda.cu.Rt
- def.cpp.Rt
- def.h
- dictionary.h.Rt
- Dynamics.h.Rt
- empty.cpp
- Factory.h
- Fast-Transforms.md.Rt
- Geometry.cpp.Rt
- Geometry.h
- GetThreads.cpp
- GetThreads.h
- gl_helper.h
- Global.cpp.Rt
- Global.h.Rt
- glue.hpp
- gpu_anim.h
- HandlerFactory.h
- Handlers.h
- hdf5Lattice.cpp
- hdf5Lattice.h
- lammps.cpp
- Lattice.cu.Rt
- Lattice.h.Rt
- LatticeAccess.inc.cpp.Rt
- LatticeContainer.h.Rt
- LatticeContainer.inc.cpp.Rt
- Lists.cpp.Rt
- Lists.h
- main.cpp
- main.R
- Makefile.in.Rt
- makefile.main.Rt
- makefile.Rt
- Model.md.Rt
- Models.md.Rt
- models.R
- mpitools.hpp
- MPMD.hpp
- Particle.hpp
- pinned_allocator.hpp
- pugiconfig.hpp
- pugixml.cpp
- pugixml.hpp
- range_int.hpp
- README.md
- Region.h
- RemoteForceInterface.cpp
- RemoteForceInterface.h
- RemoteForceInterface.hpp
- Sampler.cpp
- Sampler.h
- schema.xsd.Rt
- simplepart.cpp
- SolidAll.h
- SolidContainer.h
- SolidGrid.h
- SolidGrid.hpp
- SolidTree.cpp
- SolidTree.h
- SolidTree.hpp
- Solver.cpp.Rt
- Solver.h.Rt
- solver.vcproj
- spline.h
- SUMMARY.Rt
- SyntheticTurbulence.cpp
- SyntheticTurbulence.h
- TCLBForceGroupCommon.h
- Things.h
- timer.hpp
- types.h
- unit.cpp
- unit.h
- utils.h
- vtkLattice.cpp
- vtkLattice.h
- vtkOutput.cpp
- vtkOutput.h
- xpath_modification.cpp
- xpath_modification.h
- ZoneSettings.cpp
- ZoneSettings.h
- - main.cpp
  - makefile
- external
- - test.exceptions.sh
- - CallPythonHelper.py
- - .vimrc
  - clb.xml.nanorc
  - Rt.jsf
  - Rt.nanorc
- ADmod.R
- clear
- compareH5.py
- cp_line
- csvconcatenate
- csvdiff
- dep.R
- deploy.docs.sh
- env.sh
- gen.doc.R
- install.sh
- linemark.R
- makeAD
- mkpath
- overlay.sh
- RT
- stensil.plot.R
- stlutil
- TestEnvironment.R
- tests.sh
.codecov.yaml
.gitdeps
.gitignore
.gitmodules
LICENSE
makefile
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![TCLB Solver Header](https://raw.githubusercontent.com/CFD-GO/documents/master/assets/header.png)

TCLB Solver [![ZENADO DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3550331.svg)](https://doi.org/10.5281/zenodo.3550331) [![Article](https://zenodo.org/badge/DOI/10.1016/j.camwa.2015.12.043.svg)](https://doi.org/10.1016/j.camwa.2015.12.043)
===
TCLB is a MPI+CUDA, MPI+CPU or MPI+HIP high-performance Computational Fluid Dynamics simulation code, based on the Lattice Boltzmann Method.
It provides a clear interface for calculation of complex physics, and the implementation of new models.

**Stable release** [(`master` branch)](https://github.com/CFD-GO/TCLB/tree/master):<br/>[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/CFD-GO/TCLB?quickstart=1)<br/>[![CPU build status](https://github.com/CFD-GO/TCLB/actions/workflows/cpu_test.yml/badge.svg?branch=master)](https://github.com/CFD-GO/TCLB/actions/workflows/cpu_test.yml) [![CUDA build status](https://github.com/CFD-GO/TCLB/actions/workflows/gpu_comp.yml/badge.svg?branch=master)](https://github.com/CFD-GO/TCLB/actions/workflows/gpu_comp.yml) [![HIP build status](https://github.com/CFD-GO/TCLB/actions/workflows/hip_comp.yml/badge.svg?branch=develop)](https://github.com/CFD-GO/TCLB/actions/workflows/hip_comp.yml) [![codecov](https://codecov.io/gh/CFD-GO/TCLB/branch/master/graph/badge.svg)](https://codecov.io/gh/CFD-GO/TCLB) [![documentation](https://raw.githubusercontent.com/CFD-GO/documents/master/assets/documentation.svg?sanitize=true)](https://docs.tclb.io/)

**Current release** [(`develop` branch)](https://github.com/CFD-GO/TCLB/tree/develop):</br>[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/CFD-GO/TCLB/tree/develop?quickstart=1)<br/>[![CPU build status](https://github.com/CFD-GO/TCLB/actions/workflows/cpu_test.yml/badge.svg?branch=develop)](https://github.com/CFD-GO/TCLB/actions/workflows/cpu_test.yml) [![CUDA build status](https://github.com/CFD-GO/TCLB/actions/workflows/gpu_comp.yml/badge.svg?branch=develop)](https://github.com/CFD-GO/TCLB/actions/workflows/gpu_comp.yml) [![HIP build status](https://github.com/CFD-GO/TCLB/actions/workflows/hip_comp.yml/badge.svg?branch=develop)](https://github.com/CFD-GO/TCLB/actions/workflows/hip_comp.yml) [![codecov](https://codecov.io/gh/CFD-GO/TCLB/branch/develop/graph/badge.svg)](https://codecov.io/gh/CFD-GO/TCLB) [![documentation](https://raw.githubusercontent.com/CFD-GO/documents/master/assets/documentation.svg?sanitize=true)](https://develop.docs.tclb.io/)

## How to use it

**Install**
```bash
git clone https://github.com/CFD-GO/TCLB.git
cd TCLB
```
**Configure**
```bash
make configure
./configure
```
**Compile**
```bash
make d2q9
```
**Run**
```bash
CLB/d2q9/main example/flow/2d/karman.xml
```

## More information

### Documentation

The documentation (including tutorials) is published at
[docs.tclb.io](https://docs.tclb.io/).

For the `develop` version, the most recent documentation can be found at
[develop.docs.tclb.io](https://develop.docs.tclb.io/).

You can contribute to the documentation at
[CFD-GO/TCLB_docs](https://github.com/CFD-GO/TCLB_docs).

### Supported architectures
This code is designed to run on **Linux** with **CUDA**. We strongly recommend using Linux for compilation, computation and postprocessing.

Nevertheless, TCLB can be compiled on Windows using the [Windows Subsystem for Linux](https://pl.wikipedia.org/wiki/Windows_Subsystem_for_Linux), with CUDA supported on some system configurations (see [nVidia's website](https://docs.nvidia.com/cuda/wsl-user-guide/index.html) for more info).  It also can be compiled on MacOS (CPU only). Both Debian and Red Hat based Linux distributions are supported by the `install.sh` script described below, as is MacOS (with `brew` package manager).

### Dependencies

For the code to compile and work you'll need a few things:
- [R](https://www.r-project.org/) and some R packages ([optparse](https://cran.r-project.org/package=optparse), [rtemplate](https://github.com/llaniewski/rtemplate), [gvector](https://github.com/llaniewski/gvector), [polyAlgebra](https://github.com/llaniewski/polyAlgebra))
- [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface). We recommend [OpenMPI](http://www.open-mpi.org/)
- To use your GPU, you'll need [nVidia CUDA](https://developer.nvidia.com/cuda-zone) or [AMD HIP/ROCm](https://www.amd.com/en/graphics/servers-solutions-rocm)

Optionally, you may need:
- To integrate TCLB with R, you'll need R package [rinside](https://github.com/eddelbuettel/rinside)
- To integrate TCLB with Python, you'll need [python](https://www.python.org/), [numpy](http://www.numpy.org/) with libraries and headers
- To develop a model using Python, you'll need [python](https://www.python.org/), [sympy](http://www.sympy.org/) and R package [reticulate](https://cran.r-project.org/package=reticulate)

You can install many of these with the provided `tools/install.sh` script (note that this requires sudo):
```bash
sudo tools/install.sh essentials   # Installs essential system packages needed by TCLB
sudo tools/install.sh r            # Installs R
sudo tools/install.sh openmpi      # Installs OpenMPI
     tools/install.sh rdep         # Installs needed R packages
sudo tools/install.sh cuda         # Installs CUDA (we recommend to do it on your own)
sudo tools/install.sh python-dev   # Installs Python libraries with headers
```

You can run the `tools/install.sh` script with the `--dry` option, which will print the commands to run, so you can run them on your own.
*We do not recommend running anything with sudo without checking*

### `develop` Branch:
If you want a more recent version, you could try the development branch with `git checkout develop`

### CPU
To compile the code for CPU, you can use the `--disable-cuda` option for `./configure`:
```
./configure --disable-cuda
```
### HIP
To compile the code for AMD GPUs (ROCm), you can use the `--enable-hip` option for `./configure`:
```
./configure --enable-hip
```
### Parallel run
To run TCLB in parallel (both on multiple CPU and multiple GPU), you can use the standard syntax of MPI parallel run:
```bash
mpirun -np 8 CLB/d2q9/main example/flow/2d/karman.xml
```

### Running on clusters
To assist with using TCLB on HPC clusters (SLURM/PBS), there are scripts provided in the [TCLB_cluster](https://github.com/CFD-GO/TCLB_cluster) repository.

### LBM-DEM computation
TCLB code can be coupled with Discrete Element Method (DEM) codes, to enable computation of flow with particles.

The DEM codes that TCLB can be integrated with are:
- [LIGGGHTS](https://www.cfdem.com/liggghts-open-source-discrete-element-method-particle-simulation-code)
- [LAMMPS](https://lammps.sandia.gov/)
- [ESYS-Particle](https://launchpad.net/esys-particle)

Refer to the documentation for instructions on compilation and coupling.

## About

### Authors

TCLB began development in 2012 with the aim at providing a framework for efficient CFD computations with LBM, mainly for research.

Author: [Łukasz Łaniewski-Wołłk](https://github.com/llaniewski)

Major contributors:
* [Michał Dzikowski](https://github.com/mdzik)
* [Travis Mitchell](https://github.com/TravisMitchell)

Contributors:
* [Nathan Di Vaira](https://github.com/ndivaira)
* [Grzegorz Gruszczyński](https://github.com/ggruszczynski)
* [Bryce Hill](https://github.com/bhill23)
* [Jon McCullough](https://github.com/JonMcCullough)
* [Paweł Obrępalski](https://github.com/PabloOb)
* [Wojciech Regulski](https://github.com/wojtasMEiL)
* [Mariusz Rutkowski](https://github.com/mrutkowski-aero)
* [Dmytro Sashko](https://github.com/shkodm)

Developed at:
- [Zakład Aerodynamiki](https://meil.pw.edu.pl/ZA/) at [Politechnika Warszawska (Warsaw University of Technology)](http://pw.edu.pl/)
- [School of Mechanical & Mining Engineering](https://www.mechmining.uq.edu.au/) at [University of Queensland](http://uq.edu.au/)
- [Interdisciplinary Centre for Mathematical and Computational Modelling](https://icm.edu.pl/en) at [University of Warsaw](https://www.uw.edu.pl/)

### Citation
Please use **appropriate citations if using this software** in any research publication. The publication should cite [the original paper about TCLB](https://doi.org/10.1016/j.camwa.2015.12.043) and papers which describe the used LBM models. You can find the list of TCLB publications at [docs.tclb.io/general-info/publications/](https://docs.tclb.io/general-info/publications/). You can also find the information about published articles in the source code of the models.
The code can be cited additionally, by its [Zenodo DOI](https://doi.org/10.5281/zenodo.3550331).

### License

This software is distributed under the [GPL v3 License](LICENSE).

If you need this software under a different license, please contact the main author.

Contact: lukasz.laniewski([monkey](https://en.wikipedia.org/wiki/At_sign#Names_in_other_languages))pw.edu.pl

TCLB

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

TCLB

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README