Changeset 11543 for NEMO/trunk/doc/latex/NEMO/subfiles/apdx_DOMAINcfg.tex

Timestamp:

2019-09-13T15:57:52+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Implementation of convention for labelling references + files renaming
Now each reference is supposed to have the information of the chapter in its name
to identify quickly which file contains the reference (\label{$prefix:$chap_...)

Rename the appendices from 'annex_' to 'apdx_' to conform with the prefix used in labels (apdx:...)
Suppress the letter numbering

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/apdx_DOMAINcfg.tex (moved) (moved from NEMO/trunk/doc/latex/NEMO/subfiles/annex_DOMAINcfg.tex) (9 diffs)

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

@@ -6 +6 @@
 % ================================================================
 \chapter{A brief guide to the DOMAINcfg tool}
-\label{apdx:DOMAINcfg}
+\label{apdx:DOMCFG}
 
 \chaptertoc
@@ -121 +121 @@
 The reference coordinate transformation $z_0(k)$ defines the arrays $gdept_0$ and
 $gdepw_0$ for $t$- and $w$-points, respectively. See \autoref{sec:DOMCFG_sco} for the
-S-coordinate options.  As indicated on \autoref{fig:index_vert} \jp{jpk} is the number of
+S-coordinate options.  As indicated on \autoref{fig:DOM_index_vert} \jp{jpk} is the number of
 $w$-levels.  $gdepw_0(1)$ is the ocean surface.  There are at most \jp{jpk}-1 $t$-points
 inside the ocean, the additional $t$-point at $jk = jpk$ is below the sea floor and is not
@@ -421 +421 @@
 The depth field $h$ is not necessary the ocean depth,
 since a mixed step-like and bottom-following representation of the topography can be used
-(\autoref{fig:z_zps_s_sps}) or an envelop bathymetry can be defined (\autoref{fig:z_zps_s_sps}).
+(\autoref{fig:DOM_z_zps_s_sps}) or an envelop bathymetry can be defined (\autoref{fig:DOM_z_zps_s_sps}).
 The namelist parameter \np{rn\_rmax} determines the slope at which
 the terrain-following coordinate intersects the sea bed and becomes a pseudo z-coordinate.
@@ -436 +436 @@
 \[
   z = s_{min} + C (s) (H - s_{min})
-  % \label{eq:SH94_1}
+  % \label{eq:DOMCFG_SH94_1}
 \]
 
@@ -458 +458 @@
          + b       \frac{\tanh \lt[ \theta \lt(s + \frac{1}{2} \rt) \rt] -   \tanh \lt( \frac{\theta}{2} \rt)}
                         {                                                  2 \tanh \lt( \frac{\theta}{2} \rt)}
- \label{eq:SH94_2}
+ \label{eq:DOMCFG_SH94_2}
 \]
 
@@ -466 +466 @@
     \includegraphics[width=\textwidth]{Fig_sco_function}
     \caption{
-      \protect\label{fig:sco_function}
+      \protect\label{fig:DOMCFG_sco_function}
       Examples of the stretching function applied to a seamount;
       from left to right: surface, surface and bottom, and bottom intensified resolutions
@@ -478 +478 @@
 bottom control parameters such that $0 \leqslant \theta \leqslant 20$, and $0 \leqslant b \leqslant 1$.
 $b$ has been designed to allow surface and/or bottom increase of the vertical resolution
-(\autoref{fig:sco_function}).
+(\autoref{fig:DOMCFG_sco_function}).
 
 Another example has been provided at version 3.5 (\np{ln\_s\_SF12}) that allows a fixed surface resolution in
@@ -486 +486 @@
 \begin{equation}
   z = - \gamma h \quad \text{with} \quad 0 \leq \gamma \leq 1
-  % \label{eq:z}
+  % \label{eq:DOMCFG_z}
 \end{equation}
 
@@ -524 +524 @@
     For clarity every third coordinate surface is shown.
   }
-  \label{fig:fig_compare_coordinates_surface}
+  \label{fig:DOMCFG_fig_compare_coordinates_surface}
 \end{figure}
  % >>>>>>>>>>>>>>>>>>>>>>>>>>>>