Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

PetIBM - toolbox and applications of the immersed-boundary method on distributed-memory architectures

License Travis Docs DOI CITE_BIB

PetIBM implements immersed-boundary methods to solve 2D and 3D incompressible Navier-Stokes on stretched Cartesian grids using a projection approach.

Currently, two immersed boundary methods are implemented:

  • Immersed Boundary Projection Method (IBPM; Taira and Colonius, 2007);
  • decoupled version of the IBPM (Li et al., 2016).

With object-oriented design, the objects and classes in PetIBM can be re-used to develop other solvers easily, as long as the numerical methods used can fit into Perot's framework (Perot, 1993; Chang et. al, 2002). See Doxygen pages for API manual.

PetIBM relies on the PETSc library for data structures and parallel routines. Linear systems can be solved either on CPUs using PETSc KSP objects or on multiple CUDA-capable GPU devices using the NVIDIA AmgX library. Data transfers between PETSc and AmgX are handled by AmgXWrapper.

PetIBM runs only on Unix-based systems (no support on Windows) and was last tested on Ubuntu 16.04, MacOS Sierra 10.12.6, and Arch Linux. PetIBM was also tested on the following HPC systems: GW ColonialOne and Titan at ORNL.

Please see Documentation for more details.


PetIBM supports:

  • multiple immersed bodies,
  • moving bodies with prescribed kinematics,
  • 2D and 3D stretched Cartesian meshes,
  • distributed-memory architectures,
  • multiple GPUs on a single node,
  • GPU clusters, and
  • HDF5 I/O.


Offline API manual can be generated with Doxygen.

Papers published using PetIBM

  • Mesnard, O., & Barba, L. A. (2017). Reproducible and Replicable Computational Fluid Dynamics: It's Harder Than You Think. Computing in Science & Engineering, 19(4), 44-55,


Please e-mail Olivier Mesnard or Pi-Yueh Chuang if you have any questions, suggestions, or feedback.

To report bugs, please use the GitHub issue tracking system. We are also open to pull-requests.


  • Chang, W., Giraldo, F., & Perot, B. (2002). Analysis of an exact fractional step method. Journal of Computational Physics, 180(1), 183-199.
  • Li, R. Y., Xie, C. M., Huang, W. X., & Xu, C. X. (2016). An efficient immersed boundary projection method for flow over complex/moving boundaries. Computers & Fluids, 140, 122-135.
  • Perot, J. B. (1993). An analysis of the fractional step method. Journal of Computational Physics, 108(1), 51-58.
  • Taira, K., & Colonius, T. (2007). The immersed boundary method: a projection approach. Journal of Computational Physics, 225(2), 2118-2137.

How to cite PetIBM

If PetIBM contributes to a project that leads to a scientific publication, please cite the project. You can use this citation or the BibTeX entry below.

Pi-Yueh Chuang, Olivier Mesnard, Anush Krishnan, Lorena A. Barba (2018). PetIBM: toolbox and applications of the immersed-boundary method on distributed-memory architectures. Journal of Open Source Software, 3(25), 558, doi:10.21105/joss.00558

  doi = {10.21105/joss.00558},
  url = {},
  year = {2018},
  month = {may},
  publisher = {The Open Journal},
  volume = {3},
  number = {25},
  pages = {558},
  author = {Pi-Yueh Chuang and Olivier Mesnard and Anush Krishnan and Lorena A. Barba},
  title = {{PetIBM}: toolbox and applications of the immersed-boundary method on distributed-memory architectures},
  journal = {The Journal of Open Source Software}