Merge pull request #1606 from knutfrode/dev

[run-ex] Updated OpenBerg example

Author: knutfrode

examples/example_openberg.py

@@ -4,23 +4,52 @@
 ====================
 """
 
+from datetime import datetime, timedelta
+import numpy as np
+import matplotlib.pyplot as plt
+import opendrift
 from opendrift.models.openberg import OpenBerg
-from datetime import datetime,timedelta
- 
-o = OpenBerg()
 
-# The user can overwrite the default setup using set_config method
-o.set_config('drift:vertical_profile', False) # use surface currents for this test
+#%%
+# Currents and wind forcing
+forcing = ['https://thredds.met.no/thredds/dodsC/fou-hi/barents_eps_zdepth_be',
+           'https://pae-paha.pacioos.hawaii.edu/thredds/dodsC/ncep_global/NCEP_Global_Atmospheric_Model_best.ncd']
 
-o.add_readers_from_list([
-        'https://thredds.met.no/thredds/dodsC/cmems/topaz6/dataset-topaz6-arc-15min-3km-be.ncml',
-        'https://pae-paha.pacioos.hawaii.edu/thredds/dodsC/ncep_global/NCEP_Global_Atmospheric_Model_best.ncd'])
+#%%
+# A permutation of iceberg sizes/dimensions
+n = 10
+lengths = np.linspace(50, 500, n)
+widths = np.linspace(20, 200, n)
+sails = np.linspace(5, 50, n)
+drafts = np.linspace(2, 120, n)
+lengths, widths, sails, drafts = np.meshgrid(lengths, widths, sails, drafts)
 
+icebergs = {'lon': 19.8, 'lat': 74.3, 'time': datetime.now(),
+            'number': lengths.size, 'radius': 500,
+            'sail': sails, 'draft': drafts, 'length': lengths, 'width': widths}
 
-o.seed_elements(lon=-56, lat=72, time=datetime.now(),
-                number=100, radius=500,
-                sail=10,draft=50,length=90,width=40)
+#%%
+# Simulating drift for 48 hours
+outfile = 'icebergs.nc'
+if False:
+    o = OpenBerg()
+    o.set_config('drift:vertical_profile', False)
+    o.add_readers_from_list(forcing)
+    o.seed_elements(**icebergs)
+    o.run(duration=timedelta(days=2), outfile=outfile)
+else:
+    o = opendrift.open(outfile)
 
-o.run(duration=timedelta(days=3))
-o.plot(fast=True)
-o.plot_property('draft')
+o.animation(color='draft')
+
+#%%
+# .. image:: /gallery/animations/example_openberg_0.gif
+
+o.plot()
+
+#%%
+# Plotting the speed of icebergs
+iceberg_speed = np.sqrt(o.result.iceb_x_velocity**2 + o.result.iceb_y_velocity**2)
+iceberg_speed.plot.line(x='time', add_legend=False, color='gray')
+plt.ylabel('Iceberg speed  [m/s]')
+plt.show()

opendrift/elements/elements.py

@@ -14,6 +14,7 @@
 #
 # Copyright 2015, Knut-Frode Dagestad, MET Norway
 
+import logging; logger = logging.getLogger(__name__)
 from collections import OrderedDict
 import numpy as np
 
@@ -122,6 +123,12 @@ def __init__(self, **kwargs):
             raise TypeError('Redundant arguments: %s' %
                             str(list(redundant_args)))
 
+        # Ravel any mulitidimensional kwargs
+        for kname in kwargs:
+            if hasattr(kwargs[kname], 'ndim') and kwargs[kname].ndim > 1:
+                logger.debug(f'array {kname} is multidimensional -> flattening with ravel')
+                kwargs[kname] = kwargs[kname].ravel()
+
         # Check that input arrays have same length
         array_lengths = [1]*len(kwargs)
         for i, input_value in enumerate(kwargs.values()):