Document velocity units with square brackets

  Changed comments to use the square bracket notation to document the units of
about 1000 velocity, acceleration, and time interval arguments. Also eliminated
several redundant argument documentation blocks.  Only comments have been
changed and all answers are bitwise identical.

config_src/coupled_driver/MOM_surface_forcing.F90

@@ -94,9 +94,9 @@ module MOM_surface_forcing
     gust => NULL()              !< A spatially varying unresolved background gustiness that
                                 !! contributes to ustar (Pa).  gust is used when read_gust_2d is true.
   real, pointer, dimension(:,:) :: &
-    ustar_tidal => NULL()       !< Tidal contribution to the bottom friction velocity (m/s)
+    ustar_tidal => NULL()       !< Tidal contribution to the bottom friction velocity [m s-1]
   real :: cd_tides              !< Drag coefficient that applies to the tides (nondimensional)
-  real :: utide                 !< Constant tidal velocity to use if read_tideamp is false, in m s-1.
+  real :: utide                 !< Constant tidal velocity to use if read_tideamp is false [m s-1].
   logical :: read_tideamp       !< If true, spatially varying tidal amplitude read from a file.
 
   logical :: rigid_sea_ice      !< If true, sea-ice exerts a rigidity that acts to damp surface
@@ -112,7 +112,7 @@ module MOM_surface_forcing
                                 !! salinity to a specified value.
   logical :: restore_temp       !< If true, the coupled MOM driver adds a term to restore sea
                                 !! surface temperature to a specified value.
-  real    :: Flux_const                     !< Piston velocity for surface restoring (m/s)
+  real    :: Flux_const                     !< Piston velocity for surface restoring [m s-1]
   logical :: salt_restore_as_sflux          !< If true, SSS restore as salt flux instead of water flux
   logical :: adjust_net_srestore_to_zero    !< Adjust srestore to zero (for both salt_flux or vprec)
   logical :: adjust_net_srestore_by_scaling !< Adjust srestore w/o moving zero contour
@@ -172,7 +172,7 @@ module MOM_surface_forcing
   real, pointer, dimension(:,:) :: runoff          =>NULL() !< mass flux of liquid runoff (kg/m2/s)
   real, pointer, dimension(:,:) :: calving         =>NULL() !< mass flux of frozen runoff (kg/m2/s)
   real, pointer, dimension(:,:) :: stress_mag      =>NULL() !< The time-mean magnitude of the stress on the ocean (Pa)
-  real, pointer, dimension(:,:) :: ustar_berg      =>NULL() !< frictional velocity beneath icebergs (m/s)
+  real, pointer, dimension(:,:) :: ustar_berg      =>NULL() !< frictional velocity beneath icebergs [m s-1]
   real, pointer, dimension(:,:) :: area_berg       =>NULL() !< area covered by icebergs(m2/m2)
   real, pointer, dimension(:,:) :: mass_berg       =>NULL() !< mass of icebergs(kg/m2)
   real, pointer, dimension(:,:) :: runoff_hflx     =>NULL() !< heat content of liquid runoff (W/m2)
