resqpy 4.18.11__py3-none-any.whl → 5.1.0__py3-none-any.whl

resqpy/multi_processing/wrappers/grid_surface_mp.py

@@ -4,8 +4,10 @@ import logging
 
 log = logging.getLogger(__name__)
 
+import os
 import numpy as np
 import uuid
+import ast
 from typing import Tuple, Union, List, Optional, Callable
 from pathlib import Path
 from uuid import UUID
@@ -18,33 +20,38 @@ import resqpy.surface as rqs
 import resqpy.olio.uuid as bu
 
 
-def find_faces_to_represent_surface_regular_wrapper(index: int,
-                                                    parent_tmp_dir: str,
-                                                    use_index_as_realisation: bool,
-                                                    grid_epc: str,
-                                                    grid_uuid: Union[UUID, str],
-                                                    surface_epc: str,
-                                                    surface_uuid: Union[UUID, str],
-                                                    name: str,
-                                                    title: Optional[str] = None,
-                                                    agitate: bool = False,
-                                                    random_agitation: bool = False,
-                                                    feature_type: str = 'fault',
-                                                    trimmed: bool = False,
-                                                    is_curtain = False,
-                                                    extend_fault_representation: bool = False,
-                                                    flange_inner_ring = False,
-                                                    saucer_parameter = None,
-                                                    retriangulate: bool = False,
-                                                    related_uuid = None,
-                                                    progress_fn: Optional[Callable] = None,
-                                                    extra_metadata = None,
-                                                    return_properties: Optional[List[str]] = None,
-                                                    raw_bisector: bool = False,
-                                                    use_pack: bool = False,
-                                                    flange_radius = None,
-                                                    reorient = True,
-                                                    n_threads = 20) -> Tuple[int, bool, str, List[Union[UUID, str]]]:
+def find_faces_to_represent_surface_regular_wrapper(
+        index: int,
+        parent_tmp_dir: str,
+        use_index_as_realisation: bool,
+        grid_epc: str,
+        grid_uuid: Union[UUID, str],
+        surface_epc: str,
+        surface_uuid: Union[UUID, str],
+        name: str,
+        title: Optional[str] = None,
+        agitate: bool = False,
+        random_agitation: bool = False,
+        feature_type: str = 'fault',
+        trimmed: bool = False,
+        is_curtain = False,
+        extend_fault_representation: bool = False,
+        flange_inner_ring: bool = False,
+        saucer_parameter: Optional[float] = None,
+        retriangulate: bool = False,
+        related_uuid: Optional[Union[UUID, str]] = None,
+        progress_fn: Optional[Callable] = None,
+        extra_metadata = None,
+        return_properties: Optional[List[str]] = None,
+        raw_bisector: bool = False,
+        use_pack: bool = False,
+        flange_radius: Optional[float] = None,
+        reorient: bool = True,
+        n_threads: int = 20,
+        patchwork: bool = False,
+        grid_patching_property_uuid: Optional[Union[UUID, str]] = None,
+        surface_patching_property_uuid: Optional[Union[UUID, str]] = None) ->  \
+            Tuple[int, bool, str, List[Union[UUID, str]]]:
     """Multiprocessing wrapper function of find_faces_to_represent_surface_regular_optimised.
 
     arguments:
@@ -98,8 +105,17 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
         flange_radius (float, optional): the radial distance to use for outer flange extension points; if None,
            a large value will be calculated from the grid size; units are xy units of grid crs
         reorient (bool, default True):  if True, the points are reoriented to minimise the
-              z range prior to retriangulation (ie. z axis is approximate normal to plane of points), to enhace the triangulation
+           z range prior to retriangulation (ie. z axis is approximate normal to plane of points), to enhace the triangulation
         n_threads (int, default 20): the number of parallel threads to use in numba points in triangles function
+        patchwork (bool, default False): if True and grid bisector is included in return properties, a compostite
+           bisector is generated, based on individual ones for each patch of the surface; the following two
+           arguments must be set if patchwork is True
+        grid_patching_property_uuid (uuid, optional): required if patchwork is True, the uuid of a discrete or
+           categorical cells property on the grid which will be used to determine which patch of the surface is
+           relevant to a cell
+        surface_patching_property_uuid (uuid, optional): required if patchwork is True, the uuid of a discrete or
+           categorical property on the patches of the surface, identifying the value of the grid patching property
+           that each patch relates to
 
     returns:
         Tuple containing:
@@ -109,18 +125,15 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
             - uuid_list (List[str]): list of UUIDs of relevant objects
 
     notes:
-        Use this function as argument to the multiprocessing function; it will create a new model that is saved
-        in a temporary epc file and returns the required values, which are used in the multiprocessing function to
-        recombine all the objects into a single epc file;
-        the saucer_parameter is interpreted in one of two ways: (1) +ve fractoinal values between zero and one
-        are the fractional distance from the centre of the points to its rim at which to sample the surface for
-        extrapolation and thereby modify the recumbent z of flange points; 0 will usually give shallower and
-        smoother saucer; larger values (must be less than one) will lead to stronger and more erratic saucer
-        shape in flange; (2) other values between -90.0 and 90.0 are interpreted as an angle to apply out of
-        the plane of the original points, to give a simple (and less computationally demanding) saucer shape;
-        +ve angles result in the shift being in the direction of the -ve z hemisphere; -ve angles result in
-        the shift being in the +ve z hemisphere; in either case the direction of the shift is perpendicular
-        to the average plane of the original points
+        - use this function as argument to the multiprocessing function; it will create a new model that is saved
+          in a temporary epc file and returns the required values, which are used in the multiprocessing function to
+          recombine all the objects into a single epc file
+        - the saucer_parameter is between -90.0 and 90.0 and is interpreted as an angle to apply out of
+          the plane of the original points, to give a simple saucer shape;
+          +ve angles result in the shift being in the direction of the -ve z hemisphere; -ve angles result in
+          the shift being in the +ve z hemisphere; in either case the direction of the shift is perpendicular
+          to the average plane of the original points
+        - patchwork is not compatible with re-triangulation
     """
     tmp_dir = Path(parent_tmp_dir) / f"{uuid.uuid4()}"
     tmp_dir.mkdir(parents = True, exist_ok = True)
