review comments; add additional testing

scripts/suite_objects.py

@@ -1536,22 +1536,30 @@ def add_var_transform(self, var, compat_obj, vert_dim):
         # If needed, modify vertical dimension for vertical orientation flipping
         _, vdim    = find_vertical_dimension(var.get_dimensions())
         if vdim >= 0:
-           vdim_name  = vert_dim.split(':')[-1]
+           vdims  = vert_dim.split(':')
+           vdim_name  = vdims[-1]
            group_vvar = self.__group.call_list.find_variable(vdim_name)
-           vname      = group_vvar.get_prop_value('local_name')
-           lindices[vdim] = '1:'+vname
-           rindices[vdim] = '1:'+vname
+           if group_vvar is None:
+               raise CCPPError(f"add_var_transform: Cannot find dimension variable, {vdim_name}")
+           # end if
+           vname = group_vvar.get_prop_value('local_name')
+           if len(vdims) == 2:
+               sdim_name = vdims[0]
+               group_vvar = self.find_variable(sdim_name)
+               if group_vvar is None:
+                   raise CCPPError(f"add_var_transform: Cannot find dimension variable, {sdim_name}")
+               # end if
+               sname = group_vvar.get_prop_value('local_name')
+           else:
+               sname = '1'
+           # end if
+           lindices[vdim] = sname+':'+vname
            if compat_obj.has_vert_transforms:
-               rindices[vdim] = vname+':1:-1'
+               rindices[vdim] = vname+':'+sname+':-1'
+           else:
+               rindices[vdim] = sname+':'+vname
            # end if
         # end if
-        vdim_name  = vert_dim.split(':')[-1]
-        group_vvar = self.__group.call_list.find_variable(vdim_name)
-        vname      = group_vvar.get_prop_value('local_name')
-        lindices[vdim] = '1:'+vname
-        rindices[vdim] = '1:'+vname
-        if compat_obj.has_vert_transforms:
-            rindices[vdim] = vname+':1:-1'
 
         # If needed, modify horizontal dimension for loop substitution.
         # NOT YET IMPLEMENTED
@@ -1625,7 +1633,7 @@ def write(self, outfile, errcode, errmsg, indent):
             stmt = self.write_var_debug_check(var, internal_var, cldicts, outfile, errcode, errmsg, indent+1)
         # Write any reverse (pre-Scheme) transforms.
         if len(self.__reverse_transforms) > 0:
-            outfile.write('! Compute reverse (pre-scheme) transforms', indent+1)
+            outfile.comment('Compute reverse (pre-scheme) transforms', indent+1)
         # end if
         for (dummy, var, rindices, lindices, compat_obj) in self.__reverse_transforms:
             tstmt = self.write_var_transform(var, dummy, rindices, lindices, compat_obj, outfile, indent+1, False)
@@ -1638,7 +1646,7 @@ def write(self, outfile, errcode, errmsg, indent):
         # Write any forward (post-Scheme) transforms.
         outfile.write('',indent+1)
         if len(self.__forward_transforms) > 0:
-            outfile.write('! Compute forward (post-scheme) transforms', indent+1)
+            outfile.comment('Compute forward (post-scheme) transforms', indent+1)
         # end if
         for (var, dummy, lindices, rindices, compat_obj) in self.__forward_transforms:
             tstmt = self.write_var_transform(var, dummy, rindices, lindices, compat_obj, outfile, indent+1, True)

scripts/var_props.py

@@ -821,6 +821,18 @@ class VarCompatObj:
                      _DOCTEST_RUNENV).reverse_transform("var1_lname", "var2_lname", ('k',), ('nk-k+1',))
     'var1_lname(nk-k+1) = var2_lname(k)'
 
+    # Test that unit conversions with a scalar var works
+    >>> VarCompatObj("var_stdname", "real", "kind_phys", "Pa", [], "var1_lname", False, \
+                      "var_stdname", "real", "kind_phys", "hPa", [], "var2_lname", False, \
+                      _DOCTEST_RUNENV).forward_transform("var1_lname", "var2_lname", [], []) #doctest: +ELLIPSIS
+    'var1_lname = 1.0E-2_kind_phys*var2_lname'
+
+    # Test that unit conversions with a scalar var works
+    >>> VarCompatObj("var_stdname", "real", "kind_phys", "Pa", [], "var1_lname", False, \
+                      "var_stdname", "real", "kind_phys", "hPa", [], "var2_lname", False, \
+                      _DOCTEST_RUNENV).reverse_transform("var1_lname", "var2_lname", [], []) #doctest: +ELLIPSIS
+    'var1_lname = 1.0E+2_kind_phys*var2_lname'
+
     # Test that a 2-D var with unit conversion m->km works
     >>> VarCompatObj("var_stdname", "real", "kind_phys", "m",  ['horizontal_dimension'], "var1_lname", False, \
                      "var_stdname", "real", "kind_phys", "km", ['horizontal_dimension'], "var2_lname", False, \

test/var_compatibility_test/effr_calc.F90

@@ -16,7 +16,8 @@ module effr_calc
    !! \htmlinclude arg_table_effr_calc_run.html
    !!
    subroutine effr_calc_run(ncol, nlev, effrr_in, effrg_in, effrl_inout, &
-                            effri_out, effrs_inout, has_graupel, errmsg, errflg)
+                            effri_out, effrs_inout, has_graupel, scalar_var, &
+                            errmsg, errflg)
 
       integer,            intent(in)    :: ncol
       integer,            intent(in)    :: nlev
