resqpy.fault.combined_tr_mult_from_gcs_mults

resqpy.fault.combined_tr_mult_from_gcs_mults(model, gcs_tr_mult_uuid_list, merge_mode='minimum', sided=None, fill_value=1.0, active_only=True, apply_baffles=False)

Returns a triplet of transmissibility multiplier arrays over grid faces by combining those from gcs’es.

Parameters
  • model (Model) – the model containing all the relevant objects

  • gcs_tr_mult_uuid_list (list of UUID) – uuids of the individual grid connection set transmissibility multiplier properties to be combined

  • merge_mode (str, default 'minimum') – one of ‘minimum’, ‘multiply’, ‘maximum’, ‘exception’; how to handle multiple values applicable to the same grid face

  • sided (bool, optional) – whether to apply values on both sides of each gcs cell-face pair; if None, will default to False if merge mode is multiply, True otherwise

  • fill_value (float, optional) – the value to use for grid faces not present in any of the gcs’es; if None, NaN will be used

  • active_only (bool, default True) – if True and an active property exists for a grid connection set, then only active faces are used when combining to make the grid face arrays

  • apply_baffles (bool, default False) – if True, where a baffle property exists for a grid connection set, a transmissibility multiplier of zero will be used for faces marked as True, overriding the multiplier property values at such faces

Returns

triple numpy float arrays being transmissibility multipliers for K, J, and I grid faces; arrays have

shapes (nk + 1, nj, ni), (nk, nj + 1, ni), and (nk, nj, ni + 1) respectively

Notes

each gcs, which is the supporting representation for each input tr mult property, must be for a single grid and that grid must be the same for all the gcs’es; the three arrays returned by this function can be flattened and concatenated to create a composite array compatible with RESQML documentation for grid properties with indexable elmement of ‘faces’