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.
user/gm/Namelist_framework (diff) – NEMO

Changes between Version 5 and Version 6 of user/gm/Namelist_framework


Ignore:
Timestamp:
2018-05-03T09:02:18+02:00 (6 years ago)
Author:
gm
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • user/gm/Namelist_framework

    v5 v6  
    3434 
    3535 
    36 There is three type of namelist :  (1) "manager"  ;  (2) "associate manager"  ;  and (3) "specific". 
     36There is three type of namelist :  (1) "manager"  ;  (2) "associate manager"  ;  and (3) "specific" (may be called "self-contained" or autonomous" namelist ?). 
    3737     (1) "manager" namelist : it is required in all user configuration. It defines key parameters and activate through a logical the reading of the "associate manager" namelists. By default, all choices are deactivated, while choices is required (the model will stop at the initialization phase if no choice is made) . Such a namelist is characterized by  a " (default: NO selection) " comment at the end of their opening line : 
    3838{{{ 
     
    5252{{{ 
    5353!----------------------------------------------------------------------- 
    54 &namXXX     !   sort description                                        (default: NO) 
    55 !----------------------------------------------------------------------- 
    56 }}} 
    57  
    58 [[BR]] 
    59  
    60  
    61 Note that two other setting of these 3 types of namelist may be adopted to add a better visual identification : 
     54&namXXX     !   sort description                                        (default: OFF) 
     55!----------------------------------------------------------------------- 
     56}}} 
     57 
     58[[BR]] 
     59 
     60 
     61Note that two other settings of these 3 types of namelist may be adopted to add a better visual identification : 
    6262{{{ 
    6363!! manager namelist 
     
    7373!! specific namelist  
    7474!----------------------------------------------------------------------- 
    75 &namXXX        !   short description                                    (default: NO) 
     75&namXXX        !   short description                                    (default: OFF) 
    7676!----------------------------------------------------------------------- 
    7777}}} 
     
    8989!! specific namelist  
    9090!----------------------------------------------------------------------- 
    91 &namXXX        !   short description                                    (default: NO) 
    92 !----------------------------------------------------------------------- 
    93 }}} 
    94  
    95 [[BR]] 
    96  
    97    Note also that the I'm not very found of the tags : 
    98       "default: NO selection" ; "ln_xxxyyy =T" ; and "default: NO" 
     91&namXXX        !   short description                                    (default: OFF) 
     92!----------------------------------------------------------------------- 
     93}}} 
     94 
     95[[BR]] 
     96 
     97   Note also that the I'm not very found of the tag for manager namelist : 
     98      "default: NO selection"  
    9999   For example, they can be be : 
    100       "default: REQUIRE selection" ; "used IF ln_xxxyyy =T" ; and "default: NOT used" 
     100      "default: REQUIRE selection"  or "selection REQUIRED" or just "REQUIRED" ? 
    101101   or any other clever suggestion. 
    102102 
     
    106106 
    107107=== configuration namelist : === 
    108 This namelist aims to overwrite the reference namelist values. The way its is set in all configurations and test cases provides in the down in the NEMOGCM/CONFIG directory is the following : It have to contain the namelist : 
    109  
    110       (0) all the header of 10 sections of the ocean namelist, listing all the section namelist that are relevant for the configuration (e.g. C1D namelist description line will only appears in the C1D_PAPA configuration. 
    111  
    112       (1) In addition to namdom and namrun, ALL the "manager" namelist:  By definition all "manager namelist require to switch at least on namelist logical from FALSE to TRUE. 
    113  
    114       (2) only the "associate manager" namelist for which  the two conditions are satisfied:  -1- its manager  namelist logical equal TRUE  ; and -2- the default reference values that has been modified. 
    115  
    116       (3) only "specific" namelist for which the user have chosen to set to TRUE its control switch. In the case only the other namelist option that has been changed compare to the reference will appear. 
    117 [[BR]] 
    118  
    119  
     108This namelist aims to overwrite the reference namelist values. The way it is set in all configurations and test cases (NEMOGCM/CONFIG directory) is the following : It have to contain : 
     109 
     110      (0) all the header of 10 sections of the ocean namelist, listing all the section namelist that are relevant for the configuration (e.g. C1D namelist description line will only appears in the C1D_PAPA configuration). 
     111 
     112      (1) In addition to namdom and namrun, ALL the "manager" namelist. Indeed, by definition all the "manager" namelists require to switch at least on namelist logical from FALSE to TRUE. 
     113 
     114      (2) only the "associate manager" namelist for which  the two conditions are satisfied:  -1- its manager  namelist logical equal TRUE  ; and -2- the default reference values that has been modified.  
     115 
     116      (3) only "specific" namelist for which the user have chosen to set to TRUE its control switch. 
     117 
     118In ALL three types of namelist present in the namlist_cfg, only the namelist option that has been changed compare to the reference will appear. 
     119 
     120[[BR]] 
    120121 
    121122=== Key changes compare to v3.6 === 
    122123 
    123 - No more ORCA2 specific choices in namelist_ref. 
     124- No more ORCA2 specific choices in namelist_ref. Major changes: 
     125   namdta_tsd: ln_tsd_dmp = F ; ln_tsd_init = F 
     126 
     127   namsbc:  nn_ice = 0 (no sea-ice) ;  ln_blk = F ; ln_traqsr = F ; ln_rnf = F ; nn_fwb = 0 
     128 
     129   namrun: nn_no becomes the assimilation stage as it is now the only use of this parameter. 
     130 
     131   namtra_dmp:  ln_tradmp = F 
     132 
     133   namsbc_ssr:  nn_sssr =0 
     134 
     135   namlbc:  rn_shlat    =  -9999.  (a choice is therefore required) 
     136 
     137   namdyn_adv: ln_dynadv_vec = F 
     138 
     139   namzdf: ln_zdfevd = F 
     140 
     141   namzdf_ric: ln_mldw = F 
     142 
     143   NB: Not done but '''should be done''': nn_fsbc = 1 
     144 
    124145- generalize the notion of "manager", "associate manager" and "specific" namelists 
    125146- add the possibility of having (in the solved Primitive Equation) NO trend  in tracer or momentum advection and/or lateral mixing, Coriolis, …   
     
    150171- move ln_icebergs from namberg to namsbc namelist (affect the surface ocean boundary condition, should be a "associate manager" namelist  
    151172- nam_tide should it be an "associate manager" namelist ?? 
     173- C1D: CPP key removed, C1D_PAPA moved in TEST_CASES, and ALL the three C1D namelist should be regrouped in ONE single namelist read in namusr_def namelist. 
     174- remove namelist control for output that are also controlled via the xIOS xml file 
    152175[[BR]] 
    153176 
     
    184207   - In logical namelist use "_OFF"  instead of "_NONE"   (e.g. ln_traldf_NONE ==> ln_traldf_OFF)   '''DONE in @9526''' 
    185208   - "specific" namelist should be called '''self-contained''' or '''autonomous''' namelist 
    186  
    187