ResSimpy 2.6.0__tar.gz → 2.6.2__tar.gz

{ressimpy-2.6.0 → ressimpy-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ResSimpy
-Version: 2.6.0
+Version: 2.6.2
 Summary: A Python library for working with Reservoir Simulator Models.
 License: Apache-2.0
 License-File: LICENSE.MD
@@ -22,7 +22,7 @@ Classifier: Topic :: System :: Filesystems
 Requires-Dist: numpy (>=2.2,<2.3) ; python_version < "3.11"
 Requires-Dist: numpy (>=2.3,<2.6) ; python_version >= "3.11"
 Requires-Dist: pandas (>=2.3,<3) ; python_version < "3.11"
-Requires-Dist: pandas (>=3.0,<3.0.4) ; python_version >= "3.11"
+Requires-Dist: pandas (>=2.3,<3.0.4) ; python_version >= "3.11"
 Requires-Dist: typing-extensions (>=4.15,<5.0)
 Description-Content-Type: text/markdown
 

{ressimpy-2.6.0 → ressimpy-2.6.2}/ResSimpy/DataModelBaseClasses/Grid.py

@@ -38,6 +38,7 @@ class Grid(ABC):
     _lgrs: LGRs
     _overs: Sequence[Over]
     _tolpv: Optional[float]
+    _tolpv_grid_name: Optional[str]
 
     def __init__(self, assume_loaded: bool = False) -> None:
         """Initialises the Grid class."""
@@ -63,6 +64,7 @@ class Grid(ABC):
 
         # TOLPV
         self._tolpv: Optional[float] = None
+        self._tolpv_grid_name: Optional[str] = None
 
     @property
     def range_x(self) -> int | None:
@@ -179,6 +181,12 @@ class Grid(ABC):
         self.load_grid_properties_if_not_loaded()
         return self._tolpv
 
+    @property
+    def tolpv_grid_name(self) -> Optional[str]:
+        """Returns the grid name (or ALL) that TOLPV was applied to, when provided."""
+        self.load_grid_properties_if_not_loaded()
+        return self._tolpv_grid_name
+
     @classmethod
     @abstractmethod
     def load_structured_grid_file(cls: type[Grid], structured_grid_file: File,

{ressimpy-2.6.0 → ressimpy-2.6.2}/ResSimpy/Nexus/DataModels/StructuredGrid/NexusGrid.py

@@ -603,17 +603,44 @@ class NexusGrid(Grid):
                 self._range_y = int(second_value)
                 self._range_z = int(third_value)
 
-            # Load TOLPV scalar value
+            # Load TOLPV scalar value, optionally with a grid selector (e.g. TOLPV LGR1 0 or TOLPV ALL 0).
             if nfo.check_token('TOLPV', line):
-                tolpv_value = fo.get_token_value('TOLPV', line, [line])
-                if tolpv_value is not None:
-                    self._tolpv = float(tolpv_value)
+                tolpv_values = fo.split_line(line, upper=False)
+                if len(tolpv_values) >= 2 and tolpv_values[0].upper() == 'TOLPV':
+                    selector: str | None = None
+                    selector_or_value = tolpv_values[1]
+
+                    value_string = selector_or_value
+                    try:
+                        float(selector_or_value)
+                    except ValueError:
+                        selector = selector_or_value.upper()
+                        next_value = fo.get_nth_value(file_as_list[idx:], value_number=3, ignore_values=[])
+                        if next_value is None:
+                            continue
+                        value_string = next_value
+
+                    try:
+                        self._tolpv = float(value_string)
+                    except ValueError:
+                        continue
+
+                    self._tolpv_grid_name = selector
+
+                    if selector is not None:
+                        warnings.warn(
+                            f'TOLPV in Nexus was applied to grid {selector}.',
+                            UserWarning,
+                        )
+                else:
+                    warnings.warn(f'Unable to parse TOLPV line: {line.strip()}', UserWarning)
 
             # Load TOLPV from CORTOL keyword third value when present.
             if nfo.check_token('CORTOL', line):
                 cortol_values = line.split()
                 if len(cortol_values) >= 4:
                     self._tolpv = float(cortol_values[3])
+                    self._tolpv_grid_name = None
 
         # load the overs:
         if fo.value_in_file('OVER', file_as_list):

{ressimpy-2.6.0 → ressimpy-2.6.2}/ResSimpy/Nexus/runcontrol_operations.py

@@ -38,6 +38,18 @@ class SimControls:
         self.__number_of_processors: None | int = None
         self.__grid_to_proc: None | GridToProc = None
         self.__solver_parameters: NexusSolverParameters = NexusSolverParameters(model, model.assume_loaded)
+        self.__drsdt_limit: float | None = None
+        self.__drsdt_two_phases: bool | None = None
+
+    @property
+    def drsdt_limit(self) -> float | None:
+        """Returns the DRSDT limit loaded from the run control file."""
+        return self.__drsdt_limit
+
+    @property
+    def drsdt_two_phases(self) -> bool | None:
+        """Returns whether DRSDT applies only to blocks with oil and gas phases."""
+        return self.__drsdt_two_phases
 
     @property
     def date_format_string(self) -> str:
@@ -150,6 +162,8 @@ class SimControls:
             start_date_as_datetime = datetime.strptime(self.__model.start_date, date_format)
             date_as_datetime = start_date_as_datetime + timedelta(days=converted_date)
         else:
+            if not isinstance(converted_date, str):
+                raise ValueError("convert_date_to_number: Incorrect type for 'date' parameter")
             start_date_format = self.date_format_string
             if len(self.__model.start_date) == DATE_WITH_TIME_LENGTH:
                 start_date_format += "(%H:%M:%S)"
@@ -278,6 +292,7 @@ class SimControls:
     def load_run_control_file(self) -> None:
         """Loads the run control information into the class instance.
 
+            Loads DRSDT LIMIT and optional 2PHASE settings from the run-control file.
             If the write_times attribute is True then it expands out any INCLUDE files with the times found within
         Raises:
             ValueError: if the run_control_file attribute is None.
@@ -290,6 +305,28 @@ class SimControls:
         if (run_control_file_content is None) or (self.__model.model_files.runcontrol_file.location is None):
             raise ValueError(f"No file path provided for {self.__model.model_files.runcontrol_file.location=}")
 
+        for index, line in enumerate(run_control_file_content):
+            if not nfo.check_token('DRSDT', line):
+                continue
+
+            values = fo.split_line(line, upper=False)
+            if len(values) < 2 or values[0].upper() != 'DRSDT' or values[1].upper() != 'LIMIT':
+                warnings.warn(f'Unable to parse DRSDT line: {line.strip()}', UserWarning)
+                continue
+
+            value = fo.get_nth_value(run_control_file_content[index:], value_number=3, ignore_values=[])
+            if value is None:
+                warnings.warn(f'Unable to parse DRSDT line: {line.strip()}', UserWarning)
+                continue
+
+            try:
+                drsdt_limit = float(value)
+            except ValueError:
+                continue
+
+            self.__drsdt_limit = drsdt_limit
+            self.__drsdt_two_phases = any(item.upper() == '2PHASE' for item in values[2:])
+
         # set the start date
         for line in run_control_file_content:
             if nfo.check_token('START', line):

{ressimpy-2.6.0 → ressimpy-2.6.2}/ResSimpy/__init__.py

@@ -11,7 +11,7 @@
     Enums
 """
 
-__version__ = "2.6.0"  # Set at build time
+__version__ = "2.6.2"  # Set at build time
 
 from ResSimpy.Nexus.NexusSimulator import NexusSimulator
 from ResSimpy.OpenGoSim.OpenGoSimSimulator import OpenGoSimSimulator

{ressimpy-2.6.0 → ressimpy-2.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ResSimpy"
-version = "2.6.0" # Set at build time
+version = "2.6.2" # Set at build time
 description = "A Python library for working with Reservoir Simulator Models."
 authors = ["BP"]
 readme = "README.md"
@@ -30,7 +30,7 @@ numpy = [
   ]
 pandas = [
       { version = ">=2.3,<3",      python = "<3.11" },
-      { version = ">=3.0,<3.0.4",  python = ">=3.11" },
+      { version = ">=2.3,<3.0.4",  python = ">=3.11" },
   ]
 
 typing-extensions = "^4.15"
@@ -87,7 +87,6 @@ ignore = ["UP007",  "ANN101", "N999", "UP035", "S105", "N802", "S106", "S107", "
 # Use Google-style docstrings.
 convention = "google"
 
-
 [tool.poetry.group.docs]
 optional = true