Changeset 11598 for NEMO/trunk/doc/latex/NEMO/subfiles/chap_SBC.tex

Timestamp:

2019-09-25T22:00:42+02:00 (5 years ago)

Author:

nicolasmartin

Message:

Add template of versioning record at the beginning of chapters

File:

• NEMO/trunk/doc/latex/NEMO/subfiles/chap_SBC.tex (modified) (30 diffs)

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

@@ -6 +6 @@
 \label{chap:SBC}
 
+\thispagestyle{plain}
+
 \chaptertoc
 
+\paragraph{Changes record} ~\\
+
+{\footnotesize
+  \begin{tabularx}{\textwidth}{l||X|X}
+    Release & Author(s) & Modifications \\
+    \hline
+    {\em   4.0} & {\em ...} & {\em ...} \\
+    {\em   3.6} & {\em ...} & {\em ...} \\
+    {\em   3.4} & {\em ...} & {\em ...} \\
+    {\em <=3.4} & {\em ...} & {\em ...}
+  \end{tabularx}
+}
+
+\clearpage
 
 \begin{listing}
@@ -212 +228 @@
 where
 \begin{description}
-\item [File name]:
-  the stem name of the NetCDF file to be opened.
+\item [File name]: the stem name of the NetCDF file to be opened.
   This stem will be completed automatically by the model, with the addition of a '.nc' at its end and
   by date information and possibly a prefix (when using AGRIF).
   \autoref{tab:SBC_fldread} provides the resulting file name in all possible cases according to
   whether it is a climatological file or not, and to the open/close frequency (see below for definition).
-
   \begin{table}[htbp]
     \centering
@@ -245 +259 @@
     \label{tab:SBC_fldread}
   \end{table}
-
-\item [Record frequency]:
-  the frequency of the records contained in the input file.
+\item [Record frequency]: the frequency of the records contained in the input file.
   Its unit is in hours if it is positive (for example 24 for daily forcing) or in months if negative
   (for example -1 for monthly forcing or -12 for annual forcing).
   Note that this frequency must REALLY be an integer and not a real.
   On some computers, setting it to '24.' can be interpreted as 240!
-
-\item [Variable name]:
-  the name of the variable to be read in the input NetCDF file.
-
-\item [Time interpolation]:
-  a logical to activate, or not, the time interpolation.
+\item [Variable name]: the name of the variable to be read in the input NetCDF file.
+\item [Time interpolation]: a logical to activate, or not, the time interpolation.
   If set to 'false', the forcing will have a steplike shape remaining constant during each forcing period.
   For example, when using a daily forcing without time interpolation, the forcing remaining constant from
@@ -265 +273 @@
   For example, when using a daily forcing with time interpolation,
   linear interpolation will be performed between mid-day of two consecutive days.
-
-\item [Climatological forcing]:
-  a logical to specify if a input file contains climatological forcing which can be cycle in time,
+\item [Climatological forcing]: a logical to specify if a input file contains climatological forcing which can be cycle in time,
   or an interannual forcing which will requires additional files if
   the period covered by the simulation exceeds the one of the file.
   See the above file naming strategy which impacts the expected name of the file to be opened.
-
-\item [Open/close frequency]:
-  the frequency at which forcing files must be opened/closed.
+\item [Open/close frequency]: the frequency at which forcing files must be opened/closed.
   Four cases are coded:
   'daily', 'weekLLL' (with 'LLL' the first 3 letters of the first day of the week), 'monthly' and 'yearly' which
@@ -280 +284 @@
   For example, the first record of a yearly file containing daily data is Jan 1st even if
   the experiment is not starting at the beginning of the year.
-
-\item [Others]:
-  'weights filename', 'pairing rotation' and 'land/sea mask' are associated with
+\item [Others]:  'weights filename', 'pairing rotation' and 'land/sea mask' are associated with
   on-the-fly interpolation which is described in \autoref{subsec:SBC_iof}.
-
 \end{description}
 
@@ -449 +450 @@
 \label{subsec:SBC_SAS}
 
-
 \begin{listing}
   \nlst{namsbc_sas}
@@ -477 +477 @@
 
 \begin{itemize}
-\item \mdl{nemogcm}:
-  This routine initialises the rest of the model and repeatedly calls the stp time stepping routine (\mdl{step}).
+\item \mdl{nemogcm}: This routine initialises the rest of the model and repeatedly calls the stp time stepping routine (\mdl{step}).
   Since the ocean state is not calculated all associated initialisations have been removed.
