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 4147 for branches/2013/dev_LOCEAN_2013/DOC/TexFiles/Chapters/Chap_CFG.tex – NEMO

Ignore:
Timestamp:
2013-11-04T12:51:55+01:00 (10 years ago)
Author:
cetlod
Message:

merge in dev_LOCEAN_2013, the 1st development branch dev_r3853_CNRS9_Confsetting, from its starting point ( r3853 ) on the trunk: see ticket #1169

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/2013/dev_LOCEAN_2013/DOC/TexFiles/Chapters/Chap_CFG.tex

    r3764 r4147  
    11% ================================================================ 
    2 % Chapter Ñ Configurations 
     2% Chapter Configurations 
    33% ================================================================ 
    44\chapter{Configurations} 
     
    1616 
    1717 
    18 The purpose of this part of the manual is to introduce the \NEMO predefined configuration.  
     18The purpose of this part of the manual is to introduce the \NEMO reference configurations.  
    1919These configurations are offered as means to explore various numerical and physical options,  
    2020thus allowing the user to verify that the code is performing in a manner consistent with that  
    2121we are running. This form of verification is critical as one adopts the code for his or her particular  
    2222research purposes. The test cases also provide a sense for some of the options available  
    23 in the code, though by no means are all options exercised in the predefined configurations. 
    24  
    25  
    26 %There is several predefined ocean configuration which use is controlled by a specific CPP key.  
    27  
    28 %The key set the domain sizes (\jp{jpiglo}, \jp{jpjglo}, \jp{jpk}), the mesh and the bathymetry,  
    29 %and, in some cases, add to the model physics some specific treatments. 
    30  
     23in the code, though by no means are all options exercised in the reference configurations. 
     24 
     25Configuration is defined mainly through the \ngn{namcfg} namelist variables: 
     26%------------------------------------------namcfg---------------------------------------------------- 
     27\namdisplay{namcfg} 
     28%------------------------------------------------------------------------------------------------------------- 
    3129 
    3230% ================================================================ 
    3331% 1D model configuration 
    3432% ================================================================ 
    35 \section{Water column model: 1D model (C1D) (\key{c1d})} 
     33\section{Water column model: 1D model (C1D) (\key{c1d}) } 
    3634\label{CFG_c1d} 
    3735 
    3836The 1D model option simulates a stand alone water column within the 3D \NEMO system.  
    3937It can be applied to the ocean alone or to the ocean-ice system and can include passive tracers  
    40 or a biogeochemical model. It is set up by defining the \key{c1d} CPP key.  
     38or a biogeochemical model. It is set up by defining the position of the 1D water column in the grid  
     39(see \textit{CONFIG/SHARED/namelist\_ref} ).  
    4140The 1D model is a very useful tool   
    4241\textit{(a)} to learn about the physics and numerical treatment of vertical mixing processes ;  
     
    4847 
    4948The methodology is based on the use of the zoom functionality over the smallest possible  
    50 domain : a 3x3 domain centred on the grid point of interest (see \S\ref{MISC_zoom}),  
     49domain : a 3x3 domain centered on the grid point of interest,  
    5150with some extra routines. There is no need to define a new mesh, bathymetry,  
    5251initial state or forcing, since the 1D model will use those of the configuration it is a zoom of.  
    53 The chosen grid point is set in \mdl{par\_oce} module by setting the \jp{jpizoom} and \jp{jpjzoom}  
     52The chosen grid point is set in \textit{\ngn{namcfg}} namelist by setting the \np{jpizoom} and \np{jpjzoom}  
    5453parameters to the indices of the location of the chosen grid point. 
    5554 
     
    7675% ORCA family configurations 
    7776% ================================================================ 
    78 \section{ORCA family: global ocean with tripolar grid (\key{orca\_rX})} 
     77\section{ORCA family: global ocean with tripolar grid } 
    7978\label{CFG_orca} 
    8079 
     
    8281the LIM sea-ice model (ORCA-LIM) and possibly with PISCES biogeochemical model  
    8382(ORCA-LIM-PISCES), using various resolutions. 
     83The appropriate \textit{\&namcfg} namelist is available in \textit{CONFIG/ORCA2\_LIM/EXP00/namelist\_cfg}  
     84for ORCA2 and in \textit{CONFIG/SHARED/README\_other\_configurations\_namelist\_namcfg}  
     85for other resolutions 
    8486 
    8587 
     
    147149The NEMO system is provided with five built-in ORCA configurations which differ in the  
    148150horizontal resolution. The value of the resolution is given by the resolution at the Equator  
    149 expressed in degrees. Each of configuration is set through a CPP key, \key{orca\_rX}  
    150 (with X being an indicator of the resolution), which set the grid size and configuration  
    151 name parameters  (Tab.~\ref{Tab_ORCA}). 
     151expressed in degrees. Each of configuration is set through the \textit{\ngn{namcfg}} namelist,  
     152which sets the grid size and configuration  
     153name parameters  (Tab. \ref{Tab_ORCA}). 
    152154. 
    153155 
     
    155157\begin{table}[!t]     \begin{center} 
    156158\begin{tabular}{p{4cm} c c c c} 
    157 CPP key                        & \jp{jp\_cfg} &  \jp{jpiglo} & \jp{jpiglo} &       \\   
     159Horizontal Grid                         & \np{jp\_cfg} &  \np{jpiglo} & \np{jpjglo} &       \\   
    158160\hline  \hline 
    159 \key{orca\_r4}        &        4         &         92     &      76      &       \\ 
    160 \key{orca\_r2}       &        2         &       182     &    149      &        \\ 
    161 \key{orca\_r1}       &        1         &       362     &     292     &        \\ 
    162 \key{orca\_r05}     &        05       &       722     &     511     &        \\ 
    163 \key{orca\_r025}   &        025     &      1442    &   1021     &        \\ 
     161\~4\deg     &        4         &         92     &      76      &       \\ 
     162\~2\deg        &        2         &       182     &    149      &        \\ 
     163\~1\deg        &        1         &       362     &     292     &        \\ 
     164\~0.5\deg     &        05       &       722     &     511     &        \\ 
     165\~0.25\deg   &        025     &      1442    &   1021     &        \\ 
    164166%\key{orca\_r8}       &        8         &      2882    &   2042     &        \\ 
    165167%\key{orca\_r12}     &      12         &      4322    &   3062      &       \\ 
     
    168170\caption{ \label{Tab_ORCA}    
    169171Set of predefined parameters for ORCA family configurations. 
    170 In all cases, the name of the configuration is set to "orca" ($i.e.$ \jp{cp\_cfg}~=~orca). } 
     172In all cases, the name of the configuration is set to "orca" ($i.e.$ \np{cp\_cfg}~=~orca). } 
    171173\end{center} 
    172174\end{table} 
     
    197199in the upper 150m (see Tab.~\ref{Tab_orca_zgr} and Fig.~\ref{Fig_zgr}).  
    198200The bottom topography and the coastlines are derived from the global atlas of Smith and Sandwell (1997).  
    199 The default forcing employ the boundary forcing from \citet{Large_Yeager_Rep04} (see \S\ref{SBC_blk_core}),  
     201The default forcing uses the boundary forcing from \citet{Large_Yeager_Rep04} (see \S\ref{SBC_blk_core}),  
    200202which was developed for the purpose of running global coupled ocean-ice simulations  
    201203without an interactive atmosphere. This \citet{Large_Yeager_Rep04} dataset is available  
     
    205207 
    206208ORCA\_R2 pre-defined configuration can also be run with an AGRIF zoom over the Agulhas  
    207 current area ( \key{agrif}  defined) and,  by setting the key \key{arctic} or \key{antarctic},  
     209current area ( \key{agrif}  defined) and,  by setting the appropriate variables in  
     210\textit{\&namcfg}, see \textit{CONFIG/SHARED/namelist\_ref} 
    208211a regional Arctic or peri-Antarctic configuration is extracted from an ORCA\_R2 or R05 configurations 
    209212using sponge layers at open boundaries.  
     
    212215%       GYRE family: double gyre basin 
    213216% ------------------------------------------------------------------------------------------------------------- 
    214 \section{GYRE family: double gyre basin (\key{gyre})} 
     217\section{GYRE family: double gyre basin } 
    215218\label{CFG_gyre} 
    216219 
    217 The GYRE configuration \citep{Levy_al_OM10} have been built to simulated  
    218 the seasonal cycle of a double-gyre box model. It consist in an idealized domain  
     220The GYRE configuration \citep{Levy_al_OM10} has been built to simulate 
     221the seasonal cycle of a double-gyre box model. It consists in an idealized domain  
    219222similar to that used in the studies of \citet{Drijfhout_JPO94} and \citet{Hazeleger_Drijfhout_JPO98,  
    220223Hazeleger_Drijfhout_JPO99, Hazeleger_Drijfhout_JGR00, Hazeleger_Drijfhout_JPO00},  
     
    242245uniformly applied to the whole domain. 
    243246 
    244 The GYRE configuration is set through the \key{gyre} CPP key. Its horizontal resolution  
    245 (and thus the size of the domain) is determined by setting \jp{jp\_cfg} in \hf{par\_GYRE} file: \\ 
    246 \jp{jpiglo} $= 30 \times$ \jp{jp\_cfg} + 2   \\ 
    247 \jp{jpjglo} $= 20 \times$ \jp{jp\_cfg} + 2   \\ 
    248 Obviously, the namelist parameters have to be adjusted to the chosen resolution. 
    249 In the vertical, GYRE uses the default 30 ocean levels (\jp{jpk}=31) (Fig.~\ref{Fig_zgr}). 
     247The GYRE configuration is set through the \textit{\&namcfg} namelist defined in the reference  
     248configuration \textit{CONFIG/GYRE/EXP00/namelist\_cfg}. Its horizontal resolution  
     249(and thus the size of the domain) is determined by setting \np{jp\_cfg} : \\ 
     250\np{jpiglo} $= 30 \times$ \np{jp\_cfg} + 2   \\ 
     251\np{jpjglo} $= 20 \times$ \np{jp\_cfg} + 2   \\ 
     252Obviously, the namelist parameters have to be adjusted to the chosen resolution, see the Configurations  
     253pages on the NEMO web site (Using NEMO\/Configurations) . 
     254In the vertical, GYRE uses the default 30 ocean levels (\pp{jpk}=31) (Fig.~\ref{Fig_zgr}). 
    250255 
    251256The GYRE configuration is also used in benchmark test as it is very simple to increase  
     
    270275 
    271276\begin{description} 
    272 \item[\key{eel\_r2}]  to be described.... 
    273 \item[\key{eel\_r5} 
    274 \item[\key{eel\_r6} 
     277\item[eel\_r2]  to be described.... 
     278\item[eel\_r5 
     279\item[eel\_r6 
    275280\end{description} 
    276  
     281The appropriate \textit{\&namcfg} namelists are available in   
     282\textit{CONFIG/SHARED/README\_other\_configurations\_namelist\_namcfg} 
    277283% ------------------------------------------------------------------------------------------------------------- 
    278284%       AMM configuration 
    279285% ------------------------------------------------------------------------------------------------------------- 
    280 \section{AMM: atlantic margin configuration (\key{amm\_12km})} 
     286\section{AMM: atlantic margin configuration } 
    281287\label{MISC_config_AMM} 
    282288 
    283289The AMM, Atlantic Margins Model, is a regional model covering the 
    284290Northwest European Shelf domain on a regular lat-lon grid at 
    285 approximately 12km horizontal resolution. The key \key{amm\_12km} 
    286 is used to create the correct dimensions of the AMM domain. 
     291approximately 12km horizontal resolution. The appropriate  
     292\textit{\&namcfg} namelist  is available in \textit{CONFIG/AMM12/EXP00/namelist\_cfg}. 
     293It is used to build the correct dimensions of the AMM domain. 
    287294 
    288295This configuration tests several features of NEMO functionality specific 
Note: See TracChangeset for help on using the changeset viewer.