@@ -149,11 +162,18 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
         flange_radius = 5.0 * np.sum(np.array(grid.extent_kji, dtype = float) * np.array(grid.aligned_dxyz()))
     s_model = rq.Model(surface_epc, quiet = True)
     model.copy_uuid_from_other_model(s_model, uuid = str(surface_uuid))
+    if surface_patching_property_uuid is not None:
+        model.copy_uuid_from_other_model(s_model, uuid = surface_patching_property_uuid)
+        uuid_list.append(surface_patching_property_uuid)
     repr_type = model.type_of_part(model.part(uuid = surface_uuid), strip_obj = True)
     assert repr_type in ['TriangulatedSetRepresentation', 'PointSetRepresentation']
+    assert repr_type == 'TriangulatedSetRepresentation' or not patchwork,  \
+        'patchwork only implemented for triangulated set surfaces'
+
     extended = False
     retriangulated = False
     flange_bool = None
+
     if repr_type == 'PointSetRepresentation':
         # trim pointset to grid xyz box
         pset = rqs.PointSet(model, uuid = surface_uuid)
@@ -197,15 +217,22 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
     surf_title = surface.title
     assert surf_title
     surface.change_crs(grid.crs)
+    normal_vector = None
+    if reorient:
+        normal_vector = surface.normal()
+    if patchwork:  # disable trimming as whole patches could be trimmed out, changing the patch indexing from that expected
+        trimmed = True
     if not trimmed and surface.triangle_count() > 100:
         if not surf_title.endswith('trimmed'):
             surf_title += ' trimmed'
         trimmed_surf = rqs.Surface(model, crs_uuid = grid.crs.uuid, title = surf_title)
         # trimmed_surf.set_to_trimmed_surface(surf, xyz_box = xyz_box, xy_polygon = parent_seg.polygon)
         trimmed_surf.set_to_trimmed_surface(surface, xyz_box = grid.xyz_box(local = True))
+        trimmed_surf.extra_metadata = surface.extra_metadata
         surface = trimmed_surf
         trimmed = True
     if (extend_fault_representation and not extended) or (retriangulate and not retriangulated):
+        assert not patchwork, 'extension or re-triangulation are not compatible with patchwork'
         _, p = surface.triangles_and_points()
         pset = rqs.PointSet(model, points_array = p, crs_uuid = grid.crs.uuid, title = surf_title)
         if extend_fault_representation and not surf_title.endswith('extended'):
