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

Ignore:
Timestamp:
2019-09-25T19:06:37+02:00 (5 years ago)
Author:
nicolasmartin
Message:

Application of some coding rules

  • Replace comments before sectioning cmds by a single line of 100 characters long to display when every line should break
  • Replace multi blank lines by one single blank line
  • For list environment, put \item, label and content on the same line
  • Remove \newpage and comments line around figure envs
File:
1 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/doc/latex/NEMO/subfiles/apdx_DOMAINcfg.tex

    r11584 r11596  
    22 
    33\begin{document} 
    4 % ================================================================ 
    5 % Appendix DOMAINcfg : A brief guide to the DOMAINcfg tool 
    6 % ================================================================ 
    74\chapter{A brief guide to the DOMAINcfg tool} 
    85\label{apdx:DOMCFG} 
    … …  
    1916\end{figure} 
    2017 
    21 \newpage 
    22  
    2318This appendix briefly describes some of the options available in the 
    2419\forcode{DOMAINcfg} tool mentioned in \autoref{chap:DOM}. 
    … …  
    3530of those described elsewhere in this manual. 
    3631 
    37 % ------------------------------------------------------------------------------------------------------------- 
    38 %        Choice of horizontal grid 
    39 % ------------------------------------------------------------------------------------------------------------- 
    4032\section{Choice of horizontal grid} 
    4133\label{sec:DOMCFG_hor} 
    … …  
    5547 
    5648\begin{description} 
    57  \item[{\np{jphgr_mesh}{jphgr\_mesh}=0}]  The most general curvilinear orthogonal grids. 
     49 \item [{\np{jphgr_mesh}{jphgr\_mesh}=0}]  The most general curvilinear orthogonal grids. 
    5850  The coordinates and their first derivatives with respect to $i$ and $j$ are provided 
    5951  in a input file (\ifile{coordinates}), read in \rou{hgr\_read} subroutine of the domhgr module. 
    6052  This is now the only option available within \NEMO\ itself from v4.0 onwards. 
    61 \item[{\np{jphgr_mesh}{jphgr\_mesh}=1 to 5}] A few simple analytical grids are provided (see below). 
     53\item [{\np{jphgr_mesh}{jphgr\_mesh}=1 to 5}] A few simple analytical grids are provided (see below). 
    6254  For other analytical grids, the \mdl{domhgr} module (\texttt{DOMAINcfg} variant) must be 
    6355  modified by the user. In most cases, modifying the \mdl{usrdef\_hgr} module of \NEMO\ is 
    … …  
    10294(and the number of grid points). 
    10395 
    104 % ------------------------------------------------------------------------------------------------------------- 
    105 %        vertical reference coordinate transformation 
    106 % ------------------------------------------------------------------------------------------------------------- 
    10796\section{Vertical grid} 
    10897\label{sec:DOMCFG_vert} 
    … …  
    111100\label{sec:DOMCFG_zref} 
    112101 
    113 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    114102\begin{figure}[!tb] 
    115103  \centering 
    … …  
    121109  \label{fig:DOMCFG_zgr} 
    122110\end{figure} 
    123 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    124111 
    125112The reference coordinate transformation $z_0(k)$ defines the arrays $gdept_0$ and 
    … …  
    210197999999$., in \nam{cfg}{cfg} namelist, and specifies instead the four following parameters: 
    211198\begin{itemize} 
    212 \item 
    213   \np{ppacr}{ppacr}~$= h_{cr}$: stretching factor (nondimensional). 
     199\item \np{ppacr}{ppacr}~$= h_{cr}$: stretching factor (nondimensional). 
    214200  The larger \np{ppacr}{ppacr}, the smaller the stretching. 
    215201  Values from $3$ to $10$ are usual. 
    216 \item 
    217   \np{ppkth}{ppkth}~$= h_{th}$: is approximately the model level at which maximum stretching occurs 
     202\item \np{ppkth}{ppkth}~$= h_{th}$: is approximately the model level at which maximum stretching occurs 
    218203  (nondimensional, usually of order 1/2 or 2/3 of \jp{jpk}) 
    219 \item 
    220   \np{ppdzmin}{ppdzmin}: minimum thickness for the top layer (in meters). 
    221 \item 
    222   \np{pphmax}{pphmax}: total depth of the ocean (meters). 
     204\item \np{ppdzmin}{ppdzmin}: minimum thickness for the top layer (in meters). 
     205\item \np{pphmax}{pphmax}: total depth of the ocean (meters). 
    223206\end{itemize} 
    224207 
    … …  
    227210\np{pphmax}{pphmax}~$= 5750~m$. 
    228211 
    229 %% %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    230212\begin{table} 
    231213  \centering 
    … …  
    304286\end{table} 
    305287%%%YY 
    306 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    307288%% % ------------------------------------------------------------------------------------------------------------- 
    308289%% %        Meter Bathymetry 
    … …  
    314295\np{nn_bathy}{nn\_bathy} (found in \nam{dom}{dom} namelist (\texttt{DOMAINCFG} variant) ): 
    315296\begin{description} 
    316 \item[{\np[=0]{nn_bathy}{nn\_bathy}}]: 
     297\item [{\np[=0]{nn_bathy}{nn\_bathy}}]: 
    317298  a flat-bottom domain is defined. 
    318299  The total depth $z_w (jpk)$ is given by the coordinate transformation. 
    319300  The domain can either be a closed basin or a periodic channel depending on the parameter \np{jperio}{jperio}. 
    320 \item[{\np[=-1]{nn_bathy}{nn\_bathy}}]: 
     301\item [{\np[=-1]{nn_bathy}{nn\_bathy}}]: 
    321302  a domain with a bump of topography one third of the domain width at the central latitude. 
    322303  This is meant for the "EEL-R5" configuration, a periodic or open boundary channel with a seamount. 
    323 \item[{\np[=1]{nn_bathy}{nn\_bathy}}]: 
     304\item [{\np[=1]{nn_bathy}{nn\_bathy}}]: 
    324305  read a bathymetry and ice shelf draft (if needed). 
    325306  The \ifile{bathy\_meter} file (Netcdf format) provides the ocean depth (positive, in meters) at 
    … …  
    341322After reading the bathymetry, the algorithm for vertical grid definition differs between the different options: 
    342323\begin{description} 
    343 \item[\forcode{ln_zco = .true.}] 
     324\item [\forcode{ln_zco = .true.}] 
    344325  set a reference coordinate transformation $z_0(k)$, and set $z(i,j,k,t) = z_0(k)$ where $z_0(k)$ is the closest match to the depth at $(i,j)$. 
    345 \item[\forcode{ln_zps = .true.}] 
     326\item [\forcode{ln_zps = .true.}] 
    346327  set a reference coordinate transformation $z_0(k)$, and calculate the thickness of the deepest level at 
    347328  each $(i,j)$ point using the bathymetry, to obtain the final three-dimensional depth and scale factor arrays. 
    348 \item[\forcode{ln_sco = .true.}] 
     329\item [\forcode{ln_sco = .true.}] 
    349330  smooth the bathymetry to fulfill the hydrostatic consistency criteria and 
    350331  set the three-dimensional transformation. 
    351 \item[\forcode{s-z and s-zps}] 
     332\item [\forcode{s-z and s-zps}] 
    352333  smooth the bathymetry to fulfill the hydrostatic consistency criteria and 
    353334  set the three-dimensional transformation $z(i,j,k)$, 
    … …  
    356337%%% 
    357338 
    358 % ------------------------------------------------------------------------------------------------------------- 
    359 %        z-coordinate with constant thickness 
    360 % ------------------------------------------------------------------------------------------------------------- 
    361339\subsubsection[$Z$-coordinate with uniform thickness levels (\forcode{ln_zco})]{$Z$-coordinate with uniform thickness levels (\protect\np{ln_zco}{ln\_zco})} 
    362340\label{subsec:DOMCFG_zco} 
    … …  
    368346rarely used in modern simulations but it can be useful for testing purposes. 
    369347 
    370 % ------------------------------------------------------------------------------------------------------------- 
    371 %        z-coordinate with partial step 
    372 % ------------------------------------------------------------------------------------------------------------- 
    373348\subsubsection[$Z$-coordinate with partial step (\forcode{ln_zps})]{$Z$-coordinate with partial step (\protect\np{ln_zps}{ln\_zps})} 
    374349\label{subsec:DOMCFG_zps} 
    … …  
    398373the default thickness $e_{3t}(jk)$). 
    399374 
    400 % ------------------------------------------------------------------------------------------------------------- 
    401 %        s-coordinate 
    402 % ------------------------------------------------------------------------------------------------------------- 
    403375\subsubsection[$S$-coordinate (\forcode{ln_sco})]{$S$-coordinate (\protect\np{ln_sco}{ln\_sco})} 
    404376\label{sec:DOMCFG_sco} 
    … …  
    465437\] 
    466438 
    467 %% %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    468439\begin{figure}[!ht] 
    469440  \centering 
    … …  
    474445  \label{fig:DOMCFG_sco_function} 
    475446\end{figure} 
    476 %% %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    477447 
    478448where $H_c$ is the critical depth (\np{rn_hc}{rn\_hc}) at which the coordinate transitions from pure $\sigma$ to 
    … …  
    516486where the namelist parameters \np{rn_zb_a}{rn\_zb\_a} and \np{rn_zb_b}{rn\_zb\_b} are $a$ and $b$ respectively. 
    517487 
    518 %% %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    519488\begin{figure}[!ht] 
    520489  \centering 
    … …  
    550519and is output as part of the model mesh file at the start of the run. 
    551520 
    552 % ------------------------------------------------------------------------------------------------------------- 
    553 %        z*- or s*-coordinate 
    554 % ------------------------------------------------------------------------------------------------------------- 
    555521\subsubsection[\zstar- or \sstar-coordinate (\forcode{ln_linssh})]{\zstar- or \sstar-coordinate (\protect\np{ln_linssh}{ln\_linssh})} 
    556522\label{subsec:DOMCFG_zgr_star} 
Note: See TracChangeset for help on using the changeset viewer.