resqpy.derived_model.local_depth_adjustment

resqpy.derived_model.local_depth_adjustment(epc_file, source_grid, centre_x, centre_y, radius, centre_shift, use_local_coords, decay_shape='quadratic', ref_k0=0, store_displacement=False, inherit_properties=False, inherit_realization=None, inherit_all_realizations=False, new_grid_title=None, new_epc_file=None)

Applies a local depth adjustment to the grid, adding as a new grid part in the model.

Parameters

  • epc_file (string) – file name to rewrite the model’s xml to; if source grid is None, model is loaded from this file

  • source_grid (grid.Grid object, optional) – a multi-layer RESQML grid object; if None, the epc_file is loaded and it should contain one ijk grid object (or one ‘ROOT’ grid) which is used as the source grid

  • centre_x (floats) – the centre of the depth adjustment, corresponding to the location of maximum change in depth; crs is implicitly that of the grid but see also use_local_coords argument

  • centre_y (floats) – the centre of the depth adjustment, corresponding to the location of maximum change in depth; crs is implicitly that of the grid but see also use_local_coords argument

  • radius (float) – the radius of adjustment of depths; units are implicitly xy (projected) units of grid crs

  • centre_shift (float) – the maximum vertical depth adjustment; units are implicily z (vertical) units of grid crs; use positive value to increase depth, negative to make shallower

  • use_local_coords (boolean) – if True, centre_x & centre_y are taken to be in the local coordinates of the grid’s crs; otherwise the global coordinates

  • decay_shape (string) – ‘linear’ yields a cone shaped change in depth values; ‘quadratic’ (the default) yields a bell shaped change

  • ref_k0 (integer, default 0) – the layer in the grid to use as reference for determining the distance of a pillar from the centre of the depth adjustment; the corners of the top face of the reference layer are used

  • store_displacement (boolean, default False) – if True, 3 grid property parts are created, one each for x, y, & z displacement of cells’ centres brought about by the local depth shift

  • inherit_properties (boolean, default False) – if True, the new grid will have a copy of any properties associated with the source grid

  • inherit_realization (int, optional) – realization number for which properties will be inherited; ignored if inherit_properties is False

  • inherit_all_realizations (boolean, default False) – if True (and inherit_realization is None), properties for all realizations will be inherited; if False, only properties with a realization of None are inherited; ignored if inherit_properties is False or inherit_realization is not None

  • new_grid_title (string) – used as the citation title text for the new grid object

  • new_epc_file (string, optional) – if None, the source epc_file is extended with the new grid object; if present, a new epc file (& associated h5 file) is created to contain the adjusted grid (& crs)

Returns

new grid object which is a copy of the source grid with the local depth adjustment applied