Skip to content
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

Fixes to KPP interface #107

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Fixes to KPP interface #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1705c02
Fixes to KPP interface
vanroekel Jul 10, 2024
8ad3fa2
updates to the KPP buoyancy flux calculation
vanroekel Jul 11, 2024
295480d
Fixup to mpas_vmix_cvmix
vanroekel Jul 12, 2024
0e861cf
compile time fixes
vanroekel Jul 12, 2024
0e9cd30
runtime fixes
vanroekel Jul 12, 2024
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
2 changes: 1 addition & 1 deletion components/mpas-ocean/src/shared/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ mpas_ocn_tracer_short_wave_absorption_variable.o: mpas_ocn_constants.o mpas_ocn_

mpas_ocn_tracer_short_wave_absorption_jerlov.o: mpas_ocn_constants.o mpas_ocn_config.o

mpas_ocn_vmix.o: mpas_ocn_vmix_cvmix.o mpas_ocn_vmix_coefs_redi.o mpas_ocn_constants.o mpas_ocn_config.o mpas_ocn_diagnostics_variables.o mpas_ocn_vmix_gotm.o
mpas_ocn_vmix.o: mpas_ocn_diagnostics.o mpas_ocn_vmix_cvmix.o mpas_ocn_vmix_coefs_redi.o mpas_ocn_constants.o mpas_ocn_config.o mpas_ocn_diagnostics_variables.o mpas_ocn_vmix_gotm.o

mpas_ocn_vmix_cvmix.o: mpas_ocn_constants.o mpas_ocn_config.o mpas_ocn_diagnostics_variables.o mpas_ocn_mesh.o mpas_ocn_stokes_drift.o

Expand Down
56 changes: 14 additions & 42 deletions components/mpas-ocean/src/shared/mpas_ocn_diagnostics.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ module ocn_diagnostics
ocn_fuperp, &
ocn_filter_btr_mode_tend_vel, &
ocn_reconstruct_eddy_vectors, &
ocn_compute_kpp_input_fields, &
ocn_compute_mixing_input_fields, &
ocn_validate_state, &
ocn_build_log_filename, &
ocn_diagnostics_init
Expand Down Expand Up @@ -3241,12 +3241,12 @@ end subroutine ocn_filter_btr_mode_tend_vel!}}}

!***********************************************************************
!
! routine ocn_compute_KPP_input_fields
! routine ocn_compute_mixing_input_fields
!
!> \brief
!> Compute fields necessary to drive the CVMix KPP module
!> \author Todd Ringler
!> \date 20 August 2013
!> Compute fields necessary to drive the CVMix KPP and gotm modules
!> \author Todd Ringler, Luke Van Roekel
!> \date 11 July 2024
!> \details
!> CVMix/KPP requires the following fields as intent(in):
!> surfaceBuoyancyForcing
Expand All @@ -3255,7 +3255,7 @@ end subroutine ocn_filter_btr_mode_tend_vel!}}}
!
!-----------------------------------------------------------------------

subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
subroutine ocn_compute_mixing_input_fields(statePool, forcingPool, &
meshPool, timeLevelIn)!{{{

!-----------------------------------------------------------------
Expand Down Expand Up @@ -3303,8 +3303,7 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
evapTemperatureFlux, &
icebergTemperatureFlux, &
seaIceTemperatureFlux, &
surfaceStress, &
surfaceStressMagnitude
sfcStressMag

real (kind=RKIND), dimension(:,:), pointer :: &
layerThickness, &! layer thickness
Expand Down Expand Up @@ -3336,7 +3335,7 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
!-----------------------------------------------------------------
! Begin code

call mpas_timer_start('KPP input fields')
call mpas_timer_start('Mixing input fields')

if (present(timeLevelIn)) then
timeLevel = timeLevelIn
Expand Down Expand Up @@ -3381,18 +3380,8 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
surfaceThicknessFluxRunoff)
call mpas_pool_get_array(forcingPool, 'penetrativeTemperatureFlux', &
penetrativeTemperatureFlux)
call mpas_pool_get_array(forcingPool, 'surfaceStress', &
surfaceStress)
call mpas_pool_get_array(forcingPool, 'surfaceStressMagnitude', &
surfaceStressMagnitude)
call mpas_pool_get_array(forcingPool, 'rainTemperatureFlux', &
rainTemperatureFlux)
call mpas_pool_get_array(forcingPool, 'evapTemperatureFlux', &
evapTemperatureFlux)
call mpas_pool_get_array(forcingPool, 'seaIceTemperatureFlux', &
seaIceTemperatureFlux)
call mpas_pool_get_array(forcingPool, 'icebergTemperatureFlux', &
icebergTemperatureFlux)
sfcStressMag)

! allocate scratch space displaced density computation
ncells = nCellsAll
Expand Down Expand Up @@ -3474,12 +3463,8 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
activeTracersSurfaceFlux(indexTempFlux,iCell) &
+ penetrativeTemperatureFlux(iCell) &
- penetrativeTemperatureFluxOBL(iCell) &
- fracAbsorbed* (rainTemperatureFlux(iCell) + &
evapTemperatureFlux(iCell) + &
seaIceTemperatureFlux(iCell) + &
icebergTemperatureFlux(iCell)) &
- fracAbsorbedRunoff* &
activeTracersSurfaceFluxRunoff(indexTempFlux,iCell)
- fracAbsorbed*surfaceThicknessFlux(iCell) * &
activeTracers(indexTempFlux,kmin,iCell)

nonLocalSurfaceTracerFlux(indexSaltFlux,iCell) = &
activeTracersSurfaceFlux(indexSaltFlux,iCell) &
Expand All @@ -3500,21 +3485,8 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
surfaceBuoyancyForcing(iCell) = surfaceBuoyancyForcing(iCell)* &
gravity

! compute magnitude of surface stress
sumSurfaceStressSquared = 0.0_RKIND
do i = 1, nEdgesOnCell(iCell)
iEdge = edgesOnCell(i, iCell)
sumSurfaceStressSquared = sumSurfaceStressSquared &
+ edgeAreaFractionOfCell(i,iCell)* &
surfaceStress(iEdge)**2
enddo

! NOTE that the factor of 2 is from averaging dot products
! to cell centers on a C-grid
surfaceStressMagnitude(iCell) = &
sqrt(2.0_RKIND * sumSurfaceStressSquared)
surfaceFrictionVelocity(iCell) = &
sqrt(surfaceStressMagnitude(iCell) / rho_sw)
sqrt(sfcStressMag(iCell) / rho_sw)

enddo
!$omp end do
Expand All @@ -3525,11 +3497,11 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
salineContractionCoeff, &
densitySurfaceDisplaced)

call mpas_timer_stop('KPP input fields')
call mpas_timer_stop('Mixing input fields')

!-------------------------------------------------------------------

end subroutine ocn_compute_KPP_input_fields!}}}
end subroutine ocn_compute_mixing_input_fields!}}}