@@ -213,12 +240,13 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
         surface = rqs.Surface(model, crs_uuid = grid.crs.uuid, title = surf_title)
         flange_bool = surface.set_from_point_set(pset,
                                                  convexity_parameter = 2.0,
-                                                 reorient = True,
+                                                 reorient = reorient,
                                                  extend_with_flange = extend_fault_representation,
                                                  flange_inner_ring = flange_inner_ring,
                                                  saucer_parameter = saucer_parameter,
                                                  flange_radial_distance = flange_radius,
-                                                 make_clockwise = False)
+                                                 make_clockwise = False,
+                                                 normal_vector = normal_vector)
         del pset
         extended = extend_fault_representation
         retriangulated = True
@@ -242,7 +270,23 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
                                            discrete = True,
                                            dtype = np.uint8)
         uuid_list.append(flange_p.uuid)
-    uuid_list.append(surface_uuid)
+
+    if not patchwork:
+        uuid_list.append(surface_uuid)
+
+    patch_indices = None
+    if patchwork:  # generate a patch indices array over grid cells based on supplied patching properties
+        assert grid_patching_property_uuid is not None and surface_patching_property_uuid is not None
+        g_patching_array = rqp.Property(g_model, uuid = grid_patching_property_uuid).array_ref()
+        assert g_patching_array.shape == tuple(grid.extent_kji)
+        s_patches_array = rqp.Property(model, uuid = surface_patching_property_uuid).array_ref()
+        patch_count = surface.number_of_patches()
+        assert s_patches_array.shape == (patch_count,)
+        p_dtype = (np.int8 if s_patches_array.shape[0] < 128 else np.int32)
+        patch_indices = np.full(g_patching_array.shape, -1, dtype = p_dtype)
+        for patch in range(patch_count):
+            gp = s_patches_array[patch]
+            patch_indices[(g_patching_array == gp).astype(bool)] = patch
 
     returns = rqgs.find_faces_to_represent_surface_regular_optimised(grid,
                                                                      surface,
@@ -256,7 +300,8 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
                                                                      return_properties,
                                                                      raw_bisector = raw_bisector,
                                                                      n_batches = n_threads,
-                                                                     packed_bisectors = use_pack)
+                                                                     packed_bisectors = use_pack,
+                                                                     patch_indices = patch_indices)
 
     success = False
 
@@ -286,6 +331,7 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
 
     if success and return_properties is not None and len(return_properties):
         log.debug(f'{name} requested properties: {return_properties}')
+        assert isinstance(returns, tuple)
         properties = returns[1]
         realisation = index if use_index_as_realisation else None
         property_collection = rqp.PropertyCollection(support = gcs)
