Ignore:
Timestamp:
2018-10-18T12:53:04+02:00 (2 years ago)
Author:
nicolasmartin
Message:

Various modifications related to the setting of a NEMO Quick Start Guide

  • Add missing namelist blocks from ICE and TOP
  • Create a hidden .global.rst to gather common URL links
  • Convert animated gif to frames images for PDF export
  • Place different README.rst appropriately in the code structure and refer to them with symbolic links in doc/rst/source
File:
1 copied

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/tests/README.rst

    r10186 r10201  
    33====================== 
    44 
    5 - ``tests/ICEDYN``: 
    6    
    7   [Clement to add an illustration here ?] 
     5.. include:: .global.rst 
    86 
    9   This is an East-west + north-south periodic channel. 
    10   The configuration includes an AGRIF zoom (1:3) in the middle of the basin to test how 
    11   an ice patch is advected through it but one can also test the advection schemes (Prather and Ultimate-Macho) by 
    12   removing the ``key_agrif`` in the CPP keys. 
     7``CANAL`` 
     8   | [Illustration here ?] 
     9   | East-west periodic canal of variable size with several initial states and associated geostrophic currents 
     10      (zonal jets or vortex). 
    1311 
    14 - ``tests/VORTEX``: 
    15    
    16   This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom. 
    17   It is implemented here with an online refined subdomain (1:3) out of which the vortex propagates. 
    18   It serves as a benchmark for quantitative estimates of nesting errors as in Debreu et al. (2012), 
    19   Penven et al. (2006) or Spall and Holland (1991). 
    20   The animation below (sea level anomaly in meters) illustrates with two 1:2 successively nested grids how 
    21   the vortex smoothly propagates out of the refined grids. 
    22    
    23   .. image:: _static/VORTEX_anim.gif 
     12``ICEDYN`` 
     13   | [Illustration here ?] 
     14   | East-west + north-south periodic channel inlcuding an AGRIF zoom (1:3) in the middle of the basin to test how 
     15      an ice patch is advected through it but one can also test the advection schemes 
     16      (Prather and Ultimate-Macho) by removing the ``key_agrif`` in the CPP keys. 
     17 
     18``ISOMIP`` 
     19   | [Illustration here ?] 
     20   | Simple box configuration with an iceshelf with simple geometry on top to evaluate the impact of 
     21      various schemes and new development with iceshelf cavities. 
     22   | `test cavities <http://staff.acecrc.org.au/~bkgalton/ISOMIP/test_cavities.pdf>`_ 
     23 
     24``LOCK_EXCHANGE`` 
     25   | [Illustration here ?] 
     26   | Classical fluid dynamics experiment that has been adapted for testing advection schemes in 
     27      ocean circulation models. 
     28   | This experiment can in particular illustrate the impact of different choices of numerical schemes and/or 
     29      subgrid closures on spurious interior mixing. 
     30   | :cite:`epic31172,burchard2002getm,ILICAK201237` 
     31 
     32``OVERFLOW`` 
     33   | [Illustration here ?] 
     34   | Adapted from the non-rotating overflow configuration, 
     35      it illustrates the impact of different choices of numerical schemes and/or subgrid closures on 
     36      spurious interior mixing close to bottom topography. 
     37   | :cite:`epic31172,ILICAK201237` 
     38 
     39``VORTEX`` 
     40   .. figure:: _static/VORTEX_anim.gif 
     41 
     42      Vortex smoothly propagates out of two 1:2 successive nested grids (sea level anomaly in meters) 
     43 
     44   | Illustrates the propagation of an anticyclonic eddy over a Beta plan and flat bottom. 
     45   | It is implemented here with an online refined subdomain (1:3) out of which the vortex propagates and 
     46      serves as a benchmark to diagnose nesting errors. 
     47   | :cite:`DEBREU20121,PENVEN2006157,SPALL1991205` 
     48 
     49``WAD`` 
     50   | [Illustration here ?] 
     51   | Set of simple closed basin geometries for testing the wetting and drying capabilities. 
     52      Examples range from a closed channel with EW linear bottom slope to a parabolic EW channel with 
     53      a Gaussian ridge. 
     54 
     55References 
     56========== 
     57 
     58.. bibliography:: test_cases.bib 
     59   :all: 
     60   :style: unsrt 
Note: See TracChangeset for help on using the changeset viewer.