!***********************************************************************
!
Expand Down
2 changes: 0 additions & 2 deletions components/mpas-ocean/src/shared/mpas_ocn_tendency.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1246,8 +1246,6 @@ subroutine ocn_tend_tracer(tendPool, statePool, forcingPool, &
if (config_use_cvmix_kpp) then
call mpas_timer_start("non-local flux from KPP")
if (.not. config_cvmix_kpp_nonlocal_with_implicit_mix) then
call ocn_compute_KPP_input_fields(statePool, forcingPool,&
meshPool, timeLevel)

if (computeBudgets) then
!$omp parallel
Expand Down
6 changes: 6 additions & 0 deletions components/mpas-ocean/src/shared/mpas_ocn_vmix.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ module ocn_vmix
use ocn_vmix_coefs_redi
use ocn_diagnostics_variables
use ocn_surface_land_ice_fluxes
use ocn_diagnostics

implicit none
private
Expand Down Expand Up @@ -206,6 +207,11 @@ subroutine ocn_vmix_coefs(meshPool, statePool, forcingPool, scratchPool, err, ti
!$acc update host(vertViscTopOfEdge, vertDiffTopOfCell)
#endif

if(config_use_cvmix_kpp .or. config_use_gotm) then
call ocn_compute_mixing_input_fields(statePool, forcingPool,&
meshPool, timeLevel)
endif

call ocn_vmix_coefs_cvmix_build(meshPool, statePool, forcingPool, err1, timeLevel)
call ocn_vmix_coefs_redi_build(meshPool, statePool, err2, timeLevel)
call ocn_vmix_coefs_gotm_build(statePool, forcingPool, err3, timeLevel)
Expand Down
24 changes: 15 additions & 9 deletions components/mpas-ocean/src/shared/mpas_ocn_vmix_cvmix.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ module ocn_vmix_cvmix
type(cvmix_tidal_params_type) :: cvmix_tidal_params

logical :: cvmixOn, cvmixConvectionOn, cvmixKPPOn
real (kind=RKIND) :: backgroundVisc, backgroundDiff
real (kind=RKIND) :: multVal, backgroundVisc, backgroundDiff
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vanroekel Searching for this value doesn't bring up anything for me. Where is it assigned?


integer :: cvmixBackgroundChoice ! user choice of cvmix background scheme

Expand Down Expand Up @@ -725,7 +725,7 @@ subroutine ocn_vmix_coefs_cvmix_build(meshPool, statePool, forcingPool, err, tim
! intent out of BoundaryLayerDepth is boundary layer depth measured in meters and vertical index
indexBoundaryLayerDepth(iCell) = cvmix_variables % kOBL_depth

do k = minLevelCell(iCell), maxLevelCell(iCell) + 1
do k = minLevelCell(iCell), maxLevelCell(iCell) !floor(indexBoundaryLayerDepth(iCell)) + 1
vertViscTopOfCell(k, iCell) = cvmix_variables % Mdiff_iface(k)
vertDiffTopOfCell(k, iCell) = cvmix_variables % Tdiff_iface(k)
end do
Expand All @@ -751,7 +751,7 @@ subroutine ocn_vmix_coefs_cvmix_build(meshPool, statePool, forcingPool, err, tim
! add convective mixing to vertical viscosity/diffusivity
! if using KPP, then do not apply convective mixing within the ocean boundary layer
if(config_use_cvmix_kpp) then
do k = ceiling(indexBoundaryLayerDepth(iCell)) + 1, maxLevelCell(iCell)
do k = floor(indexBoundaryLayerDepth(iCell)) + 1, maxLevelCell(iCell)
vertViscTopOfCell(k,iCell) = vertViscTopOfCell(k,iCell) + cvmix_variables % Mdiff_iface(k)
vertDiffTopOfCell(k,iCell) = vertDiffTopOfCell(k,iCell) + cvmix_variables % Tdiff_iface(k)
enddo
Expand Down Expand Up @@ -1042,11 +1042,7 @@ subroutine ocn_vmix_cvmix_init(domain,err)!{{{
! initialize KPP boundary layer scheme
!
if (config_use_cvmix_kpp) then
if(config_cvmix_kpp_matching.eq."MatchBoth") then
call mpas_log_write( &
"Use of option MatchBoth is discouraged, use SimpleShapes instead", &
MPAS_LOG_WARN)
elseif(.not. config_cvmix_kpp_matching.eq."SimpleShapes") then
if(.not. config_cvmix_kpp_matching.eq."SimpleShapes" .and. .not. config_cvmix_kpp_matching.eq."MatchBoth") then
call mpas_log_write( &
"Unknown value for config_cvmix_kpp_matching., supported values are:" // &
" SimpleShapes or MatchBoth", &
Expand All @@ -1055,6 +1051,15 @@ subroutine ocn_vmix_cvmix_init(domain,err)!{{{
return
endif

!multVal sets the parameter for adding diffusivity/viscosity in the
!boundary layer

if (config_cvmix_kpp_matching.eq."SimpleShapes") then
multVal = 1.0_RKIND
else
multVal = 0.0_RKIND
endif

if (trim(config_cvmix_kpp_langmuir_mixing_opt) .ne. "NONE" .and. &
trim(config_cvmix_kpp_langmuir_mixing_opt) .ne. "LWF16" .and. &
trim(config_cvmix_kpp_langmuir_mixing_opt) .ne. "RWHGK16") then
Expand All @@ -1081,13 +1086,14 @@ subroutine ocn_vmix_cvmix_init(domain,err)!{{{
call cvmix_init_kpp ( &
ri_crit = config_cvmix_kpp_criticalBulkRichardsonNumber, &
interp_type = config_cvmix_kpp_interpolationOMLType, &
interp_type2 = config_cvmix_kpp_interpolationOMLType, &
interp_type2 = 'LMD94', &
lEkman = config_cvmix_kpp_EkmanOBL, &
lMonOb = config_cvmix_kpp_MonObOBL, &
MatchTechnique = config_cvmix_kpp_matching, &
surf_layer_ext = config_cvmix_kpp_surface_layer_extent, &
langmuir_mixing_str = config_cvmix_kpp_langmuir_mixing_opt, &
langmuir_entrainment_str = config_cvmix_kpp_langmuir_entrainment_opt, &
lnoDGat1 = .true., &
lenhanced_diff = config_cvmix_kpp_use_enhanced_diff)
endif

Expand Down
Loading