@@ -346,6 +392,7 @@ def find_faces_to_represent_surface_regular_wrapper(index: int,
                 if grid_pc is None:
                     grid_pc = rqp.PropertyCollection()
                     grid_pc.set_support(support = grid)
+                assert array.ndim == (2 if is_curtain else 3)
                 grid_pc.add_cached_array_to_imported_list(array,
                                                           f"from find_faces function for {surface.title}",
                                                           f'{surface.title} {p_name}',

resqpy/olio/triangulation.py

@@ -25,7 +25,7 @@ import resqpy.olio.vector_utilities as vec
 
 def _dt_scipy(points: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
     """Calculates the Delaunay triangulation for an array of points and the convex hull indices.
-    
+
     arguments:
         points (np.ndarray): coordinates of the points to triangulate; array has shape
             (npoints, ndim)
@@ -48,7 +48,7 @@ def _dt_scipy(points: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
 
 
 def _dt_simple(po, plot_fn = None, progress_fn = None, container_size_factor = None):
-    # returns Delauney triangulation of po and list of hull point indices, using a simple algorithm
+    # returns Delaunay triangulation of po and list of hull point indices, using a simple algorithm
 
     def flip(ei):
         nonlocal fm, e, t, te, p, nt, p_i, ne
@@ -234,7 +234,7 @@ def _dt_simple(po, plot_fn = None, progress_fn = None, container_size_factor = N
 
 
 def dt(p, algorithm = "scipy", plot_fn = None, progress_fn = None, container_size_factor = 100.0, return_hull = False):
-    """Returns the Delauney Triangulation of 2D point set p.
+    """Returns the Delaunay Triangulation of 2D point set p.
 
     arguments:
        p (numpy float array of shape (N, 2): the x,y coordinates of the points
@@ -253,7 +253,7 @@ def dt(p, algorithm = "scipy", plot_fn = None, progress_fn = None, container_siz
 
     returns:
        numpy int array of shape (M, 3) - being the indices into the first axis of p of the 3 points
-          per triangle in the Delauney Triangulation - and if return_hull is True, another int array
+          per triangle in the Delaunay Triangulation - and if return_hull is True, another int array
           of shape (B,) - being indices into p of the clockwise ordered points on the boundary of
           the triangulation
 
@@ -261,7 +261,7 @@ def dt(p, algorithm = "scipy", plot_fn = None, progress_fn = None, container_siz
        the plot_fn, progress_fn and container_size_factor arguments are only used by the 'simple' algorithm;
        if points p are 3D, the projection onto the xy plane is used for the triangulation
     """
-    assert p.ndim == 2 and p.shape[1] >= 2, 'bad points shape for 2D Delauney Triangulation'
+    assert p.ndim == 2 and p.shape[1] >= 2, 'bad points shape for 2D Delaunay Triangulation'
 
     if not algorithm:
         algorithm = 'scipy'
@@ -274,7 +274,7 @@ def dt(p, algorithm = "scipy", plot_fn = None, progress_fn = None, container_siz
                                    progress_fn = progress_fn,
                                    container_size_factor = container_size_factor)
     else:
-        raise Exception(f'unrecognised Delauney Triangulation algorithm name: {algorithm}')
+        raise Exception(f'unrecognised Delaunay Triangulation algorithm name: {algorithm}')
 
     assert tri.ndim == 2 and tri.shape[1] == 3
 
@@ -304,11 +304,11 @@ def ccc(p1, p2, p3):
 
 
 def voronoi(p, t, b, aoi: rql.Polyline):
-    """Returns dual Voronoi diagram for a Delauney triangulation.
+    """Returns dual Voronoi diagram for a Delaunay triangulation.
 
     arguments:
-       p (numpy float array of shape (N, 2)): seed points used in the Delauney triangulation
-       t (numpy int array of shape (M, 3)): the Delauney triangulation of p as returned by dt()
+       p (numpy float array of shape (N, 2)): seed points used in the Delaunay triangulation
+       t (numpy int array of shape (M, 3)): the Delaunay triangulation of p as returned by dt()
        b (numpy int array of shape (B,)): clockwise sorted list of indices into p of the boundary
           points of the triangulation t
        aoi (lines.Polyline): area of interest; a closed clockwise polyline that must strictly contain
@@ -329,7 +329,7 @@ def voronoi(p, t, b, aoi: rql.Polyline):
 
     # this code assumes that the Voronoi polygon for a seed point visits the circumcentres of
     # all the triangles that make use of the point – currently understood to be always the case
-    # for a Delauney triangulation
+    # for a Delaunay triangulation
 
     def __aoi_intervening_nodes(aoi_count, c_count, seg_a, seg_c):
         nodes = []
@@ -582,7 +582,7 @@ def voronoi(p, t, b, aoi: rql.Polyline):
 
     # check for concavities in hull
     if not hull.is_convex():
-        log.warning('Delauney triangulation is not convex; Voronoi diagram construction might fail')
+        log.warning('Delaunay triangulation is not convex; Voronoi diagram construction might fail')
 
     # compute circumcircle centres
     c = np.zeros((t.shape[0], 2))
@@ -750,7 +750,7 @@ def reorient(points, rough = True, max_dip = None, use_linalg = True, sample = 5
     notes:
        the original points array is not modified by this function;
        implicit xy & z units for points are assumed to be the same;
-       the function may typically be called prior to the Delauney triangulation, which uses an xy projection to
+       the function may typically be called prior to the Delaunay triangulation, which uses an xy projection to
        determine the triangulation;
        the numpy linear algebra option seems to be memory intensive, not recommended;
        downsampling will occur (for normal vector determination) when the number of points exceeds double that
@@ -868,9 +868,11 @@ def surrounding_xy_ring(p,
           being an angle to determine a z offset for the ring(s); a +ve angle results in a -ve z shift
 
     returns:
-       numpy float array of shape (N, 3) being xyz points in surrounding ring(s); z is set constant to
-       mean value of z in p (optionally adjussted based on saucer_angle);
-       N is count if inner_ring is False, 3 * count if True
+       (numpy float array, float) pair:
+       - numpy float array of shape (N, 3) being xyz points in surrounding ring(s); z is set constant to
+         mean value of z in p (optionally adjussted based on saucer_angle);
+         N is count if inner_ring is False, 3 * count if True
+       - radius used for ring of additional points
     """
 
     def make_ring(count, centre, radius, saucer_angle):
@@ -898,8 +900,8 @@ def surrounding_xy_ring(p,
         inner_radius = p_radius * 1.1
         assert radius > inner_radius
         in_ring = make_ring(2 * count, centre, inner_radius, saucer_angle)
-        return np.concatenate((in_ring, ring), axis = 0)
-    return ring
+        return np.concatenate((in_ring, ring), axis = 0), radius
+    return ring, radius
 
 
 def edges(t):

resqpy/olio/volume.py

@@ -77,26 +77,6 @@ def tetra_cell_volume(cp, centre = None, off_hand = False):
     return v / 6.0
 
 
-def tetra_volumes_slow(cp, centres = None, off_hand = False):
-    """Returns volume array for all hexahedral cells assuming bilinear faces, using loop over cells."""
-
-    # NB: deprecated, superceded by much faster function below
-    # todo: handle NaNs
-    # Pagoda style corner point data
-    assert cp.ndim == 7
-
-    flat = cp.reshape(-1, 2, 2, 2, 3)
-    cells = flat.shape[0]
-    if centres is None:
-        centres = np.mean(flat, axis = (1, 2, 3))
-    else:
-        centres = centres.reshape((-1, 3))
-    volumes = np.zeros(cells)
-    for cell in range(cells):
-        volumes[cell] = tetra_cell_volume(flat[cell], centre = centres[cell], off_hand = off_hand)
-    return volumes.reshape(cp.shape[0:3])
-
-
 def tetra_volumes(cp, centres = None, off_hand = False):
     """Returns volume array for all hexahedral cells assuming bilinear faces, using numpy operations.
 

resqpy/property/__init__.py

@@ -8,7 +8,8 @@ __all__ = [
     'reformat_column_edges_from_resqml_format', 'same_property_kind', 'selective_version_of_collection',
     'supported_local_property_kind_list', 'supported_property_kind_list', 'supported_facet_type_list',
     'expected_facet_type_dict', 'create_transmisibility_multiplier_property_kind',
-    'property_kind_and_facet_from_keyword', 'guess_uom', 'property_parts', 'property_part', 'make_aps_key'
+    'property_kind_and_facet_from_keyword', 'guess_uom', 'property_parts', 'property_part', 'make_aps_key',
+    'establish_zone_property_kind'
 ]
 
 from .property_common import property_collection_for_keyword,  \
@@ -27,7 +28,7 @@ from .property_common import property_collection_for_keyword,  \
     guess_uom,  \
     property_parts,  \
     property_part
-from .property_kind import PropertyKind, create_transmisibility_multiplier_property_kind
+from .property_kind import PropertyKind, create_transmisibility_multiplier_property_kind, establish_zone_property_kind
 from .string_lookup import StringLookup
 from .property_collection import PropertyCollection
 from .attribute_property_set import AttributePropertySet, ApsProperty, make_aps_key

resqpy/property/_collection_get_attributes.py

@@ -509,6 +509,8 @@ def _supporting_shape_surface(support, indexable_element):
         shape_list = [support.triangle_count()]
     elif indexable_element == 'nodes':
         shape_list = [support.node_count()]
+    elif indexable_element == 'patches':
+        shape_list = [len(support.patch_list)]
     return shape_list
 
 

resqpy/rq_import/_grid_from_cp.py

@@ -511,8 +511,8 @@ class _GridFromCp:
                 assert len(where_defined) == 3 and len(where_defined[0]) > 0, 'no extant cell geometries'
                 sample_kji0 = (where_defined[0][0], where_defined[1][0], where_defined[2][0])
             sample_cp = self.__cp_array[sample_kji0]
-            self.__cell_ijk_lefthanded = (vec.clockwise(sample_cp[0, 0, 0], sample_cp[0, 1, 0], sample_cp[0, 0, 1]) >=
-                                          0.0)
+            self.__cell_ijk_lefthanded =  \
+                (vec.clockwise(sample_cp[0, 0, 0], sample_cp[0, 1, 0], sample_cp[0, 0, 1]) >= 0.0)
             if not self.grid.k_direction_is_down:
                 self.__cell_ijk_lefthanded = not self.__cell_ijk_lefthanded
             if self.__crs.is_right_handed_xyz():