New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
README.rst in NEMO/trunk/tests – NEMO

source: NEMO/trunk/tests/README.rst

Last change on this file was 14854, checked in by mcastril, 17 months ago

#2662: Merge dev_r13747_HPC-11_mcastril_HPDAonline_DiagGPU

File size: 8.8 KB
Line 
1**********************
2Explore the test cases
3**********************
4
5.. todo::
6
7   CANAL animated gif is missing
8
9.. contents::
10   :local:
11   :depth: 1
12
13Installation
14============
15
16Download
17--------
18
19| The complete and up-to-date set of test cases is available on
20  :github:`NEMO test cases repository <NEMO-examples>`.
21| Download it directly into the :file:`./tests` root directory with
22
23.. code-block:: console
24
25   $ git clone http://github.com/NEMO-ocean/NEMO-examples
26
27Compilation
28-----------
29
30The compilation of the test cases is very similar to
31the manner the reference configurations are compiled.
32If you are not familiar on how to compile NEMO,
33it is first recomended to read :doc:`the instructions <install>`.
34
35| As the reference configurations are compiled with ``-r`` option,
36  test cases can be compiled by the use of :file:`makenemo` with ``-a`` option.
37| Here an example to compile a copy named WAD2 of the wetting and drying test case (WAD):
38
39.. code-block:: console
40
41   $ ./makenemo -n 'WAD2' -a 'WAD' -m 'my_arch' -j '4'
42
43Run and analysis
44----------------
45
46There no requirement of specific input file for the test_cases presented here.
47The XIOS xml input files and namelist are already setup correctly.
48For detailed description and Jupyter notebook, the reader is directed on
49the :github:`NEMO test cases repository <NEMO-examples>`
50
51The description below is a brief advertisement of some test cases.
52
53List of test cases
54==================
55
56ICE_AGRIF
57---------
58
59.. figure:: _static/ICE_AGRIF_UDIAG_43days_UM5.gif
60   :width: 200px
61   :align: left
62
63   ..
64
65| This test case illustrates the advection of an ice patch across
66  an East/West and North/South periodic channel over a slab ocean (i.e. one ocean layer),
67  and with an AGRIF zoom (1:3) in the center.
68| The purpose of this configuration is to
69  test the advection of the ice patch in and across the AGRIF boundary.
70  One can either impose ice velocities or ice-atm.
71  Stresses and let rheology define velocities (see :file:`README` for details)
72
73VORTEX
74------
75
76.. figure:: _static/VORTEX_anim.gif
77   :width: 200px
78   :align: right
79
80   ..
81
82This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom.
83It is implemented here with an online refined subdomain (1:3) out of which the vortex propagates.
84It serves as a benchmark for quantitative estimates of nesting errors as in :cite:`DEBREU2012`,
85:cite:`PENVEN2006` or :cite:`SPALL1991`.
86
87The animation (sea level anomaly in meters) illustrates with
88two 1:2 successively nested grids how the vortex smoothly propagates out of the refined grids.
89
90ISOMIP
91------
92
93.. figure:: _static/ISOMIP_moc.png
94   :width: 200px
95   :align: left
96
97   ..
98
99| The purpose of this test case is to evaluate the impact of various schemes and new development with
100  the iceshelf cavities circulation and melt.
101  This configuration served as initial assesment of the ice shelf module in :cite:`LOSCH2008` and
102  :cite:`MATHIOT2017`.
103  The default setup is the one described |ISOMIP|_.
104| The figure (meridional overturning circulation) illustrates
105  the circulation generated after 10000 days by the ice shelf melting (ice pump).
106
107.. |ISOMIP| replace:: here
108
109LOCK_EXCHANGE
110-------------
111
112.. figure:: _static/LOCK-FCT4_flux_ubs.gif
113   :width: 200px
114   :align: right
115
116   ..
117
118| The LOCK EXCHANGE experiment is a classical fluid dynamics experiment that has been adapted
119  by :cite:`HAIDVOGEL1999` for testing advection schemes in ocean circulation models.
120  It has been used by several authors including :cite:`BURCHARD2002` and :cite:`ILICAK2012`.
121  The LOCK EXCHANGE experiment can in particular illustrate
122  the impact of different choices of numerical schemes and/or subgrid closures on
123  spurious interior mixing.
124| Here the animation of the LOCK_EXCHANGE test case using
125  the advection scheme FCT4 (forth order) for tracer and ubs for dynamics.
126
127OVERFLOW
128--------
129
130.. figure:: _static/OVF-sco_FCT4_flux_cen-ahm1000.gif
131   :width: 200px
132   :align: left
133
134   ..
135
136| The OVERFLOW experiment illustrates the impact of different choices of numerical schemes and/or
137  subgrid closures on spurious interior mixing close to bottom topography.
138  The OVERFLOW experiment is adapted from the non-rotating overflow configuration described in
139  :cite:`HAIDVOGEL1999` and further used by :cite:`ILICAK2012`.
140  Here we can assess the behaviour of the second-order tracer advection scheme FCT2 and
141  forth-order FCT4, z-coordinate and sigma coordinate (...).
142| Here the animation of the OVERFLOW test case in sigma coordinate with
143  the forth-order advection scheme FCT4.
144
145WAD
146---
147
148.. figure:: _static/wad_testcase_7.gif
149   :width: 200px
150   :align: right
151
152   ..
153
154| A set of simple closed basin geometries for testing the Wetting and drying capabilities.
155  Examples range from a closed channel with EW linear bottom slope to
156  a parabolic EW channel with a Gaussian ridge.
157| Here the animation of the test case 7.
158  This test case is a simple linear slope with a mid-depth shelf with
159  an open boundary forced with a sinusoidally varying ssh.
160  This test case has been introduced to emulate a typical coastal application with
161  a tidally forced open boundary with an adverse SSH gradient that,
162  when released, creates a surge up the slope.
163  The parameters are chosen such that
164  the surge rises above sea-level before falling back and oscillating towards an equilibrium position.
165
166CANAL
167-----
168
169.. figure:: _static/CANAL_image.gif
170   :width: 200px
171   :align: left
172
173   ..
174
175East-west periodic canal of variable size with several initial states and
176associated geostrophic currents (zonal jets or vortex).
177
178ICE_ADV2D
179---------
180
181| This test case illustrates the advection of an ice patch across
182  an East/West and North/South periodic channel over a slab ocean (i.e. one ocean layer).
183  The configuration is similar to ICE_AGRIF, except for the AGRIF zoom.
184| The purpose of this configuration is to test the advection schemes available in the sea-ice code
185  (for now, Prather and Ultimate-Macho from 1st to 5th order),
186  especially the occurence of overshoots in ice thickness
187
188ICE_ADV1D
189---------
190
191| This experiment is the classical :cite:`SCHAR1996` test case ,
192  which has been used in :cite:`LIPSCOMB2004`, and in which very specific shapes of ice concentration,
193  thickness and volume converge toward the center of a basin.
194  Convergence is unidirectional (in x) while fields are homogeneous in y.
195| The purpose of this configuration is to
196  test the caracteristics of advection schemes available in the sea-ice code
197  (for now, Prather and Ultimate-Macho from 1st to 5th order),
198  especially the constitency between concentration, thickness and volume,
199  and the preservation of initial shapes.
200
201.. rubric:: References
202
203.. bibliography:: tests.bib
204   :all:
205   :style: unsrt
206   :labelprefix: T
207
208ICE_RHEO
209--------
210|
211
212BENCH
213-----
214| Benchmark configuration. Allow to run any configuration (including ORCA type or BDY) with idealized grid
215  and initial state so it does not need any input file other than the namelists.
216  As usual, all configuration changes can be done through the namelist.
217  We provide 3 example of namelist_cfg to mimic ORCA1, OR025 or ORCA12 configurations.
218  By default do not produce any output file. An extensive description of BENCH will be abailable in
219  Irrmann et al. 2021.
220
221CPL_OASIS
222---------
223| This test case checks the OASIS interface in OCE/SBC, allowing to set up
224  a coupled configuration through OASIS. See CPL_OASIS/README.md for more information.
225
226DIA_GPU
227---------
228| This is a demonstrator of diagnostic DIAHSB ported to GPU using CUDA Fortran.
229  Memory communications between host and device are asynchronous given the device has that capability.
230  This experiment is target for ORCA2_ICE_PISCES
231
232TSUNAMI
233---------
234| just use dynspg_ts to simulate the propagation of an ssh anomaly (cosinus) in a box configuration
235  with flat bottom and jpk=2.
236
237DONUT
238-----
239| Donut shaped configuration to test MPI decomposition with bdy.
240
241C1D_ASICS
242---------
243|
244
245DOME
246----
247|
248
249ICB
250----
251| ICB is a very idealized configuration used to test and debug the icb module.
252  The configuration is box with a shallow shelf (40m) on the east and west part of the domain
253  with a deep central trough (> 100m).
254  ICB are generating using the test capability of the icb model along a E-W line (this can easily be tuned).
255
256STATION_ASF
257-----------
258| this demonstration test case can be used to perform a sanity test of the SBCBLK interface of
259  NEMO.  It will test all the bulk-parameterization algorithms using an idealized
260  forcing that includes a wide range of *SSX / surface atmospheric state*
261  conditions to detect potential error / inconsistencies.  Both a short report and
262  boolean output: *passed* or *failed* is provided as an output.
263
264SWG
265---
266| Square bassin blown with an analytical wind. Vertical structure allows only one mode
267  associated with reduced gravity to develop. This configuration is based on Adcroft & Marshall 1998.
268  Also run with RK3 time stepping.
Note: See TracBrowser for help on using the repository browser.