resqpy.derived_model.fault_throw_scaling

resqpy.derived_model.fault_throw_scaling(epc_file, source_grid=None, scaling_factor=None, connection_set=None, scaling_dict=None, ref_k0=0, ref_k_faces='top', cell_range=0, offset_decay=0.5, store_displacement=False, inherit_properties=False, inherit_realization=None, inherit_all_realizations=False, inherit_gcs=True, new_grid_title=None, new_epc_file=None)

Extends epc with a new grid with fault throws multiplied by scaling factors.

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) – 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

  • scaling_factor (float, optional) – if present, the default scaling factor to apply to split pillars which do not appear in any of the faults in the scaling dictionary; if None, such pillars are left unchanged

  • connection_set (fault.GridConnectionSet object) – the connection set with associated fault feature list, used to identify which faces (and hence pillars) belong to which named fault

  • scaling_dict (dictionary mapping string to float) – the scaling factor to apply to each named fault; any faults not included in the dictionary will be left unadjusted (unless a default scaling factor is given as scaling_factor arg)

  • ref_k0 (integer, default 0) – the reference layer (zero based) to use when determining the pre-existing throws

  • ref_k_faces (string, default 'top') – ‘top’ or ‘base’ identifying which bounding interface to use as the reference

  • cell_range (integer, default 0) – the number of cells away from faults which will have depths adjusted to spatially smooth the effect of the throw scaling (ie. reduce sudden changes in gradient due to the scaling)

  • offset_decay (float, default 0.5) – DEPRECATED; ignored

  • 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 fault throw scaling

  • 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

  • inherit_gcs (boolean, default True) – if True, any grid connection set objects related to the source grid will be inherited by the modified grid

  • 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 derived grid (& crs)

Returns:

new grid (grid.Grid object), with fault throws scaled according to values in the scaling dictionary

Notes

grid points are moved along pillar lines; stretch is towards or away from mid-point of throw; same shift is applied to all layers along pillar; pillar lines assumed to be straight; the offset decay argument might be changed in a future version to give improved smoothing; if a large fault is represented by a series of parallel minor faults ‘stepping’ down, each minor fault will have the scaling factor applied independently, leading to some unrealistic results