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_SBC.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_SBC.tex

    r11551 r11558  
    1414%---------------------------------------namsbc-------------------------------------------------- 
    1515 
    16 \nlst{namsbc} 
     16\begin{listing} 
     17  \nlst{namsbc} 
     18  \caption{\texttt{namsbc}} 
     19  \label{lst:namsbc} 
     20\end{listing} 
    1721%-------------------------------------------------------------------------------------------------------------- 
    1822 
    … …  
    183187%-------------------------------------------------TABLE--------------------------------------------------- 
    184188\begin{table}[tb] 
    185   \begin{center} 
    186     \begin{tabular}{|l|l|l|l|} 
    187       \hline 
    188       Variable description                         & Model variable  & Units  & point                 \\\hline 
    189       i-component of the surface current  & ssu\_m               & $m.s^{-1}$     & U     \\\hline 
    190       j-component of the surface current  & ssv\_m               & $m.s^{-1}$     & V     \\ \hline 
    191       Sea surface temperature                & sst\_m               & \r{}$K$              & T     \\\hline 
    192       Sea surface salinty                          & sss\_m               & $psu$              & T     \\   \hline 
    193     \end{tabular} 
    194     \caption{ 
    195       \protect\label{tab:SBC_ssm} 
    196       Ocean variables provided by the ocean to the surface module (SBC). 
    197       The variable are averaged over \np{nn\_fsbc} time-step, 
    198       \ie\ the frequency of computation of surface fluxes. 
    199     } 
    200   \end{center} 
     189  \centering 
     190  \begin{tabular}{|l|l|l|l|} 
     191    \hline 
     192    Variable description                           & Model variable  & Units  & point                 \\ 
     193    \hline 
     194    i-component of the surface current & ssu\_m               & $m.s^{-1}$     & U     \\ 
     195    \hline 
     196    j-component of the surface current & ssv\_m               & $m.s^{-1}$     & V     \\ 
     197    \hline 
     198    Sea surface temperature                  & sst\_m               & \r{}$K$              & T     \\\hline 
     199    Sea surface salinty                         & sss\_m               & $psu$              & T     \\   \hline 
     200  \end{tabular} 
     201  \caption[Ocean variables provided to the surface module)]{ 
     202    Ocean variables provided to the surface module (\texttt{SBC}). 
     203    The variable are averaged over \protect\np{nn\_fsbc} time-step, 
     204    \ie\ the frequency of computation of surface fluxes.} 
     205  \label{tab:SBC_ssm} 
    201206\end{table} 
    202207%-------------------------------------------------------------------------------------------------------------- 
    … …  
    269274%--------------------------------------------------TABLE-------------------------------------------------- 
    270275  \begin{table}[htbp] 
    271     \begin{center} 
    272       \begin{tabular}{|l|c|c|c|} 
    273         \hline 
    274                                         &  daily or weekLL     &  monthly           &  yearly        \\   \hline 
    275         \np{clim}\forcode{=.false.} &  fn\_yYYYYmMMdDD.nc  &  fn\_yYYYYmMM.nc   &  fn\_yYYYY.nc  \\   \hline 
    276         \np{clim}\forcode{=.true.}  &  not possible        &  fn\_m??.nc        &  fn            \\   \hline 
    277       \end{tabular} 
    278     \end{center} 
    279     \caption{ 
    280       \protect\label{tab:SBC_fldread} 
    281       naming nomenclature for climatological or interannual input file(s), as a function of the open/close frequency. 
     276    \centering 
     277    \begin{tabular}{|l|c|c|c|} 
     278      \hline 
     279                                  &  daily or weekLL     &  monthly           &  yearly        \\ 
     280      \hline 
     281      \np{clim}\forcode{=.false.} &  fn\_yYYYYmMMdDD.nc  &  fn\_yYYYYmMM.nc   &  fn\_yYYYY.nc  \\ 
     282      \hline 
     283      \np{clim}\forcode{=.true.}  &  not possible        &  fn\_m??.nc        &  fn            \\ 
     284      \hline 
     285    \end{tabular} 
     286    \caption[Naming nomenclature for climatological or interannual input file]{ 
     287      Naming nomenclature for climatological or interannual input file, 
     288      as a function of the open/close frequency. 
    282289      The stem name is assumed to be 'fn'. 
    283290      For weekly files, the 'LLL' corresponds to the first three letters of the first day of the week 
    284291      (\ie\ 'sun','sat','fri','thu','wed','tue','mon'). 
    285       The 'YYYY', 'MM' and 'DD' should be replaced by the actual year/month/day, always coded with 4 or 2 digits. 
    286       Note that (1) in mpp, if the file is split over each subdomain, the suffix '.nc' is replaced by '\_PPPP.nc', 
     292      The 'YYYY', 'MM' and 'DD' should be replaced by the actual year/month/day, 
     293      always coded with 4 or 2 digits. 
     294      Note that (1) in mpp, if the file is split over each subdomain, 
     295      the suffix '.nc' is replaced by '\_PPPP.nc', 
    287296      where 'PPPP' is the process number coded with 4 digits; 
    288297      (2) when using AGRIF, the prefix '\_N' is added to files, where 'N' is the child grid number. 
    289298    } 
     299    \label{tab:SBC_fldread} 
    290300  \end{table} 
    291301%-------------------------------------------------------------------------------------------------------------- 
    … …  
    519529%---------------------------------------namsbc_sas-------------------------------------------------- 
    520530 
    521 \nlst{namsbc_sas} 
     531\begin{listing} 
     532  \nlst{namsbc_sas} 
     533  \caption{\texttt{namsbc\_sas}} 
     534  \label{lst:namsbc_sas} 
     535\end{listing} 
    522536%-------------------------------------------------------------------------------------------------------------- 
    523537 
    … …  
    604618%------------------------------------------namsbc_flx---------------------------------------------------- 
    605619 
    606 \nlst{namsbc_flx} 
     620\begin{listing} 
     621  \nlst{namsbc_flx} 
     622  \caption{\texttt{namsbc\_flx}} 
     623  \label{lst:namsbc_flx} 
     624\end{listing} 
    607625%------------------------------------------------------------------------------------------------------------- 
    608626 
    … …  
    627645%---------------------------------------namsbc_blk-------------------------------------------------- 
    628646 
    629 \nlst{namsbc_blk} 
     647\begin{listing} 
     648  \nlst{namsbc_blk} 
     649  \caption{\texttt{namsbc\_blk}} 
     650  \label{lst:namsbc_blk} 
     651\end{listing} 
    630652%-------------------------------------------------------------------------------------------------------------- 
    631653 
    … …  
    649671%--------------------------------------------------TABLE-------------------------------------------------- 
    650672\begin{table}[htbp] 
     673  \centering 
     674  \begin{tabular}{|l|c|c|c|} 
     675    \hline 
     676    Variable description                 & Model variable & Units              & point \\ 
     677    \hline 
     678    i-component of the 10m air velocity  & utau           & $m.s^{-1}$         & T     \\ 
     679    \hline 
     680    j-component of the 10m air velocity  & vtau           & $m.s^{-1}$         & T     \\ 
     681    \hline 
     682    10m air temperature                  & tair           & \r{}$K$            & T     \\ 
     683    \hline 
     684    Specific humidity                    & humi           & \%                 & T     \\ 
     685    \hline 
     686    Incoming long wave radiation         & qlw            & $W.m^{-2}$         & T     \\ 
     687    \hline 
     688    Incoming short wave radiation        & qsr            & $W.m^{-2}$         & T     \\ 
     689    \hline 
     690    Total precipitation (liquid + solid) & precip         & $Kg.m^{-2}.s^{-1}$ & T     \\ 
     691    \hline 
     692    Solid precipitation                  & snow           & $Kg.m^{-2}.s^{-1}$ & T     \\ 
     693    \hline 
     694    Mean sea-level pressure              & slp            & $hPa$              & T     \\ 
     695    \hline 
     696    \end{tabular} 
    651697  \label{tab:SBC_BULK} 
    652   \begin{center} 
    653     \begin{tabular}{|l|c|c|c|} 
    654       \hline 
    655       Variable description                           & Model variable   & Units                         & point \\   \hline 
    656       i-component of the 10m air velocity   & utau                   & $m.s^{-1}$                   & T         \\   \hline 
    657       j-component of the 10m air velocity   & vtau                & $m.s^{-1}$                   & T         \\   \hline 
    658       10m air temperature                      & tair                & \r{}$K$                        & T       \\   \hline 
    659       Specific humidity                        & humi           & \%                             & T      \\   \hline 
    660       Incoming long wave radiation          & qlw                & $W.m^{-2}$            & T        \\   \hline 
    661       Incoming short wave radiation          & qsr               & $W.m^{-2}$            & T        \\   \hline 
    662       Total precipitation (liquid + solid)         & precip            & $Kg.m^{-2}.s^{-1}$      & T      \\   \hline 
    663       Solid precipitation                           & snow               & $Kg.m^{-2}.s^{-1}$       & T      \\   \hline 
    664       Mean sea-level pressure                     & slp                     & $hPa$                          & T       \\ \hline 
    665     \end{tabular} 
    666   \end{center} 
    667698\end{table} 
    668699%-------------------------------------------------------------------------------------------------------------- 
    … …  
    768799%------------------------------------------namsbc_cpl---------------------------------------------------- 
    769800 
    770 \nlst{namsbc_cpl} 
     801\begin{listing} 
     802  \nlst{namsbc_cpl} 
     803  \caption{\texttt{namsbc\_cpl}} 
     804  \label{lst:namsbc_cpl} 
     805\end{listing} 
    771806%------------------------------------------------------------------------------------------------------------- 
    772807 
    … …  
    807842%------------------------------------------namsbc_apr---------------------------------------------------- 
    808843 
    809 \nlst{namsbc_apr} 
     844\begin{listing} 
     845  \nlst{namsbc_apr} 
     846  \caption{\texttt{namsbc\_apr}} 
     847  \label{lst:namsbc_apr} 
     848\end{listing} 
    810849%------------------------------------------------------------------------------------------------------------- 
    811850 
    … …  
    847886%------------------------------------------nam_tide--------------------------------------- 
    848887 
    849 \nlst{nam_tide} 
     888\begin{listing} 
     889  \nlst{nam_tide} 
     890  \caption{\texttt{nam\_tide}} 
     891  \label{lst:nam_tide} 
     892\end{listing} 
    850893%----------------------------------------------------------------------------------------- 
    851894 
    … …  
    899942%------------------------------------------namsbc_rnf---------------------------------------------------- 
    900943 
    901 \nlst{namsbc_rnf} 
     944\begin{listing} 
     945  \nlst{namsbc_rnf} 
     946  \caption{\texttt{namsbc\_rnf}} 
     947  \label{lst:namsbc_rnf} 
     948\end{listing} 
    902949%------------------------------------------------------------------------------------------------------------- 
    903950 
    … …  
    10251072%------------------------------------------namsbc_isf---------------------------------------------------- 
    10261073 
    1027 \nlst{namsbc_isf} 
     1074\begin{listing} 
     1075  \nlst{namsbc_isf} 
     1076  \caption{\texttt{namsbc\_isf}} 
     1077  \label{lst:namsbc_isf} 
     1078\end{listing} 
    10281079%-------------------------------------------------------------------------------------------------------- 
    10291080 
    … …  
    11261177%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    11271178\begin{figure}[!t] 
    1128   \begin{center} 
    1129     \includegraphics[width=\textwidth]{Fig_SBC_isf} 
    1130     \caption{ 
    1131       \protect\label{fig:SBC_isf} 
    1132       Illustration the location where the fwf is injected and whether or not the fwf is interactif or not depending of \np{nn\_isf}. 
    1133     } 
    1134   \end{center} 
     1179  \centering 
     1180  \includegraphics[width=\textwidth]{Fig_SBC_isf} 
     1181  \caption[Ice shelf location and fresh water flux definition]{ 
     1182    Illustration of the location where the fwf is injected and 
     1183    whether or not the fwf is interactif or not depending of \protect\np{nn\_isf}.} 
     1184  \label{fig:SBC_isf} 
    11351185\end{figure} 
    11361186%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    11451195%------------------------------------------namsbc_iscpl---------------------------------------------------- 
    11461196 
    1147 \nlst{namsbc_iscpl} 
     1197\begin{listing} 
     1198  \nlst{namsbc_iscpl} 
     1199  \caption{\texttt{namsbc\_iscpl}} 
     1200  \label{lst:namsbc_iscpl} 
     1201\end{listing} 
    11481202%-------------------------------------------------------------------------------------------------------- 
    11491203 
    … …  
    12101264%------------------------------------------namberg---------------------------------------------------- 
    12111265 
    1212 \nlst{namberg} 
     1266\begin{listing} 
     1267  \nlst{namberg} 
     1268  \caption{\texttt{namberg}} 
     1269  \label{lst:namberg} 
     1270\end{listing} 
    12131271%------------------------------------------------------------------------------------------------------------- 
    12141272 
    … …  
    12801338%------------------------------------------namsbc_wave-------------------------------------------------------- 
    12811339 
    1282 \nlst{namsbc_wave} 
     1340\begin{listing} 
     1341  \nlst{namsbc_wave} 
     1342  \caption{\texttt{namsbc\_wave}} 
     1343  \label{lst:namsbc_wave} 
     1344\end{listing} 
    12831345%------------------------------------------------------------------------------------------------------------- 
    12841346 
    … …  
    14831545%------------------------------------------namsbc------------------------------------------------------------- 
    14841546% 
    1485 \nlst{namsbc} 
     1547 
    14861548%------------------------------------------------------------------------------------------------------------- 
    14871549 
    14881550%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    14891551\begin{figure}[!t] 
    1490   \begin{center} 
    1491     \includegraphics[width=\textwidth]{Fig_SBC_diurnal} 
    1492     \caption{ 
    1493       \protect\label{fig:SBC_diurnal} 
    1494       Example of recontruction of the diurnal cycle variation of short wave flux from daily mean values. 
    1495       The reconstructed diurnal cycle (black line) is chosen as 
    1496       the mean value of the analytical cycle (blue line) over a time step, 
    1497       not as the mid time step value of the analytically cycle (red square). 
    1498       From \citet{bernie.guilyardi.ea_CD07}. 
    1499     } 
    1500   \end{center} 
     1552  \centering 
     1553  \includegraphics[width=\textwidth]{Fig_SBC_diurnal} 
     1554  \caption[Reconstruction of the diurnal cycle variation of short wave flux]{ 
     1555    Example of reconstruction of the diurnal cycle variation of short wave flux from 
     1556    daily mean values. 
     1557    The reconstructed diurnal cycle (black line) is chosen as 
     1558    the mean value of the analytical cycle (blue line) over a time step, 
     1559    not as the mid time step value of the analytically cycle (red square). 
     1560    From \citet{bernie.guilyardi.ea_CD07}.} 
     1561  \label{fig:SBC_diurnal} 
    15011562\end{figure} 
    15021563%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    15251586%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    15261587\begin{figure}[!t] 
    1527   \begin{center} 
    1528     \includegraphics[width=\textwidth]{Fig_SBC_dcy} 
    1529     \caption{ 
    1530       \protect\label{fig:SBC_dcy} 
    1531       Example of recontruction of the diurnal cycle variation of short wave flux from 
    1532       daily mean values on an ORCA2 grid with a time sampling of 2~hours (from 1am to 11pm). 
    1533       The display is on (i,j) plane. 
    1534     } 
    1535   \end{center} 
     1588  \centering 
     1589  \includegraphics[width=\textwidth]{Fig_SBC_dcy} 
     1590  \caption[Reconstruction of the diurnal cycle variation of short wave flux on an ORCA2 grid]{ 
     1591    Example of reconstruction of the diurnal cycle variation of short wave flux from 
     1592    daily mean values on an ORCA2 grid with a time sampling of 2~hours (from 1am to 11pm). 
     1593    The display is on (i,j) plane.} 
     1594  \label{fig:SBC_dcy} 
    15361595\end{figure} 
    15371596%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    … …  
    15691628%------------------------------------------namsbc_ssr---------------------------------------------------- 
    15701629 
    1571 \nlst{namsbc_ssr} 
     1630\begin{listing} 
     1631  \nlst{namsbc_ssr} 
     1632  \caption{\texttt{namsbc\_ssr}} 
     1633  \label{lst:namsbc_ssr} 
     1634\end{listing} 
    15721635%------------------------------------------------------------------------------------------------------------- 
    15731636 
Note: See TracChangeset for help on using the changeset viewer.