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 in NEMO/branches/2019/ENHANCE-02_ISF_domcfg – NEMO

source: NEMO/branches/2019/ENHANCE-02_ISF_domcfg/README @ 11574

Last change on this file since 11574 was 9161, checked in by davestorkey, 6 years ago

Reformulation of closea module.
See ticket #2000
https://forge.ipsl.jussieu.fr/nemo/wiki/2017WP/ROBUST-14_Dave_Storkey-Closed_Seas_rewrite

File size: 3.0 KB
Line 
1================================
2= HOW TO COMPILE
3================================
4The DOMAINcfg tool can be compiled using the maketools script in the NEMOGCM/TOOLS directory as follows:
5:::::::::::::::::::::::::::::::::
6./maketools -m $ARCH -n DOMAINcfg
7:::::::::::::::::::::::::::::::::
8where $ARCH indicates the arch file to be used from the directory NEMOGCM/ARCH.
9
10DOMAINcfg compiled will create "make_domain_cfg.exe" executable script (the main routine of this tool is make_domain_cfg.f90)
11
12================================
13= HOW TO RUN
14================================
15just run :
16:::::::::::::::::::::::::::::::::::::::::::::::::
17mpirun -np 1 ./make_domain_cfg.exe
18:::::::::::::::::::::::::::::::::::::::::::::::::
19NOTA: it can be run in multiproc mode, but in output there will be domain_cfg_00xx.nc files
20
21 === Closed seas (closea module) ===
22
23If you want to define closed seas in the bathymetry either to suppress them at runtime or
24redistribute freshwater fluxes, then you need to run make_closea_masks.py after you have
25created the basic domain_cfg file. This utility will add "closea_mask*" fields to the
26domain_cfg file to define the closed seas in the configuration. (If you have closed seas
27but don't want to treat them in a special way then you can ignore this step).
28
29================================
30= HOW TO USE
31================================
321) copy in DOMAINcfg  directory namelist_cfg all settings (that you had in 3.6_stable) of the configuration for which you want prepare domain_cfg.nc file
33IMPORTANT : keep the namelist_ref committed inchanged. !!!
34
35NEW OPTION ln_e3_dep in the namelist_ref:
36till nemo_v3.6_stable e3 were done like an analytical derivative of depth function
37now  e3=dk[depth] in discret sens
38
39If you want to create same e3[tuvw] like 3.6 you've to use "ln_e3_dep=.false."
40
41 ln_e3_dep   = .true.    ! =T : e3=dk[depth] in discret sens.
42   !                       !      ===>>> will become the only possibility in v4.0
43   !                       ! =F : e3 analytical derivative of depth function
44   !                       !      only there for backward compatibility test with v3.6
45   !
46
472) copy in DOMAINcfg directory same input files (of related configuration) required in v3.6_stable.
48
49DOMAINcfg package is EXACTLY what does exist in NEMO version 3.6 to define a model domain (both domain related namelist and initialization).
50DOMAINcfg tool creates a netcdf file "domain_cfg.nc" containing all the ocean domain informations required to define an ocean configuration,
51these files are :
52         
53    domain size
54    domain characteristics (periodic)
55    horizontal mesh
56    Coriolis parameter
57    depth and vertical scale factors
58
59FOR EXAMPLE
60- for AMM12 :
61            coordinates.nc
62            bathy_meter.nc
63            bathy_level.nc
64            amm12_rivers.nc
65            coordinates.bdy.nc
66            amm12_restart_oce.nc
67         directories:   bdydta/
68                        fluxes/
69- for ORCA2 :
70            coordinates.nc
71            bathy_meter.nc
72            bathy_level.nc
73            domain_def.xml
74            field_def.xml
75            iodef.xml
Note: See TracBrowser for help on using the repository browser.