change check_missing to function; use is_missing_value in more places in scm_input

Author: grantfirl

scm/src/scm_input.F90

@@ -4,7 +4,8 @@
 
 module scm_input
 
-use data_qc, only: is_missing_value
+use missing_values, only: missing_value
+use data_qc, only: is_missing_value, check_missing
 use scm_kinds, only: sp, dp, qp
 use scm_type_defs, only: character_length
 use netcdf
@@ -217,7 +218,7 @@ end subroutine get_config_nml
 !! "processed_case_input" directory.
 subroutine get_case_init(scm_state, scm_input)
   use scm_type_defs, only : scm_state_type, scm_input_type
-  use NetCDF_read, only: NetCDF_read_var, check, missing_value
+  use NetCDF_read, only: NetCDF_read_var, check
   type(scm_state_type), intent(inout) :: scm_state
   type(scm_input_type), target, intent(inout) :: scm_input
 
@@ -800,7 +801,7 @@ subroutine get_case_init(scm_state, scm_input)
   scm_input%input_snwdph   = input_snwdph
   scm_input%input_snoalb   = input_snoalb
   scm_input%input_sncovr   = input_sncovr
-  if (input_area > missing_value) then
+  if (.not. is_missing_value(input_area)) then
     scm_input%input_area   = input_area
   end if
   scm_input%input_tsfco    = input_tsfco
@@ -949,7 +950,7 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
   !corresponds to the DEPHY-SCM specs, version 1
 
   use scm_type_defs, only : scm_state_type, scm_input_type
-  use NetCDF_read, only: NetCDF_read_var, NetCDF_read_att, NetCDF_conditionally_read_var, check, missing_value, missing_value_int
+  use NetCDF_read, only: NetCDF_read_var, NetCDF_read_att, NetCDF_conditionally_read_var, check
   use scm_physical_constants, only: con_hvap, con_hfus, con_cp, con_rocp, con_rd
   use scm_utils, only: find_vertical_index_pressure, find_vertical_index_height
 
@@ -1515,7 +1516,7 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
     call NetCDF_read_var(ncid, "pa", .True., input_pres)
     !zh could be defined in addition to lev, use if so
     call NetCDF_read_var(ncid, "zh", .False., input_height)
-    if (input_height(1,1) == missing_value) then
+    if (is_missing_value(input_height(1,1))) then
       do i=1, input_n_init_times
         do k=1, input_n_lev
           input_height(k,i) = input_lev(k)
@@ -1526,7 +1527,7 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
     call NetCDF_read_var(ncid, "zh", .True., input_height)
     !pa could be defined in addition to lev, use if so
     call NetCDF_read_var(ncid, "pa", .False., input_pres)
-    if (input_pres(1,1) == missing_value) then
+    if (is_missing_value(input_pres(1,1))) then
       do i=1, input_n_init_times
         do k=1, input_n_lev
           input_pres(k,i) = input_lev(k)
@@ -1653,15 +1654,15 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
   call NetCDF_read_var(ncid, "ps_forc", .True., input_force_pres_surf)
   !zh_forc and pa_forc should be present according to the DEPHY standard; if not, assume that zh_forc = input_height and pa_forc = input_pres
   call NetCDF_read_var(ncid, "zh_forc", .False., input_force_height)
-  if (input_force_height(1,1) == missing_value) then
+  if (is_missing_value(input_force_height(1,1))) then
     do i=1, input_n_forcing_times
       do k=1, input_n_lev
         input_force_height(k,i) = input_height(k,1)
       end do
     end do
   end if
   call NetCDF_read_var(ncid, "pa_forc", .False., input_force_pres)
-  if (input_force_pres(1,1) == missing_value) then
+  if (is_missing_value(input_force_pres(1,1))) then
     do i=1, input_n_forcing_times
       do k=1, input_n_lev
         input_force_pres(k,i) = input_pres(k,1)
