Skip to content

Commit

Permalink
Fixed 28 variable unit descriptions
Browse files Browse the repository at this point in the history
  Corrected the unit descriptions in comments for 28 variables, which were
either inconsistent or missing.  All answers are bitwise identical.
  • Loading branch information
Hallberg-NOAA committed Dec 30, 2021
1 parent 4e2454b commit dde02fb
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 31 deletions.
24 changes: 12 additions & 12 deletions src/SIS2_ice_thm.F90
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ subroutine ice_temp_SIS2(m_pond, m_snow, m_ice, enthalpy, sice, SF_0, dSF_dT, so
real, intent(in ) :: dtt !< timestep [T ~> s]
integer, intent(in ) :: NkIce !< The number of ice layers.
real, intent(inout) :: tmelt !< accumulated top melting energy [Q R Z ~> J m-2]
real, intent(inout) :: bmelt !< accumulated bottom melting energy [Q R Z ~> J m-2]
real, intent(inout) :: bmelt !< accumulated bottom melting energy [Q R Z ~> J m-2]
type(SIS2_ice_thm_CS), intent(in) :: CS !< The SIS2 ice thermodynamics control structure
type(unit_scale_type), intent(in) :: US !< A structure with unit conversion factors
type(ice_thermo_type), intent(in) :: ITV !< The ice thermodynamic parameter structure.
Expand Down Expand Up @@ -592,7 +592,7 @@ subroutine estimate_tsurf(m_pond, m_snow, m_ice, enthalpy, sice, SF_0, dSF_dT, &
real :: Cp_ice ! The heat capacity of ice [Q degC-1 ~> J kg-1 degC-1].
real :: Cp_brine ! The heat capacity of liquid water in the brine pockets,
! [Q degC-1 ~> J kg-1 degC-1].
real :: Lat_fus ! The latent heat of fusion [Q degC-1 ~> J kg-1].
real :: Lat_fus ! The latent heat of fusion [Q ~> J kg-1].
integer :: k

temp_IC(0) = temp_from_En_S(enthalpy(0), 0.0, ITV)
Expand Down Expand Up @@ -703,9 +703,9 @@ function laytemp_SIS2(m_ice, T_fr, Qf, bf, tp, enth, salin, dtt, ITV, US) result
real, intent(in) :: m_ice !< mass of ice [R Z ~> kg m-2]
real, intent(in) :: T_fr !< ice freezing temp [degC] (determined by salinity)
real, intent(in) :: Qf !< Inward forcing [Q R Z T-1 ~> W m-2]
real, intent(in) :: bf !< response of outward heat flux to local temperature [Q R Z T-1 ~> W m-2 degC]
real, intent(in) :: bf !< response of outward heat flux to local temperature [Q R Z T-1 degC-1 ~> W m-2 degC-1]
real, intent(in) :: tp !< prior step temperature [degC]
real, intent(in) :: enth !< prior step enthalpy
real, intent(in) :: enth !< prior step enthalpy [Q ~> J kg-1] (unused)
real, intent(in) :: salin !< ice salinity [gSalt kg-1].
real, intent(in) :: dtt !< timestep [T ~> s]
type(ice_thermo_type), intent(in) :: ITV !< The ice thermodynamic parameter structure.
Expand Down Expand Up @@ -865,8 +865,8 @@ subroutine update_lay_enth(m_lay, sice, enth, ftop, ht_body, fbot, dftop_dT, &
!! the prescribed heat flux if dftop_dT = 0 [Q R Z T-1 ~> W m-2].
real, intent(in) :: ht_body !< Body heating to layer [Q R Z T-1 ~> W m-2]
real, intent(inout) :: fbot !< Downward heat below the layer at T = 0 degC [Q R Z T-1 ~> W m-2].
real, intent(in) :: dftop_dT !< The linearization of ftop with layer temperature [Q R Z T-1 ~> W m-2 degC-1].
real, intent(in) :: dfbot_dT !< The linearization of fbot with layer temperature [Q R Z T-1 ~> W m-2 degC-1].
real, intent(in) :: dftop_dT !< The linearization of ftop with layer temperature [Q R Z T-1 degC-1 ~> W m-2 degC-1].
real, intent(in) :: dfbot_dT !< The linearization of fbot with layer temperature [Q R Z T-1 degC-1 ~> W m-2 degC-1].
real, intent(in) :: dtt !< The timestep [T ~> s]
real, intent(in) :: hf_err_rat !< A conversion factor for comparing the errors
!! in explicit and implicit estimates of the updated
Expand Down Expand Up @@ -909,7 +909,7 @@ subroutine update_lay_enth(m_lay, sice, enth, ftop, ht_body, fbot, dftop_dT, &
! [Q degC-1 ~> J kg-1 degC-1].
real :: Cp_water ! The heat capacity of liquid water in the ice model,
! but not in the brine pockets [Q degC-1 ~> J kg-1 degC-1].
real :: LI ! The latent heat of fusion [Q degC-1 ~> J kg-1].
real :: LI ! The latent heat of fusion [Q ~> J kg-1].
integer :: itt
! real :: T_itt(20), dTemp(20), Err_itt(20)

Expand Down Expand Up @@ -1210,7 +1210,7 @@ subroutine ice_resize_SIS2(a_ice, m_pond, m_lay, Enthalpy, Sice_therm, Salin, &
! enthalpy [Q ~> J kg-1].
real :: min_dEnth_freeze ! The minimum enthalpy change that must occur when freezing water,
! usually enough to account for the latent heat of fusion
! in a small fraction of the water [Q ~> J kg-2].
! in a small fraction of the water [Q ~> J kg-1].
real :: m_freeze ! The newly formed ice from freezing [R Z ~> kg m-2].
real :: M_melt ! The ice mass lost to melting [R Z ~> kg m-2].
real :: evap_left ! The remaining evaporation [R Z ~> kg m-2].
Expand Down Expand Up @@ -1502,12 +1502,12 @@ subroutine add_frazil_SIS2(m_lay, Enthalpy, Sice_therm, Salin, npassive, TrLay,
! Local variables
real :: enth_frazil ! The enthalpy of newly formed frazil ice [Q ~> J kg-1].
real :: frazil_per_layer ! The frazil heat sink from each of the sublayers of
! of the ice [Q R Z ~> J kg-1].
! of the ice [Q R Z ~> J m-2].
real :: t_frazil ! The temperature which with the frazil-ice is created [degC].
real :: m_frazil ! The newly-formed mass per unit area of frazil ice [R Z ~> kg m-2].
real :: min_dEnth_freeze ! The minimum enthalpy change that must occur when freezing water,
! usually enough to account for the latent heat of fusion
! in a small fraction of the water [Q ~> J kg-2].
! in a small fraction of the water [Q ~> J kg-1].
real :: salin_freeze ! The salinity of newly frozen ice [gSalt kg-1].
real :: enthM_freezing ! The enthalpy gain due to the mass gain by freezing [Q R Z ~> J m-2].
real :: LI ! The latent heat of fusion [Q ~> J kg-1].
Expand Down Expand Up @@ -1591,7 +1591,7 @@ subroutine rebalance_ice_layers(m_lay, mtot_ice, Enthalpy, Salin, NkIce, npassiv
intent(inout) :: TrLay !< Passive tracer in the column layer [Conc]

real, dimension(NkIce) :: mlay_new ! New mass in a layer [R Z ~> kg m-2]
real, dimension(NkIce) :: enth_ice_new ! New integrated enthalpy [R Z Q ~> kg m-2 Enth]
real, dimension(NkIce) :: enth_ice_new ! New integrated enthalpy [Q R Z ~> J m-2]
real, dimension(NkIce) :: sal_ice_new ! New integrated salinity [R Z gSalt kg-1 ~> gSalt m-2]
real, dimension(NkIce,npassive) :: tr_ice_new ! New integrated tracer amount [R Z Conc ~> kg Conc m-2]
real :: m_k1_to_k2 ! The being transferred from layer k1 to layer k2 [R Z ~> kg m-2]
Expand Down Expand Up @@ -1993,7 +1993,7 @@ function Temp_from_En_S(En, S, ITV) result(Temp)
type(ice_thermo_type), intent(in) :: ITV !< The ice thermodynamic parameter structure.
real :: Temp !< Temperature [degC].

real :: I_Cp_Ice, I_Cp_Water ! Inverse heat capacities [degC Q ~> kg degC J-1].
real :: I_Cp_Ice, I_Cp_Water ! Inverse heat capacities [degC Q-1 ~> degC kg J-1].
real :: BB ! A temporary variable [Q ~> J kg-1]
real :: T_fr ! The freezing temperature [degC].
real :: En_J ! Enthalpy with 0 offset [Q ~> J kg-1].
Expand Down
4 changes: 2 additions & 2 deletions src/SIS_continuity.F90
Original file line number Diff line number Diff line change
Expand Up @@ -1191,7 +1191,7 @@ subroutine meridional_mass_flux(v, dt, G, US, IG, CS, LB, h_in, vh, htot_in, vh_
I_htot, & ! The inverse of htot or 0 [R-1 Z-1 ~> m2 kg-1].
hl, hr ! Left and right face thicknesses [R Z ~> kg m-2].
real, dimension(SZI_(G)) :: &
vhtot ! The total transports [R Z L2 s-1 ~> kg s-1].
vhtot ! The total transports [R Z L2 T-1 ~> kg s-1].
real :: CFL ! The CFL number based on the local velocity and grid spacing [nondim].
real :: curv_3 ! A measure of the thickness curvature over a grid length,
! with the same units as h_in.
Expand Down Expand Up @@ -1310,7 +1310,7 @@ subroutine meridional_mass_flux(v, dt, G, US, IG, CS, LB, h_in, vh, htot_in, vh_
enddo
elseif (present(vh_tot)) then
do i=ish,ieh
vh_tot(i,J) = vhtot(I)
vh_tot(i,J) = vhtot(i)
enddo
endif

Expand Down
14 changes: 7 additions & 7 deletions src/SIS_dyn_bgrid.F90
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module SIS_dyn_bgrid
real, dimension(:,:), pointer :: &
sig11 => NULL(), & !< The xx component of the stress tensor [R Z L2 T-2 ~> Pa m] (or N m-1).
sig12 => NULL(), & !< The xy and yx component of the stress tensor [R Z L2 T-2 ~> Pa m] (or N m-1).
sig22 => NULL() !< The yy component of the stress tensor [RZ Z L2 T-2 ~> Pa m] (or N m-1).
sig22 => NULL() !< The yy component of the stress tensor [R Z L2 T-2 ~> Pa m] (or N m-1).

! parameters for calculating water drag and internal ice stresses
real :: p0 !< Hibbler rheology pressure constant [R L2 T-2 ~> Pa]
Expand Down Expand Up @@ -642,10 +642,10 @@ function sigI(mi, ci, sig11, sig22, sig12, G, US, CS)
type(SIS_hor_grid_type), intent(in) :: G !< The horizontal grid type
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: mi !< Mass per unit ocean area of sea ice [R Z ~> kg m-2]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: ci !< Sea ice concentration [nondim]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig11 !< The xx component of the stress tensor [RZ Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig22 !< The yy component of the stress tensor [RZ Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig11 !< The xx component of the stress tensor [R Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig22 !< The yy component of the stress tensor [R Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig12 !< The xy & yx component of the stress
!! tensor [RZ Z L2 T-2 ~> Pa m] (or N m-1)
!! tensor [R Z L2 T-2 ~> Pa m] (or N m-1)
real, dimension(SZI_(G),SZJ_(G)) :: sigI !< The first stress invariant [nondim]
type(unit_scale_type), intent(in) :: US !< A structure with unit conversion factors
type(SIS_B_dyn_CS), pointer :: CS !< The control structure for this module
Expand All @@ -667,10 +667,10 @@ function sigII(mi, ci, sig11, sig22, sig12, G, US, CS)
type(SIS_hor_grid_type), intent(in) :: G !< The horizontal grid type
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: mi !< Mass per unit ocean area of sea ice [R Z ~> kg m-2]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: ci !< Sea ice concentration [nondim]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig11 !< The xx component of the stress tensor [RZ Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig22 !< The yy component of the stress tensor [RZ Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig11 !< The xx component of the stress tensor [R Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig22 !< The yy component of the stress tensor [R Z L2 T-2 ~> Pa m]
real, dimension(SZI_(G),SZJ_(G)), intent(in) :: sig12 !< The xy & yx component of the stress
!! tensor [RZ Z L2 T-2 ~> Pa m] (or N m-1)
!! tensor [R Z L2 T-2 ~> Pa m] (or N m-1)
real, dimension(SZI_(G),SZJ_(G)) :: sigII !< The second stress invariant [nondim]
type(unit_scale_type), intent(in) :: US !< A structure with unit conversion factors
type(SIS_B_dyn_CS), pointer :: CS !< The control structure for this module
Expand Down
2 changes: 1 addition & 1 deletion src/SIS_dyn_cgrid.F90
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ module SIS_dyn_cgrid
real, allocatable, dimension(:,:) :: &
str_t, & !< The tension stress tensor component [R Z L2 T-2 ~> Pa m].
str_d, & !< The divergence stress tensor component [R Z L2 T-2 ~> Pa m].
str_s !< The shearing stress tensor component (cross term) [T Z L2 T-2 ~> Pa m].
str_s !< The shearing stress tensor component (cross term) [R Z L2 T-2 ~> Pa m].

! parameters for calculating water drag and internal ice stresses
real :: p0 !< Pressure constant in the Hibler rheology [R L2 T-2 ~> Pa]
Expand Down
2 changes: 1 addition & 1 deletion src/SIS_fast_thermo.F90
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@ subroutine redo_update_ice_model_fast(IST, sOSS, Rad, FIA, TSF, optics_CSp, &
real :: flux_sw_prev ! The previous value of flux_sw_top [Q R Z T-1 ~> W m-2].
real :: rescale ! A rescaling factor between 0 and 1 [nondim].
real :: bmelt_tmp, tmelt_tmp ! Temporary arrays [Q R Z ~> J m-2].
real :: dSWt_dt ! The derivative of SW_tot with skin temperature [Q R Z T-1 ~> W m-2 degC-1].
real :: dSWt_dt ! The derivative of SW_tot with skin temperature [Q R Z T-1 degC-1 ~> W m-2 degC-1].
real :: Tskin_prev ! The previous value of Tskin [degC]
real :: T_bright ! A skin temperature below which the snow and ice attain
! their greatest brightness and albedo no longer varies [degC].
Expand Down
8 changes: 4 additions & 4 deletions src/SIS_tracer_advect.F90
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ subroutine kernel_uhh_CFL_x(G, is, ie, j, hprev, uhr, uhh, CFL, domore_u, h_negl
real, intent(in) :: mass_neglect ! A cell mass that is so small it is usually
!! lost in roundoff and can be neglected, or 0 to use
!! h_neglect times area [R Z L2 ~> kg]. If this is
!! negative use an Adcroft-rule reciprocal in CFL.
!! negative use an Adcroft-rule reciprocal in CFL.
! Local
integer :: i
real :: hup, hlos ! Upwind cell mass and an outward transport [R Z L2 ~> kg]
Expand Down Expand Up @@ -1297,7 +1297,7 @@ subroutine advect_y(Tr, hprev, vhr, vh_neglect, domore_v, ntr, nL_max, Idt, is,
intent(inout) :: Tr !< The tracers being advected
real, dimension(SZI_(G),SZJ_(G),SZCAT_(IG)), &
intent(inout) :: hprev !< Category thickness times fractional coverage
!! before this step of advection [R Z ~> kg m-2].
!! before this step of advection [R Z L2 ~> kg].
real, dimension(SZI_(G),SZJB_(G),SZCAT_(IG)), &
intent(inout) :: vhr !< Remaining volume or mass fluxes through
!! meridional faces [R Z L2 ~> kg].
Expand Down Expand Up @@ -1495,7 +1495,7 @@ subroutine kernel_vhh_CFL_y(G, is, ie, J, hprev, vhr, vhh, CFL, domore_v, h_negl
integer, intent(in) :: J !< The j-index to work on
real, dimension(SZI_(G),SZJ_(G)), &
intent(in) :: hprev !< Category thickness times fractional coverage
!! before this step of advection [R Z L2 ~> kg m-2].
!! before this step of advection [R Z L2 ~> kg].
real, dimension(SZI_(G),SZJB_(G)), &
intent(in) :: vhr !< Remaining volume or mass fluxes through
!! meridional faces [R Z L2 ~> kg].
Expand All @@ -1506,7 +1506,7 @@ subroutine kernel_vhh_CFL_y(G, is, ie, J, hprev, vhr, vhh, CFL, domore_v, h_negl
logical, dimension(SZJB_(G)), &
intent(inout) :: domore_v !< True in rows with more advection to be done
real, intent(in) :: h_neglect !< A thickness that is so small it is usually lost
!! in roundoff and can be neglected [R Z L2 ~> kg m-2].
!! in roundoff and can be neglected [R Z ~> kg m-2].
real, intent(in) :: mass_neglect ! A cell mass that is so small it is usually
!! lost in roundoff and can be neglected, or 0 to use
!! h_neglect times area [R Z L2 ~> kg]. If this is
Expand Down
8 changes: 4 additions & 4 deletions src/SIS_types.F90
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,14 @@ module SIS_types
WindStr_ocn_x, & !< The zonal wind stress on open water on an A-grid [R L Z T-2 ~> Pa].
WindStr_ocn_y, & !< The meridional wind stress on open water on an A-grid [R L Z T-2 ~> Pa].
p_atm_surf , & !< The atmospheric pressure at the top of the ice [R L Z T-2 ~> Pa].
runoff, & !< Liquid runoff into the ocean [R Z T-1 ~> kg m-2].
calving !< Calving of ice or runoff of frozen fresh water into the ocean [R Z T-1 ~> kg m-2].
runoff, & !< Liquid runoff into the ocean [R Z T-1 ~> kg m-2 s-1].
calving !< Calving of ice or runoff of frozen fresh water into the ocean [R Z T-1 ~> kg m-2 s-1].
real, allocatable, dimension(:,:) :: runoff_hflx !< The heat flux associated with runoff, based
!! on the temperature difference relative to a reference temperature [Q R Z T-1 ~> W m-2]
real, allocatable, dimension(:,:) :: calving_hflx !< The heat flux associated with calving, based
!! on the temperature difference relative to a reference temperature [Q R Z T-1 ~> W m-2]
real, allocatable, dimension(:,:) :: calving_preberg !< Calving of ice or runoff of frozen fresh
!! water into the ocean, exclusive of any iceberg contributions [R Z T-1 ~> kg m-2].
!! water into the ocean, exclusive of any iceberg contributions [R Z T-1 ~> kg m-2 s-1].
real, allocatable, dimension(:,:) :: calving_hflx_preberg !< The heat flux associated with calving
!! exclusive of any iceberg contributions, based on the temperature difference
!! relative to a reference temperature [Q R Z T-1 ~> W m-2]
Expand Down Expand Up @@ -855,7 +855,7 @@ subroutine rescale_fast_to_slow_restart_fields(FIA, Rad, TSF, G, US, IG)
FIA%evap0(i,j,k) = RZ_T_rescale * FIA%evap0(i,j,k) ! [R Z T-1 ~> kg m-2 s-1]
FIA%dshdt(i,j,k) = QRZ_T_rescale * FIA%dshdt(i,j,k) ! [Q R Z T-1 degC-1 ~> W m-2 degC-1]
FIA%dlwdt(i,j,k) = QRZ_T_rescale * FIA%dlwdt(i,j,k) ! [Q R Z T-1 degC-1 ~> W m-2 degC-1]
FIA%devapdt(i,j,k) = RZ_T_rescale * FIA%devapdt(i,j,k) ! [Q R Z T-1 degC-1 ~> kg m-2 s-1 degC-1]
FIA%devapdt(i,j,k) = RZ_T_rescale * FIA%devapdt(i,j,k) ! [R Z T-1 degC-1 ~> kg m-2 s-1 degC-1]
! ! Do not rescale FIA%Tskin_cat(i,j,k) = FIA%Tskin_cat(i,j,k) ! [degC]
enddo ; enddo ; enddo ; endif

Expand Down

0 comments on commit dde02fb

Please sign in to comment.