Merge pull request #21 from BrodiePearson/ocean/addADCMixing

Adds commenting for the tendency terms

Author: BrodiePearson

src/core_ocean/adc_mixing/Registry_adc_mixing_fields_opts.xml

@@ -275,142 +275,142 @@
 </var_struct>
 <var_struct name="adcTendArrays" time_levs="1" packages="adcMixingPKG">
   <var name="w2tend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="entrainment production term -- similar to dissipation"
+       description="entrainment/detrainment term -- similar to dissipation"
        />
   <var name="w2tend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="third order moment term (d / dz w^3)"
+       description="turbulent transport of w2 [ -d(www)/dz ]"
        />
   <var name="w2tend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy term"
+       description="parameterized pressure-strain terms (Rotta, rapid, buoyancy, Stokes)"
        />
   <var name="w2tend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
        description="buoyancy production term"
        />
   <var name="w2tend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="shear production term"
+       description="sub-plume scale tendency term for w2"
        />
   <var name="w2tend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="conversion of w2 due to splat effects"
+       description="conversion of w2 to u2/v2 due to splat effects"
        />
   <var name="w3tend1" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
-       description="entrainment production term -- similar to dissipation"
+       description="entrainment/detrainment term -- similar to dissipation"
        />
   <var name="w3tend2" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
-       description="fourth order moment term (d / dz w^4)"
+       description="turbulent transport of w3 [ -d(w^4)/dz ]"
        />
   <var name="w3tend3" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
-       description="w2 d/dz w2"
+       description="gradient production of w3 [ (3/2)*d( [w2]^2 )/dz ]"
        />
   <var name="w3tend4" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
-       description="subplume terms + return to isotropy, latter dominates"
+       description="parameterized pressure terms (Rotta, buoyancy)"
        />
   <var name="w3tend5" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
-       description="third order moment of buoyancy, turb transport of buoyancy fluxes"
+       description="buoyancy production and sub-plume scale effects"
        />
   <var name="w3tend6" type="real" dimensions="nVertLevels nCells Time" units="m^2/s^3"
        description="destruction due to splat effects"
        />
-  <var name="wttend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+  <var name="wttend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
+       description="entrainment/detrainment term -- similar to dissipation"
        />
-  <var name="wttend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production w^2 dTdz"
+  <var name="wttend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
+       description="turbulent transport of wt [ -d(wtw)/dz ]"
        />
-  <var name="wttend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="buoyancy term"
+  <var name="wttend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
+       description="parameterized pressure-scalar terms (Rotta, rapid, buoyancy, Stokes)"
        />
-  <var name="wttend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+  <var name="wttend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
+       description="gradient and buoyancy production term [ -w2*dT/dz + t*buoyancy]"
        />
-  <var name="wttend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="shear production term"
+  <var name="wttend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
+       description="dissipation of wt [ -kappa_FL*[d(wt)/dz]^2 ]"
        />
-  <var name="wttend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
+  <var name="wttend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m C/s^2"
        description="subplume scale production term"
        />
-  <var name="wstend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+  <var name="wstend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
+       description="entrainment/detrainment term -- similar to dissipation"
        />
-  <var name="wstend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production w^2 dTdz"
+  <var name="wstend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
+       description="turbulent transport of ws [ -d(wsw)/dz ]"
        />
-  <var name="wstend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="buoyancy term"
+  <var name="wstend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
+       description="parameterized pressure-scalar terms (Rotta, rapid, buoyancy, Stokes)"
        />
-  <var name="wstend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+  <var name="wstend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
+       description="gradient and buoyancy production term [ -w2*dS/dz + s*buoyancy]"
        />
-  <var name="wstend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="shear production term"
+  <var name="wstend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
+       description="dissipation of ws [ -kappa_FL*[d(ws)/dz]^2 ]"
        />
-  <var name="wstend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
+  <var name="wstend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m PSU/s^2"
        description="subplume scale production term"
        />
   <var name="uwtend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+       description="turbulent transport of uw [ -d(uww)/dz ]"
        />
   <var name="uwtend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production "
+       description="parameterized pressure-strain terms (Rotta, rapid, buoyancy, Stokes)"
        />
   <var name="uwtend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="uv covariance"
+       description="shear production of uw [-w2*dU/dz]"
        />
   <var name="uwtend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="horizontal buoyancy flux term"
+       description="buoyancy production of uw (u*buoyancy)"
        />
   <var name="uwtend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+       description="dissipation of uw [-kappa_FL*[d(uw)/dz]^2] "
        />
   <var name="vwtend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+       description="turbulent transport of vw [ -d(vww)/dz ]"
        />
   <var name="vwtend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production "
+       description="parameterized pressure-strain terms (Rotta, rapid, buoyancy, Stokes)"
        />
   <var name="vwtend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="uv covariance"
+       description="shear production of vw [-w2*dV/dz]"
        />
   <var name="vwtend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="horizontal buoyancy flux term"
+       description="buoyancy production of vw (v*buoyancy)"
        />
   <var name="vwtend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+       description="dissipation of uw [-kappa_FL*[d(uw)/dz]^2]"
        />
   <var name="u2tend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+       description="turbulent transport of u2 [ -d(uuw)/dz ]"
        />
   <var name="u2tend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production proportional to dUdz"
