address review comments; add test with dimensionless output variable

peverwhee · peverwhee · commit 4a482207a679 · 2025-08-11T14:32:42.000-06:00
diff --git a/src/data/write_init_files.py b/src/data/write_init_files.py
@@ -1255,7 +1255,7 @@ def write_phys_check_subroutine(outfile, host_dict, host_vars, host_imports,
             call_str += "min_difference, min_relative_value, is_first, diff_found)"
         else:
             # For check field, don't endrun
-            call_str = "! do nothing - variable can't be checked"
+            call_str = f"! do nothing - '{var_locname}' can't be checked against a file"
         # end if
         # Add string to dictionary:
         call_string_dict[call_string_key] = call_str
@@ -1418,7 +1418,7 @@ def write_phys_check_subroutine(outfile, host_dict, host_vars, host_imports,
     # Generate error message if required variable isn't found:
     outfile.write("case (no_exist_idx)", 5)
     outfile.blank_line()
-    outfile.comment("If an index was never found, then do nothing. We won't try to check these.", 6)
+    outfile.comment("If the index for an output variable was not found, then do nothing. We won't try to check these.", 6)
     outfile.blank_line()
 
     # start default case steps:
diff --git a/test/unit/python/sample_files/write_init_files/phys_vars_init_check_simple.F90 b/test/unit/python/sample_files/write_init_files/phys_vars_init_check_simple.F90
@@ -33,20 +33,21 @@ module phys_vars_init_check_simple
    integer, public, parameter ::          PARAM = 2
    integer, public, parameter :: READ_FROM_FILE = 3
    ! Total number of physics-related variables:
-   integer, public, parameter :: phys_var_num = 3
+   integer, public, parameter :: phys_var_num = 4
    integer, public, parameter :: phys_const_num = 16
 
    !Max length of physics-related variable standard names:
    integer, public, parameter :: std_name_len = 25
 
    ! Max length of input (IC) file variable names:
-   integer, public, parameter :: ic_name_len = 5
+   integer, public, parameter :: ic_name_len = 9
 
    ! Physics-related input variable standard names:
    character(len=25), public, protected :: phys_var_stdnames(phys_var_num) = (/ &
       'potential_temperature    ', &
       'air_pressure_at_sea_level', &
-      'tendency_of_peverwhee    ' /)
+      'tendency_of_peverwhee    ', &
+      'scalar_variable_llama    ' /)
 
    character(len=36), public, protected :: phys_const_stdnames(phys_const_num) = (/ &
       "ccpp_constituent_minimum_values     ", &
@@ -66,19 +67,22 @@ module phys_vars_init_check_simple
       "suite_name                          ", &
       "suite_part                          " /)
    !Array storing all registered IC file input names for each variable:
-   character(len=5), public, protected :: input_var_names(1, phys_var_num) = reshape((/ &
-      'theta', &
-      'slp  ', &
-      'ptend' /), (/1, phys_var_num/))
+   character(len=9), public, protected :: input_var_names(1, phys_var_num) = reshape((/ &
+      'theta    ', &
+      'slp      ', &
+      'ptend    ', &
+      'var_nodim' /), (/1, phys_var_num/))
 
    ! Array indicating whether or not variable is protected:
    logical, public, protected :: protected_vars(phys_var_num)= (/ &
+      .false., &
       .false., &
       .false., &
       .false. /)
 
    ! Variable state (UNINITIALIZED, INTIIALIZED, PARAM or READ_FROM_FILE):
    integer, public, protected :: initialized_vars(phys_var_num)= (/ &
+      UNINITIALIZED, &
       UNINITIALIZED, &
       UNINITIALIZED, &
       UNINITIALIZED /)
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_4D.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_4D.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_bvd.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_bvd.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_cnst.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_cnst.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_constituent_dim.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_constituent_dim.F90
@@ -329,7 +329,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_ddt.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_ddt.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_ddt2.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_ddt2.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_ddt_array.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_ddt_array.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_host_var.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_host_var.F90
@@ -317,7 +317,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_initial_value.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_initial_value.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_mf.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_mf.F90
@@ -322,7 +322,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_no_horiz.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_no_horiz.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_noreq.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_noreq.F90
@@ -313,7 +313,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_param.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_param.F90
@@ -324,7 +324,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_protect.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_protect.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_scalar.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_scalar.F90
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
diff --git a/test/unit/python/sample_files/write_init_files/physics_inputs_simple.F90 b/test/unit/python/sample_files/write_init_files/physics_inputs_simple.F90
@@ -235,7 +235,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
       use cam_pio_utils,               only: cam_pio_openfile, cam_pio_closefile
       use ccpp_constituent_prop_mod,   only: ccpp_constituent_prop_ptr_t
       use phys_vars_init_check_simple, only: phys_var_num, phys_var_stdnames, input_var_names, std_name_len
-      use physics_types_simple,        only: ptend, theta
+      use physics_types_simple,        only: ptend, theta, var_nodim
 
       ! Dummy arguments
       character(len=SHR_KIND_CL), intent(in) :: file_name
@@ -321,7 +321,7 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
 
                case (no_exist_idx)
 
-                  ! If an index was never found, then do nothing. We won't try to check these.
+                  ! If the index for an output variable was not found, then do nothing. We won't try to check these.
 
                case default
 
@@ -336,6 +336,9 @@ subroutine physics_check_data(file_name, suite_names, timestep, min_difference,
                      call check_field(file, input_var_names(:,name_idx), timestep, ptend, 'tendency_of_peverwhee', min_difference,                     &
                           min_relative_value, is_first, diff_found)
 
+                  case ('scalar_variable_llama')
+                     ! do nothing - 'var_nodim' can't be checked against a file
+
                   end select !check variables
                   if (diff_found) then
                      overall_diff_found = .true.
diff --git a/test/unit/python/sample_files/write_init_files/simple_build_cache_template.xml b/test/unit/python/sample_files/write_init_files/simple_build_cache_template.xml
@@ -1,10 +1,10 @@
 <CAMBuildCache>
    TAG1
    <registry>
-      <generate_init_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="a3ac9f41d4c30a0b1f9e238d31d2e51e0bfe609e" />
+      <generate_init_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="5b65f718cb93feb881f9cd98d343e21103f4a40b" />
       TAG2
-      <generate_registry_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="a3ac9f41d4c30a0b1f9e238d31d2e51e0bfe609e" />
-      <registry_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="a3ac9f41d4c30a0b1f9e238d31d2e51e0bfe609e" />
+      <generate_registry_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="5b65f718cb93feb881f9cd98d343e21103f4a40b" />
+      <registry_file file_path="$TEST_SOURCE_MODS_DIR/simple_reg.xml" hash="5b65f718cb93feb881f9cd98d343e21103f4a40b" />
       <dycore>none</dycore>
    </registry>
    <CCPP>
diff --git a/test/unit/python/sample_files/write_init_files/simple_reg.xml b/test/unit/python/sample_files/write_init_files/simple_reg.xml
@@ -18,6 +18,10 @@
       <dimensions>horizontal_dimension</dimensions>
       <ic_file_input_names>ptend</ic_file_input_names>
     </variable>
+    <variable local_name="var_nodim" standard_name="scalar_variable_llama"
+	    units="llamas s-2" type="integer">
+      <initial_value>2</initial_value>
+    </variable>
     <variable local_name="eddy_len" standard_name="eddy_length_scale"
               units="m" type="real" kind="kind_phys"  allocatable="pointer">
       <dimensions>horizontal_dimension</dimensions>
diff --git a/test/unit/python/sample_files/write_init_files/temp_adjust.F90 b/test/unit/python/sample_files/write_init_files/temp_adjust.F90
@@ -18,7 +18,7 @@ MODULE temp_adjust
 !! \htmlinclude arg_table_temp_adjust_run.html
 !!
   SUBROUTINE temp_adjust_run(nbox, lev, temp_layer,    &
-    slp, timestep, ptend, errmsg, errflg)
+    slp, timestep, ptend, llama, errmsg, errflg)
 !----------------------------------------------------------------
    IMPLICIT NONE
 !----------------------------------------------------------------
@@ -28,6 +28,7 @@ SUBROUTINE temp_adjust_run(nbox, lev, temp_layer,    &
    real(kind_phys),    intent(in)    :: slp(:)
    real(kind_phys),    intent(in)    :: timestep
    real(kind_phys),    intent(out)   :: ptend(:)
+   integer,            intent(out)   :: llama
    character(len=512), intent(out)   :: errmsg
    integer,            intent(out)   :: errflg
 !----------------------------------------------------------------
@@ -39,6 +40,7 @@ SUBROUTINE temp_adjust_run(nbox, lev, temp_layer,    &
     errflg = 0
 
     ptend = 0._kind_phys
+    llama = 12
 
     do box_index = 1, nbox
        do lev_index = 1, lev
diff --git a/test/unit/python/sample_files/write_init_files/temp_adjust.meta b/test/unit/python/sample_files/write_init_files/temp_adjust.meta
@@ -44,6 +44,12 @@
   dimensions = (horizontal_loop_extent)
   type = real | kind = kind_phys
   intent = out
+[ llama ]
+  standard_name = scalar_variable_llama
+  units = llamas s-2
+  dimensions = ()
+  type = integer
+  intent = out
 [ errmsg ]
   standard_name = ccpp_error_message
   long_name = Error message for error handling in CCPP
