New URL for NEMO forge!

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.
Users/ModelInterfacing/AGRIF – NEMO

Version 24 (modified by nicolasmartin, 6 years ago) (diff)


Using AGRIF for embedded zooms in NEMO

Last edition: Wikinfo(changed_ts)? by Wikinfo(changed_by)?

Page in progress


AGRIF (Adaptive Grid Refinement In Fortran) is a library that allows the seamless space and time refinement over rectangular regions in NEMO. Refinement factors can be odd or even (usually lower than 5 to maintain stability). Interaction between grid is "two-ways" in the sense that the parent grid feeds the child grid open boundaries and the child grid provides volume averages of prognostic variables once a given number of time step is completed. This pages provides guidelines how to use AGRIF in NEMO. For a more technical description of the library itself, please refer to the following page:


Activating AGRIF requires to append the cpp key "key_agrif" at compilation time:

./makenemo add_key 'key_agrif'

Although this is transparent to users, the way the code is processed during compilation is different from the standard case: a preprocessing stage (the so called "conv" program) translates the actual code so that saved arrays may be be switched in memory space from one domain to an other.

Definition of the grid hierarchy

An additional text file is required at run time. This is where the grid hierarchy is defined. An example of such a file, here taken from the 'VORTEX' test case, is given below:

IncludeSource(/NEMO/trunk/tests/VORTEX/EXPREF/, rev=9787, line_numbers=0)?

The first line indicates the number of zooms (1). The second line contains the starting and ending indices in both directions on the root grid (19 38 19 38) followed by the space and time refinement factors (3 3 3). The last line is the number of child grid nested in the refined region (0). A more complex example with telescoping grids can be found below and in the 'AGRIF_DEMO' reference configuration directory (NEMO 4.0 only).

Add some plots here with grid staggering and positioning ?

Note that rectangular regions must be defined so that they are connected to a single parent grid. Hence, defining overlapping grids with the same refinement ratio will not work properly, boundary data exchange and update being only performed between root and child grids. Use of east-west periodic or north-fold boundary conditions is not allowed in child grids either. Defining for instance a circumpolar zoom in a global model is therefore not possible.


Knowing the refinement factors and area, a pre-processing tool may help to create needed input files (mesh file, restart, climatological and forcing files). The key is to ensure volume matching near the child grid interface, a step done by invoking the Agrif_create_bathy.exe program. You may use the namelists provided in the NESTING directory as a guide. These correspond to the namelists used to create AGRIF_DEMO inputs.

Namelist options

Each child grid expects to read its own namelist so that different numerical choices can be made (these should be stored in the form 1_namelist_cfg, 2_namelist_cfg, etc... according to their rank in the grid hierarchy). Consistent time steps and number of steps with the chosen time refinement have to be provided. Specific to AGRIF is the following block:

IncludeSource(/NEMO/trunk/doc/namelists/namagrif, rev=10075, line_numbers=0, mimetype=text/x-fortran)?

where sponge layer coefficients have to be chosen according to the child grid mesh size.

Available in the forthcoming 4.0

The 4.0 beta release is now available? and includes new capabilities, configurations and test cases with AGRIF:

New capabilities from NEMO 3.6 to NEMO 4.0

AGRIF is continuously maintained so that it could be activated with all NEMO components (OPA, sea-ice, TOP). Depending on NEMO version, it is nevertheless not the case so that some options may not be compatible with the use of online grid refinement. Check out the table below to know the status according to the NEMO release you may use.

  • Status of available options with AGRIF (if not listed, option is compatible with AGRIF):
NEMO 3.6 NEMO 4.0
LIM2 yes -
LIM3/SI3 no yes
TOP yes yes
GLS vertical mixing no yes
z* no yes
z~ no no
Lagrangian icebergs no no
East-west periodic and/or north fold bcs in zooms no no
Online timing no no
Stochastic parameterization no no
Vertical coordinate change in zooms (key_vertical) no yes, but not tested
Number of ghost cells 1 (hard coded) 3 (parameter)
  • Important notice concerning the change of ghost cells number:

The default number of ghost cells (i.e. the number of cells that serve as open boundary data provision) has been increased from 1 to 3 in NEMO 4.0. This allows to properly handle boundary conditions for numerical schemes that have a discretization order greater than 2. On the user point of view this does not change anything++ except in the definition of level 1 grids in the file. In order to retrieve exactly the position of a nested grid in NEMO 4.0 one has to shift indices by 2 points to the south-west. Taking the VORTEX example above for NEMO 4.0, the "old" NEMO 3.6 corresponding file would contain:

IncludeSource(/NEMO/releases/release-3.6/NEMOGCM/CONFIG/ORCA2_LIM/EXP00/, rev=9594)?

++ Output files are now greater by 4 points in each direction.

New reference configuration with AGRIF: AGRIF_DEMO

Error: Failed to load processor imagebox
No macro or processor named 'imagebox' found

AGRIF_DEMO is based on the ORCA2_LIM3_PISCES global 2° configuration but it includes 3 online nested grids that demonstrate the overall capabilities of AGRIF in a realistic context, including nesting sea ice models.

The configuration includes a 1:1 grid in the Pacific and two successively nested grids with odd and even refinement ratios over the Arctic ocean. The finest grid spanning the whole Svalbard archipelago is of particular interest to check that sea ice coupling is done properly. The 1:1 grid, used alone, is used as a benchmark to check that the solution is not corrupted by grid exchanges.

Note that since grids interact only at the baroclinic time level, numerically exact results can not be achieved in the 1:1 case. One has to switch to a fully explicit in place of a split explicit free surface scheme in order to retrieve perfect reproducibility.

Corresponding file is given by:

IncludeSource(/NEMO/trunk/cfgs/AGRIF_DEMO/EXPREF/, rev=9775, line_numbers=0)?

New tests cases demonstrating some major features of AGRIF with NEMO:

  • tests/ICEDYN:

Clement to add an illustration here ?

This is an East-west + north-south periodic channel. The configuration includes an AGRIF zoom (1:3) in the middle of the basin to test how an ice patch is advected through it but one can also test the advection schemes (Prather and Ultimate-Macho) by removing the key_agrif in the cpp keys.

  • tests/VORTEX:

This test case illustrates the propagation of an anticyclonic eddy over a Beta plan and a flat bottom. It is implemented here with an online refined subdomain (1:3) out of which the vortex propagates. It serves as a benchmark for quantitative estimates of nesting errors as in Debreu et al. (2012), Penven et al. (2006) or Spall and Holland (1991). The animation below (sea level anomaly in meters) illustrates with two 1:2 successively nested grids how the vortex smoothly propagates out of the refined grids.

Error: Failed to load processor imagebox
No macro or processor named 'imagebox' found


Debreu, L., P. Marchesiello, P. Penven and G. Cambon, 2012: Two-way nesting in split-explicit ocean models: Algorithms, implementation and validation. Ocean Modelling, 49-50, 1-21.

Penven, P., L. Debreu, P. Marchesiello and J. C. McWilliams?, 2006: Evaluation and application of the ROMS 1-way embedding procedure to the central california upwelling system. Ocean Modelling, 12, 157-187.

Spall, M. A. and W. R. Holland, 1991: A Nested Primitive Equation Model for Oceanic Applications. J. Phys. Ocean., 21, 205-220.<0205:ANPEMF>2.0.CO;2

Attachments (3)