resqpy 4.18.6__py3-none-any.whl → 4.18.8__py3-none-any.whl

resqpy/__init__.py

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

resqpy/grid/_grid.py

@@ -1498,7 +1498,7 @@ class Grid(BaseResqpy):
         """
         return z_corner_point_depths(self, order = order)
 
-    def frontier(self, set_z_zero = True, title = None, add_as_part = True):
+    def frontier(self, set_z_zero = True, title = None, add_as_part = True, mode = 'mean'):
         """Returns a frontier polygon (closed polyline) based on midpoints of edge coordinate lines, with z set to zero.
         
         arguments:
@@ -1507,35 +1507,59 @@ class Grid(BaseResqpy):
             - 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
-              
+            - mode (str, default 'mean'): one of 'mean', 'top', 'base', 'inner', 'outer' determining how a non-vertical
+              edge coordinate line is converted to a point to include in the frontier
+
         returns:
             - closed Polyline representing the frontier of the grid in plan view
         """
+
+        def get_point(clep, mode, centrum):
+            if mode == 'mean':
+                return np.nanmean(clep, axis = 0)
+            if mode == 'top':
+                return clep[0]
+            if mode == 'base':
+                return clep[-1]
+            assert mode in ['inner', 'outer'], f'unrecognised frontier mode: {mode}'
+            vp = clep - np.expand_dims(centrum, axis = 0)
+            dp = np.sum(vp * vp, axis = -1)
+            if (dp[0] < dp[1] and mode == 'inner') or (dp[0] > dp[1] and mode == 'outer'):
+                return clep[0]
+            return clep[-1]
+
+        assert mode in ['mean', 'top', 'base', 'inner', 'outer']
         coords = self.coordinate_line_end_points()
+        centrum = None
+        if mode in ['inner', 'outer']:
+            centrum = np.nanmean(np.concatenate((coords[0, 0], coords[0, -1], coords[-1, 0], coords[-1, -1]), axis = 0),
+                                 axis = 0)
+            assert not np.any(
+                np.isnan(centrum)), f'trying to make frontier polygon in mode {mode} when corners of grid not defined'
         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)
+            c = get_point(coords[0, i], mode, centrum)
             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)
+            c = get_point(coords[j, ni], mode, centrum)
             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)
+            c = get_point(coords[nj, i], mode, centrum)
             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)
+            c = get_point(coords[j, 0], mode, centrum)
             if np.any(np.isnan(c)):
                 continue
             frontier[f_i] = c

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/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/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/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/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/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/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):

{resqpy-4.18.6.dist-info → resqpy-4.18.8.dist-info}/METADATA

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

{resqpy-4.18.6.dist-info → resqpy-4.18.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-resqpy/__init__.py,sha256=1V-lAV0_8CC6-e7jwBM6HpCHAUHlHA7wBY9wofSJyjs,556
+resqpy/__init__.py,sha256=d1nzdII66YXpUle9nxQk72e6mUpfRERvOp5Sgif4LLE,556
 resqpy/crs.py,sha256=R7DfcTP5xGv5pu9Y8RHA2WVM9DjBCSVMoHcz4RmQ7Yw,27646
 resqpy/derived_model/__init__.py,sha256=NFvMSOKI3cxmH7lAbddV43JjoUj-r2G7ExEfOqinD1I,1982
 resqpy/derived_model/_add_edges_per_column_property_array.py,sha256=cpW3gwp6MSYIrtvFmCjoJXcyUsgGuCDbgmwlJCJebUs,6410
@@ -34,14 +34,14 @@ resqpy/grid/_defined_geometry.py,sha256=QYQ3wLbPrlPobgUi9R1izTD4JD9qMGf5eyqbM68H
 resqpy/grid/_extract_functions.py,sha256=pOVC2vv4dJ9G7e6p3uh2mz4QPb6W7_pKiaq8HAWeyzg,28263
 resqpy/grid/_face_functions.py,sha256=0I7O6DDz7nJWczi_G2bE3L2XUr4acxREwKygXWEp6F4,16516
 resqpy/grid/_faults.py,sha256=OmukVoLpdrndqDxwE6Rj7Ul5tj3FUQVPhE0raH2FHpg,12236
-resqpy/grid/_grid.py,sha256=vjLZJoHfvlCi8vFY09_1xQEBMRnCR6AbFFs88leKrxA,134892
-resqpy/grid/_grid_types.py,sha256=vN_mMAEvcQ7HGxDQ8VMJilGXADPfJ_2rgebOJ__2P8E,3572
+resqpy/grid/_grid.py,sha256=d4hSTmtdfmuEiQIjOhSAAlJZNlYBf0Fui4PPGJE5I4U,136144
+resqpy/grid/_grid_types.py,sha256=YAmRrrm-J2HKuuwCRCAkE3ppcQLiwc4EEc6dc-sy9Fc,4362
 resqpy/grid/_intervals_info.py,sha256=ODjDz22n8U9pSpO0Muj8mJr2hYWauFDzgcVQ0RM3csQ,338
 resqpy/grid/_moved_functions.py,sha256=XboxA0pE55j-P_x5g051WheVamxkAatQGbU5aq2GkaE,604
 resqpy/grid/_pillars.py,sha256=WXvLjORlNHnm0KI3qgoRtCyXdcT9vQBkJDQWL2wtJwg,7243
 resqpy/grid/_pixel_maps.py,sha256=Aqn9dpDKjX_v8BnWMdN__ulqjeuXfE6W2_Z7EDaUqdE,5386
 resqpy/grid/_points_functions.py,sha256=72dCLWHrOUM9xSwSaEuxPUA__b6WAdk5rbeWatILdaI,70585
-resqpy/grid/_regular_grid.py,sha256=6lXWSsgzVAB4QwGOwhB7Gb9_kiU2rNM55xWIf9qT3GI,45758
+resqpy/grid/_regular_grid.py,sha256=5TzyD82S3K0H2zfBXHcGpOODmwc4X28WAUqgZ2kHCLc,46038
 resqpy/grid/_transmissibility.py,sha256=cLtuVaLgBQqRXa-_YQ5mjR_QC842Jxn2d-Hl6171yOY,22575
 resqpy/grid/_write_hdf5_from_caches.py,sha256=s3gcoilsFCCSw_wjnTjWe1xMHEWr_cessoGVgzqiqVI,9707
 resqpy/grid/_write_nexus_corp.py,sha256=yEVfiObsedEAXX6UG6ZTf56kZnQVkd3lLqE2NpL-KBM,6147
@@ -175,11 +175,11 @@ resqpy/time_series/_geologic_time_series.py,sha256=-4oMxE0R_ZEqyxb9qckawiHS0SJ-r
 resqpy/time_series/_time_duration.py,sha256=bzRf0fynlB68KUYKa0Ih7qwd4ZJnRjl_Y6AxgX7LAsM,2759
 resqpy/time_series/_time_series.py,sha256=ceCuFbmYmppx0jBitdyjtSKkcLxjZ-qyhFN_HQX-3CQ,10818
 resqpy/unstructured/__init__.py,sha256=8te-ghWhkDGe0QaLDClvVEkSMtnDtX46K1QODmJU8Xw,603
-resqpy/unstructured/_hexa_grid.py,sha256=bRzx0PHUtOziEeVk7nZv5aQlogYnqvtbrVMTXsSVcQU,15328
-resqpy/unstructured/_prism_grid.py,sha256=rejFlW6yukHicGeBc5gNZQom2q7gwuB2zEK1QEwEXw0,35856
-resqpy/unstructured/_pyramid_grid.py,sha256=qDn7FlhLfDuqJYS88tomwuv5CH7RJd7avl-qK7CUy_4,7862
-resqpy/unstructured/_tetra_grid.py,sha256=IkRRaxulhH42fE2EysLI9gfUf19YoO3nFA_Uq6CrxmI,12453
-resqpy/unstructured/_unstructured_grid.py,sha256=OTYOSGrKoE51KpRhn4818tdvmZ-q9nmahk_7wC56mvc,51550
+resqpy/unstructured/_hexa_grid.py,sha256=M22p_5nysAgF8zlqr3WPjwB5hYD6BzVu7XE99yG_hvs,15604
+resqpy/unstructured/_prism_grid.py,sha256=pTckhCQZVbqzJ7eDU9KOauujer0F-9XOHEcCrqy9eMQ,36408
+resqpy/unstructured/_pyramid_grid.py,sha256=dmukk_jlKktjfMEyfCMTpgG3hz3mZFo0O84vSWHxN-M,8138
+resqpy/unstructured/_tetra_grid.py,sha256=awF9JKI3ws2VXKa_xPZkn8AXLdIsCWrM3HL7CeO6u_U,12729
+resqpy/unstructured/_unstructured_grid.py,sha256=7DSsywdeTAkhM2Vl4_Yk6aMbb20sgEy5PUmqM5sSyVE,51808
 resqpy/weights_and_measures/__init__.py,sha256=Kp1pPZFH4rS5_PkCERZBEzGoat6n_dSS0y_KLhuIVBM,1135
 resqpy/weights_and_measures/nexus_units.py,sha256=pHqcFbe-8nyqozFgN5Ce-W-UvEnXQ6yiaX3dP1ONtAQ,5434
 resqpy/weights_and_measures/weights_and_measures.py,sha256=1WnrmhtcyCgY2crClNddmfwtf33JdVZy9wNhqPQIvuc,16210
@@ -194,7 +194,7 @@ resqpy/well/_wellbore_marker_frame.py,sha256=xvYH2_2Ie3a18LReFymbUrZboOx7Rhv5DOD
 resqpy/well/blocked_well_frame.py,sha256=Rx8jwkCjchseDZaTttPkA1-f6l7W6vRGrxWtDHlEPx8,22560
 resqpy/well/well_object_funcs.py,sha256=tWufc8wahihzMEO-Ou1dncIttrf4bNo1qmLgh3I2pOM,24717
 resqpy/well/well_utils.py,sha256=zwpYjT85nXAwWBhYB1Pygu2SgouZ-44k6hEOnpoMfBI,5969
-resqpy-4.18.6.dist-info/LICENSE,sha256=2duHPIkKQyESMdQ4hKjL8CYEsYRHXaYxt0YQkzsUYE4,1059
-resqpy-4.18.6.dist-info/METADATA,sha256=DgyxAGDisPPuPmbLYeAtAp-SvmsDo2J0nTyk3gzVwX8,4028
-resqpy-4.18.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-resqpy-4.18.6.dist-info/RECORD,,
+resqpy-4.18.8.dist-info/LICENSE,sha256=2duHPIkKQyESMdQ4hKjL8CYEsYRHXaYxt0YQkzsUYE4,1059
+resqpy-4.18.8.dist-info/METADATA,sha256=uILBwqblu0BxmkJmbnNMugLsQLb11xcPAlkBj4BI1ec,4028
+resqpy-4.18.8.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+resqpy-4.18.8.dist-info/RECORD,,