compute_permeability

compute_permeability(soln, direction=None, nu=None, dx_m=None, verbose=True)

Compute Darcy permeability from a single-phase LBM simulation.

Parameters

Name	Type	Description	Default
soln	FlowResult	A `FlowResult` returned by `solve_flow()`. `direction` and `nu` default to the values stored in the result.	required
direction	(x, y, z)	Flow direction. If None, taken from `soln.direction`.	`'x'`
nu	float or None	Kinematic viscosity in lattice units. If None, taken from `soln.nu`.	`None`
dx_m	float or None	Physical voxel size in metres. If given, results are also reported in m² and milliDarcy. E.g. `dx_m=2.85e-6` for a 2.85-µm scan.	`None`
verbose	bool	Print a summary of results to stdout. Default True.	`True`

Name	Type	Description
	dict with keys:	porosity – pore fraction (dimensionless) u_darcy – superficial velocity in the flow direction (lu/ts) u_pore – mean pore-space velocity (lu/ts) k_lu – permeability in lattice units (voxels²) k_m2 – permeability in m² (None if dx_m is None) k_mD – permeability in milliDarcy (None if dx_m is None) summary – human-readable result summary string (always populated)