Removed sort_obs_inc from the QCF table; removed code related to the sort_obs_inc logical from filter_assim and obs_increment in assim_tools_mod.f90 and obs_inc_info in algorithm_info_mod.f90

Author: mjs2369

assimilation_code/modules/assimilation/algorithm_info_mod.f90

@@ -67,7 +67,7 @@ module algorithm_info_mod
 
 type obs_inc_info_type
    integer               :: filter_kind
-   logical               :: sort_obs_inc, spread_restoration
+   logical               :: spread_restoration
    logical               :: bounded_below, bounded_above
    real(r8)              :: lower_bound,   upper_bound
 end type
@@ -82,7 +82,7 @@ module algorithm_info_mod
 
 integer, parameter :: HEADER_LINES = 2
 character(len=129), dimension(4) :: header1
-character(len=129), dimension(27) :: header2
+character(len=129), dimension(26) :: header2
 
 character(len=129), allocatable :: specified_qtys(:)
 type(algorithm_info_type), allocatable :: qcf_table_data(:)
@@ -177,7 +177,7 @@ subroutine read_qcf_table(qcf_table_filename)
                    qcf_table_data(row)%probit_state%lower_bound, qcf_table_data(row)%probit_state%upper_bound, dist_type_string_probit_extended_state, &
                    qcf_table_data(row)%probit_extended_state%bounded_below, qcf_table_data(row)%probit_extended_state%bounded_above, &
                    qcf_table_data(row)%probit_extended_state%lower_bound, qcf_table_data(row)%probit_extended_state%upper_bound, &
-                   filter_kind_string, qcf_table_data(row)%obs_inc_info%sort_obs_inc, qcf_table_data(row)%obs_inc_info%spread_restoration, &
+                   filter_kind_string, qcf_table_data(row)%obs_inc_info%spread_restoration, &
                    qcf_table_data(row)%obs_inc_info%bounded_below, qcf_table_data(row)%obs_inc_info%bounded_above, &
                    qcf_table_data(row)%obs_inc_info%lower_bound, qcf_table_data(row)%obs_inc_info%upper_bound
 
@@ -415,12 +415,11 @@ end subroutine probit_dist_info
 !------------------------------------------------------------------------
 
 
