Update branch from CICE main #6703bc533

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: doc/requirements.txt

cicecore/cicedyn/analysis/ice_diagnostics.F90

@@ -261,10 +261,8 @@ subroutine runtime_diags (dt)
       !$OMP END PARALLEL DO
       extentn = c0
       extents = c0
-      extentn = global_sum(work1, distrb_info, field_loc_center, &
-                           tarean)
-      extents = global_sum(work1, distrb_info, field_loc_center, &
-                           tareas)
+      extentn = global_sum(work1, distrb_info, field_loc_center, tarean)
+      extents = global_sum(work1, distrb_info, field_loc_center, tareas)
       extentn = extentn * m2_to_km2
       extents = extents * m2_to_km2
 

cicecore/cicedyn/analysis/ice_history.F90

@@ -263,7 +263,7 @@ subroutine init_hist (dt)
                     trim(tmpstr2), file=__FILE__, line=__LINE__)
             endif
          end do
-         
+
          close(nu_nml)
          call release_fileunit(nu_nml)
       endif
@@ -2225,7 +2225,7 @@ subroutine accum_hist (dt)
       n4Dfcum = n4Dscum + num_avail_hist_fields_4Df ! should equal num_avail_hist_fields_tot
 
       do ns = 1,nstreams
-         if (.not. hist_avg) then  ! write snapshots
+         if (.not. hist_avg(ns)) then  ! write snapshots
            do n = 1,n2D
               if (avail_hist_fields(n)%vhistfreq == histfreq(ns)) &
                   a2D(:,:,n,:) = c0

cicecore/cicedyn/analysis/ice_history_pond.F90

@@ -100,14 +100,14 @@ subroutine init_hist_pond_2D
                  trim(nml_filename), &
                  file=__FILE__, line=__LINE__)
          endif
-         
+
          ! goto this namelist in file
          call goto_nml(nu_nml,trim(nml_name),nml_error)
          if (nml_error /= 0) then
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                  file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -121,7 +121,7 @@ subroutine init_hist_pond_2D
                     trim(tmpstr2), file=__FILE__, line=__LINE__)
             endif
          end do
-         
+
          close(nu_nml)
          call release_fileunit(nu_nml)
       endif

cicecore/cicedyn/analysis/ice_history_shared.F90

@@ -38,7 +38,7 @@ module ice_history_shared
       integer (kind=int_kind), public :: history_precision
 
       logical (kind=log_kind), public :: &
-         hist_avg  ! if true, write averaged data instead of snapshots
+         hist_avg(max_nstrm)  ! if true, write averaged data instead of snapshots
 
       character (len=char_len_long), public :: &
          history_file  , & ! output file for history
@@ -743,7 +743,7 @@ subroutine construct_filename(ncfile,suffix,ns)
               imonth,'-',iday,'-',isec,'.',trim(suffix)
         else
 
-           if (hist_avg) then
+           if (hist_avg(ns)) then
               if (histfreq(ns) == '1' .or. histfreq(ns) == 'h'.or.histfreq(ns) == 'H') then
                  ! do nothing
               elseif (new_year) then
@@ -763,7 +763,7 @@ subroutine construct_filename(ncfile,suffix,ns)
 !echmod ! of other groups (including RASM which uses CESMCOUPLED)
 !echmod         if (ns > 1) write(cstream,'(i1.1)') ns-1
 
-           if (hist_avg) then    ! write averaged data
+           if (hist_avg(ns)) then    ! write averaged data
               if (histfreq(ns) == '1' .and. histfreq_n(ns) == 1)  then ! timestep
                  write(ncfile,'(a,a,i4.4,a,i2.2,a,i2.2,a,i5.5,a,a)')  &
                        history_file(1:lenstr(history_file))//trim(cstream),'_inst.', &

cicecore/cicedyn/analysis/ice_history_snow.F90

@@ -77,7 +77,7 @@ subroutine init_hist_snow_2D (dt)
       integer (kind=int_kind) :: ns
       integer (kind=int_kind) :: nml_error ! namelist i/o error flag
       real    (kind=dbl_kind) :: rhofresh, secday
-      logical (kind=log_kind) :: tr_snow      
+      logical (kind=log_kind) :: tr_snow
       character(len=char_len_long) :: tmpstr2 ! for namelist check
       character(len=char_len)      :: nml_name ! for namelist check
 

cicecore/cicedyn/dynamics/ice_dyn_vp.F90

@@ -2502,7 +2502,7 @@ function global_dot_product (nx_block  , ny_block , &
                                    vector2_x , vector2_y) &
                result(dot_product)
 
