Allow repeat subcycle variables & nested subcycles of identical length

scripts/suite_objects.py

@@ -52,12 +52,12 @@
                                              'suites':''})
 
 ###############################################################################
-def new_suite_object(item, context, parent, run_env):
+def new_suite_object(item, context, parent, run_env, loop_count=0):
 ###############################################################################
     "'Factory' method to create the appropriate suite object from XML"
     new_item = None
     if item.tag == 'subcycle':
-        new_item = Subcycle(item, context, parent, run_env)
+        new_item = Subcycle(item, context, parent, run_env, loop_count=loop_count)
     elif item.tag == 'scheme':
         new_item = Scheme(item, context, parent, run_env)
     elif item.tag == _API_TIMESPLIT_TAG:
@@ -2039,16 +2039,17 @@ def dimension_name(self):
 class Subcycle(SuiteObject):
     """Class to represent a subcycled group of schemes or scheme collections"""
 
-    def __init__(self, sub_xml, context, parent, run_env):
+    def __init__(self, sub_xml, context, parent, run_env, loop_count=0):
         self._loop_extent = sub_xml.get('loop', "1") # Number of iterations
         self._loop = None
-        # See if our loop variable is an interger or a variable
+        # See if our loop variable is an integer or a variable
         try:
             _ = int(self._loop_extent)
             self._loop = self._loop_extent
             self._loop_var_int = True
-            name = f"loop{self._loop}"
+            name = f"loop{loop_count}"
             super().__init__(name, context, parent, run_env, active_call_list=False)
+            loop_count = loop_count + 1
         except ValueError:
             self._loop_var_int = False
             lvar = parent.find_variable(standard_name=self._loop_extent, any_scope=True)
@@ -2059,12 +2060,13 @@ def __init__(self, sub_xml, context, parent, run_env):
                 self._loop_var_int = False
                 self._loop = lvar.get_prop_value('local_name')
             # end if
-            name = f"loop_{self._loop_extent}"[0:63]
+            name = f"loop{loop_count}_{self._loop_extent}"[0:63]
             super().__init__(name, context, parent, run_env, active_call_list=True)
-            parent.add_call_list_variable(lvar)
+            parent.add_call_list_variable(lvar, exists_ok=True)
+            loop_count = loop_count + 1
         # end try
         for item in sub_xml:
-            new_item = new_suite_object(item, context, self, run_env)
+            new_item = new_suite_object(item, context, self, run_env, loop_count=loop_count)
             self.add_part(new_item)
         # end for
 

test/var_compatibility_test/README.md

@@ -5,6 +5,11 @@ Tests the variable compatibility object (`VarCompatObj`):
 - Vertical array flipping (`top_at_one=true`)
 - Kind conversions (`kind_phys <-> 8`)
 - And various combinations thereof of the above cases
+- Also tests subcycles:
+  - Nested subcycles
+  - A subcycle with dynamic iteration length (defined by a standard name) and a subcycle with fixed/integer iteration length
+  - Multiple ubcycles with same standard name defining the iteration length
+  - Nested subcycles with the same iteration length
 
 ## Building/Running
 

test/var_compatibility_test/test_host_mod.F90

@@ -50,7 +50,7 @@ logical function compare_data()
     real(kind_phys), parameter :: effrr_expected = 1.0E-3 ! 1000 microns, in meter
     real(kind_phys), parameter :: effrl_expected = 5.0E-5 ! 50 microns, in meter
     real(kind_phys), parameter :: effri_expected = 7.5E-5 ! 75 microns, in meter
-    real(kind_phys), parameter :: effrs_expected = 5.1E-4 ! 510 microns, in meter
+    real(kind_phys), parameter :: effrs_expected = 5.2E-4 ! 520 microns, in meter
     real(kind_phys), parameter :: scalar_expected = 2.0E3 ! 2 km, in meter
     real(kind_phys), parameter :: tke_expected = 10.0     ! 10 J kg-1
     real(kind_phys), parameter :: tolerance = 1.0E-6      ! used as scaling factor for expected value

test/var_compatibility_test/var_compatibility_suite.xml

@@ -5,10 +5,14 @@
     <subcycle loop="num_subcycles_for_effr">
       <scheme>effr_pre</scheme>
       <subcycle loop="2">
-        <scheme>effr_calc</scheme>
+        <subcycle loop="2">
+          <scheme>effr_calc</scheme>
+        </subcycle>
       </subcycle>
       <scheme>effr_post</scheme>
     </subcycle>
+    <subcycle loop="num_subcycles_for_effr">
+    </subcycle>
     <scheme>effr_diag</scheme>
     <scheme>rad_lw</scheme>
     <scheme>rad_sw</scheme>