Add haloupdate unit test

cicecore/cicedyn/infrastructure/ice_grid.F90

@@ -360,6 +360,11 @@ subroutine init_grid1
                         file=__FILE__, line=__LINE__)
       endif
 
+      if (grid_type == 'tripole' .and. (mod(nx_global,2)/=0)) then
+         call abort_ice(subname//'ERROR: grid_type tripole requires even nx_global number', &
+                        file=__FILE__, line=__LINE__)
+      endif
+
       if (trim(grid_type) == 'displaced_pole' .or. &
           trim(grid_type) == 'tripole' .or. &
           trim(grid_type) == 'regional'     ) then

cicecore/shared/ice_constants.F90

@@ -97,8 +97,7 @@ module ice_constants
         field_loc_center   =  1, &
         field_loc_NEcorner =  2, &
         field_loc_Nface    =  3, &
-        field_loc_Eface    =  4, &
-        field_loc_Wface    =  5
+        field_loc_Eface    =  4
 
       !-----------------------------------------------------------------
       ! field type attribute - necessary for handling

configuration/scripts/Makefile

@@ -74,7 +74,7 @@ AR    := ar
 
 .SUFFIXES:
 
-.PHONY: all cice libcice targets target db_files db_flags clean realclean helloworld calchk sumchk bcstchk gridavgchk optargs
+.PHONY: all cice libcice targets target db_files db_flags clean realclean helloworld calchk sumchk bcstchk gridavgchk halochk optargs
 all: $(EXEC)
 
 cice: $(EXEC)
@@ -93,7 +93,7 @@ targets:
 	@echo " "
 	@echo "Supported Makefile Targets are: cice, libcice, makdep, depends, clean, realclean"
 	@echo "                   Diagnostics: targets, db_files, db_flags"
-	@echo "                   Unit Tests : helloworld, calchk, sumchk, bcstchk, gridavgchk, optargs"
+	@echo "                   Unit Tests : helloworld, calchk, sumchk, bcstchk, gridavgchk, halochk, optargs"
 target: targets
 
 db_files:
@@ -151,6 +151,8 @@ bcstchk: $(EXEC)
 
 gridavgchk: $(EXEC)
 
+halochk: $(EXEC)
+
 # this builds just a subset of source code specified explicitly and requires a separate target
 
 HWOBJS := helloworld.o

configuration/scripts/cice_decomp.csh

@@ -156,8 +156,10 @@ if (${ICE_DECOMP_MXBLCKS} > 0) set mxblcks = ${ICE_DECOMP_MXBLCKS}
 
 set decomp = 'cartesian'
 set dshape = 'slenderX2'
-if (${nxglob} % ${cicepes} != 0) set decomp = 'roundrobin'
-if (${mxblcks} * ${blcky} * 2 < ${nyglob}) set decomp = 'roundrobin'
+if (${cicepes} % 2 != 0)                              set decomp = 'roundrobin'
+if (${nyglob} % (${blcky} * 2) != 0)                  set decomp = 'roundrobin'
+if (${nxglob} % ${blckx} != 0)                        set decomp = 'roundrobin'
+if (((${nxglob} * 2) % (${cicepes} * ${blckx})) != 0) set decomp = 'roundrobin'
 
 #--- outputs ---
 

configuration/scripts/options/set_env.halochk

@@ -0,0 +1,2 @@
+setenv ICE_DRVOPT     unittest/halochk
+setenv ICE_TARGET     halochk

configuration/scripts/options/set_nml.cyclic

@@ -0,0 +1,3 @@
+ew_boundary_type  = 'cyclic'
+ns_boundary_type  = 'cyclic'
+

configuration/scripts/options/set_nml.open

@@ -0,0 +1,3 @@
+ew_boundary_type  = 'open'
+ns_boundary_type  = 'open'
+

configuration/scripts/options/set_nml.tripole

@@ -0,0 +1,3 @@
+grid_type = 'tripole'
+ew_boundary_type = 'cyclic'
+ns_boundary_type = 'tripole'

configuration/scripts/options/set_nml.tripolet

@@ -0,0 +1,3 @@
+grid_type = 'tripole'
+ew_boundary_type = 'cyclic'
+ns_boundary_type = 'tripoleT'

configuration/scripts/tests/unittest_suite.ts

@@ -1,14 +1,29 @@
 # Test         Grid    PEs          Sets         BFB-compare
-unittest       gx3     1x1          helloworld
-unittest       gx3     1x1          optargs
-unittest       gx3     1x1          calchk,short
-unittest       gx3     4x1x25x29x4  sumchk
-unittest       gx3     1x1x25x29x16 sumchk
-unittest       tx1     8x1          sumchk
-unittest       gx3     4x1          bcstchk
-unittest       gx3     1x1          bcstchk
-unittest       gx3     8x2          gridavgchk,dwblockall
-unittest       gx3     12x1         gridavgchk
-unittest       gx1     28x1         gridavgchk,dwblockall
-unittest       gx1     16x2         gridavgchk
-unittest       gbox128 8x2          gridavgchk
+unittest       gx3     1x1           helloworld
+unittest       gx3     1x1           optargs
+unittest       gx3     1x1           calchk,short
+unittest       gx3     4x1x25x29x4   sumchk
+unittest       gx3     1x1x25x29x16  sumchk
+unittest       tx1     8x1           sumchk
+unittest       gx3     4x1           bcstchk
+unittest       gx3     1x1           bcstchk
+unittest       gx3     8x2           gridavgchk,dwblockall
+unittest       gx3     12x1          gridavgchk
+unittest       gx1     28x1          gridavgchk,dwblockall
+unittest       gx1     16x2          gridavgchk
+unittest       gbox128 8x2           gridavgchk
+unittest       gbox80  1x1x10x10x80  halochk,cyclic,debug
+unittest       gbox80  1x1x24x23x16  halochk
+unittest       gbox80  1x1x23x24x16  halochk,cyclic
+unittest       gbox80  1x1x23x23x16  halochk,open
+unittest       tx1     1x1x90x60x16  halochk,dwblockall
+unittest       tx1     1x1x90x60x16  halochk,dwblockall,tripolet
+unittest       tx1     1x1x95x65x16  halochk,dwblockall
+unittest       tx1     1x1x95x65x16  halochk,dwblockall,tripolet
+unittest       gx3     4x2           halochk,dwblockall,debug
+unittest       gx3     8x2x16x12x10  halochk,cyclic,dwblockall
+unittest       gx3     17x1x16x12x10 halochk,open,dwblockall
+unittest       tx1     4x2           halochk,dwblockall
+unittest       tx1     4x2           halochk,dwblockall,tripolet
+unittest       tx1     4x2x65x45x10  halochk,dwblockall
+unittest       tx1     4x2x57x43x12  halochk,dwblockall,tripolet

