diff --git a/docs/developers_guide/landice/api.rst b/docs/developers_guide/landice/api.rst index 02f598c416..fe05bbdb51 100644 --- a/docs/developers_guide/landice/api.rst +++ b/docs/developers_guide/landice/api.rst @@ -330,6 +330,22 @@ ismip6_run ismip6_ais_proj2300.set_up_experiment.SetUpExperiment.setup ismip6_ais_proj2300.set_up_experiment.SetUpExperiment.run +issunguata_sermia +~~~~~~~~~~~~~~~~~ + +.. currentmodule:: compass.landice.tests.issunguata_sermia + +.. autosummary:: + :toctree: generated/ + + IssunguataSermia + + mesh_gen.MeshGen + mesh_gen.MeshGen.run + + mesh.Mesh + mesh.Mesh.run + kangerlussuaq ~~~~~~~~~~~~~ diff --git a/docs/developers_guide/landice/test_groups/index.rst b/docs/developers_guide/landice/test_groups/index.rst index c825371816..172b9adb76 100644 --- a/docs/developers_guide/landice/test_groups/index.rst +++ b/docs/developers_guide/landice/test_groups/index.rst @@ -19,6 +19,7 @@ Test groups hydro_radial ismip6_forcing ismip6_run + issunguata_sermia kangerlussuaq koge_bugt_s mismipplus diff --git a/docs/developers_guide/landice/test_groups/issunguata_sermia.rst b/docs/developers_guide/landice/test_groups/issunguata_sermia.rst new file mode 100644 index 0000000000..1b9649f69f --- /dev/null +++ b/docs/developers_guide/landice/test_groups/issunguata_sermia.rst @@ -0,0 +1,30 @@ +.. _dev_landice_issunguata_sermia: + +issunguata_sermia +============= + +The ``issunguata_sermia`` test group (:py:class:`compass.landice.tests.issunguata_sermia.IssunguataSermia`) +creates a variable resolution (default 1-10 km) mesh for a regional domain of Issunguata Sermia, Greenland +(see :ref:`landice_issunguata_sermia`). + +.. _dev_landice_issunguata_sermia_framework: + +framework +--------- + +The shared config options for the ``issunguata_sermia`` test group are described +in :ref:`landice_issunguata_sermia` in the User's Guide. + +mesh +~~~~ + +The class :py:class:`compass.landice.tests.issunguata_sermia.mesh.Mesh` +defines a step for creating a variable resolution Issunguata Sermia mesh. +This is used by the ``mesh_gen`` test case. + +mesh_gen +-------- + +The :py:class:`compass.landice.tests.issunguata_sermia.mesh_gen.MeshGen` +calls the :py:class:`compass.landice.tests.issunguata_sermia.mesh.Mesh` to create +the variable resolution Issunguata Sermia mesh. diff --git a/docs/users_guide/landice/test_groups/images/issunguata_sermia_1to10km.png b/docs/users_guide/landice/test_groups/images/issunguata_sermia_1to10km.png new file mode 100644 index 0000000000..316bfb55df Binary files /dev/null and b/docs/users_guide/landice/test_groups/images/issunguata_sermia_1to10km.png differ diff --git a/docs/users_guide/landice/test_groups/index.rst b/docs/users_guide/landice/test_groups/index.rst index 5abcff0e47..40eea55379 100644 --- a/docs/users_guide/landice/test_groups/index.rst +++ b/docs/users_guide/landice/test_groups/index.rst @@ -24,6 +24,7 @@ physics but that are not run routinely. hydro_radial ismip6_forcing ismip6_run + issunguata_sermia kangerlussuaq koge_bugt_s mismipplus diff --git a/docs/users_guide/landice/test_groups/issunguata_sermia.rst b/docs/users_guide/landice/test_groups/issunguata_sermia.rst new file mode 100644 index 0000000000..d824957372 --- /dev/null +++ b/docs/users_guide/landice/test_groups/issunguata_sermia.rst @@ -0,0 +1,77 @@ +.. _landice_issunguata_sermia: + +issunguata_sermia +============= + +The ``landice/issunguata_sermia`` test group includes a test case for creating a +mesh for Issunguata Sermia, Greenland. The optimization for basal friction +happens outside of COMPASS because it requires expert usage and takes a +larger amount of computing resources than COMPASS is typically run with. + +.. figure:: images/issunguata_sermia_1to10km.png + :width: 777 px + :align: center + + Ice thickness in meters on Issunguata Sermia 1-10km variable resolution mesh. + +The test group includes a single test case that creates the variable resolution mesh. + +config options +-------------- + +The test group uses the following default config options. At this point only +the mesh generation options are adjusted through the config file. + +.. code-block:: cfg + + # config options for issunguata sermia test cases + [mesh] + + # number of levels in the mesh + levels = 10 + + # Bounds of issunguata sermia domain + x_min = -263230. + x_max = 130000. + y_min = -2600000 + y_max = -2400000. + + # distance from ice margin to cull (km). + # Set to a value <= 0 if you do not want + # to cull based on distance from margin. + cull_distance = 5.0 + + # mesh density parameters + # minimum cell spacing (meters) + min_spac = 1.e3 + # maximum cell spacing (meters) + max_spac = 1.e4 + # log10 of max speed (m/yr) for cell spacing + high_log_speed = 2.0 + # log10 of min speed (m/yr) for cell spacing + low_log_speed = 0. + # distance at which cell spacing = max_spac (meters) + high_dist = 1.e5 + # distance within which cell spacing = min_spac (meters) + low_dist = 1.e4 + # distance at which bed topography has no effect + high_dist_bed = 1.e5 + # distance within which bed topography has maximum effect + low_dist_bed = 5.e4 + # Bed elev beneath which cell spacing is minimized + low_bed = 50.0 + # Bed elev above which cell spacing is maximized + high_bed = 100.0 + + # mesh density functions + use_speed = True + use_dist_to_grounding_line = False + use_dist_to_edge = False + use_bed = False + +mesh_gen +-------- + +``landice/issunguata_sermia/mesh_gen`` creates a variable resolution mesh. +The default is 1-10km resolution with mesh density determined by +observed ice speed. There is no model integration step.