Skip to content

Commit

Permalink
add tidal diagnostics for cvmix
Browse files Browse the repository at this point in the history
  • Loading branch information
@alperaltuntas
alperaltuntas committed Apr 3, 2018
1 parent 8977888 commit ea813b8
Showing 1 changed file with 117 additions and 67 deletions.
184 changes: 117 additions & 67 deletions src/parameterizations/vertical/MOM_tidal_mixing.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,30 @@ module MOM_tidal_mixing
public post_tidal_diagnostics
public tidal_mixing_end

!> Control structure for tidal mixing diagnostics
!> Containers for tidal mixing diagnostics
type, public :: tidal_mixing_diags
real, pointer, dimension(:,:,:) :: &
Kd_itidal => NULL(),& ! internal tide diffusivity at interfaces (m2/s)
Fl_itidal => NULL(),& ! vertical flux of tidal turbulent dissipation (m3/s3)
Kd_lowmode => NULL(),& ! internal tide diffusivity at interfaces
! due to propagating low modes (m2/s) (BDM)
Fl_lowmode => NULL(),& ! vertical flux of tidal turbulent dissipation
! due to propagating low modes (m3/s3) (BDM)
Kd_Niku => NULL(),& ! lee-wave diffusivity at interfaces (m2/s)
Kd_Niku_work => NULL(),& ! layer integrated work by lee-wave driven mixing (W/m2)
Kd_Itidal_Work => NULL(),& ! layer integrated work by int tide driven mixing (W/m2)
Kd_Lowmode_Work=> NULL() ! layer integrated work by low mode driven mixing (W/m2) BDM
Kd_itidal => NULL(),& ! internal tide diffusivity at interfaces (m2/s)
Fl_itidal => NULL(),& ! vertical flux of tidal turbulent dissipation (m3/s3)
Kd_lowmode => NULL(),& ! internal tide diffusivity at interfaces
! due to propagating low modes (m2/s) (BDM)
Fl_lowmode => NULL(),& ! vertical flux of tidal turbulent dissipation
! due to propagating low modes (m3/s3) (BDM)
Kd_Niku => NULL(),& ! lee-wave diffusivity at interfaces (m2/s)
Kd_Niku_work => NULL(),& ! layer integrated work by lee-wave driven mixing (W/m2)
Kd_Itidal_Work => NULL(),& ! layer integrated work by int tide driven mixing (W/m2)
Kd_Lowmode_Work => NULL(),& ! layer integrated work by low mode driven mixing (W/m2) BDM
N2_int => NULL(),&
vert_dep_3d => NULL()

real, pointer, dimension(:,:) :: &
TKE_itidal_used => NULL(),& ! internal tide TKE input at ocean bottom (W/m2)
N2_bot => NULL(),& ! bottom squared buoyancy frequency (1/s2)
N2_meanz => NULL(),& ! vertically averaged buoyancy frequency (1/s2)
Polzin_decay_scale_scaled => NULL(),& ! vertical scale of decay for tidal dissipation
Polzin_decay_scale => NULL() ! vertical decay scale for tidal diss with Polzin (meter)
Polzin_decay_scale => NULL(),& ! vertical decay scale for tidal diss with Polzin (meter)
Simmons_coeff_2d => NULL()

end type

!> Control structure for tidal mixing module.
Expand Down Expand Up @@ -161,6 +165,9 @@ module MOM_tidal_mixing
integer :: id_Fl_lowmode = -1
integer :: id_Polzin_decay_scale = -1
integer :: id_Polzin_decay_scale_scaled = -1
integer :: id_N2_int = -1
integer :: id_Simmons_coeff = -1
integer :: id_vert_dep = -1

end type tidal_mixing_cs

