From 750fcea9d0c8ad7d1b7c250ebaba260126fd4a52 Mon Sep 17 00:00:00 2001
From: Robert Hallberg <Robert.Hallberg@noaa.gov>
Date: Sun, 14 Jul 2024 15:32:17 -0400
Subject: [PATCH] Scale checksums in hor_bnd_diffusion

  Added missing scale arguments to the hchksum and global_mass_integral calls
for debugging in hor_bnd_diffusion, so that they now give messages to stdout
that do not change when tracers (including temperature and salinity) are
rescaled.  Also added a missing debuggingParam argument to the get_Param call
for HBD_DEBUG so that is will be logged in MOM_parameter_doc.debugging rather
that MOM_parameter_doc.all.  This commit partially addresses the scaling
problems that were noted in github.com/NCAR/MOM6/issues/275.  All solutions are
bitwise identical, but some debugging output can change to become more robust.
---
 src/tracer/MOM_hor_bnd_diffusion.F90 | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/tracer/MOM_hor_bnd_diffusion.F90 b/src/tracer/MOM_hor_bnd_diffusion.F90
index 4f6f198ff8..5b9af238d6 100644
--- a/src/tracer/MOM_hor_bnd_diffusion.F90
+++ b/src/tracer/MOM_hor_bnd_diffusion.F90
@@ -32,7 +32,7 @@ module MOM_hor_bnd_diffusion
 public boundary_k_range, hor_bnd_diffusion_end
 
 ! Private parameters to avoid doing string comparisons for bottom or top boundary layer
-integer, public, parameter :: SURFACE = -1 !< Set a value that corresponds to the surface bopundary
+integer, public, parameter :: SURFACE = -1 !< Set a value that corresponds to the surface boundary
 integer, public, parameter :: BOTTOM  = 1  !< Set a value that corresponds to the bottom boundary
 #include <MOM_memory.h>
 
@@ -146,10 +146,11 @@ logical function hor_bnd_diffusion_init(Time, G, GV, US, param_file, diag, diaba
   call initialize_remapping( CS%remap_CS, string, boundary_extrapolation = boundary_extrap ,&
        check_reconstruction=.false., check_remapping=.false.)
   call extract_member_remapping_CS(CS%remap_CS, degree=CS%deg)
-  call get_param(param_file, mdl, "DEBUG", debug, default=.false., do_not_log=.true.)
+  call get_param(param_file, mdl, "DEBUG", debug, &
+                 default=.false., debuggingParam=.true., do_not_log=.true.)
   call get_param(param_file, mdl, "HBD_DEBUG", CS%debug, &
                  "If true, write out verbose debugging data in the HBD module.", &
-                 default=debug)
+                 default=debug, debuggingParam=.true.)
 
   id_clock_hbd = cpu_clock_id('(Ocean HBD)', grain=CLOCK_MODULE)
 
@@ -208,7 +209,7 @@ subroutine hor_bnd_diffusion(G, GV, US, h, Coef_x, Coef_y, dt, Reg, CS)
     tracer => Reg%tr(m)
 
     if (CS%debug) then
-      call hchksum(tracer%t, "before HBD "//tracer%name,G%HI)
+      call hchksum(tracer%t, "before HBD "//tracer%name, G%HI, scale=tracer%conc_scale)
     endif
 
     ! for diagnostics
@@ -264,10 +265,10 @@ subroutine hor_bnd_diffusion(G, GV, US, h, Coef_x, Coef_y, dt, Reg, CS)
     endif
 
     if (CS%debug) then
-      call hchksum(tracer%t, "after HBD "//tracer%name,G%HI)
+      call hchksum(tracer%t, "after HBD "//tracer%name, G%HI, scale=tracer%conc_scale)
       ! tracer (native grid) integrated tracer amounts before and after HBD
-      tracer_int_prev = global_mass_integral(h, G, GV, tracer_old)
-      tracer_int_end = global_mass_integral(h, G, GV, tracer%t)
+      tracer_int_prev = global_mass_integral(h, G, GV, tracer_old, scale=tracer%conc_scale)
+      tracer_int_end = global_mass_integral(h, G, GV, tracer%t, scale=tracer%conc_scale)
       write(mesg,*) 'Total '//tracer%name//' before/after HBD:', tracer_int_prev, tracer_int_end
       call MOM_mesg(mesg)
     endif
@@ -1213,7 +1214,7 @@ end subroutine hor_bnd_diffusion_end
 !!
 !! \subsection section_harmonic_mean Harmonic Mean
 !!
-!! The harmonic mean (HM) betwen h1 and h2 is defined as:
+!! The harmonic mean (HM) between h1 and h2 is defined as:
 !!
 !! \f[ HM = \frac{2 \times h1 \times h2}{h1 + h2} \f]
 !!