Merge branch 'mark-petersen/ocn/reduce-output' into next (PR #6095)

Reduce ocean output fields

This PR reduces the number of variables written in the time-averaged
monthly output. It is the result of discussions with the ocean modeling
team.

This removes the 3D fields zMid and gmKappaScaling, as well as several
2D fields. We decided to turn off the eddy product variables analysis
member by default, which saves a large number of 3D fields. These are
all variables with 'Times' and 'Squared' in the name, which is up to 20
3D fields, depending on whether GM and the mesoscale eddy
parameterization are on. Eddy product variables are typically used at
high resolution to compute eddy kinetic energy and similar fields. They
are not typically needed at lower resolutions or during spin-up.

[NML]
[BFB]

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

@@ -1024,7 +1024,7 @@
 <config_AM_transectTransport_transect_group>'all'</config_AM_transectTransport_transect_group>
 
 <!-- AM_eddyProductVariables -->
-<config_AM_eddyProductVariables_enable>.true.</config_AM_eddyProductVariables_enable>
+<config_AM_eddyProductVariables_enable>.false.</config_AM_eddyProductVariables_enable>
 <config_AM_eddyProductVariables_compute_interval>'0000-00-00_01:00:00'</config_AM_eddyProductVariables_compute_interval>
 <config_AM_eddyProductVariables_output_stream>'eddyProductVariablesOutput'</config_AM_eddyProductVariables_output_stream>
 <config_AM_eddyProductVariables_compute_on_startup>.true.</config_AM_eddyProductVariables_compute_on_startup>

components/mpas-ocean/cime_config/buildnml

@@ -1191,29 +1191,13 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var name="dThreshMLD"/>')
             lines.append('    <var name="normalVelocity"/>')
             lines.append('    <var name="vertVelocityTop"/>')
-            lines.append('    <var name="zMid"/>')
             lines.append('    <var name="atmosphericPressure"/>')
             lines.append('    <var name="normalMLEvelocity"/>')
             lines.append('    <var name="vertMLEBolusVelocityTop"/>')
-            lines.append('    <var name="velocityZonalTimesTemperature_MLE"/>')
-            lines.append('    <var name="velocityMeridionalTimesTemperature_MLE"/>')
-            lines.append('    <var name="velocityZonalTimesSalinity_MLE"/>')
-            lines.append('    <var name="velocityMeridionalTimesSalinity_MLE"/>')
             if not ocn_grid.startswith("oRRS1"):
                 lines.append('    <var name="normalGMBolusVelocity"/>')
                 lines.append('    <var name="vertGMBolusVelocityTop"/>')
-                lines.append('    <var name="GMBolusVelocityZonal"/>')
-                lines.append('    <var name="GMBolusVelocityMeridional"/>')
                 lines.append('    <var name="cGMphaseSpeed"/>')
-                lines.append('    <var name="velocityZonalTimesTemperature_GM"/>')
-                lines.append('    <var name="velocityMeridionalTimesTemperature_GM"/>')
-                lines.append('    <var name="normalGMBolusVelocityTimesTemperature"/>')
-                lines.append('    <var name="normalGMBolusVelocitySquared"/>')
-                lines.append('    <var name="velocityZonalTimesSalinity_GM"/>')
-                lines.append('    <var name="velocityMeridionalTimesSalinity_GM"/>')
-                lines.append('    <var name="normalGMBolusVelocityTimesSalinity"/>')
-                lines.append('    <var name="gmKappaScaling"/>')
-                lines.append('    <var name="gmBolusKappa"/>')
                 lines.append('    <var name="mocStreamvalLatAndDepthGM"/>')
                 lines.append('    <var name="mocStreamvalLatAndDepthRegionGM"/>')
 
@@ -1235,7 +1219,6 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var name="iceRunoffFlux"/>')
             lines.append('    <var name="rainFlux"/>')
             lines.append('    <var name="snowFlux"/>')
-            lines.append('    <var name="vertNonLocalFlux"/>')
             lines.append('    <var name="bottomLayerShortwaveTemperatureFlux"/>')
             lines.append('    <var_array name="activeTracersTend"/>')
             lines.append('    <var name="salinitySurfaceRestoringTendency"/>')
@@ -1254,7 +1237,6 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var name="CFLNumberGlobal"/>')
             lines.append('    <var name="vertDiffTopOfCell"/>')
             lines.append('    <var name="vertViscTopOfCell"/>')
-            lines.append('    <var name="bulkRichardsonNumber"/>')
             lines.append('    <var name="boundaryLayerDepth"/>')
             lines.append('    <var name="columnIntegratedSpeed"/>')
             lines.append('    <var name="landIceFreshwaterFlux"/>')
@@ -1268,7 +1250,6 @@ def buildnml(case, caseroot, compname):
             lines.append('    <var name="binBoundaryMocStreamfunction"/>')
             lines.append('    <var name="surfaceBuoyancyForcing"/>')
             lines.append('    <var name="tendLayerThickness"/>')
-            lines.append('    <var name="boundaryLayerDepthSmooth"/>')
             lines.append('    <var name="pressureAdjustedSSH"/>')
             lines.append('    <var name="SSHSquared"/>')
             lines.append('    <var name="velocityZonalSquared"/>')

components/mpas-ocean/src/analysis_members/Registry_eddy_product_variables.xml

@@ -47,19 +47,15 @@
 		/>
 		<var name="velocityZonalTimesTemperature_GM" type="real" dimensions="nVertLevels nCells Time" units="m s^-1 C"
 			description="cell-wise product of component of horizontal bolus velocity in the eastward direction and temperature"
-			 packages="gm"
 		/>
 		<var name="velocityMeridionalTimesTemperature_GM" type="real" dimensions="nVertLevels nCells Time" units="m s^-1 C"
 			description="cell-wise product of component of horizontal bolus velocity in the northward direction and temperature"
-			 packages="gm"
 		/>
 		<var name="normalGMBolusVelocitySquared" type="real" dimensions="nVertLevels nEdges Time" units="m^2 s^-2"
 			description="edge based square of normal velocity"
-			 packages="gm"
 		/>
 		<var name="normalGMBolusVelocityTimesTemperature" type="real" dimensions="nVertLevels nEdges Time" units="m s^-1 C"
 			description="edge based product of normal velocity and temperature"
-			 packages="gm"
 		/>
 		<var name="velocityZonalTimesSalinity" type="real" dimensions="nVertLevels nCells Time" units="1.e-3 m s^-1"
 			description="cell-wise product of component of horizontal velocity in the eastward direction and salinity"
@@ -72,39 +68,30 @@
 		/>
 		<var name="velocityZonalTimesSalinity_GM" type="real" dimensions="nVertLevels nCells Time" units="1.e-3 m s^-1"
 			description="cell-wise product of component of horizontal bolus velocity in the eastward direction and salinity"
-			 packages="gm"
 		/>
 		<var name="velocityMeridionalTimesSalinity_GM" type="real" dimensions="nVertLevels nCells Time" units="1.e-3 m s^-1"
 			description="cell-wise product of component of horizontal bolus velocity in the northward direction and salinity"
-			 packages="gm"
 		/>
 		<var name="normalGMBolusVelocityTimesSalinity" type="real" dimensions="nVertLevels nEdges Time" units="1.e-3 m s^-1"
 			description="edge based product of normal velocity and salinity"
-			 packages="gm"
 		/>
 		<var name="velocityZonalTimesTemperature_MLE" type="real" dimensions="nVertLevels nCells Time" units="m s^-1 C"
 			description="cell-wise product of component of horizontal submeso velocity in the eastward direction and temperature"
-			 packages="submeso"
 		/>
 		<var name="velocityMeridionalTimesTemperature_MLE" type="real" dimensions="nVertLevels nCells Time" units="m s^-1 C"
 			description="cell-wise product of component of horizontal submeso velocity in the northward direction and temperature"
-			 packages="submeso"
 		/>
 		<var name="normalMLEVelocityTimesTemperature" type="real" dimensions="nVertLevels nEdges Time" units="m s^-1 C"
 			description="edge based product of normal velocity and temperature"
-			 packages="submeso"
 		/>
 		<var name="velocityZonalTimesSalinity_MLE" type="real" dimensions="nVertLevels nCells Time" units="1.e-3 m s^-1"
 			description="cell-wise product of component of horizontal submeso velocity in the eastward direction and salinity"
-			 packages="submeso"
 		/>
 		<var name="velocityMeridionalTimesSalinity_MLE" type="real" dimensions="nVertLevels nCells Time" units="1.e-3 m s^-1"
 			description="cell-wise product of component of horizontal submeso velocity in the northward direction and salinity"
-			 packages="submeso"
 		/>
 		<var name="normalMLEVelocityTimesSalinity" type="real" dimensions="nVertLevels nEdges Time" units="1.e-3 m s^-1"
 			description="edge based product of normal velocity and salinity"
-			 packages="submeso"
 		/>
 	</var_struct>
 	<streams>