Merge pull request #1740 from knutfrode/dev

OpenBerg: added min and max values for iceberg dimensions. Added defa…

Author: knutfrode

opendrift/models/basemodel/__init__.py

@@ -2526,6 +2526,7 @@ def set_up_map(self,
                 land_color = 'gray'
             else:
                 land_color = cfeature.COLORS['land']
+        land_zorder = kwargs.pop('land_zorder', 10)
 
         if 'text' in kwargs:
             if not isinstance(kwargs['text'], list):
@@ -2582,9 +2583,10 @@ def set_up_map(self,
                                   facecolor=facecolor,
                                   edgecolor='black')
             else:
-                reader_global_landmask.plot_land(ax, lonmin, latmin, lonmax,
-                                                 latmax, fast, ocean_color,
-                                                 land_color, lscale,
+                reader_global_landmask.plot_land(ax, lonmin, latmin, lonmax, latmax,
+                                                 fast=fast, ocean_color=ocean_color,
+                                                 land_color=land_color, land_zorder=land_zorder,
+                                                 lscale=lscale,
                                                  crs_plot=self.crs_plot,
                                                  crs_lonlat=self.crs_lonlat)
 

opendrift/models/openberg.py

@@ -51,21 +51,29 @@ class IcebergObj(LagrangianArray):
         ('sail', {'dtype': np.float32,
                   'units': 'm',
                   'default': 10,
+                  'min': 1,
+                  'max': 100,
                   'description': 'Sail of iceberg (part above waterline)',
                   'level': CONFIG_LEVEL_ESSENTIAL}),
         ('draft', {'dtype': np.float32,
                    'units': 'm',
                    'default': 90,
+                   'min': 1,
+                   'max': 1000,
                    'description': 'Draft of iceberg (part below waterline)',
                    'level': CONFIG_LEVEL_ESSENTIAL}),
         ('length', {'dtype': np.float32,
                     'units': 'm',
                     'default': 100,
+                    'min': 1,
+                    'max': 10000,
                     'description': 'Length of iceberg',
                     'level': CONFIG_LEVEL_ESSENTIAL}),
         ('width', {'dtype': np.float32,
                    'units': 'm',
                    'default': 30,
+                   'min': 1,
+                   'max': 10000,
                    'description': 'Width of iceberg)',
                    'level': CONFIG_LEVEL_ESSENTIAL}),
         ('weight_coef', {'dtype': np.float32,          #This parameter is relative to the shape of iceberg (e.g. 1 for tabular; 0.3 for pinnacle: It affects the mass only)
@@ -287,15 +295,15 @@ class OpenBerg(OpenDriftSimulation):
         "x_sea_water_velocity": {"fallback": None, "profiles": True},
         "y_sea_water_velocity": {"fallback": None, "profiles": True},
         "sea_floor_depth_below_sea_level": {"fallback": 10000},
-        'sea_surface_height': {'fallback': 0},
-        "sea_surface_x_slope": {"fallback": 0},
-        "sea_surface_y_slope": {"fallback": 0},
+        'sea_surface_height': {'fallback': 0, 'important': False},
+        "sea_surface_x_slope": {"fallback": 0, 'important': False},
+        "sea_surface_y_slope": {"fallback": 0, 'important': False},
         "x_wind": {"fallback": None, "important": True},
         "y_wind": {"fallback": None, "important": True},
         "sea_surface_wave_significant_height": {"fallback": 0},
         "sea_surface_wave_from_direction": {"fallback": 0},
-        "sea_surface_wave_stokes_drift_x_velocity": {"fallback": 0},
-        "sea_surface_wave_stokes_drift_y_velocity": {"fallback": 0},
+        "sea_surface_wave_stokes_drift_x_velocity": {"fallback": 0, 'important': False},
+        "sea_surface_wave_stokes_drift_y_velocity": {"fallback": 0, 'important': False},
         "sea_water_temperature": {"fallback": 2, "profiles": True},
         "sea_water_salinity": {"fallback": 35, "profiles": True},
         "sea_ice_area_fraction": {"fallback": 0},
@@ -408,6 +416,11 @@ def __init__(self, *args, **kwargs):
             },  
         })
 
+        # Since OpenBerg model is deterministic for given iceberg size,
+        # (in contrast to the Leeway model), we use a default diffusivity
+        # to yield some variability.
+        self._set_config_default('drift:horizontal_diffusivity', 100)
+
 
     def advect_iceberg(self):
         sail = self.elements.sail
@@ -504,8 +517,7 @@ def dynamic(t,iceb_vel, water_vel, wind_vel, wave_height, wave_direction, Avo, A
         if grounding:
             # Determine which icebergs are grounded
             if np.any(grounded):
-                logger.debug(f"Grounding condition: Icebergs grounded = {np.sum(grounded)}, "
-                            f"hwall = {np.round(hwall[grounded], 3)} meters")
+                logger.debug(f"Grounding condition: Icebergs grounded = {np.sum(grounded)}")
                 # Grounded icebergs stop moving
                 self.elements.moving[grounded] = 0
             else:
@@ -514,8 +526,7 @@ def dynamic(t,iceb_vel, water_vel, wind_vel, wave_height, wave_direction, Avo, A
             # Check for Degrounding regardless of whether grounding occurred now
             degrounding = np.logical_and(self.elements.moving == 0, hwall < 0)
             if np.any(degrounding):
-                logger.debug(f"Degrounding condition: Icebergs degrounded = {np.sum(degrounding)}, "
-                            f"hwall = {np.round(hwall[degrounding], 3)} meters")
+                logger.debug(f"Degrounding condition: Icebergs degrounded = {np.sum(degrounding)}")
                 # Degrounded icebergs start moving again
                 self.elements.moving[degrounding] = 1
         else:

opendrift/readers/reader_global_landmask.py

@@ -123,7 +123,9 @@ def intersecting_geometries(self, extent):
         logger.debug(f"Adding GSHHG shapes from cartopy, scale: {scale}, extent: {extent}..")
         return super().intersecting_geometries(extent)
 
-def plot_land(ax, lonmin, latmin, lonmax, latmax, fast, ocean_color = 'white', land_color = cfeature.COLORS['land'], lscale = 'auto', crs_plot=None, crs_lonlat=None):
+def plot_land(ax, lonmin, latmin, lonmax, latmax, fast,
+              ocean_color='white', land_color=cfeature.COLORS['land'], land_zorder=0,
+              lscale='auto', crs_plot=None, crs_lonlat=None):
     """
     Plot the landmask or the shapes from GSHHG.
     """
@@ -166,7 +168,7 @@ def show_landmask_roaring(roaring):
         cmap = colors.ListedColormap([ocean_color, land_color])
 
         ax.imshow(img, origin = 'lower',
-                  extent=extent, zorder=0, cmap=cmap,
+                  extent=extent, zorder=land_zorder, cmap=cmap,
                   transform=transform)
 
     if fast:
@@ -190,7 +192,7 @@ def show_landmask_roaring(roaring):
 
         land = LandmaskFeature(scale=lscale, facecolor=land_color, globe=crs_lonlat.globe, levels=[1,5,6])
 
-        ax.add_feature(land, zorder=0,
+        ax.add_feature(land, zorder=land_zorder,
                        facecolor=land_color,
                        edgecolor='black')
 

tests/models/test_openberg.py

@@ -36,6 +36,7 @@ def test_openberg_constant_forcing():
     o.set_config('environment:constant:y_sea_water_velocity', 1)
     o.set_config('environment:constant:x_wind', 0)
     o.set_config('environment:constant:y_wind', 0)
+    o.set_config('drift:horizontal_diffusivity', 0)
     o.set_config('drift:coriolis', False)
     o.seed_elements(4, 60, time=datetime.now())
     o.run(steps=2)
@@ -48,6 +49,7 @@ def test_openberg_constant_forcing():
     o.set_config('environment:constant:y_sea_water_velocity', 1)
     o.set_config('environment:constant:x_wind', 0)
     o.set_config('environment:constant:y_wind', 0)
+    o.set_config('drift:horizontal_diffusivity', 0)
     o.set_config('drift:coriolis', True)
     o.seed_elements(4, 60, time=datetime.now())
     o.run(steps=2)
@@ -60,6 +62,7 @@ def test_openberg_constant_forcing():
     o.set_config('environment:constant:y_sea_water_velocity', 1)
     o.set_config('environment:constant:x_wind', 10)
     o.set_config('environment:constant:y_wind', 0)
+    o.set_config('drift:horizontal_diffusivity', 0)
     o.set_config('drift:coriolis', True)
     o.seed_elements(4, 60, time=datetime.now())
     o.run(steps=2)
@@ -74,6 +77,7 @@ def test_openberg_norkyst():
     o.add_reader(reader_current)
     o.set_config('environment:constant:x_wind', 0)
     o.set_config('environment:constant:y_wind', 0)
+    o.set_config('drift:horizontal_diffusivity', 0)
     o.seed_elements(4., 62., time=reader_current.start_time)
     o.run(steps=3)
 
@@ -93,6 +97,7 @@ def test_grounding_and_degrounding():
     o.set_config('environment:constant:x_wind', 0)
     o.set_config('environment:constant:y_wind', 0)
     o.set_config('environment:constant:sea_floor_depth_below_sea_level', 20)
+    o.set_config('drift:horizontal_diffusivity', 0)
     o.set_config('processes:roll_over', False)
 
     drafts=np.arange(15,23)

tests/plotting/test_norkyst.py

@@ -20,7 +20,7 @@ def test_fast_norkyst():
                     time=rn.start_time)
     o.run(steps=2)
 
-    return o.plot(fast=True, buffer=.2)[1]
+    return o.plot(fast=True, buffer=.2, land_zorder=0)[1]
 
 
 @pytest.mark.slow
@@ -38,4 +38,4 @@ def test_norkyst():
                     time=rn.start_time)
     o.run(steps=2)
 
-    return o.plot(fast=False, buffer=.2)[1]
+    return o.plot(fast=False, buffer=.2, land_zorder=0)[1]

tests/readers/test_global_landmask.py

@@ -87,7 +87,7 @@ def test_plot_auto_scale(test_data, scale, fast, show_plot):
                     time=reader_nordic.start_time)
     oc.run(steps=2)
 
-    fig = oc.plot(buffer=5., lscale=scale, fast=fast, show=show_plot)[1]
+    fig = oc.plot(buffer=5., lscale=scale, fast=fast, show=show_plot, land_zorder=0)[1]
     print(fig)
     return fig