[run-ex] Factoring out method points_within_polygon from seed_within_polygon, allowing collecting points for several polygones before a final seed call

Author: knutfrode

opendrift/models/basemodel/__init__.py

@@ -1459,6 +1459,16 @@ def seed_within_polygon(self, lons, lats, number=None, **kwargs):
         if number is None:
             number = self.get_config('seed:number')
 
+        lonpoints, latpoints = self.points_within_polygon(lons, lats, number)
+
+        # Finally seed at calculated positions
+        self.seed_elements(lonpoints, latpoints, number=number, **kwargs)
+
+    @staticmethod
+    def points_within_polygon(lons, lats, number):
+        """Return a number of positions (lon, lat) within given polygon.
+
+            Helper method for seed_within_polygon"""
         lons = np.asarray(lons)
         lats = np.asarray(lats)
         if len(lons) < 3:
@@ -1526,8 +1536,7 @@ def seed_within_polygon(self, lons, lats, number=None, **kwargs):
             else:
                 break
 
-        # Finally seed at calculated positions
-        self.seed_elements(lonpoints, latpoints, number=number, **kwargs)
+        return lonpoints, latpoints
 
     @require_mode(mode=Mode.Ready)
     def seed_from_wkt(self, wkts, time, **kwargs):
@@ -1597,13 +1606,11 @@ def seed_from_geopandas(self,
         for e, (n, polygon) in enumerate(zip(number_per_polygon, g_lonlat.geometry.explode(index_parts=False))):
             logger.info(f'Seeding {n} elements within polygon number {e+1} of area {areas[e]/1e6} km2')
             lons, lats = polygon.exterior.coords.xy
-            all_lons = np.append(all_lons, lons)
-            all_lats = np.append(all_lats, lats)
-        self.seed_within_polygon(lons=all_lons,
-                                 lats=all_lats,
-                                 number=number,
-                                 time=time,
-                                 **kwargs)
+            lonpoints, latpoints = self.points_within_polygon(lons, lats, n)
+            all_lons = np.append(all_lons, lonpoints)
+            all_lats = np.append(all_lats, latpoints)
+
+        self.seed_elements(lon=all_lons, lat=all_lats, number=number, time=time, **kwargs)
 
     @require_mode(mode=Mode.Ready)
     def seed_letters(self, text, lon, lat, time, number, scale=1.2):

tests/models/test_run.py

@@ -274,11 +274,13 @@ def test_seed_shapefile(self):
         g = g.iloc[[1, 3]]  # Selecting layers number 1 and 3
         o.seed_from_geopandas(g, number=1000, time=datetime.now())
         self.assertEqual(len(o.elements_scheduled), 1000)
-        o.seed_from_shapefile(tdf +
-                                  'shapefile_spawning_areas/Torsk.shp',
-                                  number=300, time=datetime.now())
+        age_seconds = np.arange(0, 300)  # Check that vector of seed property is preserved
+        o.seed_from_shapefile(tdf + 'shapefile_spawning_areas/Torsk.shp',
+                              number=300, time=datetime.now(), age_seconds=age_seconds)
         self.assertEqual(len(o.elements_scheduled), 1300)
-        self.assertAlmostEqual(o.elements_scheduled.lat[-1], 55.04, 2)
+        self.assertAlmostEqual(o.elements_scheduled.lat[-1], 51.74, 2)
+        self.assertAlmostEqual(o.elements_scheduled.age_seconds[-1], age_seconds[-1], 2)
+        self.assertAlmostEqual(o.elements_scheduled.age_seconds[-2], age_seconds[-2], 2)
 
     @unittest.skipIf(has_ogr is False,
                      'GDAL library needed to read shapefiles')