4 | | This is an attempt to given the general philosophy behind the namelist_ref structure an what should appear in namelist_cfg. |
5 | | Such a description should probably appears in the DOC as well as in the system team and user wiki pages. |
| 4 | This page is an attempt to provide a proposed general philosophy behind the namelist_ref structure and what should appear in namelist_cfg. It also suggests some improvements to the current namelist. |
| 5 | |
| 6 | From a NEMO System Team perspective, the main objectif is to reduce drastically the duplication of sub-namelist in the namelist_cfg file for the standard configurations and test cases, and therefore facilitate namelist changes. |
| 7 | |
| 8 | From a user perspective, the main objective is to have a configuration namelist where : (1) all key choices appear, and (2) on which choices they willingly rely on the default reference namelist. Note that users that want all the namelist choices available in the namelist_cfg can still just copy the reference namelist and modify it. |
| 9 | |
| 10 | If adopted, such a description should probably appear in the DOC as well as in the system team and user wiki pages. |
| 11 | |
| 12 | [[BR]] |
| 13 | |
10 | | There is three type of namelist : (1) "manager" namelist ; (2) "associate manager" namelists ; and (3) "specific" namlists. |
11 | | (1) "manager" namelist : 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 : |
| 18 | The ocean namelist contains 10 sections : |
| 19 | {{{ |
| 20 | !! NEMO/OPA : 1 - Domain & run manager (namrun, namcfg, namdom, namtsd, namcrs, namc1d, namc1d_uvd) |
| 21 | !! namelists 2 - Surface boundary (namsbc, namsbc_flx, namsbc_blk, namsbc_cpl, |
| 22 | !! namsbc_sas, namtra_qsr, namsbc_rnf, |
| 23 | !! namsbc_isf, namsbc_iscpl, namsbc_apr, |
| 24 | !! namsbc_ssr, namsbc_wave, namberg) |
| 25 | !! 3 - lateral boundary (namlbc, namagrif, nambdy, nambdy_tide) |
| 26 | !! 4 - top/bot boundary (namdrg, namdrg_top, namdrg_bot, nambbc, nambbl) |
| 27 | !! 5 - Tracer (nameos, namtra_adv, namtra_ldf, namtra_eiv, namtra_dmp) |
| 28 | !! 6 - dynamics (namdyn_adv, namdyn_vor, namdyn_hpg, namdyn_spg, namdyn_ldf) |
| 29 | !! 7 - Vertical physics (namzdf, namzdf_ric, namzdf_tke, namzdf_gls, namzdf_iwm) |
| 30 | !! 8 - diagnostics (namnc4, namtrd, namspr, namflo, namhsb) |
| 31 | !! 9 - Obs & Assim (namobs, nam_asminc) |
| 32 | !! 10 - miscellaneous (nammpp, namctl, namsto) |
| 33 | }}} |
| 34 | |
| 35 | |
| 36 | There is three type of namelist : (1) "manager" ; (2) "associate manager" ; and (3) "specific". |
| 37 | (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 : |
18 | | (2) "associate manager" namelist : are activated |
| 44 | (2) "associate manager" namelist : It is read only if its associated flag (ln_xxxyyy) appearing in its father "manager" namelist is set to true. It contains reasonable default value that user may overwrite in namelist_cfg. Such a namelist is characterized by a " (ln_xxxyyy =T) " comment at the end of their opening line : |
| 45 | {{{ |
| 46 | !----------------------------------------------------------------------- |
| 47 | &namXXX ! sort description (ln_xxxyyy =T) |
| 48 | !----------------------------------------------------------------------- |
| 49 | }}} |
| 50 | |
| 51 | (3) "specific" namelist : they are associated with a pure optional feature (ocean parametrization such as namtra_eiv, naltra_mle, etc.) or option that does not change the the model trajectory (diagnostics, print control, etc.). They contains their own control switch (the first variable given in the namelist) and its default value is always FALSE. Such a type of namelist is characterized by a " (default: NO) " comment at the end of their opening line : |
| 52 | {{{ |
| 53 | !----------------------------------------------------------------------- |
| 54 | &namXXX ! sort description (default: NO) |
| 55 | !----------------------------------------------------------------------- |
| 56 | }}} |
| 57 | |
| 58 | [[BR]] |
23 | | - Set all . |
| 68 | !! assistant manager |
| 69 | !-=--=--=--=--=--=--=--=--=-=--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= |
| 70 | &namXXX ! short description (ln_xxxyyy =T) |
| 71 | !-=--=--=--=--=--=--=--=--=-=--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= |
| 72 | |
| 73 | !! specific namelist |
| 74 | !----------------------------------------------------------------------- |
| 75 | &namXXX ! short description (default: NO) |
| 76 | !----------------------------------------------------------------------- |
| 77 | }}} |
| 78 | or |
| 79 | {{{ |
| 80 | !-== == == == == == == == == == == == == == == == == == == == == == == = |
| 81 | &namXXX ! short description (default: NO selection) |
| 82 | !-== == == == == == == == == == == == == == == == == == == == == == == = |
| 83 | |
| 84 | !! assistant manager |
| 85 | !--= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = |
| 86 | &namXXX ! short description (ln_xxxyyy =T) |
| 87 | !--= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = |
| 88 | |
| 89 | !! specific namelist |
| 90 | !----------------------------------------------------------------------- |
| 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" |
| 99 | For example, they can be be : |
| 100 | "default: REQUIRE selection" ; "used IF ln_xxxyyy =T" ; and "default: NOT used" |
| 101 | or any other clever suggestion. |
| 102 | |
| 103 | [[BR]] |
| 104 | |
34 | | - No more ORCA2 specific choices |
35 | | - deactivate all option and set to false all switches, except in so called "associated manager" namelists (see below their definition). |
| 123 | - No more ORCA2 specific choices in namelist_ref. |
| 124 | - generalize the notion of "manager", "associate manager" and "specific" namelists |
| 125 | - add the possibility of having (in the solved Primitive Equation) NO trend in tracer or momentum advection and/or lateral mixing, Coriolis, … |
| 126 | - set to false all option in "manager" namelists, switch off all switches that , except in so called "associated manager" namelists . |
| 127 | - change to a dummy name all name and/or weight fields that need to be read in a NetCDF file. |