+       description="parameterized pressure-strain terms (Rotta, rapid, buoyancy, Stokes)"
        />
   <var name="u2tend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production proportional to dVdz"
+       description="shear production of u2 [-2*uw*dU/dz]"
        />
   <var name="u2tend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="buoyancy production"
+       description="dummy variable (should be zero)"
        />
   <var name="u2tend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+       description="dissipation of u2 [-(2/3)*dissipation]"
        />
   <var name="u2tend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="production due to splatting of w'2"
+       description="production due to splatting of w2"
        />
   <var name="v2tend1" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="divergence of turbulent transport of flux"
+       description="turbulent transport of v2 [ -d(vvw)/dz ]"
        />
   <var name="v2tend2" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production proportional to dUdz"
+       description="parameterized pressure-strain terms (Rotta, rapid, buoyancy, Stokes)"
        />
   <var name="v2tend3" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="gradient production proportional to dVdz"
+       description="shear production of v2 [-2*vw*dV/dz]"
        />
   <var name="v2tend4" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="buoyancy production"
+       description="dummy variable (should be zero)"
        />
   <var name="v2tend5" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="return to isotropy"
+       description="dissipation of v2 [-(2/3)*dissipation]"
        />
   <var name="v2tend6" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
-       description="production due to splatting of w'2"
+       description="production due to splatting of w2"
        />
   <var name="u2cliptend" type="real" dimensions="nVertLevelsP1 nCells Time" units="m^2/s^3"
        description="if less than zero, it is reset to zero, this stores when that is active"
@@ -585,6 +585,7 @@
     <var name="w2tend3"/>
     <var name="w2tend4"/>
     <var name="w2tend5"/>
+    <var name="w2tend6"/>
     <var name="u2tend1"/>
     <var name="u2tend2"/>
     <var name="u2tend3"/>

src/core_ocean/adc_mixing/mpas_ocn_turbulence.F

@@ -17,7 +17,7 @@
 !!  \date   14 Jan 2020
 !!  \details
 !!  This module creates and maintains a primary ocean mesh structure
-!!  for the ADC mixing scheme.  Eventually it will send arrays over to GPU 
+!!  for the ADC mixing scheme.  Eventually it will send arrays over to GPU
 !!  but for now just loads on to cpu
 !
 !-------------------------------------------------------------------------------
@@ -54,7 +54,7 @@ module ocn_turbulence
                        Detrainment, tumd, sumd, wumd, Mc
 
    real(kind=RKIND), dimension(:,:), pointer :: w2tend1, w2tend2,     &
-                       w2tend3, w2tend4, w2tend5, wttend1, wttend2,   &
+                       w2tend3, w2tend4, w2tend5, w2tend6, wttend1, wttend2,   &
                        wttend3, wttend4, wttend5, w3tend1, w3tend2,   &
                        w3tend3, w3tend5, w3tend4, wstend1, wstend2,   &
                        wstend3, wstend4, wstend5, uwtend1, uwtend2,   &
@@ -104,7 +104,8 @@ subroutine ocn_turbulenceCreate(domain)
                        DetrainmentTmp, tumdTmp, sumdTmp, wumdTmp, McTmp
 
    real(kind=RKIND), dimension(:,:), pointer :: w2tend1Tmp, w2tend2Tmp,     &
-                       w2tend3Tmp, w2tend4Tmp, w2tend5Tmp, wttend1Tmp, wttend2Tmp,   &
+                       w2tend3Tmp, w2tend4Tmp, w2tend5Tmp, w2tend6Tmp, &
+                       wttend1Tmp, wttend2Tmp,   &
                        wttend3Tmp, wttend4Tmp, wttend5Tmp, w3tend1Tmp, w3tend2Tmp,   &
                        w3tend3Tmp, w3tend5Tmp, w3tend4Tmp, wstend1Tmp, wstend2Tmp,   &
                        wstend3Tmp, wstend4Tmp, wstend5Tmp, uwtend1Tmp, uwtend2Tmp,   &
@@ -231,6 +232,7 @@ subroutine ocn_turbulenceCreate(domain)
       call mpas_pool_get_array(adcTendPool, 'w2tend3', w2tend3Tmp)
       call mpas_pool_get_array(adcTendPool, 'w2tend4', w2tend4Tmp)
       call mpas_pool_get_array(adcTendPool, 'w2tend5', w2tend5Tmp)
+      call mpas_pool_get_array(adcTendPool, 'w2tend6', w2tend6Tmp)
       call mpas_pool_get_array(adcTendPool, 'w3tend1', w3tend1Tmp)
       call mpas_pool_get_array(adcTendPool, 'w3tend2', w3tend2Tmp)
       call mpas_pool_get_array(adcTendPool, 'w3tend3', w3tend3Tmp)
@@ -275,6 +277,7 @@ subroutine ocn_turbulenceCreate(domain)
       adcMixing%w2tend3 = w2tend3Tmp
       adcMixing%w2tend4 = w2tend4Tmp
       adcMixing%w2tend5 = w2tend5Tmp
+      adcMixing%w2tend6 = w2tend6Tmp
       adcMixing%w3tend1 = w3tend1Tmp
       adcMixing%w3tend2 = w3tend2Tmp
       adcMixing%w3tend3 = w3tend3Tmp