Update snwredist documentation

columnphysics/icepack_snow.F90

@@ -69,6 +69,26 @@ subroutine icepack_init_snow
 
       character (len=*),parameter :: subname='(icepack_init_snow)'
 
+      !-----------------------------------------------------------------
+      ! Check for valid values
+      !-----------------------------------------------------------------
+
+      if (snwredist /= 'none' .and. snwredist /= 'bulk' .and. &
+          snwredist /= 'ITDrdg') then
+         call icepack_warnings_setabort(.true.,__FILE__,__LINE__)
+         call icepack_warnings_add(subname//'ERROR: snwredist value invalid = '//trim(snwredist))
+         return
+      endif
+
+      if (snwgrain) then
+         if (snw_aging_table /= 'file' .and. snw_aging_table /= 'test' .and. &
+             snw_aging_table /= 'snicar') then
+            call icepack_warnings_setabort(.true.,__FILE__,__LINE__)
+            call icepack_warnings_add(subname//'ERROR: snw_aging_table value invalid = '//trim(snw_aging_table))
+            return
+         endif
+      endif
+
       !-----------------------------------------------------------------
       ! Snow metamorphism lookup table
       !-----------------------------------------------------------------
@@ -230,7 +250,7 @@ subroutine icepack_init_snow
             call icepack_warnings_add(subname//'ERROR: snw_aging_table value')
             return
          endif
-      endif
+      endif   ! snwgrain
 
       end subroutine icepack_init_snow
 

doc/source/science_guide/sg_snow.rst

@@ -29,9 +29,7 @@ Snow redistribution
 
 Because the thermodynamic schemes in CICE assume a uniform snow depth over each category, ignoring the fractions of level and deformed ice, effects of snow redistribution are included only via the delta-Eddington radiation scheme. The redistributed snow depth is used to determine the effective area of bare ice (for very small snow depths) and the effective area and depth of melt ponds over level ice. Once those areas are determined, the redistributed snow volume over them is known, from which the snow depth for the remaining snow-covered area can be computed and used for its radiation balance calculation.
 
-Two basic approaches are available for snow redistribution by wind, ``snwredist`` = ``bulk``, for which a user-defined parameter :math:`p` (``snwlvlfac``) determines the ratio of snow on ridges to that on level ice, and ``snwITDrdg``, in which snow can be compacted by the wind or eroded and redeposited on other thickness categories. For both, nonlocal redistribution of snow (i.e., between grid cells) is neglected, assuming that the difference between snow mass blowing into a grid cell and that blowing out is negligible, but snow can be blown into nearby leads and open water.
-
-
+Two basic approaches are available for snow redistribution by wind, ``snwredist`` = ``bulk``, for which a user-defined parameter :math:`p` (``snwlvlfac``) determines the ratio of snow on ridges to that on level ice, and ``snwredist`` = ``ITDrdg``, in which snow can be compacted by the wind or eroded and redeposited on other thickness categories based on the standard deviation of the level and ridged ice thickness distribution. For both, nonlocal redistribution of snow (i.e., between grid cells) is neglected, assuming that the difference between snow mass blowing into a grid cell and that blowing out is negligible, but snow can be blown into nearby leads and open water.
 
 .. _snow_bulk:
 
@@ -64,7 +62,7 @@ In the shortwave module for level-ice ponds, we create a new variable :math:`h_{
 Snow redistribution and compaction by wind
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Following :cite:`Lecomte15`, when ``snwredist`` = ``snwITDrdg`` we parameterize the amount of snow lost into the ocean through leads or redistributed to other thickness categories by defining the redistribution function :math:`\Phi` for snow mass as the sum of an erosion rate :math:`\Phi_E` and a redeposition rate :math:`\Phi_R` for each category of thickness :math:`h_i`:
+Following :cite:`Lecomte15`, when ``snwredist`` = ``ITDrdg`` we parameterize the amount of snow lost into the ocean through leads or redistributed to other thickness categories by defining the redistribution function :math:`\Phi` for snow mass as the sum of an erosion rate :math:`\Phi_E` and a redeposition rate :math:`\Phi_R` for each category of thickness :math:`h_i`:
 
 .. math::
    \Phi_E = \left({\partial m \over \partial t}\right)_{erosion} = -{\gamma \over \sigma_{ITD}} \left(V-V^*\right){\rho_{max} - \rho_s \over \rho_{max}}

doc/source/user_guide/ug_case_settings.rst

@@ -313,13 +313,14 @@ snow_nml
    "``rhosnew``", "real", "new snow density", "100.0"
    "``rsnw_fall``", "real", "radius of new snow (um)", "54.526"
    "``rsnw_tmax``", "real", "maximum snow radius (um)", "1500.0"
-   "``snw_aging_table``", "test", "snow aging lookup table", "test"
-   "", "snicar", "(not available in Icepack)", ""
    "``snwgrain``",  "logical", "snow grain metamorphosis", ".false."
    "``snwlvlfac``", "real", "fraction increase in bulk snow redistribution", "0.3"
-   "``snwredist``", "``snwITDrdg``", "snow redistribution using ITD/ridges", "none"
-   "", "``bulk``", "bulk snow redistribution", ""
-   "", "``none``", "no snow redistribution", ""
+   "``snwredist``", "``bulk``", "bulk snow redistribution scheme", "``none``"
+   "", "``ITDrdg``", "ITDrdg snow redistribution scheme", ""
+   "", "``none``", "snow redistribution scheme off", ""
+   "``snw_aging_table``", "``file``", "read 1D and 3D fields for dry metamorophsis lookup table (not available in standalone Icepack)", "``test``"
+   "", "``snicar``", "read 3D fields for dry metamorophsis lookup table (not available in standalone Icepack)", ""
+   "", "``test``", "internally generated dry metamorophsis lookup table for testing", ""
    "``use_smliq_pnd``", "logical", "use liquid in snow for ponds", ".false."
    "``windmin``",  "real", "minimum wind speed to compact snow", "10.0"
    "", "", "", ""