-      use ice_domain, only: distrb_info
+      use ice_domain, only: distrb_info, ns_boundary_type
       use ice_domain_size, only: max_blocks
       use ice_fileunits, only: bfbflag
 
@@ -2552,8 +2552,14 @@ function global_dot_product (nx_block  , ny_block , &
       enddo
       !$OMP END PARALLEL DO
 
-      ! Use local summation result unless bfbflag is active
-      if (bfbflag == 'off') then
+      ! Use faster local summation result for several bfbflag settings.
+      ! The local implementation sums over each block, sums over local
+      ! blocks, and calls global_sum on a scalar and should be just as accurate as
+      ! bfbflag = 'off', 'lsum8', and 'lsum4' without the extra copies and overhead
+      ! in the more general array global_sum.  But use the array global_sum
+      ! if bfbflag is more strict or for tripole grids (requires special masking)
+      if (ns_boundary_type /= 'tripole' .and. ns_boundary_type /= 'tripoleT' .and. &
+         (bfbflag == 'off' .or. bfbflag == 'lsum8' .or. bfbflag == 'lsum4')) then
          dot_product = global_sum(sum(dot), distrb_info)
       else
          dot_product = global_sum(prod, distrb_info, field_loc_NEcorner)
@@ -3120,7 +3126,7 @@ subroutine fgmres (zetax2   , etax2   , &
                   j = indxUj(ij, iblk)
 
                   workspace_x(i, j, iblk) = workspace_x(i, j, iblk) + rhs_hess(it) * arnoldi_basis_x(i, j, iblk, it)
-                  workspace_y(i, j, iblk) = workspace_x(i, j, iblk) + rhs_hess(it) * arnoldi_basis_y(i, j, iblk, it)
+                  workspace_y(i, j, iblk) = workspace_y(i, j, iblk) + rhs_hess(it) * arnoldi_basis_y(i, j, iblk, it)
                enddo ! ij
             enddo
             !$OMP END PARALLEL DO
@@ -3151,7 +3157,6 @@ subroutine pgmres (zetax2   , etax2   , &
 
       use ice_boundary, only: ice_HaloUpdate
       use ice_domain, only: maskhalo_dyn, halo_info
-      use ice_fileunits, only: bfbflag
       use ice_timers, only: ice_timer_start, ice_timer_stop, timer_bound
 
       real (kind=dbl_kind), dimension(nx_block,ny_block,max_blocks,4), intent(in) :: &
@@ -3343,21 +3348,17 @@ subroutine pgmres (zetax2   , etax2   , &
                               workspace_x , workspace_y)
 
             ! Update workspace with boundary values
-            ! NOTE: skipped for efficiency since this is just a preconditioner
-            ! unless bfbflag is active
-            if (bfbflag /= 'off') then
-               call stack_fields(workspace_x, workspace_y, fld2)
-               call ice_timer_start(timer_bound)
-               if (maskhalo_dyn) then
-                  call ice_HaloUpdate (fld2,               halo_info_mask, &
-                                       field_loc_NEcorner, field_type_vector)
-               else
-                  call ice_HaloUpdate (fld2,               halo_info, &
-                                       field_loc_NEcorner, field_type_vector)
-               endif
-               call ice_timer_stop(timer_bound)
-               call unstack_fields(fld2, workspace_x, workspace_y)
+            call stack_fields(workspace_x, workspace_y, fld2)
+            call ice_timer_start(timer_bound)
+            if (maskhalo_dyn) then
+               call ice_HaloUpdate (fld2,               halo_info_mask, &
+                                    field_loc_NEcorner, field_type_vector)
+            else
+               call ice_HaloUpdate (fld2,               halo_info, &
+                                    field_loc_NEcorner, field_type_vector)
             endif
+            call ice_timer_stop(timer_bound)
+            call unstack_fields(fld2, workspace_x, workspace_y)
 
             !$OMP PARALLEL DO PRIVATE(iblk)
             do iblk = 1, nblocks
@@ -3528,7 +3529,7 @@ subroutine pgmres (zetax2   , etax2   , &
                   j = indxUj(ij, iblk)
 
                   workspace_x(i, j, iblk) = workspace_x(i, j, iblk) + rhs_hess(it) * arnoldi_basis_x(i, j, iblk, it)
-                  workspace_y(i, j, iblk) = workspace_x(i, j, iblk) + rhs_hess(it) * arnoldi_basis_y(i, j, iblk, it)
+                  workspace_y(i, j, iblk) = workspace_y(i, j, iblk) + rhs_hess(it) * arnoldi_basis_y(i, j, iblk, it)
                enddo ! ij
             enddo
             !$OMP END PARALLEL DO

cicecore/cicedyn/general/ice_init.F90

@@ -125,7 +125,7 @@ subroutine input_data
       use ice_timers, only: timer_stats
       use ice_memusage, only: memory_stats
       use ice_fileunits, only: goto_nml
-      
+
 #ifdef CESMCOUPLED
       use shr_file_mod, only: shr_file_setIO
 #endif
@@ -169,7 +169,7 @@ subroutine input_data
 
       character (len=char_len) :: abort_list
       character (len=char_len)      :: nml_name ! namelist name
-      character (len=char_len_long) :: tmpstr2  
+      character (len=char_len_long) :: tmpstr2
 
       character(len=*), parameter :: subname='(input_data)'
 
@@ -322,7 +322,7 @@ subroutine input_data
       histfreq(5) = 'y'      ! output frequency option for different streams
       histfreq_n(:) = 1      ! output frequency
       histfreq_base = 'zero' ! output frequency reference date
-      hist_avg = .true.      ! if true, write time-averages (not snapshots)
+      hist_avg(:) = .true.   ! if true, write time-averages (not snapshots)
       history_format = 'default' ! history file format
       history_dir  = './'    ! write to executable dir for default
       history_file = 'iceh'  ! history file name prefix
@@ -612,7 +612,7 @@ subroutine input_data
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -660,7 +660,7 @@ subroutine input_data
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -684,7 +684,7 @@ subroutine input_data
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -702,7 +702,7 @@ subroutine input_data
          ! read dynamics_nml
          nml_name = 'dynamics_nml'
          write(nu_diag,*) subname,' Reading ', trim(nml_name)
- 
+
          ! goto namelist in file
          call goto_nml(nu_nml,trim(nml_name),nml_error)
          if (nml_error /= 0) then
@@ -727,7 +727,7 @@ subroutine input_data
          ! read shortwave_nml
          nml_name = 'shortwave_nml'
          write(nu_diag,*) subname,' Reading ', trim(nml_name)
-         
+
          ! goto namelist in file
          call goto_nml(nu_nml,trim(nml_name),nml_error)
          if (nml_error /= 0) then
@@ -752,14 +752,14 @@ subroutine input_data
          ! read ponds_nml
          nml_name = 'ponds_nml'
          write(nu_diag,*) subname,' Reading ', trim(nml_name)
-         
+
          ! goto namelist in file
          call goto_nml(nu_nml,trim(nml_name),nml_error)
          if (nml_error /= 0) then
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -777,14 +777,14 @@ subroutine input_data
          ! read snow_nml
          nml_name = 'snow_nml'
          write(nu_diag,*) subname,' Reading ', trim(nml_name)
-         
+
          ! goto namelist in file
          call goto_nml(nu_nml,trim(nml_name),nml_error)
          if (nml_error /= 0) then
             call abort_ice(subname//'ERROR: searching for '// trim(nml_name), &
                file=__FILE__, line=__LINE__)
          endif
-         
+
          ! read  namelist
          nml_error =  1
          do while (nml_error > 0)
@@ -824,7 +824,7 @@ subroutine input_data
             endif
          end do
 
-         ! done reading namelist. 
+         ! done reading namelist.
          close(nu_nml)
          call release_fileunit(nu_nml)
       endif
@@ -904,7 +904,7 @@ subroutine input_data
       enddo
       call broadcast_array(histfreq_n,            master_task)
       call broadcast_scalar(histfreq_base,        master_task)
-      call broadcast_scalar(hist_avg,             master_task)
+      call broadcast_array(hist_avg,              master_task)
       call broadcast_scalar(history_dir,          master_task)
       call broadcast_scalar(history_file,         master_task)
       call broadcast_scalar(history_precision,    master_task)
@@ -2330,8 +2330,7 @@ subroutine input_data
          write(nu_diag,1033) ' histfreq         = ', histfreq(:)
          write(nu_diag,1023) ' histfreq_n       = ', histfreq_n(:)
          write(nu_diag,1031) ' histfreq_base    = ', trim(histfreq_base)
-         write(nu_diag,1011) ' hist_avg         = ', hist_avg
-         if (.not. hist_avg) write(nu_diag,1039) ' History data will be snapshots'
+         write(nu_diag,*)    ' hist_avg         = ', hist_avg(:)
          write(nu_diag,1031) ' history_dir      = ', trim(history_dir)
          write(nu_diag,1031) ' history_file     = ', trim(history_file)
          write(nu_diag,1021) ' history_precision= ', history_precision