Update config options for hurricane in User's Guide

docs/users_guide/ocean/test_groups/hurricane.rst

@@ -9,13 +9,13 @@ realistic ocean domains with regional refinement. These simulations
 are forced with time-varying atmospheric reanalysis data for tropical
 cyclone events and tides. The meshes contain refined regions in order
 to resolve coastal estuaries, making it possible to simulate the
-storm surge that results from a given hurricane event.   
+storm surge that results from a given hurricane event.
 Currently, one mesh resolution and one storm, Hurricane Sandy, are supported.
 More mesh resolutions will be supported in the future.
 
 These test are configured to use the barotropic, single layer configuration
 of MPAS-Ocean. Each mesh can optionally be created to contain the floodplain
-which can be used to simulate coastal inundation using MPAS-Ocean's 
+which can be used to simulate coastal inundation using MPAS-Ocean's
 wetting and drying scheme.
 
 Shared config options
@@ -26,42 +26,47 @@ Note that meshes and test cases may modify these options, as noted below.
 
 .. code-block:: cfg
 
-   # options for global ocean testcases
-   [global_ocean]
-   
-   ## config options related to the mesh step
-   # number of cores to use
-   mesh_cores = 1 
-   # minimum of cores, below which the step fails
-   mesh_min_cores = 1 
-   
-   # The following options are detected from .gitconfig if not explicitly entered
-   author = autodetect
-   email = autodetect
+    # options for spherical meshes
+    [spherical_mesh]
+
+    ## config options related to the step for culling land from the mesh
+    # number of cores to use
+    cull_mesh_cores = 18
+    # minimum of cores, below which the step fails
+    cull_mesh_min_cores = 1
+    # maximum memory usage allowed (in MB)
+    cull_mesh_max_memory = 1000
+
+    # Elevation threshold to use for including land cells
+    floodplain_elevation = 10.0
 
-   # Elevation threshold to use for including land cells
-   floodplain_elevation = 10.0
 
-   
+    # options for global ocean testcases
+    [global_ocean]
+
+    # The following options are detected from .gitconfig if not explicitly entered
+    author = autodetect
+    email = autodetect
+
    # options for hurricane testcases
    [hurricane]
-   
+
    ## config options related to the mesh step
    # number of cores to use
-   mesh_cores = 1 
+   mesh_cores = 1
    # minimum of cores, below which the step fails
-   mesh_min_cores = 1 
-   
+   mesh_min_cores = 1
+
    ## config options related to the initial_state step
    # number of cores to use
    init_cores = 36
    # minimum of cores, below which the step fails
-   init_min_cores = 8 
+   init_min_cores = 8
    # maximum memory usage allowed (in MB)
    init_max_memory = 1000
    # number of threads
-   init_threads = 1 
-   
+   init_threads = 1
+
    ## config options related to the forward steps
    # number of cores to use
    forward_cores = 128
@@ -70,7 +75,7 @@ Note that meshes and test cases may modify these options, as noted below.
    # maximum memory usage allowed (in MB)
    forward_max_memory = 1000
    # number of threads
-   forward_threads = 1 
+   forward_threads = 1
 
 .. _hurricane_mesh:
 
@@ -80,10 +85,10 @@ The mesh test case uses the mesh step from the global ocean test group.
 First, it generates the global mesh based on a specified mesh resolution
 function. Next, bathymetry/topography data is interpolated on the mesh from the
 STRM15+ data product. This interpolation step is necessary, because the
-topography in the floodplain is used to set a mask for the cell culling 
+topography in the floodplain is used to set a mask for the cell culling
 process. The land cells above the ``floodplain_elevation`` are then culled
 from the mesh. Finally, the bathymetry is re-interpolated onto the mesh
-since this data is not carried over from the cell culling process. 
+since this data is not carried over from the cell culling process.
 
 .. _hurricane_init:
 
@@ -94,8 +99,8 @@ atmospheric forcing, and prepares the station locations for timeseries output.
 
 initial state step
 ^^^^^^^^^^^^^^^^^^
-The initial state step runs MPAS-Ocean in init mode to create the initial 
-condition file for the forward run. The vertical mesh is setup for a 
+The initial state step runs MPAS-Ocean in init mode to create the initial
+condition file for the forward run. The vertical mesh is setup for a
 single layer case and the ssh with a thin layer on land for wetting and
 drying cases.
 
@@ -110,15 +115,15 @@ create pointstats file step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In order to perform validation of the forward simulation, timeseries data
 is recored at mesh cell centers which are closest to observation stations.
-This set reads in the observation station locations and finds the cells 
+This set reads in the observation station locations and finds the cells
 closest to them. A file is created that is the input to the
 pointWiseStats analysis member for the forward run.
 
 .. _hurricane_sandy:
 
 sandy test case
 ---------------
-The sandy test case is responsible for the forward model simulation and 
+The sandy test case is responsible for the forward model simulation and
 analysis.
 
 forward step