@@ -2164,7 +2165,7 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
     end if
 
     !kinematic surface fluxes are specified (but may need to be converted)
-    if (is_missing_value(maxval(input_force_wpthetap(:)))) then
+    if (check_missing(input_force_wpthetap(:))) then
       write(*,*) 'The global attribute surfaceForcing in '//trim(adjustl(scm_state%case_name))//'.nc indicates that the variable wpthetap should be present, but it is missing. Stopping ...'
       error stop "The global attribute surfaceForcing indicates that the variable wpthetap should be present, but it is missing."
     else
@@ -2176,30 +2177,30 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
     end if
 
     !if mixing ratios are present, and not specific humidities, convert from mixing ratio to specific humidities
-    if ((is_missing_value(maxval(input_force_wpqvp(:))) .and. &
-         is_missing_value(maxval(input_force_wpqtp(:)))) &
+    if ((check_missing(input_force_wpqvp(:)) .and. &
+         check_missing(input_force_wpqtp(:))) &
          .and. &
-        (.not. is_missing_value(maxval(input_force_wprvp(:))) .or. &
-         .not. is_missing_value(maxval(input_force_wprtp(:))))) then
-       if (.not. is_missing_value(maxval(input_force_wprvp(:)))) then
+        (.not. check_missing(input_force_wprvp(:)) .or. &
+         .not. check_missing(input_force_wprtp(:)))) then
+       if (.not. check_missing(input_force_wprvp(:))) then
          do i=1, input_n_forcing_times
            input_force_wpqvp(i) = input_force_wprvp(i)/&
               (1.0 + input_force_wprvp(i))
          end do
        end if
-       if (.not. is_missing_value(maxval(input_force_wprtp(:)))) then
+       if (.not. check_missing(input_force_wprtp(:))) then
          do i=1, input_n_forcing_times
            input_force_wpqtp(i) = input_force_wprtp(i)/&
               (1.0 + input_force_wprtp(i))
          end do
        end if
     end if
 
-    if (is_missing_value(maxval(input_force_wpqvp(:))) .and. is_missing_value(maxval(input_force_wpqtp(:)))) then
+    if (check_missing(input_force_wpqvp(:)) .and. check_missing(input_force_wpqtp(:))) then
       write(*,*) 'The global attribute surfaceForcing in '//trim(adjustl(scm_state%case_name))//'.nc indicates that the variable wpqvp, wpqtp, wprvp, or wprtp should be present, but all are missing. Stopping ...'
       error stop "The global attribute surfaceForcing indicates that the variable wpqvp, wpqtp, wprvp, or wprtp should be present, but all are missing."
     else
-      if (.not. is_missing_value(maxval(input_force_wpqvp(:)))) then !use wpqvp if available
+      if (.not. check_missing(input_force_wpqvp(:))) then !use wpqvp if available
         scm_input%input_lh_flux_sfc_kin = input_force_wpqvp(:)
       else
         !surface total flux of water should just be vapor
@@ -2229,14 +2230,14 @@ subroutine get_case_init_DEPHY(scm_state, scm_input)
     end if
 
 
-    if (is_missing_value(maxval(input_force_sfc_sens_flx(:)))) then
+    if (check_missing(input_force_sfc_sens_flx(:))) then
       write(*,*) 'The global attribute surfaceForcing in '//trim(adjustl(scm_state%case_name))//'.nc indicates that the variable sfc_sens_flx should be present, but it is missing. Stopping ...'
       error stop "The global attribute surfaceForcing in indicates that the variable sfc_sens_flx should be present, but it is missing."
     else
       scm_input%input_sh_flux_sfc = input_force_sfc_sens_flx(:)
     end if
 
-    if (is_missing_value(maxval(input_force_sfc_lat_flx(:)))) then
+    if (check_missing(input_force_sfc_lat_flx(:))) then
       write(*,*) 'The global attribute surfaceForcing in '//trim(adjustl(scm_state%case_name))//'.nc indicates that the variable sfc_lat_flx should be present, but it is missing. Stopping ...'
       error stop "The global attribute surfaceForcing indicates that the variable sfc_lat_flx should be present, but it is missing."
     else