-\item \mdl{step}:
-  The main time stepping routine now only needs to call the sbc routine (and a few utility functions).
-\item \mdl{sbcmod}:
-  This has been cut down and now only calculates surface forcing and the ice model required.
+\item \mdl{step}: The main time stepping routine now only needs to call the sbc routine (and a few utility functions).
+\item \mdl{sbcmod}: This has been cut down and now only calculates surface forcing and the ice model required.
   New surface modules that can function when only the surface level of the ocean state is defined can also be added
   (\eg\ icebergs).
-\item \mdl{daymod}:
-  No ocean restarts are read or written (though the ice model restarts are retained),
+\item \mdl{daymod}: No ocean restarts are read or written (though the ice model restarts are retained),
   so calls to restart functions have been removed.
   This also means that the calendar cannot be controlled by time in a restart file,
   so the user must check that nn\_date0 in the model namelist is correct for his or her purposes.
-\item \mdl{stpctl}:
-  Since there is no free surface solver, references to it have been removed from \rou{stp\_ctl} module.
-\item \mdl{diawri}:
-  All 3D data have been removed from the output.
+\item \mdl{stpctl}: Since there is no free surface solver, references to it have been removed from \rou{stp\_ctl} module.
+\item \mdl{diawri}: All 3D data have been removed from the output.
   The surface temperature, salinity and velocity components (which have been read in) are written along with
   relevant forcing and ice data.
@@ -502 +496 @@
 
 \begin{itemize}
-\item \mdl{sbcsas}:
-  This module initialises the input files needed for reading temperature, salinity and
+\item \mdl{sbcsas}: This module initialises the input files needed for reading temperature, salinity and
   velocity arrays at the surface.
   These filenames are supplied in namelist namsbc\_sas.
@@ -621 +614 @@
 their neutral transfer coefficients relationships with neutral wind.
 \begin{itemize}
-\item NCAR (\np[=.true.]{ln_NCAR}{ln\_NCAR}):
-  The NCAR bulk formulae have been developed by \citet{large.yeager_rpt04}.
+\item NCAR (\np[=.true.]{ln_NCAR}{ln\_NCAR}): The NCAR bulk formulae have been developed by \citet{large.yeager_rpt04}.
   They have been designed to handle the NCAR forcing, a mixture of NCEP reanalysis and satellite data.
   They use an inertial dissipative method to compute the turbulent transfer coefficients
@@ -630 +622 @@
   Note that substituting ERA40 to NCEP reanalysis fields does not require changes in the bulk formulea themself.
   This is the so-called DRAKKAR Forcing Set (DFS) \citep{brodeau.barnier.ea_OM10}.
