resqpy 5.1.8__tar.gz → 5.1.9__tar.gz

{resqpy-5.1.8 → resqpy-5.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: resqpy
-Version: 5.1.8
+Version: 5.1.9
 Summary: Python API for working with RESQML models
 License: MIT
 Keywords: RESQML

{resqpy-5.1.8 → resqpy-5.1.9}/pyproject.toml

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

{resqpy-5.1.8 → resqpy-5.1.9}/resqpy/__init__.py

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

{resqpy-5.1.8 → resqpy-5.1.9}/resqpy/surface/_tri_mesh.py

@@ -9,6 +9,7 @@ import numpy as np
 
 import resqpy.crs as rqc
 import resqpy.surface as rqs
+import resqpy.weights_and_measures as wam
 import resqpy.olio.vector_utilities as vec
 import resqpy.olio.uuid as bu
 
@@ -568,6 +569,27 @@ class TriMesh(rqs.Mesh):
 
         return p
 
+    def area(self, required_uom = None):
+        """Returns approximate area of tri mesh based on proportion of non-NaN z values.
+
+        arguments:
+            - required_uom (str, optional): RESQML area unit of measure string for result
+
+        returns:
+            - float being the approximate area of the tri mesh in its xy projection
+
+        note:
+            - default uom is crs xy_units squared
+        """
+        a = 1.0 - (float(np.count_nonzero(np.isnan(self.full_array_ref()[..., 2]))) / float(self.nj * self.ni))
+        a *= float((self.nj - 1) * (self.ni - 1)) * self.t_side * self.t_side * root_3_by_2
+        if required_uom is not None:
+            crs = rqc.Crs(self.model, uuid = self.crs_uuid)
+            if required_uom != crs.xy_units + '2':
+                uom = ('ft' if crs.xy_units.startswith('ft') else crs.xy_units) + '2'
+                a = wam.convert(a, uom, required_uom)
+        return a
+
     def is_compatible_with(self, other_tri_mesh):
         """Returns True if this tri mesh has the same xy points as the other."""