New URL for NEMO forge!

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.
Introduction.tex in trunk/DOC/TexFiles/Chapters – NEMO

source: trunk/DOC/TexFiles/Chapters/Introduction.tex @ 4661

Last change on this file since 4661 was 4661, checked in by clevy, 10 years ago

Update reference manual for namelists

File size: 16.4 KB
2% ================================================================
4% ================================================================
8The Nucleus for European Modelling of the Ocean (\NEMO) is a framework of ocean
9related engines, namely OPA\footnote{OPA = Oc\'{e}an PArall\'{e}lis\'{e}} for the
10ocean dynamics and thermodynamics, LIM\footnote{LIM= Louvain)la-neuve Ice
11Model} for the sea-ice dynamics and thermodynamics, TOP\footnote{TOP = Tracer
12in the Ocean Paradigm} for the biogeochemistry (both transport (TRP) and sources
13minus sinks (LOBSTER, PISCES)\footnote{Both LOBSTER and PISCES are not
14acronyms just name}. It is intended to be a flexible tool for studying the ocean and
15its interactions with the other components of the earth climate system (atmosphere,
16sea-ice, biogeochemical tracers, ...) over a wide range of space and time scales.
17This documentation provides information about the physics represented by the ocean
18component of \NEMO and the rationale for the choice of numerical schemes and
19the model design. More specific information about running the model on different
20computers, or how to set up a configuration, are found on the \NEMO web site
23The ocean component of \NEMO has been developed from the OPA model,
24release 8.2, described in \citet{Madec1998}. This model has been used for a wide
25range of applications, both regional or global, as a forced ocean model and as a
26model coupled with the atmosphere. A complete list of references is found on the
27\NEMO web site.
29This manual is organised in as follows. Chapter~\ref{PE} presents the model basics,
30$i.e.$ the equations and their assumptions, the vertical coordinates used, and the
31subgrid scale physics. This part deals with the continuous equations of the model
32(primitive equations, with potential temperature, salinity and an equation of state).
33The equations are written in a curvilinear coordinate system, with a choice of vertical
34coordinates ($z$ or $s$, with the rescaled height coordinate formulation \textit{z*}, or 
35\textit{s*}). Momentum equations are formulated in the vector invariant form or in the
36flux form. Dimensional units in the meter, kilogram, second (MKS) international system
37are used throughout.
39The following chapters deal with the discrete equations. Chapter~\ref{STP} presents the
40time domain. The model time stepping environment is a three level scheme in which
41the tendency terms of the equations are evaluated either centered  in time, or forward,
42or backward depending of the nature of the term.
43Chapter~\ref{DOM} presents the space domain. The model is discretised on a staggered
44grid (Arakawa C grid) with masking of land areas. Vertical discretisation used depends
45on both how the bottom topography is represented and whether the free surface is linear or not.
46Full step or partial step $z$-coordinate or $s$- (terrain-following) coordinate is used
47with linear free surface (level position are then fixed in time). In non-linear free surface,
48the corresponding rescaled height coordinate formulation (\textit{z*} or \textit{s*}) is used
49(the level position then vary in time as a function of the sea surface heigh).
50The following two chapters (\ref{TRA} and \ref{DYN}) describe the discretisation of the
51prognostic equations for the active tracers and the momentum. Explicit, split-explicit
52and filtered free surface formulations are implemented.
53A number of numerical schemes are available for momentum advection, for the computation
54of the pressure gradients, as well as for the advection of tracers (second or higher
55order advection schemes, including positive ones).
57Surface boundary conditions (chapter~\ref{SBC}) can be implemented as prescribed
58fluxes, or bulk formulations for the surface fluxes (wind stress, heat, freshwater). The
59model allows penetration of solar radiation  There is an optional geothermal heating at
60the ocean bottom. Within the \NEMO system the ocean model is interactively coupled
61with a sea ice model (LIM) and with biogeochemistry models (PISCES, LOBSTER).
62Interactive coupling to Atmospheric models is possible via the OASIS coupler
63\citep{OASIS2006}. Two-way nesting is also available through an interface to the
64AGRIF package (Adaptative Grid Refinement in \textsc{Fortran}) \citep{Debreu_al_CG2008}.
65The interface code for coupling to an alternative sea ice model (CICE, \citet{Hunke2008})
66has now been upgraded so that it works for both global and regional domains, although AGRIF
67is still not available.
69Other model characteristics are the lateral boundary conditions (chapter~\ref{LBC}). 
70Global configurations of the model make use of the ORCA tripolar grid, with special north
71fold boundary condition. Free-slip or no-slip boundary conditions are allowed at land
72boundaries. Closed basin geometries as well as periodic domains and open boundary
73conditions are possible.
75Physical parameterisations are described in chapters~\ref{LDF} and \ref{ZDF}. The
76model includes an implicit treatment of vertical viscosity and diffusivity. The lateral
77Laplacian and biharmonic viscosity and diffusion can be rotated following a geopotential
78or neutral direction. There is an optional eddy induced velocity \citep{Gent1990} with a
79space and time variable coefficient \citet{Treguier1997}. The model has vertical harmonic
80viscosity and diffusion with a space and time variable coefficient, with options to compute
81the coefficients with \citet{Blanke1993}, \citet{Large_al_RG94}, \citet{Pacanowski_Philander_JPO81},
82or \citet{Umlauf_Burchard_JMS03} mixing schemes.
83 \vspace{1cm}
86\noindent CPP keys and namelists are used for inputs to the code.  \newline
88\noindent \index{CPP keys} CPP keys \newline
89Some CPP keys are implemented in the FORTRAN code to allow code selection at compiling step. This selection of code at compilation time reduces the reliability of the whole platform since it changes the code from one set of CPP keys to the other. It is used only when the addition/suppression of the part of code highly changes the amount of memory at run time.
90Usual coding looks like :
91 \vspace{-10pt}
95#if defined key_option1   
96             This part of the FORTRAN code will be active   
97             only if key_option1 is activated at compiling step
103\noindent \index{Namelist} Namelists
105The namelist allows to input variables (character, logical, real and integer) into the code. There is one namelist file for each component of NEMO (dynamics, sea-ice, biogeochemistry...) containing all the FOTRAN namelists needed. The implementation in NEMO uses a two step process. For each FORTRAN namelist, two files are read:
107\item A reference namelist ( in \textit{CONFIG/SHARED/namelist\_ref} ) is read first. This file contains all the namelist variables which are initialised to default values 
108\item A configuration namelist ( in \textit{CONFIG/CFG\_NAME/EXP00/namelist\_cfg} ) is read aferwards. This file contains only the namelist variables which are changed from default values, and overwrites those.
110A template can be found in \textit{NEMO/OPA\_SRC/module.example}
111The effective namelist, taken in account during the run, is stored at execution time in an output\_namelist\_dyn (or \_ice or \_top) file.
112 \vspace{1cm}
115Model outputs management and specific online diagnostics are described in chapters~\ref{DIA}.
116The diagnostics includes the output of all the tendencies of the momentum and tracers equations,
117the output of tracers tendencies averaged over the time evolving mixed layer, the output of
118the tendencies of the barotropic vorticity equation, the computation of on-line floats trajectories...
119Chapter~\ref{OBS} describes a tool which reads in observation files (profile temperature
120and salinity, sea surface temperature, sea level anomaly and sea ice concentration)
121and calculates an interpolated model equivalent value at the observation location
122and nearest model timestep. Originally developed of data assimilation, it is a fantastic
123tool for model and data comparison. Chapter~\ref{ASM} describes how increments
124produced by data assimilation may be applied to the model equations.
125Finally, Chapter~\ref{CFG} provides a brief introduction to the pre-defined model
126configurations (water column model, ORCA and GYRE families of configurations).
128The model is implemented in \textsc{Fortran 90}, with preprocessing (C-pre-processor).
129It runs under UNIX. It is optimized for vector computers and parallelised by domain 
130decomposition with MPI. All input and output is done in NetCDF (Network Common Data
131Format) with a optional direct access format for output. To ensure the clarity and
132readability of the code it is necessary to follow coding rules. The coding rules for OPA
133include conventions for naming variables, with different starting letters for different types
134of variables (real, integer, parameter\ldots). Those rules are briefly presented in
135Appendix~\ref{Apdx_D} and a more complete document is available on the \NEMO web site.
137The model is organized with a high internal modularity based on physics. For example,
138each trend ($i.e.$, a term in the RHS of the prognostic equation) for momentum and
139tracers is computed in a dedicated module.  To make it easier for the user to find his way
140around the code, the module names follow a three-letter rule. For example, \mdl{traldf} 
141is a module related to the TRAcers equation, computing the Lateral DiFfussion.
142%The complete list of module names is presented in Appendix~\ref{Apdx_D}.      %====>>>> to be done !
143Furthermore, modules are organized in a few directories that correspond to their category,
144as indicated by the first three letters of their name (Tab.~\ref{Tab_chap}).
146The manual mirrors the organization of the model.
147After the presentation of the continuous equations (Chapter \ref{PE}), the following chapters
148refer to specific terms of the equations each associated with a group of modules (Tab.~\ref{Tab_chap}).
153%\begin{center} \begin{tabular}{|p{143pt}|l|l|} \hline
154\caption{ \label{Tab_chap}   Organization of Chapters mimicking the one of the model directories. }
155\begin{center}    \begin{tabular}{|l|l|l|}   \hline
156Chapter \ref{STP} & -                 & model time STePping environment \\    \hline
157Chapter \ref{DOM} & DOM    & model DOMain \\    \hline
158Chapter \ref{TRA} & TRA    & TRAcer equations (potential temperature and salinity) \\   \hline
159Chapter \ref{DYN} & DYN    & DYNamic equations (momentum) \\      \hline
160Chapter \ref{SBC}    & SBC    & Surface Boundary Conditions \\       \hline
161Chapter \ref{LBC} & LBC    & Lateral Boundary Conditions (also OBC and BDY)  \\     \hline
162Chapter \ref{LDF} & LDF    & Lateral DiFfusion (parameterisations) \\   \hline
163Chapter \ref{ZDF} & ZDF    & vertical (Z) DiFfusion (parameterisations)  \\      \hline
164Chapter \ref{DIA} & DIA    & I/O and DIAgnostics (also IOM, FLO and TRD) \\      \hline
165Chapter \ref{OBS} & OBS    & OBServation and model comparison  \\    \hline
166Chapter \ref{ASM} & ASM    & ASsiMilation increment  \\     \hline
167Chapter \ref{MISC}   & SOL    & Miscellaneous  topics (including solvers)  \\       \hline
168Chapter \ref{CFG} &  -        & predefined configurations (including C1D) \\     \hline
170\end{center}   \end{table}
174\subsubsection{Changes between releases}
175NEMO/OPA, like all research tools, is in perpetual evolution. The present document describes
176the OPA version include in the release 3.4 of NEMO.  This release differs significantly
177from version 8, documented in \citet{Madec1998}.\\
179$\bullet$ The main modifications from OPA v8 and NEMO/OPA v3.2 are :\\
181\item transition to full native \textsc{Fortran} 90, deep code restructuring and drastic
182reduction of CPP keys;
183\item introduction of partial step representation of bottom topography \citep{Barnier_al_OD06, Le_Sommer_al_OM09, Penduff_al_OS07};
184\item partial reactivation of a terrain-following vertical coordinate ($s$- and hybrid $s$-$z$)
185with the addition of several options for pressure gradient computation \footnote{Partial
186support of $s$-coordinate: there is presently no support for neutral physics in $s$-
187coordinate and for the new options for horizontal pressure gradient computation with
188a non-linear equation of state.};
189\item more choices for the treatment of the free surface: full explicit, split-explicit or filtered
190schemes, and suppression of the rigid-lid option;
191\item non linear free surface associated with the rescaled height coordinate 
192\textit{z*} or  \textit{s};
193\item additional schemes for vector and flux forms of the momentum  advection;
194\item additional advection schemes for tracers;
195\item implementation of the AGRIF package (Adaptative Grid Refinement in \textsc{Fortran}) \citep{Debreu_al_CG2008};
196\item online diagnostics : tracers trend in the mixed layer and vorticity balance;
197\item rewriting of the I/O management with the use of an I/O server;
198\item generalized ocean-ice-atmosphere-CO2 coupling interface, interfaced with OASIS 3 coupler ;
199\item surface module (SBC) that simplify the way the ocean is forced and include two
200bulk formulea (CLIO and CORE) and which includes an on-the-fly interpolation of input forcing fields ;
201\item RGB light penetration and optional use of ocean color
202\item major changes in the TKE schemes: it now includes a Langmuir cell parameterization  \citep{Axell_JGR02},
203the \citet{Mellor_Blumberg_JPO04} surface wave breaking parameterization, and has a time discretization
204which is energetically consistent with the ocean model equations \citep{Burchard_OM02, Marsaleix_al_OM08};
205\item tidal mixing parametrisation (bottom intensification) + Indonesian specific tidal mixing \citep{Koch-Larrouy_al_GRL07};
206\item introduction of LIM-3, the new Louvain-la-Neuve sea-ice model (C-grid rheology and
207new thermodynamics including bulk ice salinity) \citep{Vancoppenolle_al_OM09a, Vancoppenolle_al_OM09b}
210 \vspace{1cm}
211$\bullet$ The main modifications from NEMO/OPA v3.2 and  v3.3 are :\\
213\item introduction of a modified leapfrog-Asselin filter time stepping scheme \citep{Leclair_Madec_OM09};
214\item additional scheme for iso-neutral mixing \citep{Griffies_al_JPO98}, although it is still a "work in progress";
215\item a rewriting of the bottom boundary layer scheme, following \citet{Campin_Goosse_Tel99};
216\item addition of a Generic Length Scale vertical mixing scheme, following \citet{Umlauf_Burchard_JMS03};
217\item addition of the atmospheric pressure as an external forcing on both ocean and sea-ice dynamics;
218\item addition of a diurnal cycle on solar radiation \citep{Bernie_al_CD07};
219\item river runoffs added through a non-zero depth, and having its own temperature and salinity;
220\item CORE II normal year forcing set as the default forcing of ORCA2-LIM configuration ;
221\item generalisation of the use of \mdl{fldread} for all input fields (ocean climatology, sea-ice damping...) ;
222\item addition of an on-line observation and model comparison (thanks to NEMOVAR project);
223\item optional application of an assimilation increment (thanks to NEMOVAR project);
224\item coupling interface adjusted for WRF atmospheric model;
225\item C-grid ice rheology now available fro both LIM-2 and LIM-3 \citep{Bouillon_al_OM09};
226\item LIM-3 ice-ocean momentum coupling applied to LIM-2 ;
227\item a deep re-writting and simplification of the off-line tracer component (OFF\_SRC) ;
228\item the merge of passive and active advection and diffusion modules ;
229\item  Use of the Flexible Configuration Manager (FCM) to build configurations, generate the Makefile and produce the executable ;
230\item Linear-tangent and Adjoint component (TAM) added, phased with v3.0
232 \vspace{1cm}
233In addition, several minor modifications in the coding have been introduced with the constant
234concern of improving the model performance.
236 \vspace{1cm}
237$\bullet$ The main modifications from NEMO/OPA v3.3 and  v3.4 are :\\
239\item finalisation of above iso-neutral mixing \citep{Griffies_al_JPO98}";
240\item "Neptune effect" parametrisation;
241\item horizontal pressure gradient suitable for s-coordinate;
242\item semi-implicit bottom friction;
243\item finalisation of the merge of passive and active tracers advection-diffusion modules;
244\item a new bulk formulae (so-called MFS);
245\item use fldread for the off-line tracer component (OFF\_SRC) ;
246\item use MPI point to point communications  for north fold;
247\item diagnostic of transport ;
Note: See TracBrowser for help on using the repository browser.