Updated comments explaining the '~>' notation

  Updated comments explaining the unit scaling for dimensional consistency
testing and the use of square brackets with the '~>' notation. Only comments are
changed, and all answers are bitwise identical.

config_src/coupled_driver/MOM_surface_forcing.F90

@@ -53,7 +53,8 @@ module MOM_surface_forcing
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> surface_forcing_CS is a structure containing pointers to the forcing fields
 !! which may be used to drive MOM.  All fluxes are positive downward.

config_src/ice_solo_driver/user_surface_forcing.F90

@@ -64,7 +64,8 @@ module user_surface_forcing
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 type, public :: user_surface_forcing_CS ; private
   !   This control structure should be used to store any run-time variables

src/ALE/MOM_ALE.F90

@@ -122,7 +122,8 @@ module MOM_ALE
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 contains
 

src/ALE/MOM_regridding.F90

@@ -38,7 +38,8 @@ module MOM_regridding
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Regridding control structure
 type, public :: regridding_CS ; private

src/core/MOM.F90

@@ -138,7 +138,8 @@ module MOM
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> A structure with diagnostic IDs of the state variables
 type MOM_diag_IDs

src/core/MOM_PressureForce_Montgomery.F90

@@ -24,7 +24,8 @@ module MOM_PressureForce_Mont
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Control structure for the Montgomery potential form of pressure gradient
 type, public :: PressureForce_Mont_CS ; private

src/core/MOM_PressureForce_analytic_FV.F90

@@ -29,7 +29,8 @@ module MOM_PressureForce_AFV
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Finite volume pressure gradient control structure
 type, public :: PressureForce_AFV_CS ; private

src/core/MOM_PressureForce_blocked_AFV.F90

@@ -29,7 +29,8 @@ module MOM_PressureForce_blk_AFV
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Finite volume pressure gradient control structure
 type, public :: PressureForce_blk_AFV_CS ; private

src/core/MOM_barotropic.F90

@@ -60,7 +60,8 @@ module MOM_barotropic
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The barotropic stepping open boundary condition type
 type, private :: BT_OBC_type

src/core/MOM_forcing_type.F90

@@ -37,7 +37,8 @@ module MOM_forcing_type
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Structure that contains pointers to the boundary forcing used to drive the
 !! liquid ocean simulated by MOM.

src/core/MOM_grid.F90

@@ -18,7 +18,8 @@ module MOM_grid
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Ocean grid type. See mom_grid for details.
 type, public :: ocean_grid_type

src/core/MOM_isopycnal_slopes.F90

@@ -17,7 +17,8 @@ module MOM_isopycnal_slopes
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 contains
 

src/core/MOM_variables.F90

@@ -21,7 +21,8 @@ module MOM_variables
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> A structure for creating arrays of pointers to 3D arrays
 type, public :: p3d

src/core/MOM_verticalGrid.F90

@@ -17,7 +17,8 @@ module MOM_verticalGrid
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Describes the vertical ocean grid, including unit conversion factors
 type, public :: verticalGrid_type

src/diagnostics/MOM_diag_to_Z.F90

@@ -40,7 +40,8 @@ module MOM_diag_to_Z
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The control structure for the MOM_diag_to_Z module
 type, public :: diag_to_Z_CS ; private

src/diagnostics/MOM_diagnostics.F90

@@ -44,7 +44,8 @@ module MOM_diagnostics
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The control structure for the MOM_diagnostics module
 type, public :: diagnostics_CS ; private

src/diagnostics/MOM_sum_output.F90

@@ -35,7 +35,8 @@ module MOM_sum_output
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 integer, parameter :: NUM_FIELDS = 17 !< Number of diagnostic fields
 

src/diagnostics/MOM_wave_speed.F90

@@ -21,7 +21,8 @@ module MOM_wave_speed
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Control structure for MOM_wave_speed
 type, public :: wave_speed_CS ; private

src/diagnostics/MOM_wave_structure.F90

@@ -29,7 +29,8 @@ module MOM_wave_structure
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The control structure for the MOM_wave_structure module
 type, public :: wave_structure_CS ; !private

