source: utils/tools/DMP_TOOLS/doc_DMP_tool.tex @ 10567

Last change on this file since 10567 was 10567, checked in by nicolasmartin, 16 months ago

Transfer specific documentation of DMP_TOOL into its own directory

File size: 3.7 KB
Line 
1\documentclass{article}
2
3\usepackage{xspace, natbib, minted}
4
5\setminted{style=emacs, fontsize=\scriptsize, breaklines, frame=leftline}
6
7\renewcommand{\deg}{$^{\circ} $ \xspace}
8\newcommand{\ifile}[1]{\textit{#1.nc}\index{Input NetCDF files!#1.nc}}
9\newcommand{\mdl}[1]{\textit{#1.F90}\index{Modules!#1}}
10\newcommand{\ngn}[1]{\textit{#1}\index{Namelist Group Name!#1}}
11\newcommand{\np}[1]{\textit{#1}\index{Namelist variables!#1}}
12
13\begin{document}
14
15DMP\_TOOLS can be used to generate a netcdf file containing the restoration coefficient $\gamma$.
16Note that in order to maintain bit comparison with previous NEMO versions DMP\_TOOLS must be compiled and
17run on the same machine as the NEMO model.
18A \ifile{mesh\_mask} file for the model configuration is required as an input.
19This can be generated by carrying out a short model run with the namelist parameter \np{nn\_msh} set to 1.
20The namelist parameter \np{ln\_tradmp} will also need to be set to .false. for this to work.
21The \ngn{nam\_dmp\_create} namelist in the DMP\_TOOLS directory is used to specify options for
22the restoration coefficient.
23
24%--------------------------------------------nam_dmp_create-------------------------------------------------
25\inputminted{fortran}{./namelist}
26%-------------------------------------------------------------------------------------------------------
27
28\np{cp\_cfg}, \np{cp\_cpz}, \np{jp\_cfg} and \np{jperio} specify the model configuration being used and
29should be the same as specified in \ngn{namcfg}.
30The variable \np{lzoom} is used to specify that the damping is being used as in case \textit{a} above to
31provide boundary conditions to a zoom configuration.
32In the case of the arctic or antarctic zoom configurations this includes some specific treatment.
33Otherwise damping is applied to the 6 grid points along the ocean boundaries.
34The open boundaries are specified by the variables \np{lzoom\_n}, \np{lzoom\_e}, \np{lzoom\_s}, \np{lzoom\_w} in
35the \ngn{nam\_zoom\_dmp} namelist.
36
37The remaining switch namelist variables determine the spatial variation of the restoration coefficient in
38non-zoom configurations.
39\np{ln\_full\_field} specifies that newtonian damping should be applied to the whole model domain.
40\np{ln\_med\_red\_seas} specifies grid specific restoration coefficients in the Mediterranean Sea for
41the ORCA4, ORCA2 and ORCA05 configurations.
42If \np{ln\_old\_31\_lev\_code} is set then the depth variation of the coeffients will be specified as
43a function of the model number.
44This option is included to allow backwards compatability of the ORCA2 reference configurations with
45previous model versions.
46\np{ln\_coast} specifies that the restoration coefficient should be reduced near to coastlines.
47This option only has an effect if \np{ln\_full\_field} is true.
48\np{ln\_zero\_top\_layer} specifies that the restoration coefficient should be zero in the surface layer.
49Finally \np{ln\_custom} specifies that the custom module will be called.
50This module is contained in the file \mdl{custom} and can be edited by users.
51For example damping could be applied in a specific region.
52
53The restoration coefficient can be set to zero in equatorial regions by
54specifying a positive value of \np{nn\_hdmp}.
55Equatorward of this latitude the restoration coefficient will be zero with a smooth transition to
56the full values of a 10\deg latitud band.
57This is often used because of the short adjustment time scale in the equatorial region
58\citep{Reverdin1991, Fujio1991, Marti_PhD92}.
59The time scale associated with the damping depends on the depth as a hyperbolic tangent,
60with \np{rn\_surf} as surface value, \np{rn\_bot} as bottom value and a transition depth of \np{rn\_dep}.
61
62\bibliography{doc_DMP_tool}
63\bibliographystyle{plainnat}
64
65\end{document}
Note: See TracBrowser for help on using the repository browser.