source: branches/2016/dev_merge_2016/NEMOGCM/NEMO/OPA_SRC/USR/README-setup-configs.rtf @ 7696

{\rtf1\ansi\ansicpg1252\cocoartf1504\cocoasubrtf760
{\fonttbl\f0\fmodern\fcharset0 Courier;\f1\fmodern\fcharset0 Courier-Oblique;}
{\colortbl;\red255\green255\blue255;\red0\green0\blue0;\red255\green255\blue255;\red0\green0\blue0;
\red59\green35\blue34;\red0\green186\blue251;\red43\green175\blue187;\red42\green175\blue187;\red43\green174\blue193;
\red44\green176\blue215;\red46\green172\blue215;\red36\green180\blue215;\red46\green174\blue187;\red48\green172\blue187;
\red46\green172\blue187;}
{\*\expandedcolortbl;;\csgray\c0;\csgray\c100000;\csgenericrgb\c0\c0\c0;
\csgenericrgb\c23317\c13541\c13291;\csgenericrgb\c0\c72941\c98431;\cspthree\c37025\c72472\c77259;\cspthree\c36636\c72472\c77259;\cspthree\c37036\c72442\c79220;
\cspthree\c37465\c73131\c85887;\cspthree\c37465\c71935\c85887;\cspthree\c36299\c74327\c85887;\cssrgb\c20196\c73240\c78250;\cspthree\c37804\c71676\c77259;
\cspthree\c37414\c71676\c77259;}
{\*\listtable{\list\listtemplateid1\listhybrid{\listlevel\levelnfc23\levelnfcn23\leveljc0\leveljcn0\levelfollow0\levelstartat1\levelspace360\levelindent0{\*\levelmarker \{disc\}}{\leveltext\leveltemplateid1\'01\uc0\u8226 ;}{\levelnumbers;}\fi-360\li720\lin720 }{\listname ;}\listid1}}
{\*\listoverridetable{\listoverride\listid1\listoverridecount0\ls1}}
\paperw11900\paperh16840\margl1440\margr1440\vieww42060\viewh19020\viewkind0
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0

\f0\fs36 \cf2 \cb3 \CocoaLigature0 ==============================================================\
== HOW TO set up user\'92s configuration in NEMO version 4.0 : ==\
==============================================================\
This document describes how a configuration is set up in NEMO.\
\
In NEMO 4.0 two types of configurations can be build: global/regional and idealized.\
\
- create NEMOGCM/CONFIG/
\f1\i your_config
\f0\i0 \
- case 1: regional or global \
    => \cf4 \cb1 ln_read_cfg = .true. in \cf2 \cb3 NEMOGCM/CONFIG/
\f1\i your_config
\f0\i0 \cf4 \cb1 /EXP00/namelist_cfg (i.e. \cf2 \cb3 read domain_cfg.nc)\
- case 2: idealized \
    =>in NEMOGCM/CONFIG/
\f1\i your_config
\f0\i0 \cf4 \cb1 /EXP00/namelist_cfg :\cf2 \cb3 \
      \cf4 \cb1 ln_read_cfg = .false. (need to define usrdef_hgr.F90 and usrdef_zgr.F90) \cf2 \cb3 \
      \cf4 \cb1 ln_usr = .true.       (need to define\cb1  usrdef_sbc.F90)  \cb1   \cf2 \cb3 \
    => copy NEMOGCM/NEMO/OPA_SRC/USR in NEMOGC/CONFIG/your_config/MY_SRC routines nedeed to set up domain, forcing fields and initial state\
    \
  Routines in NEMOGCM/NEMO/OPA_SRC/USR define analytically the domain, the initial state and the surface boundary conditions for the reference configuration GYRE.\
\pard\tx220\tx720\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\li720\fi-720\pardirnatural\partightenfactor0
\ls1\ilvl0\cf5 \cb1 \CocoaLigature1 {\listtext    \'95   }\cf4 \CocoaLigature0 usrdef_hgr.F90 and usrdef_zgr.F90 : define horizontal and vertical grid\
\pard\tx220\tx720\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\li720\fi-720\pardirnatural\partightenfactor0
\ls1\ilvl0\cf4 \CocoaLigature1 {\listtext   \'95   }\CocoaLigature0 usrdef_sbc.F90    : provides at each time-step the surface boundary condition, i.e. the momentum, heat and freshwater fluxes\CocoaLigature1 \
{\listtext    \'95   }\CocoaLigature0 usrdef_istate.F90 : defines initialization of the dynamics and tracers\
\ls1\ilvl0\CocoaLigature1 {\listtext     \'95   }\CocoaLigature0 usrdef_fmask.F90  : used just in ORCA CONFIGURATIONS for alteration of f-point land/ocean mask in some straits \
\ls1\ilvl0\CocoaLigature1 {\listtext     \'95   }\CocoaLigature0 usrdef_closea.F90 : used just in ORCA CONFIGURATIONS for specific treatments associated with closed seas\
\ls1\ilvl0\CocoaLigature1 {\listtext     \'95   }\CocoaLigature0 usrdef_nam.F90    : set the domain characteristics of a user configuration\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
\cf2 \cb3 \
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
\cf4 \cb1   Other analytical examples are given in NEMOGCM/CONFIG/TEST_CASES.\
\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
\cf2 \cb3 ===========================================\
== The domain_cfg.nc file must contain : ==\
===========================================\
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
\cf4 \cb1    int ORCA  , ORCA_index         \cf6    \cf7 : configuration name, configuration resolution\cf4 \
   int jpiglo, jpjglo , jpkglo       \cf8 : global domain sizes \cf4 \
   int jperio                        \cf9 : lateral global domain b.c. \
\cf4    int ln_zco, ln_zps, ln_sco        \cf10 : flags for\cf8  z-coordinate, z-coordinate with partial steps and s-coordinate \cf10 \
\cf4    int ln_isfcav                     \cf11 : \cf10 flag  for \cf12 ice shelf cavities \cf4 \
   \cf2 \cb3 double glamt, glamu, glamv, glamf \cf13 : geographic position \cf2 \
   double gphit, gphiu, gphiv, gphif \cf13 : geographic position\cf2 \
   double iff, ff_f, ff_t            \cf13 : Coriolis parameter (if not on the sphere)\cf2 \
   double e1t, e1u, e1v, e1f         \cf13 : horizontal scale factors\cf2 \
   double e2t, e2u, e2v, e2f         \cf13 : horizontal scale factors\cf2 \
   double ie1e2u_v, e1e2u, e1e2v     \cf13 : U and V surfaces (if grid size reduction in some straits)\cf4 \cb1 \
   double e3t_1d, e3w_1d             \cf13 \cb3 : reference vertical scale factors at T and W points\cf4 \cb1 \
   double e3t_0, e3u_0, e3v_0, e3f_0, e3w_0 \cf13 \cb3 : vertical scale factors\cf14 \cb1  3D coordinate \cf13 \cb3 at T,U,V,F and W points\cf4 \cb1 \
   double e3uw_0,e3vw_0              \cf13 \cb3 : vertical scale factors \cf14 \cb1 3D coordinate \cf13 \cb3 at UW and VW points\cf4 \cb1 \
   int bottom_level, top_level       \cf13 \cb3 : \cf15 \cb1 last wet T-points, 1st wet T-points (for ice shelf cavities)\cf4 \
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
\cf2 \cb3 \
=======================================\
= HOW TO CREATE domain_cfg.nc file : ==\
=======================================\
Two options are possible :\
\
 - users can create with his own tool the domain_cfg.nc with all mandatory fields.  \
\
 - tool is available in NEMOGCM/TOOLS/DOMAINcfg based on NEMO 3.6 version. See \cf4 \cb1 NEMOGCM/TOOLS/DOMAINcfg/README.\cf2 \cb3 \
\
}