Add parametrized tidal mixing effects to ice shelf basal melt

cime_config/tests.py

@@ -239,6 +239,7 @@
         "tests" : (
             "ERS_P480_Ld5.TL319_IcoswISC30E3r5.GMPAS-JRA1p5-DIB-PISMF.mpaso-jra_1958",
             "PEM_P480_Ld5.TL319_IcoswISC30E3r5.GMPAS-JRA1p5-DIB-PISMF.mpaso-jra_1958",
+            "SMS_P480_Ld5.TL319_IcoswISC30E3r5.GMPAS-JRA1p5-DIB-PISMF-TMIX.mpaso-jra_1958",
             "SMS.ne30_oECv3_gis.IGELM_MLI.elm-extrasnowlayers",
             )
         },

components/mpas-ocean/bld/build-namelist

@@ -67,6 +67,8 @@ OPTIONS
      -ice_bgc              check for coupling with sea ice BGC
      -ntasks_ocn           NTASKS_OCN for this case
      -ninst_ocn            NINST_OCN for this case
+     -ocn_tidal_mixing     variable for defining if to run with parameterized tidal mixing
+                           Options are: false, true. Default is false
 
 NOTE: The precedence for setting the values of namelist variables is (highest to lowest):
       1. namelist values set by specific command-line options, i.e. (none right now)
