resqpy.fault.pinchout_connection_set

resqpy.fault.pinchout_connection_set(grid, skip_inactive=True, feature_name='pinchout')

Returns a new GridConnectionSet representing non-standard K face connections across pinchouts.

Parameters
  • grid (grid.Grid) – the grid for which a pinchout connection set is required

  • skip_inactive (boolean, default True) – if True, connections are not included where there is an inactive cell above or below the pinchout; if False, such connections are included

  • feature_name (string, default 'pinchout') – the name to use as citation title in the feature and interpretation

Notes

this function does not write to hdf5, nor create xml for the new grid connection set; however, it does create one feature and a corresponding interpretation and creates xml for those