Function reference
Core Functions
Solve flow and compute transport properties
| solve_flow | Run a pressure-driven single-phase LBM simulation to steady state. |
| compute_permeability | Compute Darcy permeability from a single-phase LBM simulation. |
| compute_hydraulic_conductance | Compute hydraulic conductance g from a single-phase LBM simulation. |
| FlowResult | Container for a converged single-phase LBM flow simulation. |
Utilities
VTR file I/O
| utils.read_flow_vtr | Read a flow .vtr file and return a :class:~kabs.FlowResult. |
| utils.write_flow_vtr | Write a FlowResult to a VTK Rectilinear Grid (.vtr) file. |
Visualization
Plotting helpers
| plots.plot_cross_section | Generate a 2D image of the velocity field for plotting |
| plots.add_streamlines | Overlay 2D streamlines on an existing Matplotlib axes. |
| plots.render_flow | Render a ParaView-style 3D visualisation of the solid structure and flow |