Taxila LBM: a parallel,modular lattice Boltzmann framework for simulating pore-scale flow in porous media

The lattice Boltzmann method is a popular tool for pore-scale simulation of flow. This is likely due to the ease of including complex geometries such as porous media and representing multiphase and multifluid flows. Many advancements, including multiple relaxation times, increased isotropy, and others have improved the accuracy and physical fidelity of the method. Additionally, the lattice Bolzmann method is computationally very efficient, thanks to the explicit nature of the algorithm and relatively large amount of local work. The combination of many algorithmic options and efficiency means that a software framework enabling the usage and comparison of these advancements on computers from laptops to large clusters has much to offer. In this paper, we introduce Taxila LBM, an open-source software framework for lattice Boltzmann simulations. We discuss the design of the framework and lay out the features available, including both methods in the literature and a few new enhancements which generalize methods to complex geometries. We discuss the trade-off of accuracy and performance in various methods, noting how the Taxila LBM makes it easy to perform these comparisons for real problems. And finally, we demonstrate a few common applications in pore-scale simulation, including the characterization of permeability of a Berea sandstone and analysis of multifluid flow in heterogenous micromodels.