Changeset 13390 for utils/tools

Timestamp:

2020-08-10T11:09:15+02:00 (4 years ago)

Author:

mathiot

Message:

ticket #2502: merge ticket branch into trunk. DOMAIN_cfg namelist contains now fields to specify input files names (bathy meter and level files, coord file, isf draft meter and level files), save it into the netcdf (dom_doc.exe) and re-generate the namelist if needed (xtrac_namelist.bash). The usage is documented in the DOMAIN_cfg README.rst.

Location:

utils/tools/DOMAINcfg

Files:

• README.rst (modified) (2 diffs)
• cpp_DOMAINcfg.fcm (modified) (1 diff)
• namelist_ref (modified) (1 diff)
• src/dom_doc.f90 (copied) (copied from utils/tools_ticket2502/DOMAINcfg/src/dom_doc.f90)
• src/dom_oce.F90 (modified) (1 diff)
• src/domain.F90 (modified) (3 diffs)
• src/domhgr.F90 (modified) (1 diff)
• src/domzgr.F90 (modified) (3 diffs)
• xtrac_namelist.bash (copied) (copied from utils/tools_ticket2502/DOMAINcfg/xtrac_namelist.bash)

utils/tools/DOMAINcfg/README.rst

@@ -56 +56 @@
 * id trg is a integer used to defined group of closed sea and their river outflow (for example all the great lake and the St Laurent outflow).
 
+
 2) copy in DOMAINcfg directory same input files (of related configuration) required in v3.6_stable.
 
@@ -85 +86 @@
             field_def.xml
             iodef.xml
+
+
+==============================================================
+= How to keep track of the parameter used to generate the file
+==============================================================
+To do so, you need to fill the namelist_cfg with the input file name used in
+cn_fcoord, cn_topo, cn_fisfd and the associated variable name (see namelist ref for the extensive list).
+Once you generate the domain_cfg.nc file you can run the dom_doc.exe tools available.
+
+.. code-block:: console
+
+  $ ./dom_doc.exe -h
+    usage : dom_doc -n NAMELIST-file 
+                    -d DOMAIN_CFG-file
+       
+      PURPOSE :
+         Add information in the domain_cfg.nc file after its creation for
+         NEMO4. The additional information consists in a new netcdf variable
+         called namelist_cfg, holding the content of the used namelist_cfg.
+       
+      ARGUMENTS :
+         -n NAMELIST-file : name of the namelist_cfg. file required
+         -d DOMAIN_CFG-file : name of the domain_cfg file to document. file required
+       
+      OUTPUT : 
+          input DOMAIN_CFG-file is modified on output.
+
+This will add a variable namelist_cfg into the netcdf.
+
+To extract the namelist again, simply run the available script xtrac_namelist.bash
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+./xtrac_namelist.bash input_domain_cfg_file.nc output_namelist_cfg 
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

utils/tools/DOMAINcfg/cpp_DOMAINcfg.fcm

@@ -1 @@
- bld::tool::fppkeys
+ bld::tool::fppkeys key_mpp_mpi

utils/tools/DOMAINcfg/namelist_ref

@@ -29 +29 @@
    nn_interp   =    1                          ! type of interpolation (nn_bathy =2)
    cn_domcfg   = ' '       ! Name of the domain_cfg input file
-   cn_topo     =  'bathymetry_ORCA12_V3.3.nc'  ! external topo file (nn_bathy =2)
-   cn_bath     =  'Bathymetry'                 ! topo name in file  (nn_bathy =2)
+   cn_fcoord   =  'coordinates.nc'             ! external coordinates file (jphgr_msh = 0)
+   cn_topo     =  'bathy_meter.nc           '  ! external topo file (nn_bathy =1/2)
+   cn_topolvl  =  'bathy_level.nc           '  ! external topo file (nn_bathy =1)
+   cn_fisfd    =  'isf_draft_meter.nc'         ! external isf draft (nn_bathy =1 and ln_isfcav = .true.)
+   cn_bath     =  'Bathymetry'                 ! topo name in file  (nn_bathy =1/2)
+   cn_bathlvl  =  'Bathy_level'                ! lvl name in file   (nn_bathy =1)
+   cn_visfd    =  'isf_draft'                  ! isf draft variable (nn_bathy =1 and ln_isfcav = .true.)
    cn_lon      =  'nav_lon'                    ! lon  name in file  (nn_bathy =2)
    cn_lat      =  'nav_lat'                    ! lat  name in file  (nn_bathy =2)

utils/tools/DOMAINcfg/src/dom_oce.F90

@@ -45 +45 @@
    INTEGER, PUBLIC :: nn_interp
    CHARACTER(LEN=200), PUBLIC :: cn_topo