@@ -119,6 +121,7 @@ my %opts = ( help          => 0,
              cfg_dir       => $cfgdir,
              ntasks_ocn    => 0,
              ninst_ocn     => 0,
+             ocn_tidal_mixing => undef,
            );
 
 GetOptions(
@@ -145,6 +148,7 @@ GetOptions(
     "ntasks_ocn=i"    => \$opts{'ntasks_ocn'},
     "ninst_ocn=i"     => \$opts{'ninst_ocn'},
     "preview"         => \$opts{'preview'},
+    "ocn_tidal_mixing=s"   => \$opts{'ocn_tidal_mixing'},
 )  or usage();
 
 # Give usage message.
@@ -185,6 +189,7 @@ my $atm_co2_const_val = $opts{'atm_co2_const_val'};
 my $ice_bgc       = $opts{'ice_bgc'};
 my $NINST_OCN     = $opts{'ninst_ocn'};
 my $NTASKS_OCN    = $opts{'ntasks_ocn'};
+my $OCN_TIDAL_MIXING   = $opts{'ocn_tidal_mixing'};
 $cfgdir           = $opts{'cfg_dir'};
 
 my $CIMEROOT;
@@ -205,6 +210,7 @@ print $fh  <<"EOF";
 <config_definition>
 <entry id="ocn_grid" value="$OCN_GRID">
 <entry id="ocn_forcing" value="$OCN_FORCING">
+<entry id="ocn_tidal_mixing" value="$OCN_TIDAL_MIXING">
 <entry id="decomp_prefix" value="$decomp_prefix">
 <entry id="date_stamp" value="$date_stamp">
 </config_definition>
@@ -450,6 +456,7 @@ my $ntasks = $NTASKS_OCN / $NINST_OCN;
 
 print "MPASO build-namelist: ocn_grid is $OCN_GRID \n";
 print "MPASO build-namelist: ocn_forcing is $OCN_FORCING \n";
+print "MPASO build-namelist: ocn_tidal_mixing is $OCN_TIDAL_MIXING \n";
 
 (-d $DIN_LOC_ROOT)  or mkdir $DIN_LOC_ROOT;
 if ($print>=2) { print "CIME inputdata root directory: $DIN_LOC_ROOT$eol"; }
@@ -776,6 +783,15 @@ if ($OCN_ISMF eq 'coupled') {
 } else {
 	add_default($nl, 'config_land_ice_flux_mode');
 }
+if ($OCN_TIDAL_MIXING eq 'true') {
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_alpha', 'val'=>"0.777");
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_A0', 'val'=>"0.656");
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_U0', 'val'=>"0.003");
+} else {
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_alpha');
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_A0');
+	add_default($nl, 'config_land_ice_flux_tidal_Jourdain_U0');
+}
 add_default($nl, 'config_land_ice_flux_formulation');
 add_default($nl, 'config_land_ice_flux_useHollandJenkinsAdvDiff');
 add_default($nl, 'config_land_ice_flux_attenuation_coefficient');
@@ -785,7 +801,6 @@ add_default($nl, 'config_land_ice_flux_cp_ice');
 add_default($nl, 'config_land_ice_flux_rho_ice');
 add_default($nl, 'config_land_ice_flux_explicit_topDragCoeff');
 add_default($nl, 'config_land_ice_flux_ISOMIP_gammaT');
-add_default($nl, 'config_land_ice_flux_rms_tidal_velocity');
 add_default($nl, 'config_land_ice_flux_jenkins_heat_transfer_coefficient');
 add_default($nl, 'config_land_ice_flux_jenkins_salt_transfer_coefficient');
 

components/mpas-ocean/bld/build-namelist-section

@@ -302,9 +302,11 @@ add_default($nl, 'config_land_ice_flux_cp_ice');
 add_default($nl, 'config_land_ice_flux_rho_ice');
 add_default($nl, 'config_land_ice_flux_explicit_topDragCoeff');
 add_default($nl, 'config_land_ice_flux_ISOMIP_gammaT');
-add_default($nl, 'config_land_ice_flux_rms_tidal_velocity');
 add_default($nl, 'config_land_ice_flux_jenkins_heat_transfer_coefficient');
 add_default($nl, 'config_land_ice_flux_jenkins_salt_transfer_coefficient');
+add_default($nl, 'config_land_ice_flux_tidal_Jourdain_alpha');
+add_default($nl, 'config_land_ice_flux_tidal_Jourdain_A0');
+add_default($nl, 'config_land_ice_flux_tidal_Jourdain_U0');
 
 #############################
 # Namelist group: advection #

components/mpas-ocean/bld/namelist_files/namelist_defaults_mpaso.xml

@@ -405,7 +405,6 @@
 <config_land_ice_flux_explicit_topDragCoeff ocn_grid="FRISwISC02to60E3r1">4.48e-3</config_land_ice_flux_explicit_topDragCoeff>
 <config_land_ice_flux_explicit_topDragCoeff ocn_grid="FRISwISC01to60E3r1">4.48e-3</config_land_ice_flux_explicit_topDragCoeff>
 <config_land_ice_flux_ISOMIP_gammaT>1e-4</config_land_ice_flux_ISOMIP_gammaT>
-<config_land_ice_flux_rms_tidal_velocity>5e-2</config_land_ice_flux_rms_tidal_velocity>
 <config_land_ice_flux_jenkins_heat_transfer_coefficient>0.011</config_land_ice_flux_jenkins_heat_transfer_coefficient>
 <config_land_ice_flux_jenkins_heat_transfer_coefficient ocn_grid="oEC60to30v3wLI">0.00295</config_land_ice_flux_jenkins_heat_transfer_coefficient>
 <config_land_ice_flux_jenkins_heat_transfer_coefficient ocn_grid="ECwISC30to60E1r2">0.00295</config_land_ice_flux_jenkins_heat_transfer_coefficient>
@@ -426,6 +425,9 @@
 <config_land_ice_flux_jenkins_salt_transfer_coefficient ocn_grid="FRISwISC04to60E3r1">8.42e-5</config_land_ice_flux_jenkins_salt_transfer_coefficient>
 <config_land_ice_flux_jenkins_salt_transfer_coefficient ocn_grid="FRISwISC02to60E3r1">8.42e-5</config_land_ice_flux_jenkins_salt_transfer_coefficient>
 <config_land_ice_flux_jenkins_salt_transfer_coefficient ocn_grid="FRISwISC01to60E3r1">8.42e-5</config_land_ice_flux_jenkins_salt_transfer_coefficient>
+<config_land_ice_flux_tidal_Jourdain_alpha>1.0</config_land_ice_flux_tidal_Jourdain_alpha>
+<config_land_ice_flux_tidal_Jourdain_A0>0.0</config_land_ice_flux_tidal_Jourdain_A0>
+<config_land_ice_flux_tidal_Jourdain_U0>5e-2</config_land_ice_flux_tidal_Jourdain_U0>
 
 <!-- advection -->
 <config_vert_advection_method>'flux-form'</config_vert_advection_method>

components/mpas-ocean/bld/namelist_files/namelist_definition_mpaso.xml

@@ -1590,25 +1590,41 @@ Valid values: Any positive real number
 Default: Defined in namelist_defaults.xml
 </entry>
 
-<entry id="config_land_ice_flux_rms_tidal_velocity" type="real"
+<entry id="config_land_ice_flux_jenkins_heat_transfer_coefficient" type="real"
 	category="land_ice_fluxes" group="land_ice_fluxes">
-Parameterization of tidal velocity used in computing the sub-ice-shelf friction velocity
+constant nondimensional heat transfer coefficient across the ice-ocean boundary layer
 
-Valid values: Any non-negative real number
+Valid values: Any positive real number
 Default: Defined in namelist_defaults.xml
 </entry>
 
-<entry id="config_land_ice_flux_jenkins_heat_transfer_coefficient" type="real"
+<entry id="config_land_ice_flux_jenkins_salt_transfer_coefficient" type="real"
 	category="land_ice_fluxes" group="land_ice_fluxes">
-constant nondimensional heat transfer coefficient across the ice-ocean boundary layer
+constant nondimensional salt transfer coefficient across the ice-ocean boundary layer
 
 Valid values: Any positive real number
 Default: Defined in namelist_defaults.xml
 </entry>
 
-<entry id="config_land_ice_flux_jenkins_salt_transfer_coefficient" type="real"
+<entry id="config_land_ice_flux_tidal_Jourdain_alpha" type="real"
 	category="land_ice_fluxes" group="land_ice_fluxes">
-constant nondimensional salt transfer coefficient across the ice-ocean boundary layer
+Constant in parameterization of tidal velocity used in computing the sub-ice-shelf friction velocity
+
+Valid values: Any positive real number
+Default: Defined in namelist_defaults.xml
+</entry>
+
+<entry id="config_land_ice_flux_tidal_Jourdain_A0" type="real"
+	category="land_ice_fluxes" group="land_ice_fluxes">
+Constant in parameterization of tidal velocity used in computing the sub-ice-shelf friction velocity
+
+Valid values: Any positive real number
+Default: Defined in namelist_defaults.xml
+</entry>
+
+<entry id="config_land_ice_flux_tidal_Jourdain_U0" type="real"
+	category="land_ice_fluxes" group="land_ice_fluxes">
+Constant in parameterization of tidal velocity used in computing the sub-ice-shelf friction velocity
 
 Valid values: Any positive real number
 Default: Defined in namelist_defaults.xml

components/mpas-ocean/cime_config/buildnml

@@ -37,6 +37,7 @@ def buildnml(case, caseroot, compname):
     ocn_ismf          = case.get_value("MPASO_ISMF")
     ocn_bgc           = case.get_value("MPASO_BGC")
     ocn_wave          = case.get_value("MPASO_WAVE")
+    ocn_tidal_mixing  = case.get_value("MPASO_TIDAL_MIXING")
     ocn_co2_type      = case.get_value("OCN_CO2_TYPE")
     atm_co2_const_val = case.get_value("CCSM_CO2_PPMV")
     ice_bgc           = case.get_value("MPASI_BGC")
@@ -74,6 +75,7 @@ def buildnml(case, caseroot, compname):
     data_ismf_file = ''
     analysis_mask_file = ''
     eco_forcing_file = ''
+    u_tidal_rms_file = ''
 
     if ocn_grid == 'oEC60to30v3':
         decomp_date = '230424'
@@ -134,6 +136,8 @@ def buildnml(case, caseroot, compname):
         if ocn_ic_mode == 'spunup':
             logger.warning("WARNING: The specified compset is requesting ocean ICs spunup from a G-case")
             logger.warning("         But no file available for this grid.")
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.oQU240wLI.20240221.nc'
 
     elif ocn_grid == 'oQU120':
         decomp_date = '230424'
@@ -269,6 +273,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.SOwISC12to60E2r4.rstFromG-anvil'
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.SOwISC12to60E2r4.230516.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.SOwISC12to60E2r4.20210114.nc'
 
     elif ocn_grid == 'FRISwISC08to60E3r1':
         decomp_date = '20230913'  # changed to date of partiotions in ../files_for_e3sm/assembled_files/inputdata/ocn/mpas-o/FRISwISC08to60E3r1/partitions
@@ -282,6 +288,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.FRISwISC08to60E3r1.rstFromG-anvil'   # the spun up file does not yet exist
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.FRISwISC08to60E3r1.20230913.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.FRISwISC08to60E3r1.20230913.nc'
 
     elif ocn_grid == 'FRISwISC04to60E3r1':
         decomp_date = '20230913'  # changed to date of partiotions in ../files_for_e3sm/assembled_files/inputdata/ocn/mpas-o/FRISwISC04to60E3r1/partitions
@@ -295,6 +303,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.FRISwISC04to60E3r1.rstFromG-anvil'   # the spun up file does not yet exist
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.FRISwISC04to60E3r1.20230913.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.FRISwISC04to60E3r1.20230913.nc'
 
     elif ocn_grid == 'FRISwISC02to60E3r1':
         decomp_date = '20230914'  # changed to date of partiotions in ../files_for_e3sm/assembled_files/inputdata/ocn/mpas-o/FRISwISC02to60E3r1/partitions
@@ -308,6 +318,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.FRISwISC02to60E3r1.rstFromG-anvil'   # the spun up file does not yet exist
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.FRISwISC02to60E3r1.20230914.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.FRISwISC02to60E3r1.20230914.nc'
 
     elif ocn_grid == 'FRISwISC01to60E3r1':
         decomp_date = '20230915'  # changed to date of partiotions in ../files_for_e3sm/assembled_files/inputdata/ocn/mpas-o/FRISwISC01to60E3r1/partitions
@@ -321,6 +333,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.FRISwISC01to60E3r1.rstFromG-anvil'   # the spun up file does not yet exist
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.FRISwISC01to60E3r1.20230915.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.FRISwISC01to60E3r1.20230915.nc'
 
     elif ocn_grid == 'ECwISC30to60E2r1':
         decomp_date = '200915'
@@ -334,6 +348,8 @@ def buildnml(case, caseroot, compname):
             ic_prefix = 'mpaso.ECwISC30to60E2r1.rstFromG-anvil'
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_adusumilli2020.ECwISC30to60E2r1.230429.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.ECwISC30to60E2r1.20240221.nc'
 
     elif ocn_grid == 'IcoswISC30E3r5':
         decomp_date = '20231120'
@@ -351,6 +367,8 @@ def buildnml(case, caseroot, compname):
             eco_forcing_file = 'ecoForcingSurfaceMonthly.IcoswISC30E3r5.20231215.nc'
         if ocn_ismf == 'data':
             data_ismf_file = 'prescribed_ismf_paolo2023.IcoswISC30E3r5.20240227.nc'
+        if ocn_tidal_mixing == 'true':
+            u_tidal_rms_file = 'velocityTidalRMS_CATS2008.IcoswISC30E3r5.20231120.nc'
 
     #--------------------------------------------------------------------
     # Set OCN_FORCING = datm_forced_restoring if restoring file is available
@@ -388,6 +406,9 @@ def buildnml(case, caseroot, compname):
         if data_ismf_file != '':
             input_list.write("data_ismf = {}/ocn/mpas-o/{}/{}\n".format(din_loc_root, ocn_mask, data_ismf_file))
 
+        if u_tidal_rms_file != '':
+            input_list.write("u_tidal_rms = {}/ocn/mpas-o/{}/{}\n".format(din_loc_root, ocn_mask, u_tidal_rms_file))
+
     #--------------------------------------------------------------------
     # Invoke mpas build-namelist - output will go in $CASEBUILD/mpasoconf
     #--------------------------------------------------------------------
@@ -449,6 +470,7 @@ def buildnml(case, caseroot, compname):
         sysmod += " -ocn_ismf '{}'".format(ocn_ismf)
         sysmod += " -ocn_bgc '{}'".format(ocn_bgc)
         sysmod += " -ocn_wave '{}'".format(ocn_wave)
+        sysmod += " -ocn_tidal_mixing '{}'".format(ocn_tidal_mixing)
         sysmod += " -ocn_co2_type '{}'".format(ocn_co2_type)
         sysmod += " -atm_co2_const_val '{}'".format(atm_co2_const_val)
         sysmod += " -ice_bgc '{}'".format(ice_bgc)
@@ -635,6 +657,18 @@ def buildnml(case, caseroot, compname):
                 lines.append('</stream>')
                 lines.append('')
 
+            if u_tidal_rms_file != '':
+                lines.append('<stream name="tidal_velocity_rms_parameterized"')
+                lines.append('       type="input"')
+                lines.append('       io_type="{}"'.format(ocn_pio_typename))
+                lines.append('       filename_template="{}/ocn/mpas-o/{}/{}"'.format(din_loc_root, ocn_mask, u_tidal_rms_file))
+                lines.append('       input_interval="initial_only" ')
+                lines.append('       packages="landIceFluxesPKG">')
+                lines.append('')
+                lines.append('       <var name="velocityTidalRMS"/>')
+                lines.append('</stream>')
+                lines.append('')
+
             if analysis_mask_file != '':
                 lines.append('<stream name="transectMasksInput"')
                 lines.append('        type="input"')
@@ -1289,6 +1323,7 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var name="landIceHeatFlux"/>')
             lines.append('    <var name="heatFluxToLandIce"/>')
             lines.append('    <var name="landIceFrictionVelocity"/>')
+            lines.append('    <var name="velocityTidalRMS"/>')
             lines.append('    <var_array name="landIceBoundaryLayerTracers"/>')
             lines.append('    <var_array name="landIceInterfaceTracers"/>')
             lines.append('    <var name="mocStreamvalLatAndDepth"/>')
@@ -1324,6 +1359,7 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var_array name="activeTracerVerticalAdvectionTopFlux"/>')
             lines.append('    <var_array name="activeTracerHorizontalAdvectionEdgeFlux"/>')
             lines.append('    <var_array name="totalFreshWaterTemperatureFlux"/>')
+            lines.append('    <var name="velocityTidalRMS"/>')
             if ocn_iceberg == 'true':
                 lines.append('    <var name="icebergHeatFlux"/>')
                 lines.append('    <var name="icebergFreshWaterFlux"/>')

components/mpas-ocean/cime_config/config_component.xml

@@ -26,6 +26,19 @@
         <desc>Option to describe the MPASO surface forcing</desc>
   </entry>
 
+  <entry id="MPASO_TIDAL_MIXING">
+        <type>char</type>
+        <valid_values>false,true</valid_values>
+        <default_value>false</default_value>
+        <values>
+           <value compset="MPASO_">false</value>
+           <value compset="_MPASO%.*TMIX">true</value>
+        </values>
+        <group>case_comp</group>
+        <file>env_case.xml</file>
+        <desc>Option to describe the MPASO prescribed tidal mixing</desc>
+  </entry>
+
   <entry id="MPASO_ICEBERG">
         <type>char</type>
         <valid_values>false,true</valid_values>

components/mpas-ocean/cime_config/config_compsets.xml

@@ -72,6 +72,11 @@
     <lname>2000_DATM%JRA-1p5_SLND_MPASSI%DIB_MPASO%IBDISMFDATMFORCED_DROF%JRA-1p5-AIS0ROF_SGLC_SWAV</lname>
   </compset>
 
+  <compset>
+    <alias>GMPAS-JRA1p5-DIB-PISMF-TMIX</alias>
+    <lname>2000_DATM%JRA-1p5_SLND_MPASSI%DIB_MPASO%IBPISMFDATMFORCEDTMIX_DROF%JRA-1p5-AIS0ROF_SGLC_SWAV</lname>
+  </compset>
+
   <compset>
     <alias>GMPAS-JRA1p4</alias>
     <lname>2000_DATM%JRA-1p4-2018_SLND_MPASSI_MPASO%DATMFORCED_DROF%JRA-1p4-2018_SGLC_SWAV</lname>