Skip to content

Document units in 9 vertical param modules #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adcroft merged 1 commit into from
Nov 29, 2022
Merged

Document units in 9 vertical param modules #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions src/parameterizations/vertical/MOM_bkgnd_mixing.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ module MOM_bkgnd_mixing
real :: omega !< The Earth's rotation rate [T-1 ~> s-1].
real :: N0_2Omega !< ratio of the typical Buoyancy frequency to
!! twice the Earth's rotation period, used with the
!! Henyey scaling from the mixing
!! Henyey scaling from the mixing [nondim]
real :: prandtl_bkgnd !< Turbulent Prandtl number used to convert
!! vertical background diffusivity into viscosity
!! vertical background diffusivity into viscosity [nondim]
real :: Kd_tanh_lat_scale !< A nondimensional scaling for the range of
!! diffusivities with Kd_tanh_lat_fn. Valid values
!! diffusivities with Kd_tanh_lat_fn [nondim]. Valid values
!! are in the range of -2 to 2; 0.4 reproduces CM2M.
real :: Kd_tot_ml !< The mixed layer diapycnal diffusivity [Z2 T-1 ~> m2 s-1]
!! when no other physically based mixed layer turbulence
Expand Down Expand Up @@ -151,10 +151,12 @@ subroutine bkgnd_mixing_init(Time, G, GV, US, param_file, diag, CS, physical_OBL
CS%physical_OBL_scheme = physical_OBL_scheme
if (CS%physical_OBL_scheme) then
! Check that Kdml is not set when using bulk mixed layer
call get_param(param_file, mdl, "KDML", CS%Kd_tot_ml, default=-1., do_not_log=.true.)
call get_param(param_file, mdl, "KDML", CS%Kd_tot_ml, &
units="m2 s-1", default=-1., scale=US%m2_s_to_Z2_T, do_not_log=.true.)
if (CS%Kd_tot_ml>0.) call MOM_error(FATAL, &
"bkgnd_mixing_init: KDML is a depricated parameter that should not be used.")
call get_param(param_file, mdl, "KD_ML_TOT", CS%Kd_tot_ml, default=-1., do_not_log=.true.)
call get_param(param_file, mdl, "KD_ML_TOT", CS%Kd_tot_ml, &
units="m2 s-1", default=-1., scale=US%m2_s_to_Z2_T, do_not_log=.true.)
if (CS%Kd_tot_ml>0.) call MOM_error(FATAL, &
"bkgnd_mixing_init: KD_ML_TOT cannot be set when using a physically based ocean "//&
"boundary layer mixing parameterization.")
Expand Down Expand Up @@ -338,8 +340,8 @@ subroutine calculate_bkgnd_mixing(h, tv, N2_lay, Kd_lay, Kd_int, Kv_bkgnd, j, G,
real :: I_2Omega !< 1/(2 Omega) [T ~> s]
real :: N_2Omega ! The ratio of the stratification to the Earth's rotation rate [nondim]
real :: N02_N2 ! The ratio a reference stratification to the actual stratification [nondim]
real :: I_x30 !< 2/acos(2) = 1/(sin(30 deg) * acosh(1/sin(30 deg)))
real :: deg_to_rad !< factor converting degrees to radians, pi/180.
real :: I_x30 !< 2/acos(2) = 1/(sin(30 deg) * acosh(1/sin(30 deg))) [nondim]
real :: deg_to_rad !< factor converting degrees to radians [radians degree-1], pi/180.
real :: abs_sinlat !< absolute value of sine of latitude [nondim]
real :: min_sinlat ! The minimum value of the sine of latitude [nondim]
real :: bckgrnd_vdc_psin !< PSI diffusivity in northern hemisphere [Z2 T-1 ~> m2 s-1]
Expand Down Expand Up @@ -455,7 +457,7 @@ subroutine calculate_bkgnd_mixing(h, tv, N2_lay, Kd_lay, Kd_int, Kv_bkgnd, j, G,
enddo
endif

! Now set background diffusivies based on these surface values, possibly with vertical structure.
! Now set background diffusivities based on these surface values, possibly with vertical structure.
if ((.not.CS%physical_OBL_scheme) .and. (CS%Kd /= CS%Kd_tot_ml)) then
! This is a crude way to put in a diffusive boundary layer without an explicit boundary
! layer turbulence scheme. It should not be used for any realistic ocean models.
Expand Down Expand Up @@ -527,7 +529,7 @@ subroutine check_bkgnd_scheme(CS, str)

end subroutine

!> Clear pointers and dealocate memory
!> Clear pointers and deallocate memory
subroutine bkgnd_mixing_end(CS)
type(bkgnd_mixing_cs), pointer :: CS !< Control structure for this module that
!! will be deallocated in this subroutine
Expand Down
200 changes: 114 additions & 86 deletions src/parameterizations/vertical/MOM_bulk_mixed_layer.F90
View file
Open in desktop

Large diffs are not rendered by default.

68 changes: 42 additions & 26 deletions src/parameterizations/vertical/MOM_diabatic_aux.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,20 +242,19 @@ subroutine differential_diffuse_T_S(h, T, S, Kd_T, Kd_S, dt, G, GV)

! local variables
real, dimension(SZI_(G)) :: &
b1_T, b1_S, & ! Variables used by the tridiagonal solvers of T & S [H ~> m or kg m-2].
d1_T, d1_S ! Variables used by the tridiagonal solvers [nondim].
b1_T, b1_S, & ! Variables used by the tridiagonal solvers of T & S [H ~> m or kg m-2].
d1_T, d1_S ! Variables used by the tridiagonal solvers [nondim].
real, dimension(SZI_(G),SZK_(GV)) :: &
c1_T, c1_S ! Variables used by the tridiagonal solvers [H ~> m or kg m-2].
c1_T, c1_S ! Variables used by the tridiagonal solvers [H ~> m or kg m-2].
real, dimension(SZI_(G),SZK_(GV)+1) :: &
mix_T, mix_S ! Mixing distances in both directions across each interface [H ~> m or kg m-2].
real :: h_tr ! h_tr is h at tracer points with a tiny thickness
! added to ensure positive definiteness [H ~> m or kg m-2].
real :: h_neglect ! A thickness that is so small it is usually lost
! in roundoff and can be neglected [H ~> m or kg m-2].
real :: I_h_int ! The inverse of the thickness associated with an
! interface [H-1 ~> m-1 or m2 kg-1].
real :: b_denom_T ! The first term in the denominators for the expressions
real :: b_denom_S ! for b1_T and b1_S, both [H ~> m or kg m-2].
mix_T, mix_S ! Mixing distances in both directions across each interface [H ~> m or kg m-2].
real :: h_tr ! h_tr is h at tracer points with a tiny thickness
! added to ensure positive definiteness [H ~> m or kg m-2].
real :: h_neglect ! A thickness that is so small it is usually lost
! in roundoff and can be neglected [H ~> m or kg m-2].
real :: I_h_int ! The inverse of the thickness associated with an interface [H-1 ~> m-1 or m2 kg-1].
real :: b_denom_T ! The first term in the denominator for the expression for b1_T [H ~> m or kg m-2].
real :: b_denom_S ! The first term in the denominator for the expression for b1_S [H ~> m or kg m-2].
integer :: i, j, k, is, ie, js, je, nz

is = G%isc ; ie = G%iec ; js = G%jsc ; je = G%jec ; nz = GV%ke
Expand Down Expand Up @@ -497,17 +496,18 @@ subroutine find_uv_at_h(u, v, h, u_h, v_h, G, GV, US, ea, eb, zero_mix)
!! v_h as though ea and eb were being supplied with
!! uniformly zero values.

! local variables
! Local variables
real :: b_denom_1 ! The first term in the denominator of b1 [H ~> m or kg m-2].
real :: h_neglect ! A thickness that is so small it is usually lost
! in roundoff and can be neglected [H ~> m or kg m-2].
real :: b1(SZI_(G)) ! A thickness used in the tridiagonal solver [H ~> m or kg m-2]
real :: c1(SZI_(G),SZK_(GV)) ! A variable used in the tridiagonal solver [nondim]
real :: d1(SZI_(G)) ! The complement of c1 [nondim]
real :: a_n(SZI_(G)), a_s(SZI_(G)) ! Fractional weights of the neighboring
real :: a_e(SZI_(G)), a_w(SZI_(G)) ! velocity points, ~1/2 in the open
! ocean, nondimensional.
real :: sum_area, Idenom
! Fractional weights of the neighboring velocity points, ~1/2 in the open ocean.
real :: a_n(SZI_(G)), a_s(SZI_(G)) ! Fractional weights of the neighboring velocity points [nondim]
real :: a_e(SZI_(G)), a_w(SZI_(G)) ! Fractional weights of the neighboring velocity points [nondim]
real :: sum_area ! A sum of adjacent areas [L2 ~> m2]
real :: Idenom ! The inverse of the denomninator in a weighted average [L-2 ~> m-2]
logical :: mix_vertically, zero_mixing
integer :: i, j, k, is, ie, js, je, nz
is = G%isc ; ie = G%iec ; js = G%jsc ; je = G%jec ; nz = GV%ke
Expand All @@ -527,6 +527,12 @@ subroutine find_uv_at_h(u, v, h, u_h, v_h, G, GV, US, ea, eb, zero_mix)
do i=is,ie
sum_area = G%areaCu(I-1,j) + G%areaCu(I,j)
if (sum_area > 0.0) then
! If this were a simple area weighted average, this would just be I_denom = 1.0 / sum_area.
! The other factor of sqrt(0.5*sum_area*G%IareaT(i,j)) is 1 for open ocean points on a
! Cartesian grid. This construct predates the initial commit of the MOM6 code, and was
! present in the GOLD code before February, 2010. I do not recall why this was added, and
! the GOLD CVS server that contained the relevant history and logs appears to have been
! decommissioned.
Idenom = sqrt(0.5*G%IareaT(i,j) / sum_area)
a_w(i) = G%areaCu(I-1,j) * Idenom
a_e(i) = G%areaCu(I,j) * Idenom
Expand Down Expand Up @@ -803,7 +809,7 @@ subroutine diagnoseMLDbyEnergy(id_MLD, h, tv, G, GV, US, Mixing_Energy, diagPtr)
! converges extremely quickly (usually 1 guess) since this equation turns out to be rather
! linear for PE change with increasing X.
! Input parameters:
integer, dimension(3), intent(in) :: id_MLD !< Energy output diag IDs
integer, dimension(3), intent(in) :: id_MLD !< Energy output diagnostic IDs
type(ocean_grid_type), intent(in) :: G !< Grid type
type(verticalGrid_type), intent(in) :: GV !< ocean vertical grid structure
type(unit_scale_type), intent(in) :: US !< A dimensional unit scaling type
Expand Down Expand Up @@ -1045,13 +1051,19 @@ subroutine applyBoundaryFluxesInOut(CS, G, GV, US, dt, fluxes, optics, nsw, h, t
! Local variables
integer, parameter :: maxGroundings = 5
integer :: numberOfGroundings, iGround(maxGroundings), jGround(maxGroundings)
real :: H_limit_fluxes
real :: IforcingDepthScale
real :: H_limit_fluxes ! Surface fluxes are scaled down fluxes when the total depth of the ocean
! drops below this value [H ~> m or kg m-2]
real :: IforcingDepthScale ! The inverse of the layer thickness below which mass losses are
! shifted to the next deeper layer [H ~> m or kg m-2]
real :: Idt ! The inverse of the timestep [T-1 ~> s-1]
real :: dThickness, dTemp, dSalt
real :: fractionOfForcing, hOld, Ithickness
real :: dThickness ! The change in layer thickness [H ~> m or kg m-2]
real :: dTemp ! The integrated change in layer temperature [C H ~> degC m or degC kg m-2]
real :: dSalt ! The integrated change in layer salinity [S H ~> ppt m or ppt kg m-2]
real :: fractionOfForcing ! THe fraction of the remaining forcing applied to a layer [nondim]
real :: hOld ! The original thickness of a layer [H ~> m or kg m-2]
real :: Ithickness ! The inverse of the new layer thickness [H-1 ~> m-1 or m2 kg-1]
real :: RivermixConst ! A constant used in implementing river mixing [R Z2 T-1 ~> Pa s].
real :: EnthalpyConst ! A constant used to control the enthalpy calculation
real :: EnthalpyConst ! A constant used to control the enthalpy calculation [nondim]
! By default EnthalpyConst = 1.0. If fluxes%heat_content_evap
! is associated enthalpy is provided via coupler and EnthalpyConst = 0.0.
real, dimension(SZI_(G)) :: &
Expand Down Expand Up @@ -1092,13 +1104,17 @@ subroutine applyBoundaryFluxesInOut(CS, G, GV, US, dt, fluxes, optics, nsw, h, t
opacityBand ! The opacity (inverse of the exponential absorption length) of each frequency
! band of shortwave radiation in each layer [H-1 ~> m-1 or m2 kg-1]
real, dimension(maxGroundings) :: hGrounding ! Thickness added by each grounding event [H ~> m or kg m-2]
real :: Temp_in, Salin_in
real :: Temp_in ! The initial temperature of a layer [C ~> degC]
real :: Salin_in ! The initial salinity of a layer [S ~> ppt]
real :: g_Hconv2 ! A conversion factor for use in the TKE calculation
! in units of [Z3 R2 T-2 H-2 ~> kg2 m-5 s-2 or m s-2].
real :: GoRho ! g_Earth times a unit conversion factor divided by density
! [Z T-2 R-1 ~> m4 s-2 kg-1]
logical :: calculate_energetics
logical :: calculate_buoyancy
logical :: calculate_energetics ! If true, calculate the energy required to mix the newly added
! water over the topmost grid cell, assuming that the fluxes of heat and salt
! and rejected brine are initially applied in vanishingly thin layers at the
! top of the layer before being mixed throughout the layer.
logical :: calculate_buoyancy ! If true, calculate the surface buoyancy flux.
integer, dimension(2) :: EOSdom ! The i-computational domain for the equation of state
integer :: i, j, is, ie, js, je, k, nz, nb
character(len=45) :: mesg
Expand Down
Loading