src/equation_of_state/MOM_EOS.F90

@@ -53,7 +53,8 @@ module MOM_EOS
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Calculates density of sea water from T, S and P
 interface calculate_density

src/equation_of_state/MOM_EOS_Wright.F90

@@ -22,7 +22,8 @@ module MOM_EOS_Wright
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 
 !> Compute the in situ density of sea water (in units of kg/m^3), or its anomaly with respect to

src/equation_of_state/MOM_EOS_linear.F90

@@ -18,7 +18,8 @@ module MOM_EOS_linear
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Compute the density of sea water (in kg/m^3), or its anomaly from a reference density,
 !! using a simple linear equation of state from salinity (in psu), potential temperature (in deg C)

src/framework/MOM_dyn_horgrid.F90

@@ -15,7 +15,8 @@ module MOM_dyn_horgrid
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Describes the horizontal ocean grid with only dynamic memory arrays
 type, public :: dyn_horgrid_type

src/ice_shelf/MOM_ice_shelf.F90

@@ -64,7 +64,8 @@ module MOM_ice_shelf
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Control structure that contains ice shelf parameters and diagnostics handles
 type, public :: ice_shelf_CS ; private

src/ice_shelf/MOM_ice_shelf_dynamics.F90

@@ -34,7 +34,8 @@ module MOM_ice_shelf_dynamics
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The control structure for the ice shelf dynamics.
 type, public :: ice_shelf_dyn_CS ; private

src/ice_shelf/MOM_ice_shelf_initialize.F90

@@ -19,7 +19,8 @@ module MOM_ice_shelf_initialize
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 contains
 

src/ice_shelf/user_shelf_init.F90

@@ -22,7 +22,8 @@ module user_shelf_init
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> The control structure for the user_ice_shelf module
 type, public :: user_ice_shelf_CS ; private

src/initialization/MOM_coord_initialization.F90

@@ -27,7 +27,8 @@ module MOM_coord_initialization
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 character(len=40) :: mdl = "MOM_coord_initialization" !< This module's name.
 

src/initialization/MOM_grid_initialize.F90

@@ -26,7 +26,8 @@ module MOM_grid_initialize
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Global positioning system (aka container for information to describe the grid)
 type, public :: GPS ; private

src/initialization/MOM_shared_initialization.F90

@@ -32,7 +32,8 @@ module MOM_shared_initialization
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 contains
 

src/initialization/MOM_state_initialization.F90

@@ -108,7 +108,8 @@ module MOM_state_initialization
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 character(len=40)  :: mdl = "MOM_state_initialization" !< This module's name.
 

src/initialization/MOM_tracer_initialization_from_Z.F90

@@ -35,7 +35,8 @@ module MOM_tracer_initialization_from_Z
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 character(len=40)  :: mdl = "MOM_tracer_initialization_from_Z" !< This module's name.
 

src/initialization/midas_vertmap.F90

@@ -15,7 +15,8 @@ module MIDAS_vertmap
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Fill grid edges
 interface fill_boundaries

src/parameterizations/lateral/MOM_mixed_layer_restrat.F90

@@ -31,7 +31,8 @@ module MOM_mixed_layer_restrat
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Control structure for mom_mixed_layer_restrat
 type, public :: mixedlayer_restrat_CS ; private

src/parameterizations/lateral/MOM_thickness_diffuse.F90

@@ -27,7 +27,8 @@ module MOM_thickness_diffuse
 
 ! A note on unit descriptions in comments: MOM6 uses units that can be rescaled for dimensional
 ! consistency testing. These are noted in comments with units like Z, H, L, and T, along with
-! their mks counterparts with notation like "a velocity, in Z T-1 ~> m s-1."
+! their mks counterparts with notation like "a velocity [Z T-1 ~> m s-1]".  If the units
+! vary with the Boussinesq approximation, the Boussinesq variant is given first.
 
 !> Control structure for thickness diffusion
 type, public :: thickness_diffuse_CS ; private