+   CHARACTER(LEN=200), PUBLIC :: cn_topolvl
+   CHARACTER(LEN=200), PUBLIC :: cn_fisfd
    CHARACTER(LEN=132), PUBLIC :: cn_bath
+   CHARACTER(LEN=132), PUBLIC :: cn_bathlvl
+   CHARACTER(LEN=132), PUBLIC :: cn_visfd
+   CHARACTER(LEN=132), PUBLIC :: cn_fcoord
    CHARACTER(LEN=132), PUBLIC :: cn_lon
    CHARACTER(LEN=132), PUBLIC :: cn_lat

utils/tools/DOMAINcfg/src/domain.F90

@@ -109 +109 @@
 
       NAMELIST/namdom/ ln_read_cfg, nn_bathy, cn_domcfg, cn_topo, cn_bath, cn_lon, cn_lat, rn_scale, nn_interp, &
-         &              rn_bathy , rn_e3zps_min, rn_e3zps_rat, nn_msh, rn_hmin,            &
+         &             cn_topolvl, cn_fisfd, cn_visfd, cn_bathlvl, cn_fcoord,                       & 
+         &             rn_bathy , rn_e3zps_min, rn_e3zps_rat, nn_msh, rn_hmin,                       &
          &             rn_atfp , rn_rdt   ,  ln_crs      , jphgr_msh ,                               &
          &             ppglam0, ppgphi0, ppe1_deg, ppe2_deg, ppe1_m, ppe2_m,                         &
@@ -169 +170 @@
          WRITE(numout,*) '   Namelist namdom : space & time domain'
          WRITE(numout,*) '      flag read/compute bathymetry      nn_bathy     = ', nn_bathy
-         IF( nn_bathy == 2 ) THEN
+         IF( nn_bathy == 1 ) THEN
+            WRITE(numout,*) '   read bathymetry from file      cn_topo      = ' ,TRIM(cn_topo)
+            WRITE(numout,*) '   bathymetry name in file        cn_bath      = ' ,TRIM(cn_bath)
+            WRITE(numout,*) '   read isf draft from file       cn_fisfd     = ' ,TRIM(cn_fisfd)
+            WRITE(numout,*) '   isf draft name in file         cn_visfd     = ' ,TRIM(cn_visfd)
+         ELSE IF( nn_bathy == 2 ) THEN
             WRITE(numout,*) '   compute bathymetry from file      cn_topo      = ' , cn_topo
             WRITE(numout,*) '   bathymetry name in file           cn_bath      = ' , cn_bath
@@ -435 +441 @@
    END SUBROUTINE cfg_write
 
-
-
    !!======================================================================
 END MODULE domain

utils/tools/DOMAINcfg/src/domhgr.F90

@@ -465 +465 @@
          coordinate_filename=TRIM(cn_domcfg)
       ELSE
-         coordinate_filename='coordinates'
+         coordinate_filename=cn_fcoord
       ENDIF
       CALL iom_open( coordinate_filename, inum )

utils/tools/DOMAINcfg/src/domzgr.F90

@@ -676 +676 @@
          !
          IF( ln_zco )   THEN                          ! zco : read level bathymetry 
-            CALL iom_open ( 'bathy_level.nc', inum )  
-            CALL iom_get  ( inum, jpdom_data, 'Bathy_level', bathy )
+            CALL iom_open ( cn_topolvl, inum )  
+            CALL iom_get  ( inum, jpdom_data, cn_bathlvl, bathy )
             CALL iom_close( inum )
             mbathy(:,:) = INT( bathy(:,:) )
@@ -714 +714 @@
 #endif
             IF( ntopo == 1) THEN
-               CALL iom_open ( 'bathy_meter.nc', inum ) 
-               IF ( ln_isfcav ) THEN
-                  CALL iom_get  ( inum, jpdom_data, 'Bathymetry_isf', bathy, lrowattr=.false. )
-               ELSE
-                  CALL iom_get  ( inum, jpdom_data, 'Bathymetry'    , bathy, lrowattr=ln_use_jattr  )
-               END IF
+               CALL iom_open ( cn_topo, inum ) 
+               CALL iom_get  ( inum, jpdom_data, cn_bath, bathy, lrowattr=ln_use_jattr  )
                CALL iom_close( inum )
             ELSE
@@ -738 +734 @@
             !
             IF ( ln_isfcav ) THEN
-               CALL iom_open ( 'isf_draft_meter.nc', inum ) 
-               CALL iom_get  ( inum, jpdom_data, 'isf_draft', risfdep )
+               CALL iom_open ( cn_fisfd, inum ) 
+               CALL iom_get  ( inum, jpdom_data, cn_visfd, risfdep )
                CALL iom_close( inum )
             END IF