Add support for scheme w/o run phase (#548)

Here we include a small fix to allow for schemes without run phases. Capgen assumes that all schemes have a run phase, which is not true in practice. During the "scheme analyze" section, if a scheme doesn't contain a run phase we set a flag to true (no_run_phase). Then this flag is queried later in the "scheme write" section. There are no interface changes. Addresses #543 Testing has been expanded to contain a scheme w/o a run phase.
NCAR · Mar 18, 2024 · 8dafc94 · 8dafc94
1 parent f1db415
commit 8dafc94
Show file tree

Hide file tree

Showing 11 changed files with 95 additions and 13 deletions.
diff --git a/scripts/ccpp_datafile.py b/scripts/ccpp_datafile.py
@@ -704,6 +704,9 @@ def _new_scheme_entry(parent, scheme, group_name, scheme_headers):
             emsg = "Scheme entry already exists for {} but name is {}"
             raise CCPPDatatableError(emsg.format(sch_name, pname))
         # end if
+    # Special case: Scheme w/o run phase.
+    if not scheme._has_run_phase:
+        return
     else:
         phase_entry = ET.SubElement(sch_entry, sch_tag)
         phase_entry.set("name", sch_name)

diff --git a/scripts/suite_objects.py b/scripts/suite_objects.py
@@ -1098,6 +1098,7 @@ def __init__(self, scheme_xml, context, parent, run_env):
         self.__var_debug_checks = list()
         self.__forward_transforms = list()
         self.__reverse_transforms = list()
+        self._has_run_phase = True
         self.__optional_vars = list()
         super().__init__(name, context, parent, run_env, active_call_list=True)
 
@@ -1143,6 +1144,9 @@ def analyze(self, phase, group, scheme_library, suite_vars, level):
             if phase in func:
                 my_header = func[phase]
                 self.__subroutine_name = my_header.title
+            else:
+                self._has_run_phase = False
+                return set()
             # end if
         else:
             estr = 'No schemes found for {}'
@@ -1727,11 +1731,13 @@ def write(self, outfile, errcode, errmsg, indent):
         # 
         # Write the scheme call.
         #
-        stmt = 'call {}({})'
-        outfile.write('',indent+1)
-        outfile.write('! Call scheme', indent+1)
-        outfile.write(stmt.format(self.subroutine_name, my_args), indent+1)
-        outfile.write('',indent+1)
+        if self._has_run_phase:
+            stmt = 'call {}({})'
+            outfile.write('',indent+1)
+            outfile.write('! Call scheme', indent+1)
+            outfile.write(stmt.format(self.subroutine_name, my_args), indent+1)
+            outfile.write('',indent+1)
+        # end if
         #
         # Copy any local pointers.
         #

diff --git a/test/capgen_test/run_test b/test/capgen_test/run_test
@@ -129,7 +129,7 @@ ccpp_files="${ccpp_files},${build_dir}/ccpp/test_host_ccpp_cap.F90"
 ccpp_files="${ccpp_files},${build_dir}/ccpp/ccpp_ddt_suite_cap.F90"
 ccpp_files="${ccpp_files},${build_dir}/ccpp/ccpp_temp_suite_cap.F90"
 process_list="setter=temp_set,adjusting=temp_calc_adjust"
-module_list="environ_conditions,make_ddt,temp_adjust,temp_calc_adjust,temp_set"
+module_list="environ_conditions,make_ddt,setup_coeffs,temp_adjust,temp_calc_adjust,temp_set"
 dependencies="bar.F90,foo.F90,qux.F90"
 suite_list="ddt_suite;temp_suite"
 required_vars_ddt="ccpp_error_code,ccpp_error_message,horizontal_dimension"
@@ -145,7 +145,9 @@ input_vars_ddt="${input_vars_ddt},model_times,number_of_model_times"
 input_vars_ddt="${input_vars_ddt},surface_air_pressure"
 output_vars_ddt="ccpp_error_code,ccpp_error_message"
 output_vars_ddt="${output_vars_ddt},model_times,number_of_model_times"
-required_vars_temp="ccpp_error_code,ccpp_error_message,horizontal_dimension"
+required_vars_temp="ccpp_error_code,ccpp_error_message"
+required_vars_temp="${required_vars_temp},coefficients_for_interpolation"
+required_vars_temp="${required_vars_temp},horizontal_dimension"
 required_vars_temp="${required_vars_temp},horizontal_loop_begin"
 required_vars_temp="${required_vars_temp},horizontal_loop_end"
 required_vars_temp="${required_vars_temp},index_of_water_vapor_specific_humidity"
@@ -157,7 +159,8 @@ required_vars_temp="${required_vars_temp},time_step_for_physics"
 required_vars_temp="${required_vars_temp},vertical_interface_dimension"
 required_vars_temp="${required_vars_temp},vertical_layer_dimension"
 required_vars_temp="${required_vars_temp},water_vapor_specific_humidity"
-input_vars_temp="horizontal_dimension"
+input_vars_temp="coefficients_for_interpolation"
+input_vars_temp="${input_vars_temp},horizontal_dimension"
 input_vars_temp="${input_vars_temp},horizontal_loop_begin"
 input_vars_temp="${input_vars_temp},horizontal_loop_end"
 input_vars_temp="${input_vars_temp},index_of_water_vapor_specific_humidity"
@@ -168,7 +171,9 @@ input_vars_temp="${input_vars_temp},surface_air_pressure,time_step_for_physics"
 input_vars_temp="${input_vars_temp},vertical_interface_dimension"
 input_vars_temp="${input_vars_temp},vertical_layer_dimension"
 input_vars_temp="${input_vars_temp},water_vapor_specific_humidity"
-output_vars_temp="ccpp_error_code,ccpp_error_message,potential_temperature"
+output_vars_temp="ccpp_error_code,ccpp_error_message"
+output_vars_temp="${output_vars_temp},coefficients_for_interpolation"
+output_vars_temp="${output_vars_temp},potential_temperature"
 output_vars_temp="${output_vars_temp},potential_temperature_at_interface"
 output_vars_temp="${output_vars_temp},surface_air_pressure"
 output_vars_temp="${output_vars_temp},water_vapor_specific_humidity"

diff --git a/test/capgen_test/setup_coeffs.F90 b/test/capgen_test/setup_coeffs.F90
@@ -0,0 +1,24 @@
+module setup_coeffs
+  use ccpp_kinds, ONLY: kind_phys
+  implicit none
+
+  public :: setup_coeffs_timestep_init
+
+contains
+  !> \section arg_table_setup_coeffs_timestep_init  Argument Table
+  !! \htmlinclude arg_table_setup_coeffs_timestep_init.html
+  !!
+  subroutine setup_coeffs_timestep_init(coeffs, errmsg, errflg)
+
+    real(kind_phys),    intent(inout) :: coeffs(:)
+    character(len=512), intent(out)   :: errmsg
+    integer,            intent(out)   :: errflg
+
+    errmsg = ''
+    errflg = 0
+
+    coeffs(:) = 1._kind_phys
+
+  end subroutine setup_coeffs_timestep_init
+
+end module setup_coeffs
diff --git a/test/capgen_test/setup_coeffs.meta b/test/capgen_test/setup_coeffs.meta
@@ -0,0 +1,29 @@
+[ccpp-table-properties]
+  name = setup_coeffs
+  type = scheme
+[ccpp-arg-table]
+  name = setup_coeffs_timestep_init
+  type = scheme
+[ coeffs ]
+  standard_name = coefficients_for_interpolation
+  long_name = coefficients for interpolation
+  units = none
+  dimensions = (horizontal_dimension)
+  type = real
+  kind = kind_phys
+  intent = inout
+[ errmsg ]
+  standard_name = ccpp_error_message
+  long_name = Error message for error handling in CCPP
+  units = none
+  dimensions = ()
+  type = character
+  kind = len=512
+  intent = out
+[ errflg ]
+  standard_name = ccpp_error_code
+  long_name = Error flag for error handling in CCPP
+  units = 1
+  dimensions = ()
+  type = integer
+  intent = out
diff --git a/test/capgen_test/temp_scheme_files.txt b/test/capgen_test/temp_scheme_files.txt
@@ -1,3 +1,4 @@
+setup_coeffs.meta
 temp_set.meta
 temp_adjust.meta
 temp_calc_adjust.meta
diff --git a/test/capgen_test/temp_suite.xml b/test/capgen_test/temp_suite.xml
@@ -2,6 +2,7 @@
 
 <suite name="temp_suite" version="1.0">
   <group name="physics1">
+    <scheme>setup_coeffs</scheme>
     <scheme>temp_set</scheme>
   </group>
   <group name="physics2">

diff --git a/test/capgen_test/test_host.F90 b/test/capgen_test/test_host.F90
@@ -358,23 +358,26 @@ program test
    character(len=cs), target :: test_parts1(2) = (/ 'physics1        ',       &
                                                     'physics2        ' /)
    character(len=cs), target :: test_parts2(1) = (/ 'data_prep       ' /)
-   character(len=cm), target :: test_invars1(6) = (/                          &
+   character(len=cm), target :: test_invars1(7) = (/                          &
         'potential_temperature               ',                               &
         'potential_temperature_at_interface  ',                               &
+        'coefficients_for_interpolation      ',                               &
         'surface_air_pressure                ',                               &
         'water_vapor_specific_humidity       ',                               &
         'potential_temperature_increment     ',                               &
         'time_step_for_physics               ' /)
-   character(len=cm), target :: test_outvars1(6) = (/                         &
+   character(len=cm), target :: test_outvars1(7) = (/                         &
         'potential_temperature               ',                               &
         'potential_temperature_at_interface  ',                               &
+        'coefficients_for_interpolation      ',                               &
         'surface_air_pressure                ',                               &
         'water_vapor_specific_humidity       ',                               &
         'ccpp_error_code                     ',                               &
         'ccpp_error_message                  ' /)
-   character(len=cm), target :: test_reqvars1(8) = (/                         &
+   character(len=cm), target :: test_reqvars1(9) = (/                         &
         'potential_temperature               ',                               &
         'potential_temperature_at_interface  ',                               &
+        'coefficients_for_interpolation      ',                               &
         'surface_air_pressure                ',                               &
         'water_vapor_specific_humidity       ',                               &
         'potential_temperature_increment     ',                               &

diff --git a/test/capgen_test/test_host_mod.F90 b/test/capgen_test/test_host_mod.F90
@@ -17,6 +17,7 @@ module test_host_mod
    integer,         parameter   :: index_qv = 1
    real(kind_phys), allocatable :: temp_midpoints(:,:)
    real(kind_phys)              :: temp_interfaces(ncols, pverP)
+   real(kind_phys)              :: coeffs(ncols)
    real(kind_phys), dimension(DiagDimStart:ncols, DiagDimStart:pver) ::       &
         diag1,                                                                &
         diag2

diff --git a/test/capgen_test/test_host_mod.meta b/test/capgen_test/test_host_mod.meta
@@ -90,3 +90,9 @@
   dimensions = (number_of_model_times)
   type = integer
   allocatable = True
+[ coeffs ]
+  standard_name = coefficients_for_interpolation
+  long_name = coefficients for interpolation
+  units = none
+  dimensions = (horizontal_dimension)
+  type = real | kind = kind_phys
diff --git a/test/capgen_test/test_reports.py b/test/capgen_test/test_reports.py
@@ -68,7 +68,7 @@ def usage(errmsg=None):
                os.path.join(_BUILD_DIR, "ccpp", "ccpp_ddt_suite_cap.F90"),
                os.path.join(_BUILD_DIR, "ccpp", "ccpp_temp_suite_cap.F90")]
 _PROCESS_LIST = ["setter=temp_set", "adjusting=temp_calc_adjust"]
-_MODULE_LIST = ["environ_conditions", "make_ddt", "temp_adjust",
+_MODULE_LIST = ["environ_conditions", "make_ddt", "setup_coeffs", "temp_adjust",
                 "temp_calc_adjust", "temp_set"]
 _SUITE_LIST = ["ddt_suite", "temp_suite"]
 _INPUT_VARS_DDT = ["model_times", "number_of_model_times",
@@ -85,17 +85,20 @@ def usage(errmsg=None):
 _REQUIRED_VARS_TEMP = ["ccpp_error_code", "ccpp_error_message",
                        "potential_temperature",
                        "potential_temperature_at_interface",
+                       "coefficients_for_interpolation",
                        "potential_temperature_increment",
                        "surface_air_pressure", "time_step_for_physics",
                        "water_vapor_specific_humidity"]
 _INPUT_VARS_TEMP = ["potential_temperature",
                     "potential_temperature_at_interface",
+                    "coefficients_for_interpolation",
                     "potential_temperature_increment",
                     "surface_air_pressure", "time_step_for_physics",
                     "water_vapor_specific_humidity"]
 _OUTPUT_VARS_TEMP = ["ccpp_error_code", "ccpp_error_message",
                      "potential_temperature",
                      "potential_temperature_at_interface",
+                     "coefficients_for_interpolation",
                      "surface_air_pressure", "water_vapor_specific_humidity"]
 
 def fields_string(field_type, field_list, sep):