Expand Down Expand Up @@ -567,6 +574,18 @@ logical function tidal_mixing_init(Time, G, GV, param_file, diag, diag_to_Z_CSp,
endif

endif

! CVMix tidal diagnostics
if (CS%use_cvmix_tidal) then

CS%id_N2_int = register_diag_field('ocean_model','N2_int',diag%axesT1,Time, &
'Bouyancy frequency squared, at interfaces', 's-2')
CS%id_Simmons_coeff = register_diag_field('ocean_model','Simmons_coeff',diag%axesTi,Time, &
'time-invariant portion of the tidal mixing coefficient using the Simmons', '')
CS%id_vert_dep = register_diag_field('ocean_model','vert_dep',diag%axesTi,Time, &
'vertical deposition function needed for Simmons et al tidal mixing', '')
endif

end function tidal_mixing_init


Expand Down Expand Up @@ -611,7 +630,6 @@ subroutine calculate_cvmix_tidal(h, j, G, GV, CS, N2_int, Kd)
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(inout) :: Kd

! local
logical, parameter :: init_every_tstep = .true.
real, dimension(SZK_(G)+1) :: Kd_tidal !< tidal diffusivity [m2/s]
real, dimension(SZK_(G)+1) :: Kv_tidal !< tidal viscosity [m2/s]
real, dimension(SZK_(G)+1) :: vert_dep !< vertical deposition needed for Simmons tidal mixing.
Expand All @@ -621,62 +639,77 @@ subroutine calculate_cvmix_tidal(h, j, G, GV, CS, N2_int, Kd)
integer :: isd, ied, jsd, jed
real :: dh, hcorr, Simmons_coeff
real, parameter :: rho_fw = 1000.0 ! fresh water density [kg/m^3] ! TODO: when coupled, get this from CESM (SHR_CONST_RHOFW)
type(tidal_mixing_diags), pointer :: dd

if (init_every_tstep) then

select case (CS%int_tide_profile)
case (SIMMONS_04)
do i=is,ie
iFaceHeight = 0.0 ! BBL is all relative to the surface
hcorr = 0.0
do k=1,G%ke
! cell center and cell bottom in meters (negative values in the ocean)
dh = h(i,j,k) * GV%H_to_m ! Nominal thickness to use for increment
dh = dh + hcorr ! Take away the accumulated error (could temporarily make dh<0)
hcorr = min( dh - CS%min_thickness, 0. ) ! If inflating then hcorr<0
dh = max( dh, CS%min_thickness ) ! Limit increment dh>=min_thickness
cellHeight(k) = iFaceHeight(k) - 0.5 * dh
iFaceHeight(k+1) = iFaceHeight(k) - dh
enddo

if (G%mask2dT(i,j)<1) return

call cvmix_compute_Simmons_invariant( nlev = G%ke, &
energy_flux = CS%tidal_qe_2d(i,j), &
rho = rho_fw, &
SimmonsCoeff = Simmons_coeff, &
VertDep = vert_dep, &
zw = iFaceHeight, &
zt = cellHeight, &
CVmix_tidal_params_user = CS%cvmix_tidal_params)

! Since we pass tidal_qe_2d=(CS%Gamma_itides)*tidal_energy_flux_2d, and not tidal_energy_flux_2d in
! above subroutine call, we divide Simmons_coeff by CS%Gamma_itides as a corrective step:
Simmons_coeff = Simmons_coeff / CS%Gamma_itides


call cvmix_coeffs_tidal( Mdiff_out = Kv_tidal, &
Tdiff_out = Kd_tidal, &
Nsqr = N2_int(i,:), &
OceanDepth = iFaceHeight(G%ke+1), &
SimmonsCoeff = Simmons_coeff, &
vert_dep = vert_dep, &
nlev = G%ke, &
max_nlev = G%ke, &
CVmix_params = CS%cvmix_glb_params, &
CVmix_tidal_params_user = CS%cvmix_tidal_params)

do k=1,G%ke
Kd(i,j,k) = Kd(i,j,k) + 0.5*(Kd_tidal(k) + Kd_tidal(k+1) )
!TODO: Kv(i,j,k) = ????????????
enddo
dd => CS%dd

select case (CS%int_tide_profile)
case (SIMMONS_04)
do i=is,ie
iFaceHeight = 0.0 ! BBL is all relative to the surface
hcorr = 0.0
do k=1,G%ke
! cell center and cell bottom in meters (negative values in the ocean)
dh = h(i,j,k) * GV%H_to_m ! Nominal thickness to use for increment
dh = dh + hcorr ! Take away the accumulated error (could temporarily make dh<0)
hcorr = min( dh - CS%min_thickness, 0. ) ! If inflating then hcorr<0
dh = max( dh, CS%min_thickness ) ! Limit increment dh>=min_thickness
cellHeight(k) = iFaceHeight(k) - 0.5 * dh
iFaceHeight(k+1) = iFaceHeight(k) - dh
enddo
! TODO: case (SCHMITTNER)
case default
call MOM_error(FATAL, "tidal_mixing_init: The selected"// &
" INT_TIDE_PROFILE is unavailable in CVMix")
end select
endif

if (G%mask2dT(i,j)<1) return

call cvmix_compute_Simmons_invariant( nlev = G%ke, &
energy_flux = CS%tidal_qe_2d(i,j), &
rho = rho_fw, &
SimmonsCoeff = Simmons_coeff, &
VertDep = vert_dep, &
zw = iFaceHeight, &
zt = cellHeight, &
CVmix_tidal_params_user = CS%cvmix_tidal_params)

! Since we pass tidal_qe_2d=(CS%Gamma_itides)*tidal_energy_flux_2d, and not tidal_energy_flux_2d in
! above subroutine call, we divide Simmons_coeff by CS%Gamma_itides as a corrective step:
Simmons_coeff = Simmons_coeff / CS%Gamma_itides


call cvmix_coeffs_tidal( Mdiff_out = Kv_tidal, &
Tdiff_out = Kd_tidal, &
Nsqr = N2_int(i,:), &
OceanDepth = iFaceHeight(G%ke+1), &
SimmonsCoeff = Simmons_coeff, &
vert_dep = vert_dep, &
nlev = G%ke, &
max_nlev = G%ke, &
CVmix_params = CS%cvmix_glb_params, &
CVmix_tidal_params_user = CS%cvmix_tidal_params)

do k=1,G%ke
Kd(i,j,k) = Kd(i,j,k) + 0.5*(Kd_tidal(k) + Kd_tidal(k+1) )
!TODO: Kv(i,j,k) = ????????????
enddo

! diagnostics
if (associated(dd%Kd_itidal)) then
dd%Kd_itidal(i,j,:) = Kd_tidal(:)
endif
if (associated(dd%N2_int)) then
dd%N2_int(i,j,:) = N2_int(i,:)
endif
if (associated(dd%Simmons_coeff_2d)) then
dd%Simmons_coeff_2d(i,j) = Simmons_coeff
endif
if (associated(dd%vert_dep_3d)) then
dd%vert_dep_3d(i,j,:) = vert_dep(:)
endif

enddo
! TODO: case (SCHMITTNER)
case default
call MOM_error(FATAL, "tidal_mixing_init: The selected"// &
" INT_TIDE_PROFILE is unavailable in CVMix")
end select

end subroutine calculate_cvmix_tidal

Expand Down Expand Up @@ -1137,6 +1170,16 @@ subroutine setup_tidal_diagnostics(G,CS)
if (CS%id_TKE_itidal > 0) then
allocate(dd%TKE_Itidal_used(isd:ied,jsd:jed)) ; dd%TKE_Itidal_used(:,:) = 0.
endif
! additional diags for CVMix
if (CS%id_N2_int > 0) then
allocate(dd%N2_int(isd:ied,jsd:jed,nz+1)) ; dd%N2_int(:,:,:) = 0.0
endif
if (CS%id_Simmons_coeff > 0) then
allocate(dd%Simmons_coeff_2d(isd:ied,jsd:jed)) ; dd%Simmons_coeff_2d(:,:) = 0.0
endif
if (CS%id_vert_dep > 0) then
allocate(dd%vert_dep_3d(isd:ied,jsd:jed,nz+1)) ; dd%vert_dep_3d(:,:,:) = 0.0
endif
end subroutine setup_tidal_diagnostics

subroutine post_tidal_diagnostics(G,GV,h,CS)
Expand Down Expand Up @@ -1168,6 +1211,10 @@ subroutine post_tidal_diagnostics(G,GV,h,CS)
if (CS%id_Kd_lowmode> 0) call post_data(CS%id_Kd_lowmode, dd%Kd_lowmode, CS%diag)
if (CS%id_Fl_lowmode> 0) call post_data(CS%id_Fl_lowmode, dd%Fl_lowmode, CS%diag)

if (CS%id_N2_int> 0) call post_data(CS%id_N2_int, dd%N2_int, CS%diag)
if (CS%id_vert_dep> 0) call post_data(CS%id_vert_dep, dd%vert_dep_3d, CS%diag)
if (CS%id_Simmons_coeff> 0) call post_data(CS%id_Simmons_coeff, dd%Simmons_coeff_2d, CS%diag)

if (CS%id_Kd_Itidal_Work > 0) &
call post_data(CS%id_Kd_Itidal_Work, dd%Kd_Itidal_Work, CS%diag)
if (CS%id_Kd_Niku_Work > 0) call post_data(CS%id_Kd_Niku_Work, dd%Kd_Niku_Work, CS%diag)
Expand Down Expand Up @@ -1215,6 +1262,9 @@ subroutine post_tidal_diagnostics(G,GV,h,CS)
if (associated(dd%Kd_Itidal_Work)) deallocate(dd%Kd_Itidal_Work)
if (associated(dd%Kd_Lowmode_Work)) deallocate(dd%Kd_Lowmode_Work)
if (associated(dd%TKE_itidal_used)) deallocate(dd%TKE_itidal_used)
if (associated(dd%N2_int)) deallocate(dd%N2_int)
if (associated(dd%vert_dep_3d)) deallocate(dd%vert_dep_3d)
if (associated(dd%Simmons_coeff_2d)) deallocate(dd%Simmons_coeff_2d)

end subroutine post_tidal_diagnostics

Expand Down

0 comments on commit ea813b8

Please sign in to comment.