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 bugs in CMix/KPP interface #6708

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

Fixes bugs in CMix/KPP interface #6708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c235f1
Fixes to KPP interface
vanroekel Sep 18, 2024
4d243d0
Fixes rebase conflict
vanroekel Oct 24, 2024
8de11b5
fixes restart test failure
vanroekel Oct 24, 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
1 change: 1 addition & 0 deletions components/mpas-ocean/src/Registry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2008,6 +2008,7 @@
<var name="normalBarotropicVelocity"/>
<var name="vertCoordMovementWeights"/>
<var name="xtime"/>
<var_array name="nonLocalSurfaceTracerFlux"/>
<var name="simulationStartTime"/>
<var name="landIcePressure"/>
<var name="landIceDraft"/>
Expand Down
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_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_diagnostics.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
61 changes: 14 additions & 47 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 @@ -3319,12 +3319,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 @@ -3333,7 +3333,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 @@ -3385,8 +3385,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 @@ -3419,7 +3418,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 @@ -3469,18 +3468,8 @@ subroutine ocn_compute_KPP_input_fields(statePool, forcingPool, &
surfaceThicknessFluxSubglacialRunoff)
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 @@ -3594,17 +3583,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)
if (trim(config_subglacial_runoff_mode) == 'data') then
nonLocalSurfaceTracerFlux(indexTempFlux, iCell) = nonLocalSurfaceTracerFlux(indexTempFlux, iCell) &
- fracAbsorbedSubglacialRunoff* &
activeTracersSurfaceFluxSubglacialRunoff(indexTempFlux,iCell)
end if
- fracAbsorbed*surfaceThicknessFlux(iCell) * &
activeTracers(indexTempFlux,kmin,iCell)

nonLocalSurfaceTracerFlux(indexSaltFlux,iCell) = &
activeTracersSurfaceFlux(indexSaltFlux,iCell) &
Expand All @@ -3630,21 +3610,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 @@ -3655,11 +3622,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
9 changes: 3 additions & 6 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 @@ -1317,12 +1317,9 @@ subroutine ocn_tend_tracer(tendPool, statePool, forcingPool, &
!
! Compute tracer tendency due to non-local flux computed in KPP
!
if (config_use_cvmix_kpp .or. config_use_gotm) then
call ocn_compute_KPP_input_fields(statePool, forcingPool,&
meshPool, timeLevel)

if (.not. config_cvmix_kpp_nonlocal_with_implicit_mix) then
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
if (computeBudgets) then
!$omp parallel
!$omp do schedule(runtime) private(k,n)
Expand Down Expand Up @@ -1365,8 +1362,8 @@ subroutine ocn_tend_tracer(tendPool, statePool, forcingPool, &
!$omp end do
!$omp end parallel
endif ! compute budgets
call mpas_timer_stop("non-local flux from KPP")
end if ! not non-local with implicit mix
call mpas_timer_stop("non-local flux from KPP")
end if ! KPP

! Compute tracer tendency due to production/destruction of
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 @@ -27,6 +27,7 @@ module ocn_vmix
use mpas_timer
use ocn_mesh

use ocn_diagnostics
use mpas_constants
use ocn_constants
use ocn_config
Expand Down Expand Up @@ -202,6 +203,11 @@ subroutine ocn_vmix_coefs(meshPool, statePool, forcingPool, scratchPool, err, ti
!$omp end parallel
#endif

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

#ifdef MPAS_OPENACC
!$acc update host(vertViscTopOfEdge, vertDiffTopOfCell)
#endif
Expand Down
21 changes: 13 additions & 8 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 @@ -64,7 +64,7 @@ module ocn_vmix_cvmix
type(cvmix_shear_params_type) :: cvmix_shear_params
type(cvmix_tidal_params_type) :: cvmix_tidal_params

logical :: cvmixOn, cvmixConvectionOn, cvmixKPPOn
logical :: lnonzero_surf_nonlocal, cvmixOn, cvmixConvectionOn, cvmixKPPOn
real (kind=RKIND) :: backgroundVisc, backgroundDiff

integer :: cvmixBackgroundChoice ! user choice of cvmix background scheme
Expand Down Expand Up @@ -1042,19 +1042,22 @@ 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" .and. &
.not. config_cvmix_kpp_matching.eq."ParabolicNonLocal") then
call mpas_log_write( &
"Unknown value for config_cvmix_kpp_matching., supported values are:" // &
" SimpleShapes or MatchBoth", &
" SimpleShapes or MatchBoth or ParabolicNonLocal", &
MPAS_LOG_CRIT)
err = 1
return
endif

lnonzero_surf_nonlocal = .false.
if(config_cvmix_kpp_matching .eq."ParabolicNonLocal") then
lnonzero_surf_nonlocal = .true.
end if

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 +1084,15 @@ 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., &
lnonzero_surf_nonlocal = lnonzero_surf_nonlocal, &
lenhanced_diff = config_cvmix_kpp_use_enhanced_diff)
endif

Expand Down