Merge branch 'maltrud/ocean/passive-tracer-vert-diffusion' into next …

…(PR #6263) Add distinct passive tracer background vert diffusivity Add capability to specify a different background vertical diffusivity for passive tracers than is used for active tracers. [NML] [BFB]
E3SM-Project · May 9, 2024 · 96ed35f · 96ed35f
2 parents d905663 + b25883b
commit 96ed35f
Show file tree

Hide file tree

Showing 7 changed files with 76 additions and 1 deletion.
diff --git a/components/mpas-ocean/bld/build-namelist b/components/mpas-ocean/bld/build-namelist
@@ -616,6 +616,8 @@ add_default($nl, 'config_use_cvmix');
 add_default($nl, 'config_cvmix_prandtl_number');
 add_default($nl, 'config_cvmix_background_scheme');
 add_default($nl, 'config_cvmix_background_diffusion');
+add_default($nl, 'config_cvmix_background_diffusion_passive');
+add_default($nl, 'config_cvmix_background_diffusion_passive_enable');
 add_default($nl, 'config_cvmix_background_viscosity');
 add_default($nl, 'config_cvmix_BryanLewis_bl1');
 add_default($nl, 'config_cvmix_BryanLewis_bl2');

diff --git a/components/mpas-ocean/bld/build-namelist-section b/components/mpas-ocean/bld/build-namelist-section
@@ -155,6 +155,8 @@ add_default($nl, 'config_use_cvmix');
 add_default($nl, 'config_cvmix_prandtl_number');
 add_default($nl, 'config_cvmix_background_scheme');
 add_default($nl, 'config_cvmix_background_diffusion');
+add_default($nl, 'config_cvmix_background_diffusion_passive');
+add_default($nl, 'config_cvmix_background_diffusion_passive_enable');
 add_default($nl, 'config_cvmix_background_viscosity');
 add_default($nl, 'config_cvmix_BryanLewis_bl1');
 add_default($nl, 'config_cvmix_BryanLewis_bl2');

diff --git a/components/mpas-ocean/bld/namelist_files/namelist_defaults_mpaso.xml b/components/mpas-ocean/bld/namelist_files/namelist_defaults_mpaso.xml
@@ -275,6 +275,8 @@
 <config_cvmix_prandtl_number>1.0</config_cvmix_prandtl_number>
 <config_cvmix_background_scheme>'constant'</config_cvmix_background_scheme>
 <config_cvmix_background_diffusion>0.0</config_cvmix_background_diffusion>
+<config_cvmix_background_diffusion_passive>0.0</config_cvmix_background_diffusion_passive>
+<config_cvmix_background_diffusion_passive_enable>.false.</config_cvmix_background_diffusion_passive_enable>
 <config_cvmix_background_viscosity>1.0e-4</config_cvmix_background_viscosity>
 <config_cvmix_BryanLewis_bl1>8.0e-5</config_cvmix_BryanLewis_bl1>
 <config_cvmix_BryanLewis_bl2>1.05E-4</config_cvmix_BryanLewis_bl2>

diff --git a/components/mpas-ocean/bld/namelist_files/namelist_definition_mpaso.xml b/components/mpas-ocean/bld/namelist_files/namelist_definition_mpaso.xml
@@ -747,6 +747,22 @@ Valid values: Any positive real value.
 Default: Defined in namelist_defaults.xml
 </entry>
 
+<entry id="config_cvmix_background_diffusion_passive" type="real"
+	category="cvmix" group="cvmix">
+Background vertical diffusion applied to passive tracer quantities
+
+Valid values: Any positive real value.
+Default: Defined in namelist_defaults.xml
+</entry>
+
+<entry id="config_cvmix_background_diffusion_passive_enable" type="logical"
+	category="cvmix" group="cvmix">
+flag to enable using a different background vertical diffusion for passive tracers
+
+Valid values: .true. or .false.
+Default: Defined in namelist_defaults.xml
+</entry>
+
 <entry id="config_cvmix_background_viscosity" type="real"
 	category="cvmix" group="cvmix">
 Background vertical viscosity applied to horizontal velocity

diff --git a/components/mpas-ocean/src/Registry.xml b/components/mpas-ocean/src/Registry.xml
@@ -480,6 +480,14 @@
 					description="Background vertical diffusion applied to tracer quantities"
 					possible_values="Any positive real value."
 		/>
+		<nml_option name="config_cvmix_background_diffusion_passive" type="real" default_value="1.0e-5" units="m^2 s^-1"
+					description="Background vertical diffusion applied to passive tracer quantities"
+					possible_values="Any positive real value."
+		/>
+		<nml_option name="config_cvmix_background_diffusion_passive_enable" type="logical" default_value=".false."
+					description="flag to enable using a different background vertical diffusion for passive tracers"
+					possible_values=".true. or .false."
+					/>
 		<nml_option name="config_cvmix_background_viscosity" type="real" default_value="1.0e-4" units="m^2 s^-1"
 					description="Background vertical viscosity applied to horizontal velocity"
 					possible_values="Any positive real value."
@@ -3178,6 +3186,10 @@
 			 description="vertical diffusion defined at the cell center (horizontally) and top (vertically)"
 			 packages="forwardMode;analysisMode"
 		/>
+		<var name="vertDiffPassiveTopOfCell" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2 s^-1"
+			 description="vertical diffusion defined at the cell center (horizontally) and top (vertically) for passive tracers"
+			 packages="forwardMode;analysisMode"
+		/>
 		<var name="bulkRichardsonNumber" type="real" dimensions="nVertLevels nCells Time" units="1"
 			 description="CVMix/KPP: bulk Richardson number"
 			 missing_value="FILLVAL" missing_value_mask="cellMask"

diff --git a/components/mpas-ocean/src/shared/mpas_ocn_diagnostics_variables.F b/components/mpas-ocean/src/shared/mpas_ocn_diagnostics_variables.F
@@ -144,6 +144,7 @@ module ocn_diagnostics_variables
    real (kind=RKIND), dimension(:), pointer :: sshCellWetDry
 
    real (kind=RKIND), dimension(:,:), pointer :: vertDiffTopOfCell
+   real (kind=RKIND), dimension(:,:), pointer :: vertDiffPassiveTopOfCell
    real (kind=RKIND), dimension(:,:,:), pointer :: vertNonLocalFlux
    integer, dimension(:,:), pointer :: rediLimiterCount
    real (kind=RKIND), dimension(:,:,:), pointer :: activeTracerSurfaceFluxTendency
@@ -501,6 +502,8 @@ subroutine ocn_diagnostics_variables_init(domain, jenkinsOn, hollandJenkinsOn, e
                    vertViscTopOfCell)
          call mpas_pool_get_array(diagnosticsPool, 'vertDiffTopOfCell', &
                    vertDiffTopOfCell)
+         call mpas_pool_get_array(diagnosticsPool, 'vertDiffPassiveTopOfCell', &
+                   vertDiffPassiveTopOfCell)
          call mpas_pool_get_array(diagnosticsPool, 'vertAleTransportTop', &
                    vertAleTransportTop)
          call mpas_pool_get_array(diagnosticsPool, 'vertTransportVelocityTop', &
@@ -759,6 +762,7 @@ subroutine ocn_diagnostics_variables_init(domain, jenkinsOn, hollandJenkinsOn, e
          !$acc                   barotropicForcing,               &
          !$acc                   vertViscTopOfCell,               &
          !$acc                   vertDiffTopOfCell,               &
+         !$acc                   vertDiffPassiveTopOfCell,        &
          !$acc                   GMStreamFuncZonal,               &
          !$acc                   relativeVorticity,               &
          !$acc                   kineticEnergyCell,               &
@@ -1006,6 +1010,7 @@ subroutine ocn_diagnostics_variables_destroy(err) !{{{
          !$acc                   barotropicForcing,               &
          !$acc                   vertViscTopOfCell,               &
          !$acc                   vertDiffTopOfCell,               &
+         !$acc                   vertDiffPassiveTopOfCell,        &
          !$acc                   GMStreamFuncZonal,               &
          !$acc                   relativeVorticity,               &
          !$acc                   kineticEnergyCell,               &
@@ -1211,6 +1216,7 @@ subroutine ocn_diagnostics_variables_destroy(err) !{{{
                  barotropicForcing,               &
                  vertViscTopOfCell,               &
                  vertDiffTopOfCell,               &
+                 vertDiffPassiveTopOfCell,        &
                  GMStreamFuncZonal,               &
                  relativeVorticity,               &
                  kineticEnergyCell,               &

diff --git a/components/mpas-ocean/src/shared/mpas_ocn_vmix.F b/components/mpas-ocean/src/shared/mpas_ocn_vmix.F
@@ -1583,9 +1583,44 @@ subroutine ocn_vmix_implicit(dt, meshPool, statePool, forcingPool, scratchPool,
                !$acc enter data copyin(tracerGroupSurfaceFlux)
 #endif
 
-               call ocn_tracer_vmix_tend_implicit(dt, vertDiffTopOfCell, layerThickness, tracersGroup, &
+               if (trim(groupItr % memberName) /= 'activeTracers' .and. &
+                   config_cvmix_background_diffusion_passive_enable) then
+
+
+#ifdef MPAS_OPENACC
+                  !$acc parallel loop gang vector collapse(3) present(vertDiffPassiveTopOfCell, vertDiffTopOfCell)
+#else
+                  !$omp parallel
+                  !$omp do schedule(runtime) private(k, iTracer)
+#endif
+                  do iCell = 1, nCellsOwned
+                  do k = 2, maxLevelCell(iCell)
+                      vertDiffPassiveTopOfCell(k,iCell) = vertDiffTopOfCell(k,iCell) - &
+                         config_cvmix_background_diffusion + config_cvmix_background_diffusion_passive
+                  end do
+                  end do
+#ifndef MPAS_OPENACC
+                  !$omp end do
+                  !$omp end parallel
+#endif
+
+
+
+
+
+
+#ifdef MPAS_OPENACC
+                      !$acc update host (vertDiffPassiveTopOfCell)
+#endif
+
+                      call ocn_tracer_vmix_tend_implicit(dt, vertDiffPassiveTopOfCell, layerThickness, tracersGroup, &
+                        vertNonLocalFlux, tracerGroupSurfaceFlux,  &
+                        config_cvmix_kpp_nonlocal_with_implicit_mix, err)
+               else
+                      call ocn_tracer_vmix_tend_implicit(dt, vertDiffTopOfCell, layerThickness, tracersGroup, &
                         vertNonLocalFlux, tracerGroupSurfaceFlux,  &
                         config_cvmix_kpp_nonlocal_with_implicit_mix, err)
+               end if
 #ifdef MPAS_OPENACC
                !$acc exit data delete(tracerGroupSurfaceFlux)
 #endif