from_neighbor_pores

openpnm.models.misc.neighbor_lookups.from_neighbor_pores(target, prop, mode='min', ignore_nans=True)[source]

Adopt a value based on the values in neighboring pores

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 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 True the result will ignore nans in the neighbors

Returns

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

Return type

ndarray