source: NEMO/trunk/README-setup-configs @ 10075

Last change on this file since 10075 was 9635, checked in by nicolasmartin, 3 years ago

Reorganisation plan for NEMO repository: reinstate test cases in the trunk under './tests' root folder
In order to be clear, the development of the test cases is back to the trunk but the official hub for
the NEMO demonstration cases will be on Github (https://github.com/sflavoni/NEMO-test-cases)
As a result, when we will set the new release, 'tests' will be emptied and
the last developements will be copied to the Github repository.

Other changes:

  • README-setup-configs edited for path changes and moved to the root
  • cfg.txt renamed to ref_cfgs.txt
  • uspcfg.txt renamed to rmt_cfgs.txt ('rmt' for remote) and moved to ./tests
  • makenemo will create new configuration using work_cfgs.txt file, this file will be ignored by SVN thanks to svn:ignore property set
File size: 3.2 KB
Line 
1==============================================================
2== HOW TO set up user’s configuration in NEMO version 4.0 : ==
3==============================================================
4This document describes how a configuration is set up in NEMO.
5
6In NEMO 4.0 two types of configurations can be build: global/regional and idealized.
7
8- create ./cfgs/your_config
9- case 1: regional or global
10    => ln_read_cfg = .true. in ./cfgs/your_config/EXP00/namelist_cfg (i.e. read domain_cfg.nc)
11- case 2: idealized
12    =>in ./cfgs/your_config/EXP00/namelist_cfg :
13      ln_read_cfg = .false. (need to define usrdef_hgr.F90 and usrdef_zgr.F90)
14      ln_usr = .true.       (need to define usrdef_sbc.F90)   
15    => copy ./src/OCE/USR in ./cfgs/your_config/MY_SRC routines nedeed to set up domain, forcing fields and initial state
16   
17  Routines in NEMOGCM/NEMO/OCE/USR define analytically the domain, the initial state and the surface boundary conditions for the reference configuration GYRE.
18     •   usrdef_hgr.F90 and usrdef_zgr.F90 : define horizontal and vertical grid
19     •   usrdef_sbc.F90    : provides at each time-step the surface boundary condition, i.e. the momentum, heat and freshwater fluxes
20     •   usrdef_istate.F90 : defines initialization of the dynamics and tracers
21     •   usrdef_fmask.F90  : used just in ORCA CONFIGURATIONS for alteration of f-point land/ocean mask in some straits
22     •   usrdef_closea.F90 : used just in ORCA CONFIGURATIONS for specific treatments associated with closed seas
23     •   usrdef_nam.F90    : set the domain characteristics of a user configuration
24
25  Other analytical examples are given in ./tests.
26
27===========================================
28== The domain_cfg.nc file must contain : ==
29===========================================
30   int ORCA  , ORCA_index            : configuration name, configuration resolution
31   int jpiglo, jpjglo , jpkglo       : global domain sizes
32   int jperio                        : lateral global domain b.c.
33   int ln_zco, ln_zps, ln_sco        : flags for z-coordinate, z-coordinate with partial steps and s-coordinate
34   int ln_isfcav                     : flag  for ice shelf cavities
35   double glamt, glamu, glamv, glamf : geographic position
36   double gphit, gphiu, gphiv, gphif : geographic position
37   double iff, ff_f, ff_t            : Coriolis parameter (if not on the sphere)
38   double e1t, e1u, e1v, e1f         : horizontal scale factors
39   double e2t, e2u, e2v, e2f         : horizontal scale factors
40   double ie1e2u_v, e1e2u, e1e2v     : U and V surfaces (if grid size reduction in some straits)
41   double e3t_1d, e3w_1d             : reference vertical scale factors at T and W points
42   double e3t_0, e3u_0, e3v_0, e3f_0, e3w_0 : vertical scale factors 3D coordinate at T,U,V,F and W points
43   double e3uw_0,e3vw_0              : vertical scale factors 3D coordinate at UW and VW points
44   int bottom_level, top_level       : last wet T-points, 1st wet T-points (for ice shelf cavities)
45
46=======================================
47= HOW TO CREATE domain_cfg.nc file : ==
48=======================================
49Two options are possible :
50
51 - users can create with his own tool the domain_cfg.nc with all mandatory fields. 
52
53 - tool is available in ./tools/DOMAINcfg based on NEMO 3.6 version. See ./tools/DOMAINcfg/README.
Note: See TracBrowser for help on using the repository browser.