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

Ignore:
Timestamp:
2019-09-17T17:04:06+02:00 (5 years ago)
Author:
nicolasmartin
Message:

Review all figure envs + activation of listoflistings

  1. Figure env:
    • Replace center sub-env with only \centering cmd
    • Add alternate caption for \listoffigures (shorter one between square brackets, i.e. \caption[]{})
    • Place \label outside of \caption and remove useless \protect
  1. Namelist listings
    • Put \nlst with the namelist inlcusion in a listing float env with caption and label
    • Remove namelist duplicates

-- This line, and those below, will be ignored--
M subfiles/apdx_triads.tex
M subfiles/chap_model_basics_zstar.tex
M subfiles/chap_SBC.tex
M subfiles/apdx_DOMAINcfg.tex
M subfiles/apdx_s_coord.tex
M subfiles/chap_DOM.tex
M subfiles/chap_ASM.tex
M subfiles/chap_DIU.tex
M subfiles/chap_cfgs.tex
M subfiles/chap_ZDF.tex
M subfiles/chap_OBS.tex
M subfiles/chap_model_basics.tex
M subfiles/chap_time_domain.tex
M subfiles/apdx_algos.tex
M subfiles/chap_TRA.tex
M subfiles/chap_DYN.tex
M subfiles/chap_misc.tex
M subfiles/chap_DIA.tex
M subfiles/apdx_invariants.tex
M subfiles/chap_LBC.tex
M subfiles/apdx_diff_opers.tex
M subfiles/chap_STO.tex
M subfiles/chap_LDF.tex

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r11552 r11558  
    88\label{chap:DOM} 
    99 
    10 %\chaptertoc 
     10\chaptertoc 
    1111 
    1212% Missing things: 
    … …  
    5757%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    5858\begin{figure}[!tb] 
    59   \begin{center} 
    60     \includegraphics[width=\textwidth]{Fig_cell} 
    61     \caption{ 
    62       \protect\label{fig:DOM_cell} 
    63       Arrangement of variables. 
    64       $t$ indicates scalar points where temperature, salinity, density, pressure and 
    65       horizontal divergence are defined. 
    66       $(u,v,w)$ indicates vector points, and $f$ indicates vorticity points where both relative and 
    67       planetary vorticities are defined. 
    68     } 
    69   \end{center} 
     59  \centering 
     60  \includegraphics[width=\textwidth]{Fig_cell} 
     61  \caption[Arrangement of variables in the unit cell of space domain]{ 
     62    Arrangement of variables in the unit cell of space domain. 
     63    $t$ indicates scalar points where 
     64    temperature, salinity, density, pressure and horizontal divergence are defined. 
     65    $(u,v,w)$ indicates vector points, 
     66    and $f$ indicates vorticity points where 
     67    both relative and planetary vorticities are defined.} 
     68  \label{fig:DOM_cell} 
    7069\end{figure} 
    7170%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    102101%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    103102\begin{table}[!tb] 
    104   \begin{center} 
    105     \begin{tabular}{|p{46pt}|p{56pt}|p{56pt}|p{56pt}|} 
    106       \hline 
    107       t  & $i      $ & $j      $ & $k      $ \\ 
    108       \hline 
    109       u  & $i + 1/2$ & $j      $ & $k      $ \\ 
    110       \hline 
    111       v  & $i      $ & $j + 1/2$ & $k      $ \\ 
    112       \hline 
    113       w  & $i      $ & $j      $ & $k + 1/2$ \\ 
    114       \hline 
    115       f  & $i + 1/2$ & $j + 1/2$ & $k      $ \\ 
    116       \hline 
    117       uw & $i + 1/2$ & $j      $ & $k + 1/2$ \\ 
    118       \hline 
    119       vw & $i      $ & $j + 1/2$ & $k + 1/2$ \\ 
    120       \hline 
    121       fw & $i + 1/2$ & $j + 1/2$ & $k + 1/2$ \\ 
    122       \hline 
    123     \end{tabular} 
    124     \caption{ 
    125       \protect\label{tab:DOM_cell} 
    126       Location of grid-points as a function of integer or integer and a half value of the column, line or level. 
    127       This indexing is only used for the writing of the semi -discrete equations. 
    128       In the code, the indexing uses integer values only and is positive downwards in the vertical with $k=1$ at the surface. 
    129       (see \autoref{subsec:DOM_Num_Index}) 
    130     } 
    131   \end{center} 
     103  \centering 
     104  \begin{tabular}{|p{46pt}|p{56pt}|p{56pt}|p{56pt}|} 
     105    \hline 
     106    t & $i      $ & $j      $ & $k      $ \\ 
     107    \hline 
     108    u & $i + 1/2$ & $j      $ & $k      $ \\ 
     109    \hline 
     110    v & $i      $ & $j + 1/2$ & $k      $ \\ 
     111    \hline 
     112    w & $i      $ & $j      $ & $k + 1/2$ \\ 
     113    \hline 
     114    f & $i + 1/2$ & $j + 1/2$ & $k      $ \\ 
     115    \hline 
     116    uw   & $i + 1/2$ & $j      $ & $k + 1/2$ \\ 
     117    \hline 
     118    vw   & $i      $ & $j + 1/2$ & $k + 1/2$ \\ 
     119    \hline 
     120    fw   & $i + 1/2$ & $j + 1/2$ & $k + 1/2$ \\ 
     121    \hline 
     122  \end{tabular} 
     123  \caption[Location of grid-points]{ 
     124    Location of grid-points as a function of integer or 
     125    integer and a half value of the column, line or level. 
     126    This indexing is only used for the writing of the semi -discrete equations. 
     127    In the code, the indexing uses integer values only and 
     128    is positive downwards in the vertical with $k=1$ at the surface. 
     129    (see \autoref{subsec:DOM_Num_Index})} 
     130  \label{tab:DOM_cell} 
    132131\end{table} 
    133132%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    148147%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    149148\begin{figure}[!t] 
    150   \begin{center} 
    151     \includegraphics[width=\textwidth]{Fig_zgr_e3} 
    152     \caption{ 
    153       \protect\label{fig:DOM_zgr_e3} 
    154       Comparison of (a) traditional definitions of grid-point position and grid-size in the vertical, 
    155       and (b) analytically derived grid-point position and scale factors. 
    156       For both grids here, the same $w$-point depth has been chosen but 
    157       in (a) the $t$-points are set half way between $w$-points while 
    158       in (b) they are defined from an analytical function: 
    159       $z(k) = 5 \, (k - 1/2)^3 - 45 \, (k - 1/2)^2 + 140 \, (k - 1/2) - 150$. 
    160       Note the resulting difference between the value of the grid-size $\Delta_k$ and 
    161       those of the scale factor $e_k$. 
    162     } 
    163   \end{center} 
     149  \centering 
     150  \includegraphics[width=\textwidth]{Fig_zgr_e3} 
     151  \caption[Comparison of grid-point position, vertical grid-size and scale factors]{ 
     152    Comparison of (a) traditional definitions of grid-point position and grid-size in the vertical, 
     153    and (b) analytically derived grid-point position and scale factors. 
     154    For both grids here, the same $w$-point depth has been chosen but 
     155    in (a) the $t$-points are set half way between $w$-points while 
     156    in (b) they are defined from an analytical function: 
     157    $z(k) = 5 \, (k - 1/2)^3 - 45 \, (k - 1/2)^2 + 140 \, (k - 1/2) - 150$. 
     158    Note the resulting difference between the value of the grid-size $\Delta_k$ and 
     159    those of the scale factor $e_k$.} 
     160  \label{fig:DOM_zgr_e3} 
    164161\end{figure} 
    165162%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    266263%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    267264\begin{figure}[!tb] 
    268   \begin{center} 
    269     \includegraphics[width=\textwidth]{Fig_index_hor} 
    270     \caption{ 
    271       \protect\label{fig:DOM_index_hor} 
    272       Horizontal integer indexing used in the \fortran\ code. 
    273       The dashed area indicates the cell in which variables contained in arrays have the same $i$- and $j$-indices 
    274     } 
    275   \end{center} 
     265  \centering 
     266  \includegraphics[width=\textwidth]{Fig_index_hor} 
     267  \caption[Horizontal integer indexing]{ 
     268    Horizontal integer indexing used in the \fortran\ code. 
     269    The dashed area indicates the cell in which 
     270    variables contained in arrays have the same $i$- and $j$-indices} 
     271  \label{fig:DOM_index_hor} 
    276272\end{figure} 
    277273%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    321317%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    322318\begin{figure}[!pt] 
    323   \begin{center} 
    324     \includegraphics[width=\textwidth]{Fig_index_vert} 
    325     \caption{ 
    326       \protect\label{fig:DOM_index_vert} 
    327       Vertical integer indexing used in the \fortran\ code. 
    328       Note that the $k$-axis is oriented downward. 
    329       The dashed area indicates the cell in which variables contained in arrays have a common $k$-index. 
    330     } 
    331   \end{center} 
     319  \centering 
     320  \includegraphics[width=\textwidth]{Fig_index_vert} 
     321  \caption[Vertical integer indexing]{ 
     322    Vertical integer indexing used in the \fortran\ code. 
     323    Note that the $k$-axis is oriented downward. 
     324    The dashed area indicates the cell in which 
     325    variables contained in arrays have a common $k$-index.} 
     326  \label{fig:DOM_index_vert} 
    332327\end{figure} 
    333328%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    338333\section{Spatial domain configuration} 
    339334\label{subsec:DOM_config} 
    340  
    341 \nlst{namcfg} 
    342335 
    343336Two typical methods are available to specify the spatial domain configuration; 
    … …  
    468461\label{subsec:DOM_zgr} 
    469462%-----------------------------------------namdom------------------------------------------- 
    470 \nlst{namdom} 
     463\begin{listing} 
     464  \nlst{namdom} 
     465  \caption{\texttt{namdom}} 
     466  \label{lst:namdom} 
     467\end{listing} 
    471468%------------------------------------------------------------------------------------------------------------- 
    472469 
    … …  
    482479%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    483480\begin{figure}[!tb] 
    484   \begin{center} 
    485     \includegraphics[width=\textwidth]{Fig_z_zps_s_sps} 
    486     \caption{ 
    487       \protect\label{fig:DOM_z_zps_s_sps} 
    488       The ocean bottom as seen by the model: 
    489       (a) $z$-coordinate with full step, 
    490       (b) $z$-coordinate with partial step, 
    491       (c) $s$-coordinate: terrain following representation, 
    492       (d) hybrid $s-z$ coordinate, 
    493       (e) hybrid $s-z$ coordinate with partial step, and 
    494       (f) same as (e) but in the non-linear free surface (\protect\np{ln\_linssh}\forcode{=.false.}). 
    495       Note that the non-linear free surface can be used with any of the 5 coordinates (a) to (e). 
    496     } 
    497   \end{center} 
     481  \centering 
     482  \includegraphics[width=\textwidth]{Fig_z_zps_s_sps} 
     483  \caption[Ocean bottom regarding coordinate systems ($z$, $s$ and hybrid $s-z$)]{ 
     484    The ocean bottom as seen by the model: 
     485    (a) $z$-coordinate with full step, 
     486    (b) $z$-coordinate with partial step, 
     487    (c) $s$-coordinate: terrain following representation, 
     488    (d) hybrid $s-z$ coordinate, 
     489    (e) hybrid $s-z$ coordinate with partial step, and 
     490    (f) same as (e) but in the non-linear free surface (\protect\np{ln\_linssh}\forcode{=.false.}). 
     491    Note that the non-linear free surface can be used with any of the 5 coordinates (a) to (e).} 
     492  \label{fig:DOM_z_zps_s_sps} 
    498493\end{figure} 
    499494%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    654649\label{subsec:DOM_meshmask} 
    655650 
    656 \nlst{namcfg} 
    657  
    658651Most of the arrays relating to a particular ocean model configuration discussed in this chapter 
    659652(grid-point position, scale factors) 
    … …  
    665658checking or confirmation is required. 
    666659 
    667 \nlst{namdom} 
    668  
    669660Alternatively, all the arrays relating to a particular ocean model configuration 
    670661(grid-point position, scale factors, depths and masks) 
    … …  
    680671\label{sec:DOM_DTA_tsd} 
    681672%-----------------------------------------namtsd------------------------------------------- 
    682 \nlst{namtsd} 
     673\begin{listing} 
     674  \nlst{namtsd} 
     675  \caption{\texttt{namtsd}} 
     676  \label{lst:namtsd} 
     677\end{listing} 
    683678%------------------------------------------------------------------------------------------ 
    684679 
Note: See TracChangeset for help on using the changeset viewer.