Merge pull request #681 from pybamm-team/issue-570-processed-var-warning

Issue 570 processed var warning
pybamm-team · Oct 25, 2019 · 9d3ea6b · 9d3ea6b
2 parents fd9073d + 2962b1d
commit 9d3ea6b
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@
 
 ## Bug fixes
 
+-   Add warning if `ProcessedVariable` is called outisde its interpolation range ([#681](https://github.com/pybamm-team/PyBaMM/pull/681))
 -   Improve the way `ProcessedVariable` objects are created in higher dimensions ([#581](https://github.com/pybamm-team/PyBaMM/pull/581))
 
 # [v0.1.0](https://github.com/pybamm-team/PyBaMM/tree/v0.1.0) - 2019-10-08

diff --git a/pybamm/__init__.py b/pybamm/__init__.py
@@ -25,7 +25,7 @@ def _load_version_int():
 __version_int__ = _load_version_int()
 __version__ = ".".join([str(x) for x in __version_int__])
 if sys.version_info[0] < 3:
-    del (x)  # Before Python3, list comprehension iterators leaked
+    del x  # Before Python3, list comprehension iterators leaked
 
 #
 # Expose PyBaMM version

diff --git a/pybamm/logger.py b/pybamm/logger.py
@@ -3,6 +3,11 @@
 #
 import logging
 
+
+def set_logging_level(level):
+    logger.setLevel(level)
+
+
 format = (
     "%(asctime)s - [%(levelname)s] %(module)s.%(funcName)s(%(lineno)d): "
     + "%(message)s"
@@ -12,7 +17,5 @@
 
 # Create a custom logger
 logger = logging.getLogger(__name__)
+set_logging_level("WARNING")
 
-
-def set_logging_level(level):
-    logger.setLevel(level)
diff --git a/pybamm/processed_variable.py b/pybamm/processed_variable.py
@@ -391,19 +391,24 @@ def initialise_3D_scikit_fem(self):
             fill_value=np.nan,
         )
 
-    def __call__(self, t=None, x=None, r=None, y=None, z=None):
+    def __call__(self, t=None, x=None, r=None, y=None, z=None, warn=True):
         """
         Evaluate the variable at arbitrary t (and x, r, y and/or z), using interpolation
         """
         if self.dimensions == 1:
-            return self._interpolation_function(t)
+            out = self._interpolation_function(t)
         elif self.dimensions == 2:
             if t is None:
-                return self._interpolation_function(y, z)
+                out = self._interpolation_function(y, z)
             else:
-                return self.call_2D(t, x, r, z)
+                out = self.call_2D(t, x, r, z)
         elif self.dimensions == 3:
-            return self.call_3D(t, x, r, y, z)
+            out = self.call_3D(t, x, r, y, z)
+        if warn is True and np.isnan(out).any():
+            pybamm.logger.warning(
+                "Calling variable outside interpolation range (returns 'nan')"
+            )
+        return out
 
     def call_2D(self, t, x, r, z):
         "Evaluate a 2D variable"

diff --git a/pybamm/quick_plot.py b/pybamm/quick_plot.py
@@ -320,7 +320,9 @@ def plot(self, t):
                             spatial_scale = self.spatial_scales[spatial_var_name]
                         self.plots[key][i][j], = ax.plot(
                             spatial_var_value * spatial_scale,
-                            variable(t, **{spatial_var_name: spatial_var_value}),
+                            variable(
+                                t, **{spatial_var_name: spatial_var_value}, warn=False
+                            ),
                             lw=2,
                             color=colors[i],
                             linestyle=linestyles[j],
@@ -333,7 +335,7 @@ def plot(self, t):
                         full_t = self.ts[i]
                         self.plots[key][i][j], = ax.plot(
                             full_t * self.time_scale,
-                            variable(full_t),
+                            variable(full_t, warn=False),
                             lw=2,
                             color=colors[i],
                             linestyle=linestyles[j],
@@ -394,7 +396,9 @@ def update(self, val):
                     for j, variable in enumerate(variable_lists):
                         plot[i][j].set_ydata(
                             variable(
-                                t_dimensionless, **{spatial_var_name: spatial_var_value}
+                                t_dimensionless,
+                                **{spatial_var_name: spatial_var_value},
+                                warn=False
                             )
                         )
             else:

diff --git a/tests/unit/test_logger.py b/tests/unit/test_logger.py
@@ -8,11 +8,11 @@
 class TestLogger(unittest.TestCase):
     def test_logger(self):
         logger = pybamm.logger
-        self.assertEqual(logger.level, 0)
+        self.assertEqual(logger.level, 30)
         pybamm.set_logging_level("INFO")
         self.assertEqual(logger.level, 20)
-        pybamm.set_logging_level("WARNING")
-        self.assertEqual(logger.level, 30)
+        pybamm.set_logging_level("ERROR")
+        self.assertEqual(logger.level, 40)
 
 
 if __name__ == "__main__":

diff --git a/tests/unit/test_processed_variable.py b/tests/unit/test_processed_variable.py
@@ -195,6 +195,11 @@ def test_processed_var_1D_interpolation(self):
         np.testing.assert_array_equal(processed_eqn(t_sol), t_sol * y_sol[0])
         np.testing.assert_array_almost_equal(processed_eqn(0.5), 0.5 * 2.5)
 
+        # Suppress warning for this test
+        pybamm.set_logging_level("ERROR")
+        np.testing.assert_array_equal(processed_eqn(2), np.nan)
+        pybamm.set_logging_level("WARNING")
+
     def test_processed_var_2D_interpolation(self):
         t = pybamm.t
         var = pybamm.Variable("var", domain=["negative electrode", "separator"])