from_neighbor_throats

from_neighbor_throats(target, prop, mode='min', ignore_nans=True)

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. The default value is ‘min’. Options are:

  mode	meaning
  ’min’	Returns the value of the minimum property of the neighboring throats
  ’max’	Returns the value of the maximum property of the neighboring throats
  ’mean’	Returns the value of the mean property of the neighboring throats
  ’sum’	Returns the sum of the property of the neighboring throats

Returns:

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

Return type:

ndarray