scm/src/scm_type_defs.F90

@@ -1058,7 +1058,7 @@ subroutine physics_set(physics, scm_input, scm_state)
     !this should be utilized for variables that cannot be modified or "forced" by the SCM;
     !most of this routine follows what is in FV3/io/FV3GFS_io.F90/sfc_prop_restart_read
     use scm_physical_constants, only: con_tice
-    use data_qc, only: conditionally_set_var, check_missing
+    use data_qc, only: conditionally_set_var
     use NetCDF_read, only: missing_value
 
     class(physics_type) :: physics

scm/src/scm_utils.F90

@@ -60,53 +60,53 @@ function is_missing_value_dp(var) result(missing)
     end if
   end function is_missing_value_dp
 
-  subroutine check_missing_int_0d(var, missing)
+  function check_missing_int_0d(var) result(missing)
     integer, intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if (var == missing_value_int) missing = .true.
-  end subroutine check_missing_int_0d
+  end function check_missing_int_0d
 
-  subroutine check_missing_int_1d(var, missing)
+  function check_missing_int_1d(var) result(missing)
     integer, dimension(:), intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if ( ANY(var == missing_value_int)) missing = .true.
-  end subroutine check_missing_int_1d
+  end function check_missing_int_1d
 
-  subroutine check_missing_real_sp_0d(var, missing)
+  function check_missing_real_sp_0d(var) result(missing)
     real(kind=sp), intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if (var == missing_value_sp) missing = .true.
-  end subroutine check_missing_real_sp_0d
+  end function check_missing_real_sp_0d
 
-  subroutine check_missing_real_sp_1d(var, missing)
+  function check_missing_real_sp_1d(var) result(missing)
     real(kind=sp), dimension(:), intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if ( ANY(var == missing_value_sp)) missing = .true.
-  end subroutine check_missing_real_sp_1d
+  end function check_missing_real_sp_1d
 
-  subroutine check_missing_real_dp_0d(var, missing)
+  function check_missing_real_dp_0d(var) result(missing)
     real(kind=kind_scm_dp), intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if (var == missing_value_dp) missing = .true.
-  end subroutine check_missing_real_dp_0d
+  end function check_missing_real_dp_0d
 
-  subroutine check_missing_real_dp_1d(var, missing)
+  function check_missing_real_dp_1d(var) result(missing)
     real(kind=kind_scm_dp), dimension(:), intent(in) :: var
-    logical, intent(out) :: missing
+    logical :: missing
 
     missing = .false.
     if ( ANY(var == missing_value_dp)) missing = .true.
-  end subroutine check_missing_real_dp_1d
+  end function check_missing_real_dp_1d
 
   subroutine conditionally_set_int_var_0d(input, set_var, input_name, req, missing)
     integer, intent(in) :: input
@@ -115,7 +115,7 @@ subroutine conditionally_set_int_var_0d(input, set_var, input_name, req, missing
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input
@@ -135,7 +135,7 @@ subroutine conditionally_set_int_var_1d(input, set_var, input_name, req, missing
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input
@@ -155,7 +155,7 @@ subroutine conditionally_set_real_sp_var_0d(input, set_var, input_name, req, mis
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input
@@ -175,7 +175,7 @@ subroutine conditionally_set_real_sp_var_1d(input, set_var, input_name, req, mis
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input
@@ -195,7 +195,7 @@ subroutine conditionally_set_real_dp_var_0d(input, set_var, input_name, req, mis
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input
@@ -215,7 +215,7 @@ subroutine conditionally_set_real_dp_var_1d(input, set_var, input_name, req, mis
     logical, intent(in) :: req
     logical, intent(out) :: missing
 
-    call check_missing(input, missing)
+    missing = check_missing(input)
 
     if (.not. missing) then
       set_var = input