-\item COARE 3.0 (\np[=.true.]{ln_COARE_3p0}{ln\_COARE\_3p0}):
-  See \citet{fairall.bradley.ea_JC03} for more details
-\item COARE 3.5 (\np[=.true.]{ln_COARE_3p5}{ln\_COARE\_3p5}):
-  See \citet{edson.jampana.ea_JPO13} for more details
-\item ECMWF (\np[=.true.]{ln_ECMWF}{ln\_ECMWF}):
-  Based on \href{https://www.ecmwf.int/node/9221}{IFS (Cy31)} implementation and documentation.
+\item COARE 3.0 (\np[=.true.]{ln_COARE_3p0}{ln\_COARE\_3p0}): See \citet{fairall.bradley.ea_JC03} for more details
+\item COARE 3.5 (\np[=.true.]{ln_COARE_3p5}{ln\_COARE\_3p5}): See \citet{edson.jampana.ea_JPO13} for more details
+\item ECMWF (\np[=.true.]{ln_ECMWF}{ln\_ECMWF}): Based on \href{https://www.ecmwf.int/node/9221}{IFS (Cy31)} implementation and documentation.
   Surface roughness lengths needed for the Obukhov length are computed following \citet{beljaars_QJRMS95}.
 \end{itemize}
@@ -741 +730 @@
 \label{sec:SBC_tide}
 
-
 \begin{listing}
   \nlst{nam_tide}
@@ -924 +912 @@
 
 \begin{description}
-
-  \item [{\np[=1]{nn_isf}{nn\_isf}}]:
-  The ice shelf cavity is represented (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
+  \item [{\np[=1]{nn_isf}{nn\_isf}}]: The ice shelf cavity is represented (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
   The fwf and heat flux are depending of the local water properties.
 
@@ -932 +918 @@
 
    \begin{description}
-   \item [{\np[=1]{nn_isfblk}{nn\_isfblk}}]:
-     The melt rate is based on a balance between the upward ocean heat flux and
+   \item [{\np[=1]{nn_isfblk}{nn\_isfblk}}]: The melt rate is based on a balance between the upward ocean heat flux and
      the latent heat flux at the ice shelf base. A complete description is available in \citet{hunter_rpt06}.
-   \item [{\np[=2]{nn_isfblk}{nn\_isfblk}}]:
-     The melt rate and the heat flux are based on a 3 equations formulation
+   \item [{\np[=2]{nn_isfblk}{nn\_isfblk}}]: The melt rate and the heat flux are based on a 3 equations formulation
      (a heat flux budget at the ice base, a salt flux budget at the ice base and a linearised freezing point temperature equation).
      A complete description is available in \citet{jenkins_JGR91}.
@@ -952 +936 @@
      There are 3 different ways to compute the exchange coeficient:
    \begin{description}
-        \item [{\np[=0]{nn_gammablk}{nn\_gammablk}}]:
-     The salt and heat exchange coefficients are constant and defined by \np{rn_gammas0}{rn\_gammas0} and \np{rn_gammat0}{rn\_gammat0}.
+        \item [{\np[=0]{nn_gammablk}{nn\_gammablk}}]: The salt and heat exchange coefficients are constant and defined by \np{rn_gammas0}{rn\_gammas0} and \np{rn_gammat0}{rn\_gammat0}.
      \begin{gather*}
        % \label{eq:SBC_isf_gamma_iso}
@@ -960 +943 @@
      \end{gather*}
      This is the recommended formulation for ISOMIP.
-   \item [{\np[=1]{nn_gammablk}{nn\_gammablk}}]:
-     The salt and heat exchange coefficients are velocity dependent and defined as
+   \item [{\np[=1]{nn_gammablk}{nn\_gammablk}}]: The salt and heat exchange coefficients are velocity dependent and defined as
      \begin{gather*}
        \gamma^{T} = rn\_gammat0 \times u_{*} \\
@@ -968 +950 @@
      where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn_hisf_tbl}{rn\_hisf\_tbl} meters).
      See \citet{jenkins.nicholls.ea_JPO10} for all the details on this formulation. It is the recommended formulation for realistic application.
-   \item [{\np[=2]{nn_gammablk}{nn\_gammablk}}]:
-     The salt and heat exchange coefficients are velocity and stability dependent and defined as:
+   \item [{\np[=2]{nn_gammablk}{nn\_gammablk}}]: The salt and heat exchange coefficients are velocity and stability dependent and defined as:
 \[
 \gamma^{T,S} = \frac{u_{*}}{\Gamma_{Turb} + \Gamma^{T,S}_{Mole}}
@@ -979 +960 @@
      This formulation has not been extensively tested in \NEMO\ (not recommended).
    \end{description}
-  \item [{\np[=2]{nn_isf}{nn\_isf}}]:
-   The ice shelf cavity is not represented.
+  \item [{\np[=2]{nn_isf}{nn\_isf}}]: The ice shelf cavity is not represented.
    The fwf and heat flux are computed using the \citet{beckmann.goosse_OM03} parameterisation of isf melting.
    The fluxes are distributed along the ice shelf edge between the depth of the average grounding line (GL)
@@ -986 +966 @@
    (\np{sn_depmin_isf}{sn\_depmin\_isf}) as in (\np[=3]{nn_isf}{nn\_isf}).
    The effective melting length (\np{sn_Leff_isf}{sn\_Leff\_isf}) is read from a file.
-  \item [{\np[=3]{nn_isf}{nn\_isf}}]:
-   The ice shelf cavity is not represented.
+  \item [{\np[=3]{nn_isf}{nn\_isf}}]: The ice shelf cavity is not represented.
    The fwf (\np{sn_rnfisf}{sn\_rnfisf}) is prescribed and distributed along the ice shelf edge between
    the depth of the average grounding line (GL) (\np{sn_depmax_isf}{sn\_depmax\_isf}) and
    the base of the ice shelf along the calving front (\np{sn_depmin_isf}{sn\_depmin\_isf}).
    The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.
-  \item [{\np[=4]{nn_isf}{nn\_isf}}]:
-   The ice shelf cavity is opened (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
+  \item [{\np[=4]{nn_isf}{nn\_isf}}]: The ice shelf cavity is opened (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
    However, the fwf is not computed but specified from file \np{sn_fwfisf}{sn\_fwfisf}).
    The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.
@@ -1037 +1015 @@
 At each restart step:
 
-\begin{description}
-\item [Step 1]: the ice sheet model send a new bathymetry and ice shelf draft netcdf file.
-\item [Step 2]: a new domcfg.nc file is built using the DOMAINcfg tools.
-\item [Step 3]: \NEMO\ run for a specific period and output the average melt rate over the period.
-\item [Step 4]: the ice sheet model run using the melt rate outputed in step 4.
-\item [Step 5]: go back to 1.
-\end{description}
+\begin{enumerate}
+\item the ice sheet model send a new bathymetry and ice shelf draft netcdf file.
+\item a new domcfg.nc file is built using the DOMAINcfg tools.
+\item \NEMO\ run for a specific period and output the average melt rate over the period.
+\item the ice sheet model run using the melt rate outputed in step 4.
+\item go back to 1.
+\end{enumerate}
 
 If \np[=.true.]{ln_iscpl}{ln\_iscpl}, the isf draft is assume to be different at each restart step with
@@ -1050 +1028 @@
 
 \begin{description}
-\item [Thin a cell down]:
-  T/S/ssh are unchanged and U/V in the top cell are corrected to keep the barotropic transport (bt) constant
+\item [Thin a cell down]: T/S/ssh are unchanged and U/V in the top cell are corrected to keep the barotropic transport (bt) constant
   ($bt_b=bt_n$).
-\item [Enlarge  a cell]:
-  See case "Thin a cell down"
-\item [Dry a cell]:
-  mask, T/S, U/V and ssh are set to 0.
+\item [Enlarge  a cell]: See case "Thin a cell down"
+\item [Dry a cell]: mask, T/S, U/V and ssh are set to 0.
   Furthermore, U/V into the water column are modified to satisfy ($bt_b=bt_n$).
-\item [Wet a cell]:
-  mask is set to 1, T/S is extrapolated from neighbours, $ssh_n = ssh_b$ and U/V set to 0.
+\item [Wet a cell]: mask is set to 1, T/S is extrapolated from neighbours, $ssh_n = ssh_b$ and U/V set to 0.
   If no neighbours, T/S is extrapolated from old top cell value.
   If no neighbours along i,j and k (both previous test failed), T/S/U/V/ssh and mask are set to 0.
-\item [Dry a column]:
-   mask, T/S, U/V are set to 0 everywhere in the column and ssh set to 0.
-\item [Wet a column]:
-  set mask to 1, T/S is extrapolated from neighbours, ssh is extrapolated from neighbours and U/V set to 0.
+\item [Dry a column]: mask, T/S, U/V are set to 0 everywhere in the column and ssh set to 0.
+\item [Wet a column]: set mask to 1, T/S is extrapolated from neighbours, ssh is extrapolated from neighbours and U/V set to 0.
   If no neighbour, T/S/U/V and mask set to 0.
 \end{description}
@@ -1109 +1081 @@
 Two initialisation schemes are possible.
 \begin{description}
-\item [{\np{nn_test_icebergs}{nn\_test\_icebergs}~$>$~0}]
-  In this scheme, the value of \np{nn_test_icebergs}{nn\_test\_icebergs} represents the class of iceberg to generate
+\item [{\np{nn_test_icebergs}{nn\_test\_icebergs}~$>$~0}] In this scheme, the value of \np{nn_test_icebergs}{nn\_test\_icebergs} represents the class of iceberg to generate
   (so between 1 and 10), and \np{nn_test_icebergs}{nn\_test\_icebergs} provides a lon/lat box in the domain at each grid point of
   which an iceberg is generated at the beginning of the run.
@@ -1116 +1087 @@
   \np{nn_test_icebergs}{nn\_test\_icebergs} is defined by four numbers in \np{nn_test_box}{nn\_test\_box} representing the corners of
   the geographical box: lonmin,lonmax,latmin,latmax
-\item [{\np[=-1]{nn_test_icebergs}{nn\_test\_icebergs}}]
-  In this scheme, the model reads a calving file supplied in the \np{sn_icb}{sn\_icb} parameter.
+\item [{\np[=-1]{nn_test_icebergs}{nn\_test\_icebergs}}] In this scheme, the model reads a calving file supplied in the \np{sn_icb}{sn\_icb} parameter.
   This should be a file with a field on the configuration grid (typically ORCA)
   representing ice accumulation rate at each model point.
@@ -1184 +1154 @@
 \end{description}
 
-% ----------------------------------------------------------------
-% Neutral drag coefficient from wave model (ln_cdgw)
-
-% ----------------------------------------------------------------
 %% =================================================================================================
 \subsection[Neutral drag coefficient from wave model (\forcode{ln_cdgw})]{Neutral drag coefficient from wave model (\protect\np{ln_cdgw}{ln\_cdgw})}
@@ -1198 +1164 @@
 air-sea interface following \citet{large.yeager_rpt04}.
 
-% ----------------------------------------------------------------
-% 3D Stokes Drift (ln_sdw, nn_sdrift)
-% ----------------------------------------------------------------
 %% =================================================================================================
 \subsection[3D Stokes Drift (\forcode{ln_sdw} \& \forcode{nn_sdrift})]{3D Stokes Drift (\protect\np{ln_sdw}{ln\_sdw} \& \np{nn_sdrift}{nn\_sdrift})}
@@ -1294 +1257 @@
 \]
 
-% ----------------------------------------------------------------
-% Stokes-Coriolis term (ln_stcor)
-% ----------------------------------------------------------------
 %% =================================================================================================
 \subsection[Stokes-Coriolis term (\forcode{ln_stcor})]{Stokes-Coriolis term (\protect\np{ln_stcor}{ln\_stcor})}
@@ -1308 +1268 @@
 \np[=.true.]{ln_stcor}{ln\_stcor} has to be set.
 
-% ----------------------------------------------------------------
-% Waves modified stress (ln_tauwoc, ln_tauw)
-% ----------------------------------------------------------------
 %% =================================================================================================
 \subsection[Wave modified stress (\forcode{ln_tauwoc} \& \forcode{ln_tauw})]{Wave modified sress (\protect\np{ln_tauwoc}{ln\_tauwoc} \& \np{ln_tauw}{ln\_tauw})}
@@ -1357 +1314 @@
 \label{subsec:SBC_dcy}
 %
-
 
 \begin{figure}[!t]
@@ -1475 +1431 @@
 the value of the \np{nn_ice}{nn\_ice} namelist parameter found in \nam{sbc}{sbc} namelist.
 \begin{description}
-\item [nn\_ice = 0]
-  there will never be sea-ice in the computational domain.
+\item [nn\_ice = 0] there will never be sea-ice in the computational domain.
   This is a typical namelist value used for tropical ocean domain.
   The surface fluxes are simply specified for an ice-free ocean.
   No specific things is done for sea-ice.
-\item [nn\_ice = 1]
-  sea-ice can exist in the computational domain, but no sea-ice model is used.
+\item [nn\_ice = 1] sea-ice can exist in the computational domain, but no sea-ice model is used.
   An observed ice covered area is read in a file.
   Below this area, the SST is restored to the freezing point and
@@ -1492 +1446 @@
   is usually referred as the \textit{ice-if} model.
   It can be found in the \mdl{sbcice\_if} module.
-\item [nn\_ice = 2 or more]
-  A full sea ice model is used.
+\item [nn\_ice = 2 or more] A full sea ice model is used.
   This model computes the ice-ocean fluxes,
   that are combined with the air-sea fluxes using the ice fraction of each model cell to
@@ -1545 +1498 @@
 
 \begin{description}
-\item [{\np[=0]{nn_fwb}{nn\_fwb}}]
-  no control at all.
+\item [{\np[=0]{nn_fwb}{nn\_fwb}}] no control at all.
   The mean sea level is free to drift, and will certainly do so.
-\item [{\np[=1]{nn_fwb}{nn\_fwb}}]
-  global mean \textit{emp} set to zero at each model time step.
+\item [{\np[=1]{nn_fwb}{nn\_fwb}}] global mean \textit{emp} set to zero at each model time step.
   %GS: comment below still relevant ?
   %Note that with a sea-ice model, this technique only controls the mean sea level with linear free surface and no mass flux between ocean and ice (as it is implemented in the current ice-ocean coupling).
-\item [{\np[=2]{nn_fwb}{nn\_fwb}}]
-  freshwater budget is adjusted from the previous year annual mean budget which
+\item [{\np[=2]{nn_fwb}{nn\_fwb}}] freshwater budget is adjusted from the previous year annual mean budget which
   is read in the \textit{EMPave\_old.dat} file.
   As the model uses the Boussinesq approximation, the annual mean fresh water budget is simply evaluated from