Update docs

docs/developers_guide/ocean/test_groups/drying_slope.rst

@@ -34,13 +34,17 @@ defines a step for setting up the initial state for each test case.
 
 First, a mesh appropriate for the resolution is generated using
 :py:func:`mpas_tools.planar_hex.make_planar_hex_mesh()`.  Then, the mesh is
-culled to remove periodicity in the y direction. MPAS-Ocean is then run in init
-mode. If the vertical coordinate is ``sigma``, the vertical grid configured
-accordingly during init mode. During this init mode run, ssh is initialized
-using the tidal forcing config options, and temperature and salinity are set
-to constant values by default. (Namelist options may be modified to produce a
-plug of different temperature values from the background, but this is not
-employed in this test case.)
+culled to remove periodicity in the y direction. The vertical grid is
+configured according to the config options in the ``vertial_grid`` section.
+The bottom depth is then set according to config options
+``right_bottom_depth`` and ``left_bottom_depth``. The initial layer
+thicknesses are set to the minimum thickness and the initial state is set to
+a constant value by default according to the config options
+``background_temperature`` and ``background_salinity``. Optionally, a mass of
+warmer water can be initialized over part of the domain, a "plug," using
+config options ``plug_width_frac`` and ``plug_width_temperature``. For current
+configurations, tracer tendencies are off and these tracer options do not
+affect the flow.
 
 forward
 ~~~~~~~
@@ -50,7 +54,9 @@ defines a step for running MPAS-Ocean from the initial condition produced in
 the ``initial_state`` step. If ``damping_coeff`` is provided as an argument to 
 the constructor, the associate namelist option
 (``config_Rayleigh_damping_coeff``) will be given this value. MPAS-Ocean is run
-in ``run()``.
+in ``run()``. The time step is determined as a function of resolution by the
+config option ``dt_per_km``. The number of tasks is determined as a function
+of resolution by ``ntasks_baseline`` and ``min_tasks``.
 
 viz
 ~~~
@@ -112,16 +118,6 @@ Both ``sigma`` and ``single_layer`` coordinate types are supported. For
 runs at one value of the implicit bottom drag coefficient. 
 
 
-.. _dev_ocean_drying_slope_ramp:
-
-ramp
-----
-
-The :py:class:`compass.ocean.tests.drying_slope.ramp.Ramp` is identical to the
-default class except it sets ``ramp`` to ``True`` for the forward step to enable
-the ramp feature for wetting and drying.
-.. _dev_ocean_drying_slope_log_law:
-
 loglaw
 ------
 

docs/users_guide/ocean/test_groups/drying_slope.rst

@@ -52,32 +52,74 @@ The config options for this test case are:
    # Options related to the vertical grid
    [vertical_grid]
    
+   # the type of vertical grid
+   grid_type = uniform
+   
+   # Number of vertical levels
+   bottom_depth = 10.
+   
    # Number of vertical levels
    vert_levels = 10
    
-   # The type of vertical coordinate (e.g. z-level, z-star)
-   coord_type = sigma
+   # Thickness of each layer in the thin film region
+   thin_film_thickness = 1.0e-3
+   
+   # Whether to use "partial" or "full", or "None" to not alter the topography
+   partial_cell_type = None
+   
+   # The minimum fraction of a layer for partial cells
+   min_pc_fraction = 0.1
    
    # config options for drying slope test cases
    [drying_slope]
    
-   # the number of grid cells in x and y
+   # the number of grid cells in x
    nx = 6
    
+   # Length over which wetting and drying actually occur
+   Ly_analysis = 25.
+   
+   # Domain length
+   Ly = 30.
+   
+   # Bottom depth at the right side of the domain
+   right_bottom_depth = 10.
+   
+   # Bottom depth at the left side of the domain
+   left_bottom_depth = 0.
+   
+   # Plug width as a fraction of the domain
+   plug_width_frac = 0.0
+   
+   # Plug temperature
+   plug_temperature = 20.0
+   
+   # Background temperature
+   background_temperature = 20.0
+   
+   # Background salinity
+   background_salinity = 35.0
+   
    # time step in s per km of horizontal resolution
    dt_per_km = 30
    
+   # Number of tasks at 1km resolution
+   ntasks_baseline = 4
+   
+   # Minimum number of tasks
+   min_tasks = 1
+   
    # config options for visualizing drying slope ouptut
    [drying_slope_convergence]
    
    resolutions = 0.25, 0.5, 1, 2
-
+   
    # config options for visualizing drying slope ouptut
    [drying_slope_viz]
    
    # whether to generate movie
    generate_movie = False
-
+   
    # frames per second for movies
    frames_per_second = 30
    
@@ -118,15 +160,6 @@ processors and the results of each are compared. ``RES`` is either 250m or 1km.
 Rayleigh drag coefficient of 0.01. Rayleigh drag is not compatible with
 ``single_layer`` so implicit drag with a constant coefficient is used.
 
-ramp
-----
-
-``ocean/drying_slope/${RES}/${COORD}/ramp`` is identical to the ``default``
-test except the factor that scales velocities and velocity tendencies is
-ramped over a given layer thickness range rather than a binary switch at the
-minimum thickness. ``RES`` is either 250m or 1km. ``COORD`` is either
-``single_layer`` or ``sigma``.
-
 loglaw
 ------