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 11435 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_CONFIG.tex – NEMO

Ignore:
Timestamp:
2019-08-14T14:45:08+02:00 (5 years ago)
Author:
nicolasmartin
Message:

Various corrections on chapters

Cleaning the indexes by fixing/removing wrong entries (or appending a ? to unknown items) and
improve the classification with new index definitions for CPP keys and namelist blocks:

  • from \key{...} cmd, key_ prefix no longer precedes the index entry
  • namelist block declaration moves from \ngn{nam...} to \nam{...} (i.e. \ngn{namtra\_ldf} -> \nam{tra\_ldf}) The expected prefix nam is added to the printed word but not the index entry.

Now we have indexes with a better sorting instead of all CPP keys under 'K' and namelists blocks under 'N'.

Fix missing space issues with alias commands by adding a trailing backslash (\NEMO\, \ie\, \eg\, ...).
There is no perfect solution for this, and I prefer not using a particular package to solve it.

Review the initial LaTeX code snippet for the historic changes in chapters

Finally, for readability and future diff visualisations, please avoid writing paragraphs with continuous lines.
Break the lines around 80 to 100 characters long

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/NEMO/subfiles/chap_CONFIG.tex

    r11214 r11435  
    88\label{chap:CFG} 
    99 
    10 \minitoc 
     10\chaptertoc 
    1111 
    1212\newpage 
     
    1818\label{sec:CFG_intro} 
    1919 
    20 The purpose of this part of the manual is to introduce the NEMO reference configurations. 
     20The purpose of this part of the manual is to introduce the \NEMO\ reference configurations. 
    2121These configurations are offered as means to explore various numerical and physical options, 
    2222thus allowing the user to verify that the code is performing in a manner consistent with that we are running. 
     
    2424The reference configurations also provide a sense for some of the options available in the code, 
    2525though by no means are all options exercised in the reference configurations. 
    26 Configuration is defined manually through the \textit{namcfg} namelist variables. 
     26Configuration is defined manually through the \nam{cfg} namelist variables. 
    2727 
    2828%------------------------------------------namcfg---------------------------------------------------- 
     
    3838\label{sec:CFG_c1d} 
    3939 
    40 The 1D model option simulates a stand alone water column within the 3D NEMO system. 
     40The 1D model option simulates a stand alone water column within the 3D \NEMO\ system. 
    4141It can be applied to the ocean alone or to the ocean-ice system and can include passive tracers or a biogeochemical model. 
    4242It is set up by defining the position of the 1D water column in the grid 
    43 (see \textit{cfgs/SHARED/namelist\_ref}).  
     43(see \path{./cfgs/SHARED/namelist\_ref}). 
    4444The 1D model is a very useful tool 
    4545\textit{(a)} to learn about the physics and numerical treatment of vertical mixing processes; 
     
    5454 
    5555The 1D model has some specifies. First, all the horizontal derivatives are assumed to be zero, 
    56 and second, the two components of the velocity are moved on a $T$-point.  
    57 Therefore, defining \key{c1d} changes some things in the code behaviour:  
     56and second, the two components of the velocity are moved on a $T$-point. 
     57Therefore, defining \key{c1d} changes some things in the code behaviour: 
    5858\begin{description} 
    5959\item[(1)] 
     
    6868\end{description} 
    6969All the relevant \textit{\_c1d} modules can be found in the src/OCE/C1D directory of 
    70 the NEMO distribution. 
     70the \NEMO\ distribution. 
    7171 
    7272% to be added:  a test case on the yearlong Ocean Weather Station (OWS) Papa dataset of Martin (1985) 
     
    8080The ORCA family is a series of global ocean configurations that are run together with 
    8181the SI3 model (ORCA-ICE) and possibly with PISCES biogeochemical model (ORCA-ICE-PISCES). 
    82 An appropriate namelist is available in \path{cfgs/ORCA2_ICE_PISCES/EXPREF/namelist_cfg} for ORCA2. 
     82An appropriate namelist is available in \path{./cfgs/ORCA2_ICE_PISCES/EXPREF/namelist_cfg} for ORCA2. 
    8383The domain of ORCA2 configuration is defined in \ifile{ORCA\_R2\_zps\_domcfg} file, 
    84 this file is available in tar file on the NEMO community zenodo platform: \\ 
     84this file is available in tar file on the \NEMO\ community zenodo platform: \\ 
    8585https://doi.org/10.5281/zenodo.2640723 
    8686 
    87 In this namelist\_cfg the name of domain input file is set in \ngn{namcfg} block of namelist.  
     87In this namelist\_cfg the name of domain input file is set in \nam{cfg} block of namelist. 
    8888 
    8989%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    118118(\autoref{fig:MISC_ORCA_msh}). 
    119119The resulting mesh presents no loss of continuity in either the mesh lines or the scale factors, 
    120 or even the scale factor derivatives over the whole ocean domain, as the mesh is not a composite mesh.  
     120or even the scale factor derivatives over the whole ocean domain, as the mesh is not a composite mesh. 
    121121%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    122122\begin{figure}[!tbp] 
     
    137137%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    138138 
    139 The method is applied to Mercator grid (\ie same zonal and meridional grid spacing) poleward of 20\deg{N}, 
     139The method is applied to Mercator grid (\ie\ same zonal and meridional grid spacing) poleward of 20\deg{N}, 
    140140so that the Equator is a mesh line, which provides a better numerical solution for equatorial dynamics. 
    141141The choice of the series of embedded ellipses (position of the foci and variation of the ellipses) 
     
    146146a half a degree grid (ORCA\_R05). 
    147147The smallest ocean scale factor is found in along Antarctica, 
    148 while the ratio of anisotropy remains close to one except near the Victoria Island in the Canadian Archipelago.  
     148while the ratio of anisotropy remains close to one except near the Victoria Island in the Canadian Archipelago. 
    149149 
    150150% ------------------------------------------------------------------------------------------------------------- 
     
    154154\label{subsec:CFG_orca_resolution} 
    155155 
    156 The NEMO system is provided with five built-in ORCA configurations which differ in the horizontal resolution. 
     156The \NEMO\ system is provided with five built-in ORCA configurations which differ in the horizontal resolution. 
    157157The value of the resolution is given by the resolution at the Equator expressed in degrees. 
    158158Each of configuration is set through the \textit{domain\_cfg} domain configuration file, 
    159159which sets the grid size and configuration name parameters. 
    160 The NEMO System Team provides only ORCA2 domain input file "\ifile{ORCA\_R2\_zps\_domcfg}" file 
    161 (Tab. \autoref{tab:ORCA}). 
     160The \NEMO\ System Team provides only ORCA2 domain input file "\ifile{ORCA\_R2\_zps\_domcfg}" file 
     161(\autoref{tab:ORCA}). 
    162162 
    163163%--------------------------------------------------TABLE-------------------------------------------------- 
     
    165165  \begin{center} 
    166166    \begin{tabular}{p{4cm} c c c c} 
    167       Horizontal Grid                         & \np{ORCA\_index} &  \np{jpiglo} & \np{jpjglo} &       \\ 
    168       \hline 
    169       \hline 
    170       \~4\deg     &        4         &         92     &      76      &       \\ 
    171       \~2\deg        &        2         &       182     &    149      &        \\ 
    172       \~1\deg        &        1         &       362     &     292     &        \\ 
    173       \~0.5\deg     &        05       &       722     &     511     &        \\ 
    174       \~0.25\deg   &        025     &      1442    &   1021     &        \\ 
    175       % \key{orca\_r8}       &        8         &      2882    &   2042     &        \\ 
    176       % \key{orca\_r12}     &      12         &      4322    &   3062      &       \\ 
    177       \hline 
    178       \hline 
     167      Horizontal Grid & \jp{ORCA\_index} & \jp{jpiglo} & \jp{jpjglo} \\ 
     168      \hline \hline 
     169%             4   \deg &              4   &          92 &          76 \\ 
     170             2   \deg &              2   &         182 &         149 \\ 
     171             1   \deg &              1   &         362 &         292 \\ 
     172             0.5 \deg &              05  &         722 &         511 \\ 
     173             0.25\deg &              025 &        1442 &        1021 \\ 
     174      \hline \hline 
    179175    \end{tabular} 
    180176    \caption{ 
     
    198194Note that the tropical mesh refinements in ORCA\_R2 and R1 strongly increases the mesh anisotropy there. 
    199195 
    200 The ORCA\_R05 and higher global configurations do not incorporate any regional refinements.   
     196The ORCA\_R05 and higher global configurations do not incorporate any regional refinements. 
    201197 
    202198For ORCA\_R1 and R025, setting the configuration key to 75 allows to use 75 vertical levels, otherwise 46 are used. 
     
    204200(see \autoref{tab:orca_zgr}). %\sfcomment{HERE I need to put new table for ORCA2 values} and \autoref{fig:zgr}). 
    205201 
    206 Only the ORCA\_R2 is provided with all its input files in the NEMO distribution. 
     202Only the ORCA\_R2 is provided with all its input files in the \NEMO\ distribution. 
    207203%It is very similar to that used as part of the climate model developed at IPSL for the 4th IPCC assessment of 
    208204%climate change (Marti et al., 2009). 
    209 %It is also the basis for the \NEMO contribution to the Coordinate Ocean-ice Reference Experiments (COREs) 
    210 %documented in \citet{griffies.biastoch.ea_OM09}.  
     205%It is also the basis for the \NEMO\ contribution to the Coordinate Ocean-ice Reference Experiments (COREs) 
     206%documented in \citet{griffies.biastoch.ea_OM09}. 
    211207 
    212208This version of ORCA\_R2 has 31 levels in the vertical, with the highest resolution (10m) in the upper 150m 
    213 (see \autoref{tab:orca_zgr} and \autoref{fig:zgr}).  
    214 The bottom topography and the coastlines are derived from the global atlas of Smith and Sandwell (1997).  
    215 The default forcing uses the boundary forcing from \citet{large.yeager_rpt04} (see \autoref{subsec:SBC_blk_core}),  
     209(see \autoref{tab:orca_zgr} and \autoref{fig:zgr}). 
     210The bottom topography and the coastlines are derived from the global atlas of Smith and Sandwell (1997). 
     211The default forcing uses the boundary forcing from \citet{large.yeager_rpt04} (see \autoref{subsec:SBC_blk_core}), 
    216212which was developed for the purpose of running global coupled ocean-ice simulations without 
    217213an interactive atmosphere. 
    218214This \citet{large.yeager_rpt04} dataset is available through 
    219215the \href{http://nomads.gfdl.noaa.gov/nomads/forms/mom4/CORE.html}{GFDL web site}. 
    220 The "normal year" of \citet{large.yeager_rpt04} has been chosen of the NEMO distribution since release v3.3.  
    221  
    222 ORCA\_R2 pre-defined configuration can also be run with multiply online nested zooms (\ie with AGRIF, \key{agrif} defined). This is available as the AGRIF\_DEMO configuration that can be found in the \path{cfgs/AGRIF_DEMO/} directory. 
     216The "normal year" of \citet{large.yeager_rpt04} has been chosen of the \NEMO\ distribution since release v3.3. 
     217 
     218ORCA\_R2 pre-defined configuration can also be run with multiply online nested zooms (\ie\ with AGRIF, \key{agrif} defined). 
     219This is available as the AGRIF\_DEMO configuration that can be found in the \path{./cfgs/AGRIF_DEMO/} directory. 
    223220 
    224221A regional Arctic or peri-Antarctic configuration is extracted from an ORCA\_R2 or R05 configurations using 
    225 sponge layers at open boundaries.  
     222sponge layers at open boundaries. 
    226223 
    227224% ------------------------------------------------------------------------------------------------------------- 
     
    236233\citet{hazeleger.drijfhout_JPO98, hazeleger.drijfhout_JPO99, hazeleger.drijfhout_JGR00, hazeleger.drijfhout_JPO00}, 
    237234over which an analytical seasonal forcing is applied. 
    238 This allows to investigate the spontaneous generation of a large number of interacting, transient mesoscale eddies  
    239 and their contribution to the large scale circulation.  
     235This allows to investigate the spontaneous generation of a large number of interacting, transient mesoscale eddies 
     236and their contribution to the large scale circulation. 
    240237 
    241238The GYRE configuration run together with the PISCES biogeochemical model (GYRE-PISCES). 
     
    245242The configuration is meant to represent an idealized North Atlantic or North Pacific basin. 
    246243The circulation is forced by analytical profiles of wind and buoyancy fluxes. 
    247 The applied forcings vary seasonally in a sinusoidal manner between winter and summer extrema \citep{levy.klein.ea_OM10}.  
     244The applied forcings vary seasonally in a sinusoidal manner between winter and summer extrema \citep{levy.klein.ea_OM10}. 
    248245The wind stress is zonal and its curl changes sign at 22\deg{N} and 36\deg{N}. 
    249246It forces a subpolar gyre in the north, a subtropical gyre in the wider part of the domain and 
     
    257254 
    258255The GYRE configuration is set like an analytical configuration. 
    259 Through \np{ln\_read\_cfg}\forcode{ = .false.} in \textit{namcfg} namelist defined in 
    260 the reference configuration \path{cfgs/GYRE_PISCES/EXPREF/namelist_cfg} 
     256Through \np{ln\_read\_cfg}\forcode{ = .false.} in \nam{cfg} namelist defined in 
     257the reference configuration \path{./cfgs/GYRE_PISCES/EXPREF/namelist_cfg} 
    261258analytical definition of grid in GYRE is done in usrdef\_hrg, usrdef\_zgr routines. 
    262259Its horizontal resolution (and thus the size of the domain) is determined by 
    263 setting \np{nn\_GYRE} in \ngn{namusr\_def}: \\ 
    264  
    265 \np{jpiglo} $= 30 \times$ \np{nn\_GYRE} + 2   \\ 
    266  
    267 \np{jpjglo} $= 20 \times$ \np{nn\_GYRE} + 2   \\ 
     260setting \np{nn\_GYRE} in \nam{usr\_def}: \\ 
     261 
     262\jp{jpiglo} $= 30 \times$ \np{nn\_GYRE} + 2   \\ 
     263 
     264\jp{jpjglo} $= 20 \times$ \np{nn\_GYRE} + 2   \\ 
    268265 
    269266Obviously, the namelist parameters have to be adjusted to the chosen resolution, 
    270 see the Configurations pages on the NEMO web site (NEMO Configurations). 
     267see the Configurations pages on the \NEMO\ web site (\NEMO\ Configurations). 
    271268In the vertical, GYRE uses the default 30 ocean levels (\jp{jpk}\forcode{ = 31}) (\autoref{fig:zgr}). 
    272269 
     
    275272For example, keeping a same model size on each processor while increasing the number of processor used is very easy, 
    276273even though the physical integrity of the solution can be compromised. 
    277 Benchmark is activate via \np{ln\_bench}\forcode{ = .true.} in \ngn{namusr\_def} in 
    278 namelist \path{cfgs/GYRE_PISCES/EXPREF/namelist_cfg}. 
     274Benchmark is activate via \np{ln\_bench}\forcode{ = .true.} in \nam{usr\_def} in 
     275namelist \path{./cfgs/GYRE_PISCES/EXPREF/namelist_cfg}. 
    279276 
    280277%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    299296The AMM, Atlantic Margins Model, is a regional model covering the Northwest European Shelf domain on 
    300297a regular lat-lon grid at approximately 12km horizontal resolution. 
    301 The appropriate \textit{\&namcfg} namelist  is available in \textit{cfgs/AMM12/EXPREF/namelist\_cfg}. 
     298The appropriate \textit{\&namcfg} namelist  is available in \path{./cfgs/AMM12/EXPREF/namelist\_cfg}. 
    302299It is used to build the correct dimensions of the AMM domain. 
    303300 
    304 This configuration tests several features of NEMO functionality specific to the shelf seas. 
     301This configuration tests several features of \NEMO\ functionality specific to the shelf seas. 
    305302In particular, the AMM uses $s$-coordinates in the vertical rather than $z$-coordinates and 
    306303is forced with tidal lateral boundary conditions using a Flather boundary condition from the BDY module. 
Note: See TracChangeset for help on using the changeset viewer.