resqpy 4.18.5__tar.gz → 4.18.7__tar.gz

{resqpy-4.18.5 → resqpy-4.18.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: resqpy
-Version: 4.18.5
+Version: 4.18.7
 Summary: Python API for working with RESQML models
 Home-page: https://github.com/bp/resqpy
 License: MIT

{resqpy-4.18.5 → resqpy-4.18.7}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "resqpy"
-version = "4.18.5" # Set at build time
+version = "4.18.7" # Set at build time
 description = "Python API for working with RESQML models"
 authors = ["BP"]
 license = "MIT"

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/__init__.py

@@ -28,6 +28,6 @@
 
 import logging
 
-__version__ = "4.18.5"  # Set at build time
+__version__ = "4.18.7"  # Set at build time
 log = logging.getLogger(__name__)
 log.info(f"Imported resqpy version {__version__}")

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/grid/_extract_functions.py

@@ -501,7 +501,7 @@ def extract_inactive_mask(grid, check_pinchout = False):
     geom_defined = grr_dg.cell_geometry_is_defined_ref(grid)
     if grid.inactive is None:
         if geom_defined is None or geom_defined is True:
-            grid.inactive = np.zeros(tuple(grid.extent_kji))  # ie. all active
+            grid.inactive = np.zeros(tuple(grid.extent_kji), dtype = bool)  # ie. all active
         else:
             grid.inactive = np.logical_not(grr_dg.cell_geometry_is_defined_ref(grid))
     if check_pinchout:
@@ -524,6 +524,7 @@ def extract_inactive_mask(grid, check_pinchout = False):
             active_gpc = rprop.selective_version_of_collection(active_gpc,
                                                                time_index = grid.time_index,
                                                                time_series_uuid = grid.time_series_uuid)
+            active_parts = active_gpc.parts()
         else:
             active_parts = []
             for part in active_gpc.parts():

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/grid/_grid.py

@@ -15,6 +15,7 @@ import resqpy.grid as grr
 import resqpy.grid_surface as rqgs
 import resqpy.fault as rqf
 import resqpy.property as rqp
+import resqpy.lines as rql
 import resqpy.olio.grid_functions as gf
 import resqpy.olio.uuid as bu
 import resqpy.olio.write_hdf5 as rwh5
@@ -75,7 +76,8 @@ class Grid(BaseResqpy):
                  geometry_required = True,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Create a Grid object and optionally populate from xml tree.
 
         arguments:
@@ -91,6 +93,8 @@ class Grid(BaseResqpy):
               ignored if loading from xml
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if loading from xml
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created Grid object
@@ -147,6 +151,8 @@ class Grid(BaseResqpy):
             self.title = 'ROOT'
 
         if uuid is not None:
+            if load_inactive:
+                self.extract_inactive_mask()
             if geometry_required:
                 assert self.geometry_root is not None, 'grid geometry not present in xml'
             if find_properties:
@@ -185,7 +191,6 @@ class Grid(BaseResqpy):
         self.extract_parent()
         self.extract_children()
         # self.create_column_pillar_mapping()  # mapping now created on demand in other methods
-        self.extract_inactive_mask()
         self.extract_stratigraphy()
         self.get_represented_interpretation()
 
@@ -1493,6 +1498,62 @@ class Grid(BaseResqpy):
         """
         return z_corner_point_depths(self, order = order)
 
+    def frontier(self, set_z_zero = True, title = None, add_as_part = True):
+        """Returns a frontier polygon (closed polyline) based on midpoints of edge coordinate lines, with z set to zero.
+        
+        arguments:
+            - set_z_zero (bool, default True): if True, the z values of the returned polyline are all set to zero; if False,
+              they are left at the midpoint z values from the edge coordinate lines
+            - title (str, optional): the citation title for the polyline; if None, one is generated using the grid title
+            - add_as_part (bool default True): if True, the xml is created for the polyline and it is added as a part to
+              the model; if False, the create_xml() method is not called fot the polyline
+              
+        returns:
+            - closed Polyline representing the frontier of the grid in plan view
+        """
+        coords = self.coordinate_line_end_points()
+        nj = self.nj
+        ni = self.ni
+        frontier = np.zeros((2 * (nj + ni), 3), dtype = float)
+        f_i = 0
+        for i in range(self.ni):
+            c = np.nanmean(coords[0, i], axis = 0)
+            if np.any(np.isnan(c)):
+                continue
+            frontier[f_i] = c
+            f_i += 1
+        for j in range(self.nj):
+            c = np.nanmean(coords[j, ni], axis = 0)
+            if np.any(np.isnan(c)):
+                continue
+            frontier[f_i] = c
+            f_i += 1
+        for i in range(self.ni, 0, -1):
+            c = np.nanmean(coords[nj, i], axis = 0)
+            if np.any(np.isnan(c)):
+                continue
+            frontier[f_i] = c
+            f_i += 1
+        for j in range(self.nj, 0, -1):
+            c = np.nanmean(coords[j, 0], axis = 0)
+            if np.any(np.isnan(c)):
+                continue
+            frontier[f_i] = c
+            f_i += 1
+        assert 4 <= f_i <= 2 * (nj + ni), 'failed to define frontier polygon (NaNs in grid geometry?)'
+        if set_z_zero:
+            frontier[:, 2] = 0.0
+        if not title:
+            title = f'frontier of {self.title}'
+        pl = rql.Polyline(self.model,
+                          set_coord = frontier[:f_i],
+                          set_crs = self.crs_uuid,
+                          is_closed = True,
+                          title = title)
+        if add_as_part:
+            pl.create_xml()
+        return pl
+
     def corner_points(self, cell_kji0 = None, points_root = None, cache_resqml_array = True, cache_cp_array = False):
         """Returns a numpy array of corner points for a single cell or the whole grid.
 

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/grid/_grid_types.py

@@ -51,13 +51,15 @@ def is_regular_grid(grid_root):
     return grid_flavour(grid_root) == 'IjkBlockGrid'
 
 
-def any_grid(parent_model, uuid = None, find_properties = True):
+def any_grid(parent_model, uuid = None, find_properties = True, load_inactive = True):
     """Returns a Grid or RegularGrid or UnstructuredGrid object depending on the extra metadata in the xml.
 
     arguments:
         parent_model (Model): the model within which the grid exists
         uuid (UUID): the uuid of the grid object to be instantiated
         find_properties (bool, default True): passed onward to the instantiation method
+        load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+            populated if a property of kind 'active' is found for the grid
 
     note:
         full list of resqpy grid class objects which could be returned:
@@ -70,17 +72,30 @@ def any_grid(parent_model, uuid = None, find_properties = True):
     if flavour is None:
         return None
     if flavour == 'IjkGrid':
-        return grr.Grid(parent_model, uuid = uuid, find_properties = find_properties)
+        return grr.Grid(parent_model, uuid = uuid, find_properties = find_properties, load_inactive = load_inactive)
     if flavour == 'IjkBlockGrid':
-        return grr.RegularGrid(parent_model, extent_kji = None, uuid = uuid, find_properties = find_properties)
+        return grr.RegularGrid(parent_model,
+                               extent_kji = None,
+                               uuid = uuid,
+                               find_properties = find_properties,
+                               load_inactive = load_inactive)
     if flavour == 'UnstructuredGrid':
-        return rug.UnstructuredGrid(parent_model, uuid = uuid, find_properties = find_properties)
+        return rug.UnstructuredGrid(parent_model,
+                                    uuid = uuid,
+                                    find_properties = find_properties,
+                                    load_inactive = load_inactive)
     if flavour == 'TetraGrid':
-        return rug.TetraGrid(parent_model, uuid = uuid, find_properties = find_properties)
+        return rug.TetraGrid(parent_model,
+                             uuid = uuid,
+                             find_properties = find_properties,
+                             load_inactive = load_inactive)
     if flavour == 'HexaGrid':
-        return rug.HexaGrid(parent_model, uuid = uuid, find_properties = find_properties)
+        return rug.HexaGrid(parent_model, uuid = uuid, find_properties = find_properties, load_inactive = load_inactive)
     if flavour == 'PyramidGrid':
         return rug.PyramidGrid(parent_model, uuid = uuid, find_properties = find_properties)
     if flavour == 'PrismGrid':
-        return rug.PrismGrid(parent_model, uuid = uuid, find_properties = find_properties)
+        return rug.PrismGrid(parent_model,
+                             uuid = uuid,
+                             find_properties = find_properties,
+                             load_inactive = load_inactive)
     return None

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/grid/_regular_grid.py

@@ -46,7 +46,8 @@ class RegularGrid(grr_g.Grid):
                  find_properties = True,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a regular grid object based on dxyz, or derived from a Mesh object.
 
         arguments:
@@ -82,6 +83,8 @@ class RegularGrid(grr_g.Grid):
               ignored if loading from xml
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if loading from xml
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created RegularGrid object with inheritance from the Grid class
@@ -184,7 +187,8 @@ class RegularGrid(grr_g.Grid):
                              geometry_required = False,
                              title = title,
                              originator = originator,
-                             extra_metadata = extra_metadata)
+                             extra_metadata = extra_metadata,
+                             load_inactive = load_inactive)
 
         self.geometry_defined_for_all_cells_cached = True
         self.geometry_defined_for_all_pillars_cached = True

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/unstructured/_hexa_grid.py

@@ -23,7 +23,8 @@ class HexaGrid(rug.UnstructuredGrid):
                  cache_geometry = False,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a new resqpy HexaGrid object (RESQML UnstructuredGrid with cell shape hexahedral)
 
         arguments:
@@ -39,6 +40,8 @@ class HexaGrid(rug.UnstructuredGrid):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created HexaGrid object
@@ -52,7 +55,8 @@ class HexaGrid(rug.UnstructuredGrid):
                          cell_shape = 'hexahedral',
                          title = title,
                          originator = originator,
-                         extra_metadata = extra_metadata)
+                         extra_metadata = extra_metadata,
+                         load_inactive = load_inactive)
 
         if self.root is not None:
             assert grr.grid_flavour(self.root) == 'HexaGrid'

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/unstructured/_prism_grid.py

@@ -34,7 +34,8 @@ class PrismGrid(rug.UnstructuredGrid):
                  cache_geometry = False,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a new resqpy PrismGrid object (RESQML UnstructuredGrid with cell shape trisngular prism)
 
         arguments:
@@ -50,6 +51,8 @@ class PrismGrid(rug.UnstructuredGrid):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created PrismGrid object
@@ -63,7 +66,8 @@ class PrismGrid(rug.UnstructuredGrid):
                          cell_shape = 'prism',
                          title = title,
                          originator = originator,
-                         extra_metadata = extra_metadata)
+                         extra_metadata = extra_metadata,
+                         load_inactive = load_inactive)
 
         if self.root is not None:
             assert grr.grid_flavour(self.root) in ['PrismGrid', 'VerticalPrismGrid']
@@ -110,7 +114,8 @@ class VerticalPrismGrid(PrismGrid):
                  cache_geometry = False,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a new resqpy VerticalPrismGrid object.
 
         arguments:
@@ -126,6 +131,8 @@ class VerticalPrismGrid(PrismGrid):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created VerticalPrismGrid object
@@ -139,7 +146,8 @@ class VerticalPrismGrid(PrismGrid):
                          cache_geometry = cache_geometry,
                          title = title,
                          originator = originator,
-                         extra_metadata = extra_metadata)
+                         extra_metadata = extra_metadata,
+                         load_inactive = load_inactive)
 
         if self.root is not None:
             assert grr.grid_flavour(self.root) in ['VerticalPrismGrid', 'PrismGrid']

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/unstructured/_pyramid_grid.py

@@ -22,7 +22,8 @@ class PyramidGrid(rug.UnstructuredGrid):
                  cache_geometry = False,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a new resqpy PyramidGrid object (RESQML UnstructuredGrid with cell shape pyramidal)
 
         arguments:
@@ -38,6 +39,8 @@ class PyramidGrid(rug.UnstructuredGrid):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created PyramidGrid object
@@ -51,7 +54,8 @@ class PyramidGrid(rug.UnstructuredGrid):
                          cell_shape = 'pyramidal',
                          title = title,
                          originator = originator,
-                         extra_metadata = extra_metadata)
+                         extra_metadata = extra_metadata,
+                         load_inactive = load_inactive)
 
         if self.root is not None:
             assert grr.grid_flavour(self.root) == 'PyramidGrid'

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/unstructured/_tetra_grid.py

@@ -24,7 +24,8 @@ class TetraGrid(rug.UnstructuredGrid):
                  cache_geometry = False,
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Creates a new resqpy TetraGrid object (RESQML UnstructuredGrid with cell shape tetrahedral)
 
         arguments:
@@ -40,6 +41,8 @@ class TetraGrid(rug.UnstructuredGrid):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created TetraGrid object
@@ -53,7 +56,8 @@ class TetraGrid(rug.UnstructuredGrid):
                          cell_shape = 'tetrahedral',
                          title = title,
                          originator = originator,
-                         extra_metadata = extra_metadata)
+                         extra_metadata = extra_metadata,
+                         load_inactive = load_inactive)
 
         if self.root is not None:
             assert grr.grid_flavour(self.root) == 'TetraGrid'

{resqpy-4.18.5 → resqpy-4.18.7}/resqpy/unstructured/_unstructured_grid.py

@@ -35,7 +35,8 @@ class UnstructuredGrid(BaseResqpy):
                  cell_shape = 'polyhedral',
                  title = None,
                  originator = None,
-                 extra_metadata = {}):
+                 extra_metadata = {},
+                 load_inactive = True):
         """Create an Unstructured Grid object and optionally populate from xml tree.
 
         arguments:
@@ -55,6 +56,8 @@ class UnstructuredGrid(BaseResqpy):
               ignored if uuid is present
            extra_metadata (dict, optional): dictionary of extra metadata items to add to the grid;
               ignored if uuid is present
+           load_inactive (bool, default True): if True and uuid is provided, the inactive attribubte is
+              populated if a property of kind 'active' is found for the grid
 
         returns:
            a newly created Unstructured Grid object
@@ -103,6 +106,8 @@ class UnstructuredGrid(BaseResqpy):
             self.title = 'ROOT'
 
         if uuid is not None:
+            if load_inactive:
+                self.extract_inactive_mask()
             if geometry_required:
                 assert self.geometry_root is not None, 'unstructured grid geometry not present in xml'
             if cache_geometry and self.geometry_root is not None:
@@ -127,7 +132,6 @@ class UnstructuredGrid(BaseResqpy):
             assert self.node_count > 3
             self.face_count = rqet.find_tag_int(self.geometry_root, 'FaceCount')
             assert self.face_count > 3
-        self.extract_inactive_mask()
         # note: geometry arrays not loaded until demanded; see cache_all_geometry_arrays()
 
     def set_cell_count(self, n: int):