diff --git a/docs/developers_guide/ocean/test_groups/baroclinic_gyre.rst b/docs/developers_guide/ocean/test_groups/baroclinic_gyre.rst index 300de2f6c8..1cf9b97810 100644 --- a/docs/developers_guide/ocean/test_groups/baroclinic_gyre.rst +++ b/docs/developers_guide/ocean/test_groups/baroclinic_gyre.rst @@ -16,7 +16,7 @@ Framework At this stage, the test case is available at 80-km horizontal resolution. By default, the 15 vertical layers vary linearly in thickness with depth, from 50m at the surface to 190m at depth (full depth: 1800m). -The test group includes 2 test cases, called ``performance`` for a short (10-day) run, and ``long`` for a 3-year simulation to run it to quasi-equilibrium. Both test cases have 2 steps, +The test group includes 2 test cases, called ``performance_test`` for a short (10-day) run, and ``3_year_test`` for a 3-year simulation to run it to quasi-equilibrium. Both test cases have 2 steps, ``initial_state``, which defines the mesh and initial conditions for the model, and ``forward``, which performs the time integration of the model. @@ -48,18 +48,18 @@ The class :py:class:`compass.ocean.tests.baroclinic_gyre.forward.Forward` defines a step for running MPAS-Ocean from the initial condition produced in the ``initial_state`` step. -performance +performance_test ------------- -``ocean/baroclinic_gyre/80km/performance`` is the default version of the +``ocean/baroclinic_gyre/80km/performance_test`` is the default version of the baroclinic eddies test case for a short (10-day) test run and validation of prognostic variables for regression testing. Currently, only the 80-km horizontal resolution is supported. -long +3_year_test ----------- -``ocean/baroclinic_gyre/80km/long`` performs a longer (3 year) integration +``ocean/baroclinic_gyre/80km/3_year_test`` performs a longer (3 year) integration of the model forward in time. The point is to compare the quasi-steady state with theroretical scaling and results from other models. Currently, only the 80-km horizontal resolution is supported. diff --git a/docs/users_guide/ocean/test_groups/baroclinic_gyre.rst b/docs/users_guide/ocean/test_groups/baroclinic_gyre.rst index c419524071..2734051e37 100644 --- a/docs/users_guide/ocean/test_groups/baroclinic_gyre.rst +++ b/docs/users_guide/ocean/test_groups/baroclinic_gyre.rst @@ -76,10 +76,10 @@ represent temperature. Analysis -------------- -For scientific validation, this test case is meant to be run to quasi-steady state and its mean state compared to the MITgcm test case and / or theoretical scaling. This is done through an analysis step in the ``long`` case. -Examples of qualitative plots include: i) equilibrated SSH contours on top of surface heat fluxes, ii) barotropic streamfunction (compared to MITgcm or a braotropic gyre test case). +For scientific validation, this test case is meant to be run to quasi-steady state and its mean state compared to the MITgcm test case and / or theoretical scaling. This is done through an analysis step in the ``3_year_test`` case. +Examples of qualitative plots include: i) equilibrated SSH contours on top of surface heat fluxes, ii) barotropic streamfunction (compared to MITgcm or a barotropic gyre test case). -Examples of checks against theory include: iii) max of simulated barotropic streamfunction ~ Sverdrup transport, iv) simulated thermocline depth ~ scaling argument for penetration depth (Vallis (2017) or Cushman-Roisin and Beckers (2011). +Examples of checks against theory include: iii) max of simulated barotropic streamfunction ~ Sverdrup transport, iv) simulated thermocline depth ~ scaling argument for penetration depth (Vallis (2017) or Cushman-Roisin and Beckers (2011)). Consider the Sverdrup transport: @@ -145,6 +145,9 @@ All 2 test cases share the same set of config options: # Maximum zonal wind stress value wind_stress_max = 0.1 + + # Constant salinity value (also used in restoring) + initial_salinity = 34. # Surface temperature restoring temp_min = 0. @@ -153,16 +156,16 @@ All 2 test cases share the same set of config options: # Restoring piston velocity for surface temperature (s-1) restoring_temp_piston_vel = 3.86e-7 -performance +performance_test ------------ -``ocean/baroclinic_gyre/performance`` is the default version of the +``ocean/baroclinic_gyre/performance_test`` is the default version of the baroclinic_gyre test case for a short (10-day) test run and validation of prognostic variables for regression testing. -long +3_year_test -------- -``ocean/baroclinic_gyre/long`` is an additional version of the +``ocean/baroclinic_gyre/3_year_test`` is an additional version of the baroclinic_gyre test case for a test run to quasi equilibirum (3 years) and validation of the mean state against theory and results from other models.