get_conduit_data

GenericMetric.get_conduit_data(poreprop, throatprop=None, mode='mean')

Combines requested data into a single 3-column array.

Parameters
  • poreprop (str) – The dictionary key to the pore property of interest

  • throatprop (str, optional) – The dictionary key to the throat property of interest. If not given then the same property as poreprop is assumed. So if poreprop = ‘pore.foo’ (or just ‘foo’), then throatprop is set to ‘throat.foo’).

  • mode (string) –

    How interpolation should be peformed for missing values. If values are present for both pores and throats, then this argument is ignored. The interpolate data method is used. Options are:

    • ’mean’ (default)

    ’mean’ (default):

    Finds the mean value of the neighboring pores (or throats)

    • ’min’

      Finds the minimum of the neighboring pores (or throats)

    • ’max’

      Finds the maximum of the neighboring pores (or throats)

Returns

conduit_data – An Nt-by-3 array with each column containing the requested property for each pore-throat-pore conduit.

Return type

ndarray