-subroutine obs_inc_info(obs_qty, filter_kind, sort_obs_inc, spread_restoration, &
+subroutine obs_inc_info(obs_qty, filter_kind, spread_restoration, &
    bounded_below, bounded_above, lower_bound, upper_bound)
 
 integer,  intent(in)  :: obs_qty
 integer,  intent(inout) :: filter_kind
-logical,  intent(inout) :: sort_obs_inc
 logical,  intent(inout) :: spread_restoration
 logical,  intent(inout) :: bounded_below, bounded_above
 real(r8), intent(inout) :: lower_bound,  upper_bound
@@ -440,7 +439,7 @@ subroutine obs_inc_info(obs_qty, filter_kind, sort_obs_inc, spread_restoration,
    filter_kind = BOUNDED_NORMAL_RHF
    bounded_below = .false.;    bounded_above = .false.
    lower_bound   = missing_r8; upper_bound   = missing_r8
-   sort_obs_inc = .false.; spread_restoration = .false.
+   spread_restoration = .false.
    return
 endif
 
@@ -455,13 +454,12 @@ subroutine obs_inc_info(obs_qty, filter_kind, sort_obs_inc, spread_restoration,
    filter_kind = BOUNDED_NORMAL_RHF
    bounded_below = .false.;    bounded_above = .false.
    lower_bound   = missing_r8; upper_bound   = missing_r8
-   sort_obs_inc = .false.; spread_restoration = .false.
-   ! Default settings for now for Icepack and tracer model tests (sort_obs_inc, spread_restoration)
+   spread_restoration = .false.
+   ! Default settings for now for Icepack and tracer model tests (spread_restoration)
 
    else
 
       filter_kind = qcf_table_data(QTY_loc(1))%obs_inc_info%filter_kind
-      sort_obs_inc = qcf_table_data(QTY_loc(1))%obs_inc_info%sort_obs_inc
       spread_restoration = qcf_table_data(QTY_loc(1))%obs_inc_info%spread_restoration
       bounded_below = qcf_table_data(QTY_loc(1))%obs_inc_info%bounded_below
       bounded_above = qcf_table_data(QTY_loc(1))%obs_inc_info%bounded_above
@@ -584,9 +582,8 @@ subroutine log_qcf_table_data()
                qcf_table_data(row)%probit_state%lower_bound, qcf_table_data(row)%probit_state%upper_bound, qcf_table_data(row)%probit_extended_state%dist_type, &
                qcf_table_data(row)%probit_extended_state%bounded_below, qcf_table_data(row)%probit_extended_state%bounded_above, &
                qcf_table_data(row)%probit_extended_state%lower_bound, qcf_table_data(row)%probit_extended_state%upper_bound, &
-               qcf_table_data(row)%obs_inc_info%filter_kind, qcf_table_data(row)%obs_inc_info%sort_obs_inc, &
-               qcf_table_data(row)%obs_inc_info%spread_restoration, qcf_table_data(row)%obs_inc_info%bounded_below, qcf_table_data(row)%obs_inc_info%bounded_above, &
-               qcf_table_data(row)%obs_inc_info%lower_bound, qcf_table_data(row)%obs_inc_info%upper_bound
+               qcf_table_data(row)%obs_inc_info%filter_kind, qcf_table_data(row)%obs_inc_info%spread_restoration, qcf_table_data(row)%obs_inc_info%bounded_below, &
+               qcf_table_data(row)%obs_inc_info%bounded_above, qcf_table_data(row)%obs_inc_info%lower_bound, qcf_table_data(row)%obs_inc_info%upper_bound
 call error_handler(E_MSG, 'log_qcf_table_data:', trim(log_msg), source)
 end do
 

assimilation_code/modules/assimilation/assim_tools_mod.f90

@@ -145,7 +145,7 @@ module assim_tools_mod
 !
 integer  :: filter_kind                     = 1
 real(r8) :: cutoff                          = 0.2_r8
-logical  :: sort_obs_inc                    = .false.
+logical  :: sort_obs_inc                    = .true.
 logical  :: spread_restoration              = .false.
 logical  :: sampling_error_correction       = .false.
 integer  :: adaptive_localization_threshold = -1
@@ -421,22 +421,6 @@ subroutine filter_assim(ens_handle, obs_ens_handle, obs_seq, keys,           &
 ! Need to give create_mean_window the mean copy
 call create_mean_window(ens_handle, ENS_MEAN_COPY, distribute_mean)
 
-! filter kinds 1 and 8 return sorted increments, however non-deterministic
-! inflation can scramble these. the sort is expensive, so help users get better
-! performance by rejecting namelist combinations that do unneeded work.
-if (sort_obs_inc) then
-   if(deterministic_inflate(inflate) .and. ((filter_kind == 1) .or. (filter_kind == 8))) then
-      write(msgstring,  *) 'With a deterministic filter [assim_tools_nml:filter_kind = ',filter_kind,']'
-      write(msgstring2, *) 'and deterministic inflation [filter_nml:inf_deterministic = .TRUE.]'
-      write(msgstring3, *) 'assim_tools_nml:sort_obs_inc = .TRUE. is not needed and is expensive.'
-      call error_handler(E_MSG,'', '')  ! whitespace
-      call error_handler(E_MSG,'WARNING filter_assim:', msgstring, source, &
-                         text2=msgstring2,text3=msgstring3)
-      call error_handler(E_MSG,'', '')  ! whitespace
-      sort_obs_inc = .FALSE.
-   endif
-endif
-
 ! Open the localization diagnostics file
 if(output_localization_diagnostics .and. my_task_id() == 0) &
   localization_unit = open_file(localization_diagnostics_file, action = 'append')
@@ -987,7 +971,7 @@ subroutine obs_increment(ens_in, ens_size, obs, obs_var, obs_kind, obs_inc, &
 bounded_below = .false.;      lower_bound = 0.0_r8
 bounded_above = .false.;      upper_bound = 0.0_r8
 
-call obs_inc_info(obs_kind, filter_kind, sort_obs_inc, spread_restoration, &
+call obs_inc_info(obs_kind, filter_kind, spread_restoration, &
         bounded_below, bounded_above, lower_bound, upper_bound)
 
 ! Could add logic to check on sort being true when not needed.
@@ -1082,21 +1066,6 @@ subroutine obs_increment(ens_in, ens_size, obs, obs_var, obs_kind, obs_inc, &
 ! Add in the extra increments if doing observation space covariance inflation
 if(do_obs_inflate(inflate)) obs_inc = obs_inc + inflate_inc
 
-! To minimize regression errors, may want to sort to minimize increments
-! This makes sense for any of the non-deterministic algorithms
-! By doing it here, can take care of both standard non-deterministic updates
-! plus non-deterministic obs space covariance inflation. This is expensive, so
-! don't use it if it's not needed.
-if (sort_obs_inc) then
-   new_val = ens_in + obs_inc
-   ! Sorting to make increments as small as possible
-   call index_sort(ens_in, ens_index, ens_size)
-   call index_sort(new_val, new_index, ens_size)
-   do i = 1, ens_size
-      obs_inc(ens_index(i)) = new_val(new_index(i)) - ens_in(ens_index(i))
-   end do
-endif
-
 ! Get the net change in spread if obs space inflation was used
 if(do_obs_inflate(inflate)) net_a = net_a * sqrt(my_cov_inflate)