from_neighbor_throats

openpnm.models.geometry.pore_size.from_neighbor_throats(target, prop, mode='max')

Adopt a value from the values found in neighboring throats

Parameters

• target (Base) – The object which this model is associated with. This controls the length of the calculated array, and also provides access to other necessary properties.

• prop (str) – The dictionary key of the array containing the throat property to be used in the calculation.

• mode (str) – Controls how the pore property is calculated. Options are ‘min’, ‘max’ and ‘mean’.

Returns

value – Array containing customized values based on those of adjacent throats.

Return type

ndarray