@@ -587,7 +587,7 @@ subroutine convert_IOB_to_forces(IOB, forces, index_bounds, Time, G, US, CS, dt_
   real, dimension(SZI_(G),SZJ_(G)) :: &
     rigidity_at_h, &  ! Ice rigidity at tracer points (m3 s-1)
     net_mass_src, &   ! A temporary of net mass sources, in kg m-2 s-1.
-    ustar_tmp         ! A temporary array of ustar values, in m s-1.
+    ustar_tmp         ! A temporary array of ustar values [m s-1].
 
   real :: I_GEarth      ! 1.0 / G%G_Earth  (s^2/m)
   real :: Kv_rho_ice    ! (CS%kv_sea_ice / CS%density_sea_ice) ( m^5/(s*kg) )
@@ -1142,7 +1142,7 @@ subroutine surface_forcing_init(Time, G, US, param_file, diag, CS)
                                                   !! structure for this module
 
   ! Local variables
-  real :: utide  ! The RMS tidal velocity, in m s-1.
+  real :: utide  ! The RMS tidal velocity [m s-1].
   type(directories)  :: dirs
   logical            :: new_sim, iceberg_flux_diags
   type(time_type)    :: Time_frc
@@ -1333,7 +1333,7 @@ subroutine surface_forcing_init(Time, G, US, param_file, diag, CS)
 
   endif
 
-! Optionally read tidal amplitude from input file (m s-1) on model grid.
+! Optionally read tidal amplitude from input file [m s-1] on model grid.
 ! Otherwise use default tidal amplitude for bottom frictionally-generated
 ! dissipation. Default cd_tides is chosen to yield approx 1 TWatt of
 ! work done against tides globally using OSU tidal amplitude.

config_src/coupled_driver/ocean_model_MOM.F90

@@ -240,7 +240,7 @@ subroutine ocean_model_init(Ocean_sfc, OS, Time_init, Time_in, gas_fields_ocn)
                                               !! internal variables in the ice model.
   ! Local variables
   real :: Rho0        ! The Boussinesq ocean density, in kg m-3.
-  real :: G_Earth     ! The gravitational acceleration in m s-2.
+  real :: G_Earth     ! The gravitational acceleration [m s-2].
   real :: HFrz        !< If HFrz > 0 (m), melt potential will be computed.
                       !! The actual depth over which melt potential is computed will
                       !! min(HFrz, OBLD), where OBLD is the boundary layer depth.
@@ -439,19 +439,19 @@ subroutine update_ocean_model(Ice_ocean_boundary, OS, Ocean_sfc, time_start_upda
   logical, optional, intent(in)    :: end_cycle   !< This indicates whether this call is to be
                                               !! treated as the last call to step_MOM in a
                                               !! time-stepping cycle; missing is like true.
-  real,    optional, intent(in)    :: cycle_length !< The duration of a coupled time stepping cycle, in s.
+  real,    optional, intent(in)    :: cycle_length !< The duration of a coupled time stepping cycle [s].
 
   ! Local variables
   type(time_type) :: Time_seg_start ! Stores the ocean model time at the start of this call to allow
                             ! step_MOM to temporarily change the time as seen by internal modules.
   type(time_type) :: Time1  ! The value of the ocean model's time at the start of a call to step_MOM.
   integer :: index_bnds(4)  ! The computational domain index bounds in the ice-ocean boundary type.
   real :: weight            ! Flux accumulation weight of the current fluxes.
-  real :: dt_coupling       ! The coupling time step in seconds.
-  real :: dt_therm          ! A limited and quantized version of OS%dt_therm (sec)
-  real :: dt_dyn            ! The dynamics time step in sec.
-  real :: dtdia             ! The diabatic time step in sec.
-  real :: t_elapsed_seg     ! The elapsed time in this update segment, in s.
+  real :: dt_coupling       ! The coupling time step [s].
+  real :: dt_therm          ! A limited and quantized version of OS%dt_therm [s].
+  real :: dt_dyn            ! The dynamics time step [s].
+  real :: dtdia             ! The diabatic time step [s].
+  real :: t_elapsed_seg     ! The elapsed time in this update segment [s].
   integer :: n              ! The internal iteration counter.
   integer :: nts            ! The number of baroclinic dynamics time steps in a thermodynamic step.
   integer :: n_max          ! The number of calls to step_MOM dynamics in this call to update_ocean_model.

config_src/ice_solo_driver/MOM_surface_forcing.F90

@@ -104,7 +104,7 @@ module MOM_surface_forcing
 
   real :: Rho0                  ! Boussinesq reference density (kg/m^3)
   real :: G_Earth               ! gravitational acceleration (m/s^2)
-  real :: Flux_const            ! piston velocity for surface restoring (m/s)
+  real :: Flux_const            ! piston velocity for surface restoring [m s-1]
 
   real    :: gust_const                 ! constant unresolved background gustiness for ustar (Pa)
   logical :: read_gust_2d               ! if true, use 2-dimensional gustiness supplied from a file

config_src/ice_solo_driver/user_surface_forcing.F90

@@ -80,8 +80,8 @@ module user_surface_forcing
   logical :: restorebuoy     ! If true, use restoring surface buoyancy forcing.
   real :: Rho0               !   The density used in the Boussinesq
                              ! approximation, in kg m-3.
-  real :: G_Earth            !   The gravitational acceleration in m s-2.
-  real :: Flux_const         !   The restoring rate at the surface, in m s-1.
+  real :: G_Earth            !   The gravitational acceleration [m s-2].
+  real :: Flux_const         !   The restoring rate at the surface [m s-1].
   real :: gust_const         !   A constant unresolved background gustiness
                              ! that contributes to ustar, in Pa.
 

config_src/mct_driver/MOM_ocean_model.F90

@@ -248,7 +248,7 @@ subroutine ocean_model_init(Ocean_sfc, OS, Time_init, Time_in, gas_fields_ocn, i
 ! been used in a previous call to initialize_ocean_type.
 
   real :: Rho0           !< The Boussinesq ocean density, in kg m-3.
-  real :: G_Earth        !< The gravitational acceleration in m s-2.
+  real :: G_Earth        !< The gravitational acceleration [m s-2].
                          !! This include declares and sets the variable "version".
   real :: HFrz           !< If HFrz > 0 (m), melt potential will be computed.
                          !! The actual depth over which melt potential is computed will

config_src/mct_driver/MOM_surface_forcing.F90

@@ -94,10 +94,10 @@ module MOM_surface_forcing
     gust => NULL(), &           !< spatially varying unresolved background
                                 !! gustiness that contributes to ustar (Pa).
                                 !! gust is used when read_gust_2d is true.
-    ustar_tidal => NULL()     !< tidal contribution to the bottom friction velocity (m/s)
+    ustar_tidal => NULL()     !< tidal contribution to the bottom friction velocity [m s-1]
   real :: cd_tides            !< drag coefficient that applies to the tides (nondimensional)
   real :: utide               !< constant tidal velocity to use if read_tideamp
-                              !! is false, in m s-1.
+                              !! is false [m s-1].
   logical :: read_tideamp     !< If true, spatially varying tidal amplitude read from a file.
   logical :: rigid_sea_ice    !< If true, sea-ice exerts a rigidity that acts
                               !! to damp surface deflections (especially surface
@@ -110,7 +110,7 @@ module MOM_surface_forcing
                                 !! sea-ice viscosity becomes effective, in kg m-2,
                                 !! typically of order 1000 kg m-2.
   logical :: allow_flux_adjustments !< If true, use data_override to obtain flux adjustments
-  real    :: Flux_const             !< piston velocity for surface restoring (m/s)
+  real    :: Flux_const             !< piston velocity for surface restoring [m s-1]
   logical :: salt_restore_as_sflux  !< If true, SSS restore as salt flux instead of water flux
   logical :: adjust_net_srestore_to_zero !< adjust srestore to zero (for both salt_flux or vprec)
   logical :: adjust_net_srestore_by_scaling !< adjust srestore w/o moving zero contour
@@ -169,7 +169,7 @@ module MOM_surface_forcing
   real, pointer, dimension(:,:) :: fprec           =>NULL() !< mass flux of frozen precip (kg/m2/s)
   real, pointer, dimension(:,:) :: runoff          =>NULL() !< mass flux of liquid runoff (kg/m2/s)
   real, pointer, dimension(:,:) :: calving         =>NULL() !< mass flux of frozen runoff (kg/m2/s)
-  real, pointer, dimension(:,:) :: ustar_berg      =>NULL() !< frictional velocity beneath icebergs (m/s)
+  real, pointer, dimension(:,:) :: ustar_berg      =>NULL() !< frictional velocity beneath icebergs [m s-1]
   real, pointer, dimension(:,:) :: area_berg       =>NULL() !< area covered by icebergs(m2/m2)
   real, pointer, dimension(:,:) :: mass_berg       =>NULL() !< mass of icebergs(kg/m2)
   real, pointer, dimension(:,:) :: runoff_hflx     =>NULL() !< heat content of liquid runoff (W/m2)
@@ -979,7 +979,7 @@ subroutine surface_forcing_init(Time, G, US, param_file, diag, CS, restore_salt,
                                              !! temp/salt restoring will be applied
 
   ! local variables
-  real :: utide  !< The RMS tidal velocity, in m s-1.
+  real :: utide  !< The RMS tidal velocity [m s-1].
   type(directories)  :: dirs
   logical            :: new_sim, iceberg_flux_diags
   type(time_type)    :: Time_frc
@@ -1150,7 +1150,7 @@ subroutine surface_forcing_init(Time, G, US, param_file, diag, CS, restore_salt,
 
   endif
 
-! Optionally read tidal amplitude from input file (m s-1) on model grid.
+! Optionally read tidal amplitude from input file [m s-1] on model grid.
 ! Otherwise use default tidal amplitude for bottom frictionally-generated
 ! dissipation. Default cd_tides is chosen to yield approx 1 TWatt of
 ! work done against tides globally using OSU tidal amplitude.

config_src/mct_driver/ocn_comp_mct.F90

@@ -765,7 +765,7 @@ end subroutine ocean_model_init_sfc
 !! x2o_Foxx_rof
 !!
 !! Variables in MOM6 fluxes that are **NOT** filled by the coupler:
-!! ustar_berg, frictional velocity beneath icebergs (m/s)
+!! ustar_berg, frictional velocity beneath icebergs [m s-1]
 !! area_berg, area covered by icebergs(m2/m2)
 !! mass_berg, mass of icebergs(kg/m2)
 !! runoff_hflx, heat content of liquid runoff (W/m2)
@@ -804,8 +804,8 @@ end subroutine ocean_model_init_sfc
 !!
 !! Surface temperature (Kelvin)
 !! Surface salinity (psu)
-!! Surface eastward velocity (m/s)
-!! Surface northward velocity (m/s)
+!! Surface eastward velocity [m s-1]
+!! Surface northward velocity [m s-1]
 !! Zonal slope in the sea surface height
 !! Meridional slope in the sea surface height
 !!

config_src/mct_driver/ocn_cpl_indices.F90

@@ -10,8 +10,8 @@ module ocn_cpl_indices
   type cpl_indices_type
     ! ocean to coupler
     integer :: o2x_So_t          !< Surface potential temperature (deg C)
-    integer :: o2x_So_u          !< Surface zonal velocity (m/s)
-    integer :: o2x_So_v          !< Surface meridional velocity (m/s)
+    integer :: o2x_So_u          !< Surface zonal velocity [m s-1]
+    integer :: o2x_So_v          !< Surface meridional velocity [m s-1]
     integer :: o2x_So_s          !< Surface salinity (PSU)
     integer :: o2x_So_dhdx       !< Zonal slope in the sea surface height
     integer :: o2x_So_dhdy       !< Meridional lope in the sea surface height

config_src/solo_driver/MESO_surface_forcing.F90

@@ -27,8 +27,8 @@ module MESO_surface_forcing
   logical :: use_temperature !< If true, temperature and salinity are used as state variables.
   logical :: restorebuoy     !< If true, use restoring surface buoyancy forcing.
   real :: Rho0               !< The density used in the Boussinesq approximation, in kg m-3.
-  real :: G_Earth            !< The gravitational acceleration in m s-2.
-  real :: Flux_const         !< The restoring rate at the surface, in m s-1.
+  real :: G_Earth            !< The gravitational acceleration [m s-2].
+  real :: Flux_const         !< The restoring rate at the surface [m s-1].
   real :: gust_const         !< A constant unresolved background gustiness
                              !! that contributes to ustar, in Pa.
   real, dimension(:,:), pointer :: &

config_src/solo_driver/MOM_surface_forcing.F90

@@ -80,9 +80,9 @@ module MOM_surface_forcing
 
   real :: Rho0                  !< Boussinesq reference density (kg/m^3)
   real :: G_Earth               !< gravitational acceleration (m/s^2)
-  real :: Flux_const            !< piston velocity for surface restoring (m/s)
-  real :: Flux_const_T          !< piston velocity for surface temperature restoring (m/s)
-  real :: Flux_const_S          !< piston velocity for surface salinity restoring (m/s)
+  real :: Flux_const            !< piston velocity for surface restoring [m s-1]
+  real :: Flux_const_T          !< piston velocity for surface temperature restoring [m s-1]
+  real :: Flux_const_S          !< piston velocity for surface salinity restoring [m s-1]
   real :: latent_heat_fusion    !< latent heat of fusion (J/kg)
   real :: latent_heat_vapor     !< latent heat of vaporization (J/kg)
   real :: tau_x0                !< Constant zonal wind stress used in the WIND_CONFIG="const" forcing
@@ -672,7 +672,7 @@ subroutine wind_forcing_by_data_override(sfc_state, forces, day, G, US, CS)
   ! Local variables
   real :: temp_x(SZI_(G),SZJ_(G)) ! Pseudo-zonal and psuedo-meridional
   real :: temp_y(SZI_(G),SZJ_(G)) ! wind stresses at h-points, in Pa.
-  real :: temp_ustar(SZI_(G),SZJ_(G)) ! ustar in m s-1 (not rescaled).
+  real :: temp_ustar(SZI_(G),SZJ_(G)) ! ustar [m s-1] (not rescaled).
   integer :: i, j, is_in, ie_in, js_in, je_in
   logical :: read_uStar
 

config_src/solo_driver/Neverland_surface_forcing.F90

@@ -33,8 +33,8 @@ module Neverland_surface_forcing
   logical :: restorebuoy     !< If true, use restoring surface buoyancy forcing.
   real :: Rho0               !< The density used in the Boussinesq
                              !! approximation, in kg m-3.
-  real :: G_Earth            !< The gravitational acceleration in m s-2.
-  real :: flux_const         !<  The restoring rate at the surface, in m s-1.
+  real :: G_Earth            !< The gravitational acceleration [m s-2].
+  real :: flux_const         !<  The restoring rate at the surface [m s-1].
   real, dimension(:,:), pointer :: &
     buoy_restore(:,:) => NULL() !< The pattern to restore buoyancy to.
   character(len=200) :: inputdir !< The directory where NetCDF input files are.

config_src/solo_driver/user_surface_forcing.F90

@@ -34,8 +34,8 @@ module user_surface_forcing
   logical :: use_temperature !< If true, temperature and salinity are used as state variables.
   logical :: restorebuoy     !< If true, use restoring surface buoyancy forcing.
   real :: Rho0               !< The density used in the Boussinesq approximation, in kg m-3.
-  real :: G_Earth            !< The gravitational acceleration in m s-2.
-  real :: Flux_const         !< The restoring rate at the surface, in m s-1.
+  real :: G_Earth            !< The gravitational acceleration [m s-2].
+  real :: Flux_const         !< The restoring rate at the surface [m s-1].
   real :: gust_const         !< A constant unresolved background gustiness
                              !! that contributes to ustar, in Pa.