source: NEMO/trunk/tests/README.rst @ 10431

Last change on this file since 10431 was 10279, checked in by nicolasmartin, 2 years ago

Various improvments for quick start guide

  • implementation of Rtd theme (Read the Docs) with custom layout and style file
  • add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
  • enhancement of bibliography management and configuration file for guide building
  • standardisation of headings markup
  • numerous edits
File size: 5.2 KB
Line 
1**********************
2Explore the test cases
3**********************
4
5.. contents::
6   :local:
7
8List
9====
10
11  The description below is a brief description of the test cases available in NEMO.
12
13ICEDYN
14------
15 
16  This test case illustrates the advection of an ice patch across a East/West and North/South periodic channel.
17  This configuration can be used to test the advection of the ice patch in an AGRIF zoom (1:3)
18  and across the AGRIF boundary or to test the ice advection schemes (Prather and Ultimate-Macho).
19  In the latest case user need to remove ``key_agrif`` out of the CPP keys list.
20
21  .. image:: _static/ICEDYN_UDIAG_43days_UM5.gif
22
23VORTEX
24------
25 
26  This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom.
27  It is implemented here with an online refined subdomain (1:3) out of which the vortex propagates.
28  It serves as a benchmark for quantitative estimates of nesting errors as in Debreu et al. (2012) :cite:`DEBREU2012`,
29  Penven et al. (2006) :cite:`PENVEN2006` or Spall and Holland (1991) :cite:`SPALL1991`.
30 
31  The animation below (sea level anomaly in meters) illustrates with two 1:2 successively nested grids how
32  the vortex smoothly propagates out of the refined grids.
33 
34  .. image:: _static/VORTEX_anim.gif
35
36ISOMIP
37------
38
39  The purpose of this test case is to evaluate the impact of various schemes and new development with the iceshelf cavities circulation and melt.
40  This configuration served as initial assesment of the ice shelf module in Losh et al. (2008) :cite:`LOSCH2008` and Mathiot et al. (2017) :cite:`MATHIOT2017`.
41  The default setup is the one described `here <http://staff.acecrc.org.au/~bkgalton/ISOMIP/test_cavities.pdf>`_.
42 
43  The figure below (meridional overturning circulation) illustrates the circulation generated after 10000 days by the ice shelf melting (ice pump).
44
45  .. image:: _static/ISOMIP_moc.png
46
47LOCK_EXCHANGE
48-------------
49
50  The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted
51  by Haidvogel and Beckmann (1999) :cite:`HAIDVOGEL1999` for testing advection schemes in ocean circulation models.
52  It has been used by several authors including Burchard and Bolding (2002) :cite:`BURCHARD2002` and Ilicak et al. (2012) :cite:`ILICAK2012`.
53  The LOCK EXCHANGE experiment can in particular illustrate the impact of different choices of numerical schemes
54  and/or subgrid closures on spurious interior mixing.
55
56  Below the animation of the LOCK_EXCHANGE test case using the advection scheme FCT4 (forth order) for tracer and ubs for dynamics.
57
58  .. image:: _static/LOCK-FCT4_flux_ubs.gif
59
60OVERFLOW
61--------
62
63  The OVERFLOW experiment illustrates the impact of different choices of numerical schemes
64  and/or subgrid closures on spurious interior mixing close to bottom topography.
65  The OVERFLOW experiment is adapted from the non-rotating overflow configuration described
66  in Haidvogel and Beckmann (1999) :cite:`HAIDVOGEL1999` and further used by Ilicak et al. (2012) :cite:`ILICAK2012`.
67  Here we can assess the behaviour of the second-order tracer advection scheme FCT2 and fortht-order FCT4, z-coordinate and sigma coordinate (...).
68
69  Below the animation of the OVERFLOW test case in sigma coordinate with the forth-order advection scheme FCT4.
70
71  .. image:: _static/OVF-sco_FCT4_flux_cen-ahm1000.gif
72
73WAD
74---
75
76  A set of simple closed basin geometries for testing the Wetting and drying capabilities.
77  Examples range from a closed channel with EW linear bottom slope to a parabolic EW channel with a Gaussian ridge.
78 
79  Below the animation of the test case 7. This test case is a simple linear slope with a mid-depth shelf with an open boundary forced with a sinusoidally varying ssh.
80  This test case has been introduced to emulate a typical coastal application with a tidally forced open boundary with an adverse SSH gradient that, when released, creates a surge up the slope.
81  The parameters are chosen such that the surge rises above sea-level before falling back and oscillating towards an equilibrium position
82
83  .. image:: _static/wad_testcase_7.gif
84
85CANAL
86-----
87
88  East-west periodic canal of variable size with several initial states and associated geostrophic currents (zonal jets or vortex).
89
90  .. image::_static/CANAL_image.gif
91
92Compile test cases
93==================
94
95The compilation of the test cases is very similar to the manner the reference configurations are compiled.
96If you are not familiar on how to compile NEMO, it is first recomended to read :doc:`the instructions <install>`
97
98| In the same manner as the ref. cfg are compiled with '-r' option, test cases can be compile by the use of makenemo with '-a' option.
99
100| Here an example to compile a copy named WAD2 of the wetting and drying test case (WAD) on the macport_osx architecture on 4 cores:
101
102.. code-block:: console
103 
104   $ ./makenemo -n WAD2 -a WAD -m macport_osx -j 4
105
106Run and analyse the test cases
107==============================
108
109There no requirement of specific input file for the test_cases presented here. The XIOS xml input files and namelist are already setup correctly.
110For detailed description and Jupyter notebook, the reader is directed on
111the `NEMO test cases repository <http://github.com/NEMO-ocean/NEMO-examples>`_
112
113References
114==========
115
116.. bibliography:: test_cases.bib
117   :all:
118   :style: unsrt
119   :labelprefix: T
Note: See TracBrowser for help on using the repository browser.