porespy.simulations.drainage_dt#

porespy.simulations.drainage_dt(im, inlets, outlets=None, dt=None, steps=None, smooth=True)#

Performs a distance transform based drainage simulation using distance transform thresholding for the erosion step and a second distance transform for the dilation step.

Parameters:

  • im (ndarray) – The boolean image of the void space on which to perform the simulation

  • inlets (ndarray (optional)) – A boolean array with True values indicating the inlet locations for the invading (non-wetting) fluid. If not provided then access limitations will not be applied, meaning that the invading fluid cand appear anywhere within the domain.

  • outlets (ndarray (optional)) – A boolean array with True values indicating the outlet locations through which defending (wetting) phase would exit the domain. If not provided then trapping of the wetting phase is ignored.

  • dt (ndarray, optional) – The distance transform of the void space. This is optional, but providing it if it is already available save some time. Also, it can be converted to integer type or round to fewer decimal places to reduce the number of unique sphere sizes to insert if steps=None.

  • steps (scalar or array_like) – Controls which sphere sizes to invade. If an int then this many steps between 1 and the maximum size are used. A tuple is treated as the start and stop of the integer values. A list or ndarray is used directly. If None (default) then each unique value in the distance transform is used.

  • smooth (boolean) – If True (default) then the spheres are drawn without any single voxel protrusions on the faces.

Returns:

results – A dataclass-like object with the following attributes:

Attribute

Description

im_seq

A numpy array with each voxel value indicating the sequence at which it was invaded. Values of -1 indicate that it was not invaded.

im_size

A numpy array with each voxel value indicating the radius of spheres being inserted when it was invaded.

Return type:

Results object

Notes

The distance transforms will be executed in parallel if porespy.settings.ncores > 1

On this page