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.
Changeset 13369 for utils/tools/SIREN/src/create_layout.f90 – NEMO

Ignore:
Timestamp:
2020-07-31T10:50:52+02:00 (4 years ago)
Author:
jpaul
Message:

update: cf changelog inside documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • utils/tools/SIREN/src/create_layout.f90

    r12080 r13369  
    55! DESCRIPTION: 
    66!> @file 
    7 !> @brief  
     7!> @brief 
    88!> This program creates/computes the domain layout for you configuration. 
    99!> 
     
    1515!> Then the number of sea/land processors is compute with mask. 
    1616!> 
    17 !> The optimized domain layout is assumed to be the domain layout, with the the most land  
     17!> The optimized domain layout is assumed to be the domain layout, with the the most land 
    1818!> processors removed. If no land processor could be removed, it assumed to be the domain layout 
    1919!> with the most sea processors. 
     
    4444!> 
    4545!>    here after, each sub-namelist parameters is detailed. 
    46 !>    @note  
     46!>    @note 
    4747!>       default values are specified between brackets 
    4848!> 
     
    6363!>          - none 
    6464!> 
    65 !>    - **in_maxerror** [@a 5]<br/>  
     65!>    - **in_maxerror** [@a 5]<br/> 
    6666!>       maximum number of error allowed 
    6767!> 
     
    7171!>    - **cn_varcfg** [@a ./cfg/variable.cfg]<br/> 
    7272!>       path to the variable configuration file.<br/> 
    73 !>       the variable configuration file defines standard name,  
    74 !>       default interpolation method, axis,...  
    75 !>       to be used for some known variables.<br/>  
    76 !> 
    77 !>    - **cn_dimcfg** [@a ./cfg/dimension.cfg]<br/>  
    78 !>       path to the dimension configuration file.<br/>  
    79 !>       the dimension configuration file defines dimensions allowed.<br/>  
    80 !> 
    81 !>    - **cn_dumcfg** [@a ./cfg/dummy.cfg]<br/>  
     73!>       the variable configuration file defines standard name, 
     74!>       default interpolation method, axis,... 
     75!>       to be used for some known variables.<br/> 
     76!> 
     77!>    - **cn_dimcfg** [@a ./cfg/dimension.cfg]<br/> 
     78!>       path to the dimension configuration file.<br/> 
     79!>       the dimension configuration file defines dimensions allowed.<br/> 
     80!> 
     81!>    - **cn_dumcfg** [@a ./cfg/dummy.cfg]<br/> 
    8282!>       path to the useless (dummy) configuration file.<br/> 
    83 !>       the dummy configuration file defines useless  
     83!>       the dummy configuration file defines useless 
    8484!>       dimension or variable. these dimension(s) or variable(s) will not be 
    8585!>       processed.<br/> 
    8686!> 
    87 !> @subsection subvar namvar  
     87!> @subsection subvar namvar 
    8888!>    the variable sub-namelist parameters are : 
    8989!> 
    90 !>    - **cn_varfile** [@a ]<br/>  
    91 !>       list of variable, and associated file  
    92 !>       @warning  
     90!>    - **cn_varfile** [@a ]<br/> 
     91!>       list of variable, and associated file 
     92!>       @warning 
    9393!>          variable name must be __Bathymetry__ here. 
    9494!> 
    9595!>    - **cn_varfile** [@a ]<br/>: 
    96 !>       list of variable, and associated file.<br/>  
     96!>       list of variable, and associated file.<br/> 
    9797!>       *cn_varfile* is the path and filename of the file where find 
    9898!>       variable to be used as mask grid.<br/> 
    9999!> 
    100 !>       Examples:  
     100!>       Examples: 
    101101!>          - 'Bathymetry:bathy_meter.nc' 
    102102!> 
    103 !> @subsection subout namout  
     103!> @subsection subout namout 
    104104!>    the output sub-namelist parameters are : 
    105105!> 
     
    114114!>       - if *in_niproc*, and *in_njproc* are provided : the program only look for land 
    115115!>         processor to be removed 
    116 !>       - if *in_nproc* is provided : the program compute each possible domain layout,  
    117 !>         and save the one with the most land processor to be removed  
     116!>       - if *in_nproc* is provided : the program compute each possible domain layout, 
     117!>         and save the one with the most land processor to be removed 
    118118!>       - with no information about number of processors, the program 
    119119!>         assume to use only one processor 
     
    136136   USE fct                             ! basic useful function 
    137137   USE date                            ! date manager 
    138    USE math                            !  
     138   USE math                            ! 
    139139   USE att                             ! attribute manager 
    140140   USE dim                             ! dimension manager 
     
    174174 
    175175   TYPE(TMULTI)                            :: tl_multi 
    176     
     176 
    177177   ! namelist variable 
    178178   ! namlog 
    179    CHARACTER(LEN=lc)                       :: cn_logfile = 'create_layout.log'  
    180    CHARACTER(LEN=lc)                       :: cn_verbosity = 'warning'  
     179   CHARACTER(LEN=lc)                       :: cn_logfile = 'create_layout.log' 
     180   CHARACTER(LEN=lc)                       :: cn_verbosity = 'warning' 
    181181   INTEGER(i4)                             :: in_maxerror = 5 
    182182 
    183183   ! namcfg 
    184    CHARACTER(LEN=lc)                       :: cn_varcfg = './cfg/variable.cfg'  
     184   CHARACTER(LEN=lc)                       :: cn_varcfg = './cfg/variable.cfg' 
    185185   CHARACTER(LEN=lc)                       :: cn_dimcfg = './cfg/dimension.cfg' 
    186186   CHARACTER(LEN=lc)                       :: cn_dumcfg = './cfg/dummy.cfg' 
     
    191191   ! namout 
    192192   INTEGER(i4)                             :: in_niproc = 0 
    193    INTEGER(i4)                             :: in_njproc = 0  
     193   INTEGER(i4)                             :: in_njproc = 0 
    194194   INTEGER(i4)                             :: in_nproc  = 0 
    195195   !------------------------------------------------------------------- 
     
    206206 
    207207   NAMELIST /namvar/ &  !< source grid namelist 
    208    &  cn_varfile        !< input file and mask variable    
     208   &  cn_varfile        !< input file and mask variable 
    209209 
    210210   NAMELIST /namout/ &  !< output namelist 
     
    212212   &  in_njproc,     & 
    213213   &  in_nproc 
    214    !-------------------------------------------------------------------    
     214   !------------------------------------------------------------------- 
    215215 
    216216   ! 
     
    224224   IF( il_narg /= 1 )THEN 
    225225      WRITE(cl_errormsg,*) ' ERROR : one argument is needed ' 
    226       CALL fct_help(cp_myname,cl_errormsg)  
     226      CALL fct_help(cp_myname,cl_errormsg) 
    227227      CALL EXIT(1) 
    228228   ELSE 
     
    259259               IF( il_status /= 0 )THEN 
    260260                  WRITE(cl_errormsg,*) " ERROR : error opening "//TRIM(cl_namelist) 
    261                   CALL fct_help(cp_myname,cl_errormsg)  
     261                  CALL fct_help(cp_myname,cl_errormsg) 
    262262                  CALL EXIT(1) 
    263263               ENDIF 
     
    298298 
    299299               WRITE(cl_errormsg,*) " ERROR : can't find "//TRIM(cl_namelist) 
    300                CALL fct_help(cp_myname,cl_errormsg)  
     300               CALL fct_help(cp_myname,cl_errormsg) 
    301301               CALL EXIT(1) 
    302302 
     
    314314 
    315315      CALL multi_print(tl_multi) 
    316        
     316 
    317317      ! open file 
    318318      tl_file=file_init(TRIM(tl_multi%t_mpp(1)%c_name)) 
Note: See TracChangeset for help on using the changeset viewer.