Convergence on ustar for CICE. (CICE-Consortium#452) (#5)

* Add atmiter_conv to CICE

* Add documentation

* trigger build the docs

Co-authored-by: David A. Bailey <dbailey@ucar.edu>

cicecore/cicedynB/general/ice_init.F90

@@ -117,7 +117,7 @@ subroutine input_data
         ahmax, R_ice, R_pnd, R_snw, dT_mlt, rsnw_mlt, emissivity, &
         mu_rdg, hs0, dpscale, rfracmin, rfracmax, pndaspect, hs1, hp1, &
         a_rapid_mode, Rac_rapid_mode, aspect_rapid_mode, dSdt_slow_mode, &
-        phi_c_slow_mode, phi_i_mushy, kalg
+        phi_c_slow_mode, phi_i_mushy, kalg, atmiter_conv
 
       integer (kind=int_kind) :: ktherm, kstrength, krdg_partic, krdg_redist, natmiter, &
         kitd, kcatbound
@@ -204,7 +204,8 @@ subroutine input_data
 
       namelist /forcing_nml/ &
         formdrag,       atmbndy,         calc_strair,   calc_Tsfc,      &
-        highfreq,       natmiter,        ustar_min,     emissivity,     &
+        highfreq,       natmiter,        atmiter_conv,                  &
+        ustar_min,      emissivity,     &
         fbot_xfer_type, update_ocn_f,    l_mpond_fresh, tfrz_option,    &
         oceanmixed_ice, restore_ice,     restore_ocn,   trestore,       &
         precip_units,   default_season,  wave_spec_type,nfreq,          &
@@ -357,6 +358,7 @@ subroutine input_data
       formdrag        = .false.   ! calculate form drag
       highfreq        = .false.   ! calculate high frequency RASM coupling
       natmiter        = 5         ! number of iterations for atm boundary layer calcs
+      atmiter_conv    = c0        ! ustar convergence criteria
       precip_units    = 'mks'     ! 'mm_per_month' or
                                   ! 'mm_per_sec' = 'mks' = kg/m^2 s
       tfrz_option     = 'mushy'   ! freezing temp formulation
@@ -631,6 +633,7 @@ subroutine input_data
       call broadcast_scalar(formdrag,           master_task)
       call broadcast_scalar(highfreq,           master_task)
       call broadcast_scalar(natmiter,           master_task)
+      call broadcast_scalar(atmiter_conv,       master_task)
       call broadcast_scalar(update_ocn_f,       master_task)
       call broadcast_scalar(l_mpond_fresh,      master_task)
       call broadcast_scalar(ustar_min,          master_task)
@@ -1154,6 +1157,7 @@ subroutine input_data
          write(nu_diag,1010) ' formdrag                  = ', formdrag
          write(nu_diag,1010) ' highfreq                  = ', highfreq
          write(nu_diag,1020) ' natmiter                  = ', natmiter
+         write(nu_diag,1005) ' atmiter_conv              = ', atmiter_conv
          write(nu_diag,1010) ' calc_strair               = ', calc_strair
          write(nu_diag,1010) ' calc_Tsfc                 = ', calc_Tsfc
 
@@ -1305,7 +1309,8 @@ subroutine input_data
       endif
 
       call icepack_init_parameters(ustar_min_in=ustar_min, albicev_in=albicev, albicei_in=albicei, &
-         albsnowv_in=albsnowv, albsnowi_in=albsnowi, natmiter_in=natmiter, emissivity_in=emissivity, &
+         albsnowv_in=albsnowv, albsnowi_in=albsnowi, natmiter_in=natmiter, atmiter_conv_in=atmiter_conv, &
+         emissivity_in=emissivity, &
          ahmax_in=ahmax, shortwave_in=shortwave, albedo_type_in=albedo_type, R_ice_in=R_ice, R_pnd_in=R_pnd, &
          R_snw_in=R_snw, dT_mlt_in=dT_mlt, rsnw_mlt_in=rsnw_mlt, &
          kstrength_in=kstrength, krdg_partic_in=krdg_partic, krdg_redist_in=krdg_redist, mu_rdg_in=mu_rdg, &

configuration/scripts/ice_in

@@ -167,6 +167,7 @@
     calc_Tsfc       = .true.
     highfreq        = .false.
     natmiter        = 5
+    atmiter_conv    = 0.0d0
     ustar_min       = 0.0005
     emissivity      = 0.95
     fbot_xfer_type  = 'constant'

doc/source/cice_index.rst

@@ -61,6 +61,7 @@ either Celsius or Kelvin units).
    "ardgn", "fractional area of ridged ice", ""
    "aspect_rapid_mode", ":math:`\bullet` brine convection aspect ratio", "1"
    "astar", "e-folding scale for participation function", "0.05"
+   "atmiter_conv", ":math:`\bullet` convergence criteria for ustar", "0.00"
    "atm_data_dir", ":math:`\bullet` directory for atmospheric forcing data", ""
    "atm_data_format", ":math:`\bullet` format of atmospheric forcing files", ""
    "atm_data_type", ":math:`\bullet` type of atmospheric forcing", ""

doc/source/user_guide/ug_case_settings.rst

@@ -332,7 +332,8 @@ Table of namelist options
    "\*","``calc_strair``", "true", "calculate wind stress and speed", ""
    "","", "false", "read wind stress and speed from files", ""
    "\*","``highfreq``", "true/false", "high-frequency atmo coupling", ""
-   "\*","``natmiter``", "integer", "number of atmo boundary layer iterations", ""
+   "\*","``natmiter``", "integer", "number of atmo boundary layer iterations", "5"
+   "\*","``atmiter_conv``", "real", "convergence criteria for ustar", "0.0"
    "\*","``calc_Tsfc``", "true/false", "calculate surface temperature", "``.true.``"
    "\*","``default_season``","``winter``", "Sets initial values of forcing and is overwritten if forcing is read in.", ""
    "\*","``precip_units``", "``mks``", "liquid precipitation data units", ""