@@ -26,6 +27,7 @@ subroutine effr_calc_run(ncol, nlev, effrr_in, effrg_in, effrl_inout, &
       real(kind_phys),    intent(out)   :: effri_out(:,:)
       real(8),intent(inout) :: effrs_inout(:,:)
       logical,            intent(in)    :: has_graupel
+      real(kind_phys),    intent(inout) :: scalar_var
       character(len=512), intent(out)   :: errmsg
       integer,            intent(out)   :: errflg
       !----------------------------------------------------------------
@@ -44,6 +46,7 @@ subroutine effr_calc_run(ncol, nlev, effrr_in, effrg_in, effrl_inout, &
       effrl_inout = min(max(effrl_inout,re_qc_min),re_qc_max)
       effri_out   = re_qi_avg
       effrs_inout = effrs_inout + 10.0 ! in micrometer
+      scalar_var = 2.0 ! in km
 
    end subroutine effr_calc_run
 

test/var_compatibility_test/effr_calc.meta

@@ -66,6 +66,14 @@
   dimensions = ()
   type = logical
   intent = in
+[ scalar_var ]
+  standard_name = scalar_variable_for_testing
+  long_name = scalar variable for testing
+  units = km
+  dimensions = ()
+  type = real
+  kind = kind_phys
+  intent = inout
 [ errmsg ]
   standard_name = ccpp_error_message
   long_name = Error message for error handling in CCPP

test/var_compatibility_test/run_test

@@ -140,6 +140,7 @@ required_vars_var_compatibility="${required_vars_var_compatibility},flag_indicat
 required_vars_var_compatibility="${required_vars_var_compatibility},horizontal_dimension"
 required_vars_var_compatibility="${required_vars_var_compatibility},horizontal_loop_begin"
 required_vars_var_compatibility="${required_vars_var_compatibility},horizontal_loop_end"
+required_vars_var_compatibility="${required_vars_var_compatibility},scalar_variable_for_testing"
 required_vars_var_compatibility="${required_vars_var_compatibility},vertical_layer_dimension"
 input_vars_var_compatibility="effective_radius_of_stratiform_cloud_graupel"
 input_vars_var_compatibility="${input_vars_var_compatibility},effective_radius_of_stratiform_cloud_liquid_water_particle"
@@ -149,11 +150,13 @@ input_vars_var_compatibility="${input_vars_var_compatibility},flag_indicating_cl
 input_vars_var_compatibility="${input_vars_var_compatibility},horizontal_dimension"
 input_vars_var_compatibility="${input_vars_var_compatibility},horizontal_loop_begin"
 input_vars_var_compatibility="${input_vars_var_compatibility},horizontal_loop_end"
+input_vars_var_compatibility="${input_vars_var_compatibility},scalar_variable_for_testing"
 input_vars_var_compatibility="${input_vars_var_compatibility},vertical_layer_dimension"
 output_vars_var_compatibility="ccpp_error_code,ccpp_error_message"
 output_vars_var_compatibility="${output_vars_var_compatibility},effective_radius_of_stratiform_cloud_ice_particle"
 output_vars_var_compatibility="${output_vars_var_compatibility},effective_radius_of_stratiform_cloud_liquid_water_particle"
 output_vars_var_compatibility="${output_vars_var_compatibility},effective_radius_of_stratiform_cloud_snow_particle"
+output_vars_var_compatibility="${output_vars_var_compatibility},scalar_variable_for_testing"
 
 ##
 ## Run a database report and check the return string

test/var_compatibility_test/test_host.F90

@@ -351,28 +351,31 @@ program test
 
    character(len=cs), target :: test_parts1(1) = (/ 'radiation       ' /)
 
-   character(len=cm), target :: test_invars1(5) = (/                          &
+   character(len=cm), target :: test_invars1(6) = (/                          &
         'effective_radius_of_stratiform_cloud_rain_particle        ',         &
         'effective_radius_of_stratiform_cloud_liquid_water_particle',         &
         'effective_radius_of_stratiform_cloud_snow_particle        ',         &
         'effective_radius_of_stratiform_cloud_graupel              ',         &
+        'scalar_variable_for_testing                               ',         &
         'flag_indicating_cloud_microphysics_has_graupel            '/)
 
-   character(len=cm), target :: test_outvars1(5) = (/                         &
+   character(len=cm), target :: test_outvars1(6) = (/                         &
         'ccpp_error_code                                           ',         &
         'ccpp_error_message                                        ',         &
         'effective_radius_of_stratiform_cloud_ice_particle         ',         &
         'effective_radius_of_stratiform_cloud_liquid_water_particle',         &
-        'effective_radius_of_stratiform_cloud_snow_particle        ' /)
+        'effective_radius_of_stratiform_cloud_snow_particle        ',         &
+        'scalar_variable_for_testing                               ' /)
 
-   character(len=cm), target :: test_reqvars1(8) = (/                         &
+   character(len=cm), target :: test_reqvars1(9) = (/                         &
         'ccpp_error_code                                           ',         &
         'ccpp_error_message                                        ',         &
         'effective_radius_of_stratiform_cloud_rain_particle        ',         &
         'effective_radius_of_stratiform_cloud_ice_particle         ',         &
         'effective_radius_of_stratiform_cloud_liquid_water_particle',         &
         'effective_radius_of_stratiform_cloud_snow_particle        ',         &
         'effective_radius_of_stratiform_cloud_graupel              ',         &
+        'scalar_variable_for_testing                               ',         &
         'flag_indicating_cloud_microphysics_has_graupel            '/)
 
     type(suite_info) :: test_suites(1)

test/var_compatibility_test/test_host_data.F90

@@ -10,6 +10,7 @@ module test_host_data
           effrl,                                     & ! effective radius of cloud liquid water
           effri,                                     & ! effective radius of cloud ice
           effrg                                        ! effective radius of cloud graupel
+     real(kind_phys) :: scalar_var
   end type physics_state
 
   public allocate_physics_state

test/var_compatibility_test/test_host_data.meta

@@ -33,3 +33,10 @@
   type = real
   kind = kind_phys
   active = (flag_indicating_cloud_microphysics_has_graupel)
+[scalar_var]
+  standard_name = scalar_variable_for_testing
+  long_name = unused scalar variable
+  units = m
+  dimensions = ()
+  type = real
+  kind = kind_phys

test/var_compatibility_test/test_host_mod.F90

@@ -27,6 +27,7 @@ subroutine init_data()
     phys_state%effrr = 1.0E-3 ! 1000 microns, in meter
     phys_state%effrl = 1.0E-4 ! 100 microns, in meter
     phys_state%effri = 5.0E-5 ! 50 microns, in meter
+    phys_state%scalar_var = 1.0 ! in m
     effrs            = 5.0E-4 ! 500 microns, in meter
     if (mp_has_graupel) then
        phys_state%effrg = 2.5E-4 ! 250 microns, in meter
@@ -40,6 +41,7 @@ logical function compare_data()
     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 :: scalar_expected = 2.0E3 ! 2 km, in meter
     real(kind_phys), parameter :: tolerance = 1.0E-6      ! used as scaling factor for expected value
 
     compare_data = .true.
@@ -68,6 +70,12 @@ logical function compare_data()
         compare_data = .false.
     end if
 
+    if (abs(  phys_state%scalar_var - scalar_expected) > tolerance*scalar_expected) then
+        write(6, '(a,e16.7,a,e16.7)') 'Error: max diff of            scalar_var from expected value exceeds tolerance: ', &
+                                      abs(  phys_state%scalar_var - scalar_expected), ' > ', tolerance*scalar_expected
+        compare_data = .false.
+    end if
+
   end function compare_data
 
 end module test_host_mod

test/var_compatibility_test/test_reports.py

@@ -72,11 +72,13 @@ def usage(errmsg=None):
                           "effective_radius_of_stratiform_cloud_rain_particle",
                           "effective_radius_of_stratiform_cloud_snow_particle",
                           "effective_radius_of_stratiform_cloud_graupel",
+                          "scalar_variable_for_testing",
                           "flag_indicating_cloud_microphysics_has_graupel"]
 _OUTPUT_VARS_VAR_ACTION = ["ccpp_error_code", "ccpp_error_message",
                            "effective_radius_of_stratiform_cloud_ice_particle",
                            "effective_radius_of_stratiform_cloud_liquid_water_particle",
-                           "effective_radius_of_stratiform_cloud_snow_particle"]
+                           "effective_radius_of_stratiform_cloud_snow_particle",
+                           "scalar_variable_for_testing"]
 _REQUIRED_VARS_VAR_ACTION = _INPUT_VARS_VAR_ACTION + _OUTPUT_VARS_VAR_ACTION
 
 def fields_string(field_type, field_list, sep):