- openpnm.models.geometry.throat_size.from_neighbor_pores(target, prop='pore.diameter', mode='min')¶
Adopt a value based on the values in neighboring pores
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 to the array containing the pore property to be used in the calculation.
mode (str) – Controls how the throat property is calculated. Options are ‘min’, ‘max’ and ‘mean’.
ignore_nans (bool (default is
True)) – If
Truethe result will ignore
nansin the neighbors
value – Array containing customized values based on those of adjacent pores.
- Return type