resqpy.grid_surface.generate_untorn_surface_for_x_section

resqpy.grid_surface.generate_untorn_surface_for_x_section(grid, axis, ref_slice0=0, plus_face=False, quad_triangles=True, as_single_layer=False)[source]

Returns a Surface object generated from the grid cross section points for an unfaulted grid.

Parameters:
  • grid (grid.Grid object) – the grid object from which a cross section is to be converted to a surface

  • axis (string) – ‘I’ or ‘J’ being the axis of the cross-sectional slice (ie. dimension being dropped)

  • ref_slice0 (int, default 0) – the reference value for indices in I or J (as defined in axis)

  • plus_face (boolean, default False) – if False, negative face is used; if True, positive

  • quad_triangles (boolean, default True) – if True, 4 triangles are used to represent each cell face, which gives a unique solution with a shared node of the 4 triangles at the mean point of the 4 corners of the face; if False, only 2 triangles are used, which gives a non-unique solution

  • as_single_layer (boolean, default False) – if True, the top points from the top layer are used together with the basal points from the base layer, to effect a single layer equivalent cross section surface

Returns:

a resqml_surface.Surface object with a single triangulated patch

Notes

The resulting surface is assigned to the same model as grid, though xml is not generated and hdf5 is not written. Strictly, the RESQML business rules for a triangulated surface require a separate patch for areas of the surface which are not joined; therefore, a fault running down through the grid should result in separate patches; however, at present the code uses a single patch regardless.