doc/source/user_guide/ug_implementation.rst

@@ -284,7 +284,28 @@ fold, on the logical grid. The point with index i along the ghost T-row
 of index :math:`n+1` physically coincides with point
 :math:`{\tt nx\_global}-{\tt i}+1` on the T-row of index :math:`n`. The
 ghost U-row of index :math:`n+1` physically coincides with the U-row of
-index :math:`n-1`.
+index :math:`n-1`.  In the schematics below, symbols A-H represent
+grid points from 1:nx_global at a given j index and the setup of the
+tripole seam is depicted within a few rows of the seam.
+
+.. _tab-tripole:
+
+.. table:: Tripole (u-fold) Grid Schematic
+   :align: center
+
+   +--------------+---------------------------------------+--------------+
+   | global j     |                                       | global j     |
+   | index        |          grid point IDs (i index)     | index source |
+   +==============+====+====+====+====+====+====+====+====+==============+
+   | ny_global+2  |  H |  G |  F |  E |  D |  C |  B |  A | ny_global-1  |
+   +--------------+----+----+----+----+----+----+----+----+--------------+
+   | ny_global+1  |  H |  G |  F |  E |  D |  C |  B |  A | ny_global    |
+   +--------------+----+----+----+----+----+----+----+----+--------------+
+   | ny_global    |  A |  B |  C |  D |  E |  F |  G |  H |              |
+   +--------------+----+----+----+----+----+----+----+----+--------------+
+   | ny_global-1  |  A |  B |  C |  D |  E |  F |  G |  H |              |
+   +--------------+----+----+----+----+----+----+----+----+--------------+
+
 
 In the T-fold tripole grid, the poles have T-index 1 and and
 :math:`{\tt nx\_global}/2+1` on the top T-row of the physical grid, and
@@ -301,6 +322,27 @@ north of U-row :math:`n`. Ghost T-row :math:`n+1` coincides with T-row
 :math:`n-1`, and ghost U-row :math:`n+1` coincides with U-row
 :math:`n-2`.
 
+.. _tab-tripoleT:
+
+.. table:: TripoleT (t-fold) Grid Schematic
+   :align: center
+
+   +--------------+--------------------------------------------+--------------+
+   | global j     |                                            | global j     |
+   | index        |          grid point IDs (i index)          | index source |
+   +==============+====+====+====+====+====+====+====+====+====+==============+
+   | ny_global+2  |    |  H |  G |  F |  E |  D |  C |  B |  A | ny_global-2  |
+   +--------------+----+----+----+----+----+----+----+----+----+--------------+
+   | ny_global+1  |    |  H |  G |  F |  E |  D |  C |  B |  A | ny_global-1  |
+   +--------------+----+----+----+----+----+----+----+----+----+--------------+
+   | ny_global    |  A | BH | CG | DF |  E | FD | GC | HB |    |              |
+   +--------------+----+----+----+----+----+----+----+----+----+--------------+
+   | ny_global-1  |  A |  B |  C |  D |  E |  F |  G |  H |    |              |
+   +--------------+----+----+----+----+----+----+----+----+----+--------------+
+   | ny_global-2  |  A |  B |  C |  D |  E |  F |  G |  H |    |              |
+   +--------------+----+----+----+----+----+----+----+----+----+--------------+
+
+
 The tripole grid thus requires two special kinds of treatment for
 certain rows, arranged by the halo-update routines. First, within rows
 along the fold, coincident points must always have the same value. This
@@ -310,7 +352,8 @@ the coincident physical rows. Both operations involve the tripole
 buffer, which is used to assemble the data for the affected rows.
 Special treatment is also required in the scattering routine, and when
 computing global sums one of each pair of coincident points has to be
-excluded.
+excluded.  Halos of center, east, north, and northeast points are supported,
+and each requires slightly different halo indexing across the tripole seam.
 
 *****************
 Rectangular grids

doc/source/user_guide/ug_testing.rst

@@ -736,6 +736,7 @@ The following are brief descriptions of some of the current unit tests,
  - **calchk** is a unit test that exercises the CICE calendar over 100,000 years and verifies correctness.
    This test does not depend on the CICE initialization.
  - **gridavgchk** is a unit test that exercises the CICE grid_average_X2Y methods and verifies results.
+ - **halochk** is a unit test that exercises the CICE haloUpdate methods and verifies results.
  - **helloworld** is a simple test that writes out helloworld and uses no CICE infrastructure.
    This tests exists to demonstrate how to build a unit test by specifying the object files directly
    in the Makefile