resqpy.olio.relperm.relperm_parts_in_model

resqpy.olio.relperm.relperm_parts_in_model(model, phase_combo=None, low_sal=None, table_index=None, title=None, related_uuid=None)[source]

Returns list of part names within model that are representing RelPerm dataframe support objects.

Parameters:
  • model (model.Model) – the model to be inspected for dataframes

  • phase_combo (str, optional) – the combination of phases whose relative permeability behaviour is described. Options include ‘water-oil’, ‘gas-oil’, ‘gas-water’, ‘oil-water’, ‘oil-gas’ and ‘water-gas’

  • low_sal (boolean, optional) – if True, indicates that the water-oil table contains the low-salinity data for relative permeability and capillary pressure

  • table_index (int, optional) – the index of the relative permeability table when multiple relative permeability tables are present. Note, indices should start at 1.

  • title (str, optional) – if present, only parts with a citation title exactly matching will be included

  • related_uuid (uuid, optional) – if present, only parts relating to this uuid are included

Returns:

list of str, each element in the list is a part name, within model, which is representing the support for a RelPerm object