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.
chap_SBC.tex in NEMO/trunk/doc/latex/NEMO/subfiles – NEMO

source: NEMO/trunk/doc/latex/NEMO/subfiles/chap_SBC.tex @ 11596

Last change on this file since 11596 was 11596, checked in by nicolasmartin, 5 years ago

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 size: 92.1 KB
Line 
1\documentclass[../main/NEMO_manual]{subfiles}
2
3\begin{document}
4
5\chapter{Surface Boundary Condition (SBC, SAS, ISF, ICB)}
6\label{chap:SBC}
7
8\chaptertoc
9
10%---------------------------------------namsbc--------------------------------------------------
11
12\begin{listing}
13  \nlst{namsbc}
14  \caption{\forcode{&namsbc}}
15  \label{lst:namsbc}
16\end{listing}
17%--------------------------------------------------------------------------------------------------------------
18
19The ocean needs seven fields as surface boundary condition:
20
21\begin{itemize}
22\item the two components of the surface ocean stress $\left( {\tau_u \;,\;\tau_v} \right)$
23\item the incoming solar and non solar heat fluxes $\left( {Q_{ns} \;,\;Q_{sr} } \right)$
24\item the surface freshwater budget $\left( {\textit{emp}} \right)$
25\item the surface salt flux associated with freezing/melting of seawater $\left( {\textit{sfx}} \right)$
26\item the atmospheric pressure at the ocean surface $\left( p_a \right)$
27\end{itemize}
28
29Four different ways are available to provide the seven fields to the ocean. They are controlled by
30namelist \nam{sbc}{sbc} variables:
31
32\begin{itemize}
33\item a bulk formulation (\np[=.true.]{ln_blk}{ln\_blk} with four possible bulk algorithms),
34\item a flux formulation (\np[=.true.]{ln_flx}{ln\_flx}),
35\item a coupled or mixed forced/coupled formulation (exchanges with a atmospheric model via the OASIS coupler),
36(\np{ln_cpl}{ln\_cpl} or \np[=.true.]{ln_mixcpl}{ln\_mixcpl}),
37\item a user defined formulation (\np[=.true.]{ln_usr}{ln\_usr}).
38\end{itemize}
39
40The frequency at which the forcing fields have to be updated is given by the \np{nn_fsbc}{nn\_fsbc} namelist parameter.
41
42When the fields are supplied from data files (bulk, flux and mixed formulations),
43the input fields do not need to be supplied on the model grid.
44Instead, a file of coordinates and weights can be supplied to map the data from the input fields grid to
45the model points (so called "Interpolation on the Fly", see \autoref{subsec:SBC_iof}).
46If the "Interpolation on the Fly" option is used, input data belonging to land points (in the native grid)
47should be masked or filled to avoid spurious results in proximity of the coasts, as
48large sea-land gradients characterize most of the atmospheric variables.
49
50In addition, the resulting fields can be further modified using several namelist options.
51These options control:
52
53\begin{itemize}
54\item the rotation of vector components supplied relative to an east-north coordinate system onto
55  the local grid directions in the model,
56\item the use of a land/sea mask for input fields (\np[=.true.]{nn_lsm}{nn\_lsm}),
57\item the addition of a surface restoring term to observed SST and/or SSS (\np[=.true.]{ln_ssr}{ln\_ssr}),
58\item the modification of fluxes below ice-covered areas (using climatological ice-cover or a sea-ice model)
59  (\np[=0..3]{nn_ice}{nn\_ice}),
60\item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np[=.true.]{ln_rnf}{ln\_rnf}),
61\item the addition of ice-shelf melting as lateral inflow (parameterisation) or
62  as fluxes applied at the land-ice ocean interface (\np[=.true.]{ln_isf}{ln\_isf}),
63\item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift
64  (\np[=0..2]{nn_fwb}{nn\_fwb}),
65\item the transformation of the solar radiation (if provided as daily mean) into an analytical diurnal cycle
66  (\np[=.true.]{ln_dm2dc}{ln\_dm2dc}),
67\item the activation of wave effects from an external wave model  (\np[=.true.]{ln_wave}{ln\_wave}),
68\item a neutral drag coefficient is read from an external wave model (\np[=.true.]{ln_cdgw}{ln\_cdgw}),
69\item the Stokes drift from an external wave model is accounted for (\np[=.true.]{ln_sdw}{ln\_sdw}),
70\item the choice of the Stokes drift profile parameterization (\np[=0..2]{nn_sdrift}{nn\_sdrift}),
71\item the surface stress given to the ocean is modified by surface waves (\np[=.true.]{ln_tauwoc}{ln\_tauwoc}),
72\item the surface stress given to the ocean is read from an external wave model (\np[=.true.]{ln_tauw}{ln\_tauw}),
73\item the Stokes-Coriolis term is included (\np[=.true.]{ln_stcor}{ln\_stcor}),
74\item the light penetration in the ocean (\np[=.true.]{ln_traqsr}{ln\_traqsr} with namelist \nam{tra_qsr}{tra\_qsr}),
75\item the atmospheric surface pressure gradient effect on ocean and ice dynamics (\np[=.true.]{ln_apr_dyn}{ln\_apr\_dyn} with namelist \nam{sbc_apr}{sbc\_apr}),
76\item the effect of sea-ice pressure on the ocean (\np[=.true.]{ln_ice_embd}{ln\_ice\_embd}).
77\end{itemize}
78
79In this chapter, we first discuss where the surface boundary conditions appear in the model equations.
80Then we present the three ways of providing the surface boundary conditions,
81followed by the description of the atmospheric pressure and the river runoff.
82Next, the scheme for interpolation on the fly is described.
83Finally, the different options that further modify the fluxes applied to the ocean are discussed.
84One of these is modification by icebergs (see \autoref{sec:SBC_ICB_icebergs}),
85which act as drifting sources of fresh water.
86Another example of modification is that due to the ice shelf melting/freezing (see \autoref{sec:SBC_isf}),
87which provides additional sources of fresh water.
88
89\section{Surface boundary condition for the ocean}
90\label{sec:SBC_ocean}
91
92The surface ocean stress is the stress exerted by the wind and the sea-ice on the ocean.
93It is applied in \mdl{dynzdf} module as a surface boundary condition of the computation of
94the momentum vertical mixing trend (see \autoref{eq:DYN_zdf_sbc} in \autoref{sec:DYN_zdf}).
95As such, it has to be provided as a 2D vector interpolated onto the horizontal velocity ocean mesh,
96\ie\ resolved onto the model (\textbf{i},\textbf{j}) direction at $u$- and $v$-points.
97
98The surface heat flux is decomposed into two parts, a non solar and a solar heat flux,
99$Q_{ns}$ and $Q_{sr}$, respectively.
100The former is the non penetrative part of the heat flux
101(\ie\ the sum of sensible, latent and long wave heat fluxes plus
102the heat content of the mass exchange between the ocean and sea-ice).
103It is applied in \mdl{trasbc} module as a surface boundary condition trend of
104the first level temperature time evolution equation
105(see \autoref{eq:TRA_sbc} and \autoref{eq:TRA_sbc_lin} in \autoref{subsec:TRA_sbc}).
106The latter is the penetrative part of the heat flux.
107It is applied as a 3D trend of the temperature equation (\mdl{traqsr} module) when
108\np[=.true.]{ln_traqsr}{ln\_traqsr}.
109The way the light penetrates inside the water column is generally a sum of decreasing exponentials
110(see \autoref{subsec:TRA_qsr}).
111
112The surface freshwater budget is provided by the \textit{emp} field.
113It represents the mass flux exchanged with the atmosphere (evaporation minus precipitation) and
114possibly with the sea-ice and ice shelves (freezing minus melting of ice).
115It affects the ocean in two different ways:
116$(i)$  it changes the volume of the ocean, and therefore appears in the sea surface height equation as      %GS: autoref ssh equation to be added
117a volume flux, and
118$(ii)$ it changes the surface temperature and salinity through the heat and salt contents of
119the mass exchanged with atmosphere, sea-ice and ice shelves.
120
121%\colorbox{yellow}{Miss: }
122%
123%A extensive description of all namsbc namelist (parameter that have to be
124%created!)
125%
126%Especially the \np{nn_fsbc}{nn\_fsbc}, the \mdl{sbc\_oce} module (fluxes + mean sst sss ssu
127%ssv) \ie\ information required by flux computation or sea-ice
128%
129%\mdl{sbc\_oce} containt the definition in memory of the 7 fields (6+runoff), add
130%a word on runoff: included in surface bc or add as lateral obc{\ldots}.
131%
132%Sbcmod manage the ``providing'' (fourniture) to the ocean the 7 fields
133%
134%Fluxes update only each nf\_sbc time step (namsbc) explain relation
135%between nf\_sbc and nf\_ice, do we define nf\_blk??? ? only one
136%nf\_sbc
137%
138%Explain here all the namlist namsbc variable{\ldots}.
139%
140% explain : use or not of surface currents
141%
142%\colorbox{yellow}{End Miss }
143
144The ocean model provides, at each time step, to the surface module (\mdl{sbcmod})
145the surface currents, temperature and salinity.
146These variables are averaged over \np{nn_fsbc}{nn\_fsbc} time-step (\autoref{tab:SBC_ssm}), and
147these averaged fields are used to compute the surface fluxes at the frequency of \np{nn_fsbc}{nn\_fsbc} time-steps.
148
149%-------------------------------------------------TABLE---------------------------------------------------
150\begin{table}[tb]
151  \centering
152  \begin{tabular}{|l|l|l|l|}
153    \hline
154    Variable description                           & Model variable  & Units  & point                 \\
155    \hline
156    i-component of the surface current & ssu\_m               & $m.s^{-1}$     & U     \\
157    \hline
158    j-component of the surface current & ssv\_m               & $m.s^{-1}$     & V     \\
159    \hline
160    Sea surface temperature                  & sst\_m               & \r{}$K$              & T     \\\hline
161    Sea surface salinty                         & sss\_m               & $psu$              & T     \\   \hline
162  \end{tabular}
163  \caption[Ocean variables provided to the surface module)]{
164    Ocean variables provided to the surface module (\texttt{SBC}).
165    The variable are averaged over \protect\np{nn_fsbc}{nn\_fsbc} time-step,
166    \ie\ the frequency of computation of surface fluxes.}
167  \label{tab:SBC_ssm}
168\end{table}
169%--------------------------------------------------------------------------------------------------------------
170
171%\colorbox{yellow}{Penser a} mettre dans le restant l'info nn\_fsbc ET nn\_fsbc*rdt de sorte de reinitialiser la moyenne si on change la frequence ou le pdt
172
173\section{Input data generic interface}
174\label{sec:SBC_input}
175
176A generic interface has been introduced to manage the way input data
177(2D or 3D fields, like surface forcing or ocean T and S) are specified in \NEMO.
178This task is achieved by \mdl{fldread}.
179The module is designed with four main objectives in mind:
180\begin{enumerate}
181\item optionally provide a time interpolation of the input data every specified model time-step, whatever their input frequency is,
182  and according to the different calendars available in the model.
183\item optionally provide an on-the-fly space interpolation from the native input data grid to the model grid.
184\item make the run duration independent from the period cover by the input files.
185\item provide a simple user interface and a rather simple developer interface by
186  limiting the number of prerequisite informations.
187\end{enumerate}
188
189As a result, the user has only to fill in for each variable a structure in the namelist file to
190define the input data file and variable names, the frequency of the data (in hours or months),
191whether its is climatological data or not, the period covered by the input file (one year, month, week or day),
192and three additional parameters for the on-the-fly interpolation.
193When adding a new input variable, the developer has to add the associated structure in the namelist,
194read this information by mirroring the namelist read in \rou{sbc\_blk\_init} for example,
195and simply call \rou{fld\_read} to obtain the desired input field at the model time-step and grid points.
196
197The only constraints are that the input file is a NetCDF file, the file name follows a nomenclature
198(see \autoref{subsec:SBC_fldread}), the period it cover is one year, month, week or day, and,
199if on-the-fly interpolation is used, a file of weights must be supplied (see \autoref{subsec:SBC_iof}).
200
201Note that when an input data is archived on a disc which is accessible directly from the workspace where
202the code is executed, then the user can set the \np{cn_dir}{cn\_dir} to the pathway leading to the data.
203By default, the data are assumed to be in the same directory as the executable, so that cn\_dir='./'.
204
205\subsection[Input data specification (\textit{fldread.F90})]{Input data specification (\protect\mdl{fldread})}
206\label{subsec:SBC_fldread}
207
208The structure associated with an input variable contains the following information:
209\begin{forlines}
210!  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask !
211!             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      !
212\end{forlines}
213where
214\begin{description}
215\item [File name]:
216  the stem name of the NetCDF file to be opened.
217  This stem will be completed automatically by the model, with the addition of a '.nc' at its end and
218  by date information and possibly a prefix (when using AGRIF).
219  \autoref{tab:SBC_fldread} provides the resulting file name in all possible cases according to
220  whether it is a climatological file or not, and to the open/close frequency (see below for definition).
221
222%--------------------------------------------------TABLE--------------------------------------------------
223  \begin{table}[htbp]
224    \centering
225    \begin{tabular}{|l|c|c|c|}
226      \hline
227                                  &  daily or weekLL     &  monthly           &  yearly        \\
228      \hline
229      \np[=.false.]{clim}{clim} &  fn\_yYYYYmMMdDD.nc  &  fn\_yYYYYmMM.nc   &  fn\_yYYYY.nc  \\
230      \hline
231      \np[=.true.]{clim}{clim}  &  not possible        &  fn\_m??.nc        &  fn            \\
232      \hline
233    \end{tabular}
234    \caption[Naming nomenclature for climatological or interannual input file]{
235      Naming nomenclature for climatological or interannual input file,
236      as a function of the open/close frequency.
237      The stem name is assumed to be 'fn'.
238      For weekly files, the 'LLL' corresponds to the first three letters of the first day of the week
239      (\ie\ 'sun','sat','fri','thu','wed','tue','mon').
240      The 'YYYY', 'MM' and 'DD' should be replaced by the actual year/month/day,
241      always coded with 4 or 2 digits.
242      Note that (1) in mpp, if the file is split over each subdomain,
243      the suffix '.nc' is replaced by '\_PPPP.nc',
244      where 'PPPP' is the process number coded with 4 digits;
245      (2) when using AGRIF, the prefix '\_N' is added to files, where 'N' is the child grid number.
246    }
247    \label{tab:SBC_fldread}
248  \end{table}
249%--------------------------------------------------------------------------------------------------------------
250
251\item [Record frequency]:
252  the frequency of the records contained in the input file.
253  Its unit is in hours if it is positive (for example 24 for daily forcing) or in months if negative
254  (for example -1 for monthly forcing or -12 for annual forcing).
255  Note that this frequency must REALLY be an integer and not a real.
256  On some computers, setting it to '24.' can be interpreted as 240!
257
258\item [Variable name]:
259  the name of the variable to be read in the input NetCDF file.
260
261\item [Time interpolation]:
262  a logical to activate, or not, the time interpolation.
263  If set to 'false', the forcing will have a steplike shape remaining constant during each forcing period.
264  For example, when using a daily forcing without time interpolation, the forcing remaining constant from
265  00h00'00'' to 23h59'59".
266  If set to 'true', the forcing will have a broken line shape.
267  Records are assumed to be dated at the middle of the forcing period.
268  For example, when using a daily forcing with time interpolation,
269  linear interpolation will be performed between mid-day of two consecutive days.
270
271\item [Climatological forcing]:
272  a logical to specify if a input file contains climatological forcing which can be cycle in time,
273  or an interannual forcing which will requires additional files if
274  the period covered by the simulation exceeds the one of the file.
275  See the above file naming strategy which impacts the expected name of the file to be opened.
276
277\item [Open/close frequency]:
278  the frequency at which forcing files must be opened/closed.
279  Four cases are coded:
280  'daily', 'weekLLL' (with 'LLL' the first 3 letters of the first day of the week), 'monthly' and 'yearly' which
281  means the forcing files will contain data for one day, one week, one month or one year.
282  Files are assumed to contain data from the beginning of the open/close period.
283  For example, the first record of a yearly file containing daily data is Jan 1st even if
284  the experiment is not starting at the beginning of the year.
285
286\item [Others]:
287  'weights filename', 'pairing rotation' and 'land/sea mask' are associated with
288  on-the-fly interpolation which is described in \autoref{subsec:SBC_iof}.
289
290\end{description}
291
292Additional remarks:\\
293(1) The time interpolation is a simple linear interpolation between two consecutive records of the input data.
294The only tricky point is therefore to specify the date at which we need to do the interpolation and
295the date of the records read in the input files.
296Following \citet{leclair.madec_OM09}, the date of a time step is set at the middle of the time step.
297For example, for an experiment starting at 0h00'00" with a one-hour time-step,
298a time interpolation will be performed at the following time: 0h30'00", 1h30'00", 2h30'00", etc.
299However, for forcing data related to the surface module,
300values are not needed at every time-step but at every \np{nn_fsbc}{nn\_fsbc} time-step.
301For example with \np[=3]{nn_fsbc}{nn\_fsbc}, the surface module will be called at time-steps 1, 4, 7, etc.
302The date used for the time interpolation is thus redefined to the middle of \np{nn_fsbc}{nn\_fsbc} time-step period.
303In the previous example, this leads to: 1h30'00", 4h30'00", 7h30'00", etc. \\
304(2) For code readablility and maintenance issues, we don't take into account the NetCDF input file calendar.
305The calendar associated with the forcing field is build according to the information provided by
306user in the record frequency, the open/close frequency and the type of temporal interpolation.
307For example, the first record of a yearly file containing daily data that will be interpolated in time is assumed to
308start Jan 1st at 12h00'00" and end Dec 31st at 12h00'00". \\
309(3) If a time interpolation is requested, the code will pick up the needed data in the previous (next) file when
310interpolating data with the first (last) record of the open/close period.
311For example, if the input file specifications are ''yearly, containing daily data to be interpolated in time'',
312the values given by the code between 00h00'00" and 11h59'59" on Jan 1st will be interpolated values between
313Dec 31st 12h00'00" and Jan 1st 12h00'00".
314If the forcing is climatological, Dec and Jan will be keep-up from the same year.
315However, if the forcing is not climatological, at the end of
316the open/close period, the code will automatically close the current file and open the next one.
317Note that, if the experiment is starting (ending) at the beginning (end) of
318an open/close period, we do accept that the previous (next) file is not existing.
319In this case, the time interpolation will be performed between two identical values.
320For example, when starting an experiment on Jan 1st of year Y with yearly files and daily data to be interpolated,
321we do accept that the file related to year Y-1 is not existing.
322The value of Jan 1st will be used as the missing one for Dec 31st of year Y-1.
323If the file of year Y-1 exists, the code will read its last record.
324Therefore, this file can contain only one record corresponding to Dec 31st,
325a useful feature for user considering that it is too heavy to manipulate the complete file for year Y-1.
326
327\subsection{Interpolation on-the-fly}
328\label{subsec:SBC_iof}
329
330Interpolation on the Fly allows the user to supply input files required for the surface forcing on
331grids other than the model grid.
332To do this, he or she must supply, in addition to the source data file(s), a file of weights to be used to
333interpolate from the data grid to the model grid.
334The original development of this code used the SCRIP package
335(freely available \href{http://climate.lanl.gov/Software/SCRIP}{here} under a copyright agreement).
336In principle, any package such as CDO can be used to generate the weights, but the variables in
337the input weights file must have the same names and meanings as assumed by the model.
338Two methods are currently available: bilinear and bicubic interpolations.
339Prior to the interpolation, providing a land/sea mask file, the user can decide to remove land points from
340the input file and substitute the corresponding values with the average of the 8 neighbouring points in
341the native external grid.
342Only "sea points" are considered for the averaging.
343The land/sea mask file must be provided in the structure associated with the input variable.
344The netcdf land/sea mask variable name must be 'LSM' and must have the same horizontal and vertical dimensions as
345the associated variables and should be equal to 1 over land and 0 elsewhere.
346The procedure can be recursively applied by setting nn\_lsm > 1 in namsbc namelist.
347Note that nn\_lsm=0 forces the code to not apply the procedure, even if a land/sea mask file is supplied.
348
349\subsubsection{Bilinear interpolation}
350\label{subsec:SBC_iof_bilinear}
351
352The input weights file in this case has two sets of variables:
353src01, src02, src03, src04 and wgt01, wgt02, wgt03, wgt04.
354The "src" variables correspond to the point in the input grid to which the weight "wgt" is applied.
355Each src value is an integer corresponding to the index of a point in the input grid when
356written as a one dimensional array.
357For example, for an input grid of size 5x10, point (3,2) is referenced as point 8, since (2-1)*5+3=8.
358There are four of each variable because bilinear interpolation uses the four points defining
359the grid box containing the point to be interpolated.
360All of these arrays are on the model grid, so that values src01(i,j) and wgt01(i,j) are used to
361generate a value for point (i,j) in the model.
362
363Symbolically, the algorithm used is:
364\[
365  f_{m}(i,j) = f_{m}(i,j) + \sum_{k=1}^{4} {wgt(k)f(idx(src(k)))}
366\]
367where function idx() transforms a one dimensional index src(k) into a two dimensional index,
368and wgt(1) corresponds to variable "wgt01" for example.
369
370\subsubsection{Bicubic interpolation}
371\label{subsec:SBC_iof_bicubic}
372
373Again, there are two sets of variables: "src" and "wgt".
374But in this case, there are 16 of each.
375The symbolic algorithm used to calculate values on the model grid is now:
376
377\[
378  \begin{split}
379    f_{m}(i,j) =  f_{m}(i,j) +& \sum_{k=1}^{4} {wgt(k)f(idx(src(k)))}
380    +  \sum_{k=5 }^{8 } {wgt(k)\left.\frac{\partial f}{\partial i}\right| _{idx(src(k))} }    \\
381    +& \sum_{k=9 }^{12} {wgt(k)\left.\frac{\partial f}{\partial j}\right| _{idx(src(k))} }
382    +  \sum_{k=13}^{16} {wgt(k)\left.\frac{\partial ^2 f}{\partial i \partial j}\right| _{idx(src(k))} }
383  \end{split}
384\]
385The gradients here are taken with respect to the horizontal indices and not distances since
386the spatial dependency has been included into the weights.
387
388\subsubsection{Implementation}
389\label{subsec:SBC_iof_imp}
390
391To activate this option, a non-empty string should be supplied in
392the weights filename column of the relevant namelist;
393if this is left as an empty string no action is taken.
394In the model, weights files are read in and stored in a structured type (WGT) in the fldread module,
395as and when they are first required.
396This initialisation procedure determines whether the input data grid should be treated as cyclical or not by
397inspecting a global attribute stored in the weights input file.
398This attribute must be called "ew\_wrap" and be of integer type.
399If it is negative, the input non-model grid is assumed to be not cyclic.
400If zero or greater, then the value represents the number of columns that overlap.
401$E.g.$ if the input grid has columns at longitudes 0, 1, 2, .... , 359, then ew\_wrap should be set to 0;
402if longitudes are 0.5, 2.5, .... , 358.5, 360.5, 362.5, ew\_wrap should be 2.
403If the model does not find attribute ew\_wrap, then a value of -999 is assumed.
404In this case, the \rou{fld\_read} routine defaults ew\_wrap to value 0 and
405therefore the grid is assumed to be cyclic with no overlapping columns.
406(In fact, this only matters when bicubic interpolation is required.)
407Note that no testing is done to check the validity in the model,
408since there is no way of knowing the name used for the longitude variable,
409so it is up to the user to make sure his or her data is correctly represented.
410
411Next the routine reads in the weights.
412Bicubic interpolation is assumed if it finds a variable with name "src05", otherwise bilinear interpolation is used.
413The WGT structure includes dynamic arrays both for the storage of the weights (on the model grid),
414and when required, for reading in the variable to be interpolated (on the input data grid).
415The size of the input data array is determined by examining the values in the "src" arrays to
416find the minimum and maximum i and j values required.
417Since bicubic interpolation requires the calculation of gradients at each point on the grid,
418the corresponding arrays are dimensioned with a halo of width one grid point all the way around.
419When the array of points from the data file is adjacent to an edge of the data grid,
420the halo is either a copy of the row/column next to it (non-cyclical case),
421or is a copy of one from the first few columns on the opposite side of the grid (cyclical case).
422
423\subsubsection{Limitations}
424\label{subsec:SBC_iof_lim}
425
426\begin{enumerate}
427\item The case where input data grids are not logically rectangular (irregular grid case) has not been tested.
428\item This code is not guaranteed to produce positive definite answers from positive definite inputs when
429  a bicubic interpolation method is used.
430\item The cyclic condition is only applied on left and right columns, and not to top and bottom rows.
431\item The gradients across the ends of a cyclical grid assume that the grid spacing between
432  the two columns involved are consistent with the weights used.
433\item Neither interpolation scheme is conservative. (There is a conservative scheme available in SCRIP,
434  but this has not been implemented.)
435\end{enumerate}
436
437\subsubsection{Utilities}
438\label{subsec:SBC_iof_util}
439
440% to be completed
441A set of utilities to create a weights file for a rectilinear input grid is available
442(see the directory NEMOGCM/TOOLS/WEIGHTS).
443
444\subsection{Standalone surface boundary condition scheme (SAS)}
445\label{subsec:SBC_SAS}
446
447%---------------------------------------namsbc_sas--------------------------------------------------
448
449\begin{listing}
450  \nlst{namsbc_sas}
451  \caption{\forcode{&namsbc_sas}}
452  \label{lst:namsbc_sas}
453\end{listing}
454%--------------------------------------------------------------------------------------------------------------
455
456In some circumstances, it may be useful to avoid calculating the 3D temperature,
457salinity and velocity fields and simply read them in from a previous run or receive them from OASIS.
458For example:
459
460\begin{itemize}
461\item Multiple runs of the model are required in code development to
462  see the effect of different algorithms in the bulk formulae.
463\item The effect of different parameter sets in the ice model is to be examined.
464\item Development of sea-ice algorithms or parameterizations.
465\item Spinup of the iceberg floats
466\item Ocean/sea-ice simulation with both models running in parallel (\np[=.true.]{ln_mixcpl}{ln\_mixcpl})
467\end{itemize}
468
469The Standalone Surface scheme provides this capacity.
470Its options are defined through the \nam{sbc_sas}{sbc\_sas} namelist variables.
471A new copy of the model has to be compiled with a configuration based on ORCA2\_SAS\_LIM.
472However, no namelist parameters need be changed from the settings of the previous run (except perhaps nn\_date0).
473In this configuration, a few routines in the standard model are overriden by new versions.
474Routines replaced are:
475
476\begin{itemize}
477\item \mdl{nemogcm}:
478  This routine initialises the rest of the model and repeatedly calls the stp time stepping routine (\mdl{step}).
479  Since the ocean state is not calculated all associated initialisations have been removed.
480\item \mdl{step}:
481  The main time stepping routine now only needs to call the sbc routine (and a few utility functions).
482\item \mdl{sbcmod}:
483  This has been cut down and now only calculates surface forcing and the ice model required.
484  New surface modules that can function when only the surface level of the ocean state is defined can also be added
485  (\eg\ icebergs).
486\item \mdl{daymod}:
487  No ocean restarts are read or written (though the ice model restarts are retained),
488  so calls to restart functions have been removed.
489  This also means that the calendar cannot be controlled by time in a restart file,
490  so the user must check that nn\_date0 in the model namelist is correct for his or her purposes.
491\item \mdl{stpctl}:
492  Since there is no free surface solver, references to it have been removed from \rou{stp\_ctl} module.
493\item \mdl{diawri}:
494  All 3D data have been removed from the output.
495  The surface temperature, salinity and velocity components (which have been read in) are written along with
496  relevant forcing and ice data.
497\end{itemize}
498
499One new routine has been added:
500
501\begin{itemize}
502\item \mdl{sbcsas}:
503  This module initialises the input files needed for reading temperature, salinity and
504  velocity arrays at the surface.
505  These filenames are supplied in namelist namsbc\_sas.
506  Unfortunately, because of limitations with the \mdl{iom} module,
507  the full 3D fields from the mean files have to be read in and interpolated in time,
508  before using just the top level.
509  Since fldread is used to read in the data, Interpolation on the Fly may be used to change input data resolution.
510\end{itemize}
511
512The user can also choose in the \nam{sbc_sas}{sbc\_sas} namelist to read the mean (nn\_fsbc time-step) fraction of solar net radiation absorbed in the 1st T level using
513 (\np[=.true.]{ln_flx}{ln\_flx}) and to provide 3D oceanic velocities instead of 2D ones (\np{ln_flx}{ln\_flx}\forcode{=.true.}). In that last case, only the 1st level will be read in.
514
515\section[Flux formulation (\textit{sbcflx.F90})]{Flux formulation (\protect\mdl{sbcflx})}
516\label{sec:SBC_flx}
517%------------------------------------------namsbc_flx----------------------------------------------------
518
519\begin{listing}
520  \nlst{namsbc_flx}
521  \caption{\forcode{&namsbc_flx}}
522  \label{lst:namsbc_flx}
523\end{listing}
524%-------------------------------------------------------------------------------------------------------------
525
526In the flux formulation (\np[=.true.]{ln_flx}{ln\_flx}),
527the surface boundary condition fields are directly read from input files.
528The user has to define in the namelist \nam{sbc_flx}{sbc\_flx} the name of the file,
529the name of the variable read in the file, the time frequency at which it is given (in hours),
530and a logical setting whether a time interpolation to the model time step is required for this field.
531See \autoref{subsec:SBC_fldread} for a more detailed description of the parameters.
532
533Note that in general, a flux formulation is used in associated with a restoring term to observed SST and/or SSS.
534See \autoref{subsec:SBC_ssr} for its specification.
535
536\section[Bulk formulation (\textit{sbcblk.F90})]{Bulk formulation (\protect\mdl{sbcblk})}
537\label{sec:SBC_blk}
538%---------------------------------------namsbc_blk--------------------------------------------------
539
540\begin{listing}
541  \nlst{namsbc_blk}
542  \caption{\forcode{&namsbc_blk}}
543  \label{lst:namsbc_blk}
544\end{listing}
545%--------------------------------------------------------------------------------------------------------------
546
547In the bulk formulation, the surface boundary condition fields are computed with bulk formulae using atmospheric fields
548and ocean (and sea-ice) variables averaged over \np{nn_fsbc}{nn\_fsbc} time-step.
549
550The atmospheric fields used depend on the bulk formulae used.
551In forced mode, when a sea-ice model is used, a specific bulk formulation is used.
552Therefore, different bulk formulae are used for the turbulent fluxes computation
553over the ocean and over sea-ice surface.
554For the ocean, four bulk formulations are available thanks to the \href{https://brodeau.github.io/aerobulk/}{Aerobulk} package (\citet{brodeau.barnier.ea_JPO16}):
555the NCAR (formerly named CORE), COARE 3.0, COARE 3.5 and ECMWF bulk formulae.
556The choice is made by setting to true one of the following namelist variable:
557 \np{ln_NCAR}{ln\_NCAR}, \np{ln_COARE_3p0}{ln\_COARE\_3p0}\np{ln_COARE_3p5}{ln\_COARE\_3p5} and  \np{ln_ECMWF}{ln\_ECMWF}.
558For sea-ice, three possibilities can be selected:
559a constant transfer coefficient (1.4e-3; default value), \citet{lupkes.gryanik.ea_JGR12} (\np{ln_Cd_L12}{ln\_Cd\_L12}), and \citet{lupkes.gryanik_JGR15} (\np{ln_Cd_L15}{ln\_Cd\_L15}) parameterizations
560
561Common options are defined through the \nam{sbc_blk}{sbc\_blk} namelist variables.
562The required 9 input fields are:
563
564%--------------------------------------------------TABLE--------------------------------------------------
565\begin{table}[htbp]
566  \centering
567  \begin{tabular}{|l|c|c|c|}
568    \hline
569    Variable description                 & Model variable & Units              & point \\
570    \hline
571    i-component of the 10m air velocity  & utau           & $m.s^{-1}$         & T     \\
572    \hline
573    j-component of the 10m air velocity  & vtau           & $m.s^{-1}$         & T     \\
574    \hline
575    10m air temperature                  & tair           & \r{}$K$            & T     \\
576    \hline
577    Specific humidity                    & humi           & \%                 & T     \\
578    \hline
579    Incoming long wave radiation         & qlw            & $W.m^{-2}$         & T     \\
580    \hline
581    Incoming short wave radiation        & qsr            & $W.m^{-2}$         & T     \\
582    \hline
583    Total precipitation (liquid + solid) & precip         & $Kg.m^{-2}.s^{-1}$ & T     \\
584    \hline
585    Solid precipitation                  & snow           & $Kg.m^{-2}.s^{-1}$ & T     \\
586    \hline
587    Mean sea-level pressure              & slp            & $hPa$              & T     \\
588    \hline
589    \end{tabular}
590  \label{tab:SBC_BULK}
591\end{table}
592%--------------------------------------------------------------------------------------------------------------
593
594Note that the air velocity is provided at a tracer ocean point, not at a velocity ocean point ($u$- and $v$-points).
595It is simpler and faster (less fields to be read), but it is not the recommended method when
596the ocean grid size is the same or larger than the one of the input atmospheric fields.
597
598The \np{sn_wndi}{sn\_wndi}, \np{sn_wndj}{sn\_wndj}, \np{sn_qsr}{sn\_qsr}, \np{sn_qlw}{sn\_qlw}, \np{sn_tair}{sn\_tair}, \np{sn_humi}{sn\_humi}, \np{sn_prec}{sn\_prec},
599\np{sn_snow}{sn\_snow}, \np{sn_tdif}{sn\_tdif} parameters describe the fields and the way they have to be used
600(spatial and temporal interpolations).
601
602\np{cn_dir}{cn\_dir} is the directory of location of bulk files
603\np{ln_taudif}{ln\_taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.)
604\np{rn_zqt}{rn\_zqt}: is the height of humidity and temperature measurements (m)
605\np{rn_zu}{rn\_zu}: is the height of wind measurements (m)
606
607Three multiplicative factors are available:
608\np{rn_pfac}{rn\_pfac} and \np{rn_efac}{rn\_efac} allow to adjust (if necessary) the global freshwater budget by
609increasing/reducing the precipitations (total and snow) and or evaporation, respectively.
610The third one,\np{rn_vfac}{rn\_vfac}, control to which extend the ice/ocean velocities are taken into account in
611the calculation of surface wind stress.
612Its range must be between zero and one, and it is recommended to set it to 0 at low-resolution (ORCA2 configuration).
613
614As for the flux formulation, information about the input data required by the model is provided in
615the namsbc\_blk namelist (see \autoref{subsec:SBC_fldread}).
616
617\subsection[Ocean-Atmosphere Bulk formulae (\textit{sbcblk\_algo\_coare.F90, sbcblk\_algo\_coare3p5.F90, sbcblk\_algo\_ecmwf.F90, sbcblk\_algo\_ncar.F90})]{Ocean-Atmosphere Bulk formulae (\mdl{sbcblk\_algo\_coare}, \mdl{sbcblk\_algo\_coare3p5}, \mdl{sbcblk\_algo\_ecmwf}, \mdl{sbcblk\_algo\_ncar})}
618\label{subsec:SBC_blk_ocean}
619
620Four different bulk algorithms are available to compute surface turbulent momentum and heat fluxes over the ocean.
621COARE 3.0, COARE 3.5 and ECMWF schemes mainly differ by their roughness lenghts computation and consequently
622their neutral transfer coefficients relationships with neutral wind.
623\begin{itemize}
624\item NCAR (\np[=.true.]{ln_NCAR}{ln\_NCAR}):
625  The NCAR bulk formulae have been developed by \citet{large.yeager_rpt04}.
626  They have been designed to handle the NCAR forcing, a mixture of NCEP reanalysis and satellite data.
627  They use an inertial dissipative method to compute the turbulent transfer coefficients
628  (momentum, sensible heat and evaporation) from the 10m wind speed, air temperature and specific humidity.
629  This \citet{large.yeager_rpt04} dataset is available through
630  the \href{http://nomads.gfdl.noaa.gov/nomads/forms/mom4/NCAR.html}{GFDL web site}.
631  Note that substituting ERA40 to NCEP reanalysis fields does not require changes in the bulk formulea themself.
632  This is the so-called DRAKKAR Forcing Set (DFS) \citep{brodeau.barnier.ea_OM10}.
633\item COARE 3.0 (\np[=.true.]{ln_COARE_3p0}{ln\_COARE\_3p0}):
634  See \citet{fairall.bradley.ea_JC03} for more details
635\item COARE 3.5 (\np[=.true.]{ln_COARE_3p5}{ln\_COARE\_3p5}):
636  See \citet{edson.jampana.ea_JPO13} for more details
637\item ECMWF (\np[=.true.]{ln_ECMWF}{ln\_ECMWF}):
638  Based on \href{https://www.ecmwf.int/node/9221}{IFS (Cy31)} implementation and documentation.
639  Surface roughness lengths needed for the Obukhov length are computed following \citet{beljaars_QJRMS95}.
640\end{itemize}
641
642\subsection{Ice-Atmosphere Bulk formulae}
643\label{subsec:SBC_blk_ice}
644
645Surface turbulent fluxes between sea-ice and the atmosphere can be computed in three different ways:
646
647\begin{itemize}
648\item Constant value (\np[ Cd_ice=1.4e-3 ]{constant value}{constant\ value}):
649  default constant value used for momentum and heat neutral transfer coefficients
650\item \citet{lupkes.gryanik.ea_JGR12} (\np[=.true.]{ln_Cd_L12}{ln\_Cd\_L12}):
651  This scheme adds a dependency on edges at leads, melt ponds and flows
652  of the constant neutral air-ice drag. After some approximations,
653  this can be resumed to a dependency on ice concentration (A).
654  This drag coefficient has a parabolic shape (as a function of ice concentration)
655  starting at 1.5e-3 for A=0, reaching 1.97e-3 for A=0.5 and going down 1.4e-3 for A=1.
656  It is theoretically applicable to all ice conditions (not only MIZ).
657\item \citet{lupkes.gryanik_JGR15} (\np[=.true.]{ln_Cd_L15}{ln\_Cd\_L15}):
658  Alternative turbulent transfer coefficients formulation between sea-ice
659  and atmosphere with distinct momentum and heat coefficients depending
660  on sea-ice concentration and atmospheric stability (no melt-ponds effect for now).
661  The parameterization is adapted from ECHAM6 atmospheric model.
662  Compared to Lupkes2012 scheme, it considers specific skin and form drags
663  to compute neutral transfer coefficients for both heat and momentum fluxes.
664  Atmospheric stability effect on transfer coefficient is also taken into account.
665\end{itemize}
666
667\section[Coupled formulation (\textit{sbccpl.F90})]{Coupled formulation (\protect\mdl{sbccpl})}
668\label{sec:SBC_cpl}
669%------------------------------------------namsbc_cpl----------------------------------------------------
670
671\begin{listing}
672  \nlst{namsbc_cpl}
673  \caption{\forcode{&namsbc_cpl}}
674  \label{lst:namsbc_cpl}
675\end{listing}
676%-------------------------------------------------------------------------------------------------------------
677
678In the coupled formulation of the surface boundary condition,
679the fluxes are provided by the OASIS coupler at a frequency which is defined in the OASIS coupler namelist,
680while sea and ice surface temperature, ocean and ice albedo, and ocean currents are sent to
681the atmospheric component.
682
683A generalised coupled interface has been developed.
684It is currently interfaced with OASIS-3-MCT versions 1 to 4 (\key{oasis3}).
685An additional specific CPP key (\key{oa3mct\_v1v2}) is needed for OASIS-3-MCT versions 1 and 2.
686It has been successfully used to interface \NEMO\ to most of the European atmospheric GCM
687(ARPEGE, ECHAM, ECMWF, HadAM, HadGAM, LMDz), as well as to \href{http://wrf-model.org/}{WRF}
688(Weather Research and Forecasting Model).
689
690When PISCES biogeochemical model (\key{top}) is also used in the coupled system,
691the whole carbon cycle is computed.
692In this case, CO$_2$ fluxes will be exchanged between the atmosphere and the ice-ocean system
693(and need to be activated in \nam{sbc_cpl}{sbc\_cpl} ).
694
695The namelist above allows control of various aspects of the coupling fields (particularly for vectors) and
696now allows for any coupling fields to have multiple sea ice categories (as required by LIM3 and CICE).
697When indicating a multi-category coupling field in \nam{sbc_cpl}{sbc\_cpl}, the number of categories will be determined by
698the number used in the sea ice model.
699In some limited cases, it may be possible to specify single category coupling fields even when
700the sea ice model is running with multiple categories -
701in this case, the user should examine the code to be sure the assumptions made are satisfactory.
702In cases where this is definitely not possible, the model should abort with an error message.
703
704\section[Atmospheric pressure (\textit{sbcapr.F90})]{Atmospheric pressure (\protect\mdl{sbcapr})}
705\label{sec:SBC_apr}
706%------------------------------------------namsbc_apr----------------------------------------------------
707
708\begin{listing}
709  \nlst{namsbc_apr}
710  \caption{\forcode{&namsbc_apr}}
711  \label{lst:namsbc_apr}
712\end{listing}
713%-------------------------------------------------------------------------------------------------------------
714
715The optional atmospheric pressure can be used to force ocean and ice dynamics
716(\np[=.true.]{ln_apr_dyn}{ln\_apr\_dyn}, \nam{sbc}{sbc} namelist).
717The input atmospheric forcing defined via \np{sn_apr}{sn\_apr} structure (\nam{sbc_apr}{sbc\_apr} namelist)
718can be interpolated in time to the model time step, and even in space when the interpolation on-the-fly is used.
719When used to force the dynamics, the atmospheric pressure is further transformed into
720an equivalent inverse barometer sea surface height, $\eta_{ib}$, using:
721\[
722  % \label{eq:SBC_ssh_ib}
723  \eta_{ib} = -  \frac{1}{g\,\rho_o}  \left( P_{atm} - P_o \right)
724\]
725where $P_{atm}$ is the atmospheric pressure and $P_o$ a reference atmospheric pressure.
726A value of $101,000~N/m^2$ is used unless \np{ln_ref_apr}{ln\_ref\_apr} is set to true.
727In this case, $P_o$ is set to the value of $P_{atm}$ averaged over the ocean domain,
728\ie\ the mean value of $\eta_{ib}$ is kept to zero at all time steps.
729
730The gradient of $\eta_{ib}$ is added to the RHS of the ocean momentum equation (see \mdl{dynspg} for the ocean).
731For sea-ice, the sea surface height, $\eta_m$, which is provided to the sea ice model is set to $\eta - \eta_{ib}$
732(see \mdl{sbcssr} module).
733$\eta_{ib}$ can be written in the output.
734This can simplify altimetry data and model comparison as
735inverse barometer sea surface height is usually removed from these date prior to their distribution.
736
737When using time-splitting and BDY package for open boundaries conditions,
738the equivalent inverse barometer sea surface height $\eta_{ib}$ can be added to BDY ssh data:
739\np{ln_apr_obc}{ln\_apr\_obc}  might be set to true.
740
741\section[Surface tides (\textit{sbctide.F90})]{Surface tides (\protect\mdl{sbctide})}
742\label{sec:SBC_tide}
743
744%------------------------------------------nam_tide---------------------------------------
745
746\begin{listing}
747  \nlst{nam_tide}
748  \caption{\forcode{&nam_tide}}
749  \label{lst:nam_tide}
750\end{listing}
751%-----------------------------------------------------------------------------------------
752
753The tidal forcing, generated by the gravity forces of the Earth-Moon and Earth-Sun sytems,
754is activated if \np{ln_tide}{ln\_tide} and \np{ln_tide_pot}{ln\_tide\_pot} are both set to \forcode{.true.} in \nam{_tide}{\_tide}.
755This translates as an additional barotropic force in the momentum \autoref{eq:MB_PE_dyn} such that:
756\[
757  % \label{eq:SBC_PE_dyn_tides}
758  \frac{\partial {\mathrm {\mathbf U}}_h }{\partial t}= ...
759  +g\nabla (\Pi_{eq} + \Pi_{sal})
760\]
761where $\Pi_{eq}$ stands for the equilibrium tidal forcing and
762$\Pi_{sal}$ is a self-attraction and loading term (SAL).
763
764The equilibrium tidal forcing is expressed as a sum over a subset of
765constituents chosen from the set of available tidal constituents
766defined in file \hf{SBC/tide} (this comprises the tidal
767constituents \textit{M2, N2, 2N2, S2, K2, K1, O1, Q1, P1, M4, Mf, Mm,
768  Msqm, Mtm, S1, MU2, NU2, L2}, and \textit{T2}). Individual
769constituents are selected by including their names in the array
770\np{clname}{clname} in \nam{_tide}{\_tide} (e.g., \np{clname}{clname}\forcode{(1)='M2', }
771\np{clname}{clname}\forcode{(2)='S2'} to select solely the tidal consituents \textit{M2}
772and \textit{S2}). Optionally, when \np{ln_tide_ramp}{ln\_tide\_ramp} is set to
773\forcode{.true.}, the equilibrium tidal forcing can be ramped up
774linearly from zero during the initial \np{rdttideramp}{rdttideramp} days of the
775model run.
776
777The SAL term should in principle be computed online as it depends on
778the model tidal prediction itself (see \citet{arbic.garner.ea_DSR04} for a
779discussion about the practical implementation of this term).
780Nevertheless, the complex calculations involved would make this
781computationally too expensive. Here, two options are available:
782$\Pi_{sal}$ generated by an external model can be read in
783(\np[=.true.]{ln_read_load}{ln\_read\_load}), or a ``scalar approximation'' can be
784used (\np[=.true.]{ln_scal_load}{ln\_scal\_load}). In the latter case
785\[
786  \Pi_{sal} = \beta \eta,
787\]
788where $\beta$ (\np{rn_scal_load}{rn\_scal\_load} with a default value of 0.094) is a
789spatially constant scalar, often chosen to minimize tidal prediction
790errors. Setting both \np{ln_read_load}{ln\_read\_load} and \np{ln_scal_load}{ln\_scal\_load} to
791\forcode{.false.} removes the SAL contribution.
792
793\section[River runoffs (\textit{sbcrnf.F90})]{River runoffs (\protect\mdl{sbcrnf})}
794\label{sec:SBC_rnf}
795%------------------------------------------namsbc_rnf----------------------------------------------------
796
797\begin{listing}
798  \nlst{namsbc_rnf}
799  \caption{\forcode{&namsbc_rnf}}
800  \label{lst:namsbc_rnf}
801\end{listing}
802%-------------------------------------------------------------------------------------------------------------
803
804%River runoff generally enters the ocean at a nonzero depth rather than through the surface.
805%Many models, however, have traditionally inserted river runoff to the top model cell.
806%This was the case in \NEMO\ prior to the version 3.3. The switch toward a input of runoff
807%throughout a nonzero depth has been motivated by the numerical and physical problems
808%that arise when the top grid cells are of the order of one meter. This situation is common in
809%coastal modelling and becomes more and more often open ocean and climate modelling
810%\footnote{At least a top cells thickness of 1~meter and a 3 hours forcing frequency are
811%required to properly represent the diurnal cycle \citep{bernie.woolnough.ea_JC05}. see also \autoref{fig:SBC_dcy}.}.
812
813%To do this we need to treat evaporation/precipitation fluxes and river runoff differently in the
814%\mdl{tra\_sbc} module.  We decided to separate them throughout the code, so that the variable
815%\textit{emp} represented solely evaporation minus precipitation fluxes, and a new 2d variable
816%rnf was added which represents the volume flux of river runoff (in kg/m2s to remain consistent with
817%emp).  This meant many uses of emp and emps needed to be changed, a list of all modules which use
818%emp or emps and the changes made are below:
819
820%Rachel:
821River runoff generally enters the ocean at a nonzero depth rather than through the surface.
822Many models, however, have traditionally inserted river runoff to the top model cell.
823This was the case in \NEMO\ prior to the version 3.3,
824and was combined with an option to increase vertical mixing near the river mouth.
825
826However, with this method numerical and physical problems arise when the top grid cells are of the order of one meter.
827This situation is common in coastal modelling and is becoming more common in open ocean and climate modelling
828\footnote{
829  At least a top cells thickness of 1~meter and a 3 hours forcing frequency are required to
830  properly represent the diurnal cycle \citep{bernie.woolnough.ea_JC05}.
831  see also \autoref{fig:SBC_dcy}.}.
832
833As such from V~3.3 onwards it is possible to add river runoff through a non-zero depth,
834and for the temperature and salinity of the river to effect the surrounding ocean.
835The user is able to specify, in a NetCDF input file, the temperature and salinity of the river,
836along with the depth (in metres) which the river should be added to.
837
838Namelist variables in \nam{sbc_rnf}{sbc\_rnf}, \np{ln_rnf_depth}{ln\_rnf\_depth}, \np{ln_rnf_sal}{ln\_rnf\_sal} and
839\np{ln_rnf_temp}{ln\_rnf\_temp} control whether the river attributes (depth, salinity and temperature) are read in and used.
840If these are set as false the river is added to the surface box only, assumed to be fresh (0~psu),
841and/or taken as surface temperature respectively.
842
843The runoff value and attributes are read in in sbcrnf.
844For temperature -999 is taken as missing data and the river temperature is taken to
845be the surface temperatue at the river point.
846For the depth parameter a value of -1 means the river is added to the surface box only,
847and a value of -999 means the river is added through the entire water column.
848After being read in the temperature and salinity variables are multiplied by the amount of runoff
849(converted into m/s) to give the heat and salt content of the river runoff.
850After the user specified depth is read ini,
851the number of grid boxes this corresponds to is calculated and stored in the variable \np{nz_rnf}{nz\_rnf}.
852The variable \textit{h\_dep} is then calculated to be the depth (in metres) of
853the bottom of the lowest box the river water is being added to
854(\ie\ the total depth that river water is being added to in the model).
855
856The mass/volume addition due to the river runoff is, at each relevant depth level, added to
857the horizontal divergence (\textit{hdivn}) in the subroutine \rou{sbc\_rnf\_div} (called from \mdl{divhor}).
858This increases the diffusion term in the vicinity of the river, thereby simulating a momentum flux.
859The sea surface height is calculated using the sum of the horizontal divergence terms,
860and so the river runoff indirectly forces an increase in sea surface height.
861
862The \textit{hdivn} terms are used in the tracer advection modules to force vertical velocities.
863This causes a mass of water, equal to the amount of runoff, to be moved into the box above.
864The heat and salt content of the river runoff is not included in this step,
865and so the tracer concentrations are diluted as water of ocean temperature and salinity is moved upward out of
866the box and replaced by the same volume of river water with no corresponding heat and salt addition.
867
868For the linear free surface case, at the surface box the tracer advection causes a flux of water
869(of equal volume to the runoff) through the sea surface out of the domain,
870which causes a salt and heat flux out of the model.
871As such the volume of water does not change, but the water is diluted.
872
873For the non-linear free surface case, no flux is allowed through the surface.
874Instead in the surface box (as well as water moving up from the boxes below) a volume of runoff water is added with
875no corresponding heat and salt addition and so as happens in the lower boxes there is a dilution effect.
876(The runoff addition to the top box along with the water being moved up through
877boxes below means the surface box has a large increase in volume, whilst all other boxes remain the same size)
878
879In trasbc the addition of heat and salt due to the river runoff is added.
880This is done in the same way for both vvl and non-vvl.
881The temperature and salinity are increased through the specified depth according to
882the heat and salt content of the river.
883
884In the non-linear free surface case (vvl),
885near the end of the time step the change in sea surface height is redistrubuted through the grid boxes,
886so that the original ratios of grid box heights are restored.
887In doing this water is moved into boxes below, throughout the water column,
888so the large volume addition to the surface box is spread between all the grid boxes.
889
890It is also possible for runnoff to be specified as a negative value for modelling flow through straits,
891\ie\ modelling the Baltic flow in and out of the North Sea.
892When the flow is out of the domain there is no change in temperature and salinity,
893regardless of the namelist options used,
894as the ocean water leaving the domain removes heat and salt (at the same concentration) with it.
895
896%\colorbox{yellow}{Nevertheless, Pb of vertical resolution and 3D input : increase vertical mixing near river mouths to mimic a 3D river
897
898%All river runoff and emp fluxes are assumed to be fresh water (zero salinity) and at the same temperature as the sea surface.}
899
900%\colorbox{yellow}{river mouths{\ldots}}
901
902%IF( ln_rnf ) THEN                                     ! increase diffusivity at rivers mouths
903%        DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + rn_avt_rnf * rnfmsk(:,:)   ;   END DO
904%ENDIF
905
906%\gmcomment{  word doc of runoffs:
907%
908%In the current \NEMO\ setup river runoff is added to emp fluxes, these are then applied at just the sea surface as a volume change (in the variable volume case this is a literal volume change, and in the linear free surface case the free surface is moved) and a salt flux due to the concentration/dilution effect.  There is also an option to increase vertical mixing near river mouths; this gives the effect of having a 3d river.  All river runoff and emp fluxes are assumed to be fresh water (zero salinity) and at the same temperature as the sea surface.
909%Our aim was to code the option to specify the temperature and salinity of river runoff, (as well as the amount), along with the depth that the river water will affect.  This would make it possible to model low salinity outflow, such as the Baltic, and would allow the ocean temperature to be affected by river runoff.
910
911%The depth option makes it possible to have the river water affecting just the surface layer, throughout depth, or some specified point in between.
912
913%To do this we need to treat evaporation/precipitation fluxes and river runoff differently in the tra_sbc module.  We decided to separate them throughout the code, so that the variable emp represented solely evaporation minus precipitation fluxes, and a new 2d variable rnf was added which represents the volume flux of river runoff (in kg/m2s to remain consistent with emp).  This meant many uses of emp and emps needed to be changed, a list of all modules which use emp or emps and the changes made are below:
914
915\section[Ice shelf melting (\textit{sbcisf.F90})]{Ice shelf melting (\protect\mdl{sbcisf})}
916\label{sec:SBC_isf}
917%------------------------------------------namsbc_isf----------------------------------------------------
918
919\begin{listing}
920  \nlst{namsbc_isf}
921  \caption{\forcode{&namsbc_isf}}
922  \label{lst:namsbc_isf}
923\end{listing}
924%--------------------------------------------------------------------------------------------------------
925
926The namelist variable in \nam{sbc}{sbc}, \np{nn_isf}{nn\_isf}, controls the ice shelf representation.
927Description and result of sensitivity test to \np{nn_isf}{nn\_isf} are presented in \citet{mathiot.jenkins.ea_GMD17}.
928The different options are illustrated in \autoref{fig:SBC_isf}.
929
930\begin{description}
931
932  \item [{\np[=1]{nn_isf}{nn\_isf}}]:
933  The ice shelf cavity is represented (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
934  The fwf and heat flux are depending of the local water properties.
935
936  Two different bulk formulae are available:
937
938   \begin{description}
939   \item [{\np[=1]{nn_isfblk}{nn\_isfblk}}]:
940     The melt rate is based on a balance between the upward ocean heat flux and
941     the latent heat flux at the ice shelf base. A complete description is available in \citet{hunter_rpt06}.
942   \item [{\np[=2]{nn_isfblk}{nn\_isfblk}}]:
943     The melt rate and the heat flux are based on a 3 equations formulation
944     (a heat flux budget at the ice base, a salt flux budget at the ice base and a linearised freezing point temperature equation).
945     A complete description is available in \citet{jenkins_JGR91}.
946   \end{description}
947
948     Temperature and salinity used to compute the melt are the average temperature in the top boundary layer \citet{losch_JGR08}.
949     Its thickness is defined by \np{rn_hisf_tbl}{rn\_hisf\_tbl}.
950     The fluxes and friction velocity are computed using the mean temperature, salinity and velocity in the the first \np{rn_hisf_tbl}{rn\_hisf\_tbl} m.
951     Then, the fluxes are spread over the same thickness (ie over one or several cells).
952     If \np{rn_hisf_tbl}{rn\_hisf\_tbl} larger than top $e_{3}t$, there is no more feedback between the freezing point at the interface and the the top cell temperature.
953     This can lead to super-cool temperature in the top cell under melting condition.
954     If \np{rn_hisf_tbl}{rn\_hisf\_tbl} smaller than top $e_{3}t$, the top boundary layer thickness is set to the top cell thickness.\\
955
956     Each melt bulk formula depends on a exchange coeficient ($\Gamma^{T,S}$) between the ocean and the ice.
957     There are 3 different ways to compute the exchange coeficient:
958   \begin{description}
959        \item [{\np[=0]{nn_gammablk}{nn\_gammablk}}]:
960     The salt and heat exchange coefficients are constant and defined by \np{rn_gammas0}{rn\_gammas0} and \np{rn_gammat0}{rn\_gammat0}.
961     \begin{gather*}
962       % \label{eq:SBC_isf_gamma_iso}
963       \gamma^{T} = rn\_gammat0 \\
964       \gamma^{S} = rn\_gammas0
965     \end{gather*}
966     This is the recommended formulation for ISOMIP.
967   \item [{\np[=1]{nn_gammablk}{nn\_gammablk}}]:
968     The salt and heat exchange coefficients are velocity dependent and defined as
969     \begin{gather*}
970       \gamma^{T} = rn\_gammat0 \times u_{*} \\
971       \gamma^{S} = rn\_gammas0 \times u_{*}
972     \end{gather*}
973     where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn_hisf_tbl}{rn\_hisf\_tbl} meters).
974     See \citet{jenkins.nicholls.ea_JPO10} for all the details on this formulation. It is the recommended formulation for realistic application.
975   \item [{\np[=2]{nn_gammablk}{nn\_gammablk}}]:
976     The salt and heat exchange coefficients are velocity and stability dependent and defined as:
977\[
978\gamma^{T,S} = \frac{u_{*}}{\Gamma_{Turb} + \Gamma^{T,S}_{Mole}}
979\]
980     where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn_hisf_tbl}{rn\_hisf\_tbl} meters),
981     $\Gamma_{Turb}$ the contribution of the ocean stability and
982     $\Gamma^{T,S}_{Mole}$ the contribution of the molecular diffusion.
983     See \citet{holland.jenkins_JPO99} for all the details on this formulation.
984     This formulation has not been extensively tested in \NEMO\ (not recommended).
985   \end{description}
986  \item [{\np[=2]{nn_isf}{nn\_isf}}]:
987   The ice shelf cavity is not represented.
988   The fwf and heat flux are computed using the \citet{beckmann.goosse_OM03} parameterisation of isf melting.
989   The fluxes are distributed along the ice shelf edge between the depth of the average grounding line (GL)
990   (\np{sn_depmax_isf}{sn\_depmax\_isf}) and the base of the ice shelf along the calving front
991   (\np{sn_depmin_isf}{sn\_depmin\_isf}) as in (\np[=3]{nn_isf}{nn\_isf}).
992   The effective melting length (\np{sn_Leff_isf}{sn\_Leff\_isf}) is read from a file.
993  \item [{\np[=3]{nn_isf}{nn\_isf}}]:
994   The ice shelf cavity is not represented.
995   The fwf (\np{sn_rnfisf}{sn\_rnfisf}) is prescribed and distributed along the ice shelf edge between
996   the depth of the average grounding line (GL) (\np{sn_depmax_isf}{sn\_depmax\_isf}) and
997   the base of the ice shelf along the calving front (\np{sn_depmin_isf}{sn\_depmin\_isf}).
998   The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.
999  \item [{\np[=4]{nn_isf}{nn\_isf}}]:
1000   The ice shelf cavity is opened (\np[=.true.]{ln_isfcav}{ln\_isfcav} needed).
1001   However, the fwf is not computed but specified from file \np{sn_fwfisf}{sn\_fwfisf}).
1002   The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.
1003   As in \np[=1]{nn_isf}{nn\_isf}, the fluxes are spread over the top boundary layer thickness (\np{rn_hisf_tbl}{rn\_hisf\_tbl})\\
1004\end{description}
1005
1006$\bullet$ \np[=1]{nn_isf}{nn\_isf} and \np[=2]{nn_isf}{nn\_isf} compute a melt rate based on
1007the water mass properties, ocean velocities and depth.
1008This flux is thus highly dependent of the model resolution (horizontal and vertical),
1009realism of the water masses onto the shelf ...\\
1010
1011$\bullet$ \np[=3]{nn_isf}{nn\_isf} and \np[=4]{nn_isf}{nn\_isf} read the melt rate from a file.
1012You have total control of the fwf forcing.
1013This can be useful if the water masses on the shelf are not realistic or
1014the resolution (horizontal/vertical) are too coarse to have realistic melting or
1015for studies where you need to control your heat and fw input.\\
1016
1017The ice shelf melt is implemented as a volume flux as for the runoff.
1018The fw addition due to the ice shelf melting is, at each relevant depth level, added to
1019the horizontal divergence (\textit{hdivn}) in the subroutine \rou{sbc\_isf\_div}, called from \mdl{divhor}.
1020See the runoff section \autoref{sec:SBC_rnf} for all the details about the divergence correction.\\
1021
1022\begin{figure}[!t]
1023  \centering
1024  \includegraphics[width=0.66\textwidth]{Fig_SBC_isf}
1025  \caption[Ice shelf location and fresh water flux definition]{
1026    Illustration of the location where the fwf is injected and
1027    whether or not the fwf is interactif or not depending of \protect\np{nn_isf}{nn\_isf}.}
1028  \label{fig:SBC_isf}
1029\end{figure}
1030
1031\section{Ice sheet coupling}
1032\label{sec:SBC_iscpl}
1033%------------------------------------------namsbc_iscpl----------------------------------------------------
1034
1035\begin{listing}
1036  \nlst{namsbc_iscpl}
1037  \caption{\forcode{&namsbc_iscpl}}
1038  \label{lst:namsbc_iscpl}
1039\end{listing}
1040%--------------------------------------------------------------------------------------------------------
1041
1042Ice sheet/ocean coupling is done through file exchange at the restart step.
1043At each restart step:
1044
1045\begin{description}
1046\item [Step 1]: the ice sheet model send a new bathymetry and ice shelf draft netcdf file.
1047\item [Step 2]: a new domcfg.nc file is built using the DOMAINcfg tools.
1048\item [Step 3]: \NEMO\ run for a specific period and output the average melt rate over the period.
1049\item [Step 4]: the ice sheet model run using the melt rate outputed in step 4.
1050\item [Step 5]: go back to 1.
1051\end{description}
1052
1053If \np[=.true.]{ln_iscpl}{ln\_iscpl}, the isf draft is assume to be different at each restart step with
1054potentially some new wet/dry cells due to the ice sheet dynamics/thermodynamics.
1055The wetting and drying scheme applied on the restart is very simple and described below for the 6 different possible cases:
1056
1057\begin{description}
1058\item [Thin a cell down]:
1059  T/S/ssh are unchanged and U/V in the top cell are corrected to keep the barotropic transport (bt) constant
1060  ($bt_b=bt_n$).
1061\item [Enlarge  a cell]:
1062  See case "Thin a cell down"
1063\item [Dry a cell]:
1064  mask, T/S, U/V and ssh are set to 0.
1065  Furthermore, U/V into the water column are modified to satisfy ($bt_b=bt_n$).
1066\item [Wet a cell]:
1067  mask is set to 1, T/S is extrapolated from neighbours, $ssh_n = ssh_b$ and U/V set to 0.
1068  If no neighbours, T/S is extrapolated from old top cell value.
1069  If no neighbours along i,j and k (both previous test failed), T/S/U/V/ssh and mask are set to 0.
1070\item [Dry a column]:
1071   mask, T/S, U/V are set to 0 everywhere in the column and ssh set to 0.
1072\item [Wet a column]:
1073  set mask to 1, T/S is extrapolated from neighbours, ssh is extrapolated from neighbours and U/V set to 0.
1074  If no neighbour, T/S/U/V and mask set to 0.
1075\end{description}
1076
1077Furthermore, as the before and now fields are not compatible (modification of the geometry),
1078the restart time step is prescribed to be an euler time step instead of a leap frog and $fields_b = fields_n$.\\
1079
1080The horizontal extrapolation to fill new cell with realistic value is called \np{nn_drown}{nn\_drown} times.
1081It means that if the grounding line retreat by more than \np{nn_drown}{nn\_drown} cells between 2 coupling steps,
1082the code will be unable to fill all the new wet cells properly.
1083The default number is set up for the MISOMIP idealised experiments.
1084This coupling procedure is able to take into account grounding line and calving front migration.
1085However, it is a non-conservative processe.
1086This could lead to a trend in heat/salt content and volume.\\
1087
1088In order to remove the trend and keep the conservation level as close to 0 as possible,
1089a simple conservation scheme is available with \np[=.true.]{ln_hsb}{ln\_hsb}.
1090The heat/salt/vol. gain/loss is diagnosed, as well as the location.
1091A correction increment is computed and apply each time step during the next \np{rn_fiscpl}{rn\_fiscpl} time steps.
1092For safety, it is advised to set \np{rn_fiscpl}{rn\_fiscpl} equal to the coupling period (smallest increment possible).
1093The corrective increment is apply into the cell itself (if it is a wet cell), the neigbouring cells or the closest wet cell (if the cell is now dry).
1094
1095\section{Handling of icebergs (ICB)}
1096\label{sec:SBC_ICB_icebergs}
1097%------------------------------------------namberg----------------------------------------------------
1098
1099\begin{listing}
1100  \nlst{namberg}
1101  \caption{\forcode{&namberg}}
1102  \label{lst:namberg}
1103\end{listing}
1104%-------------------------------------------------------------------------------------------------------------
1105
1106Icebergs are modelled as lagrangian particles in \NEMO\ \citep{marsh.ivchenko.ea_GMD15}.
1107Their physical behaviour is controlled by equations as described in \citet{martin.adcroft_OM10} ).
1108(Note that the authors kindly provided a copy of their code to act as a basis for implementation in \NEMO).
1109Icebergs are initially spawned into one of ten classes which have specific mass and thickness as
1110described in the \nam{berg}{berg} namelist: \np{rn_initial_mass}{rn\_initial\_mass} and \np{rn_initial_thickness}{rn\_initial\_thickness}.
1111Each class has an associated scaling (\np{rn_mass_scaling}{rn\_mass\_scaling}),
1112which is an integer representing how many icebergs of this class are being described as one lagrangian point
1113(this reduces the numerical problem of tracking every single iceberg).
1114They are enabled by setting \np[=.true.]{ln_icebergs}{ln\_icebergs}.
1115
1116Two initialisation schemes are possible.
1117\begin{description}
1118\item [{\np{nn_test_icebergs}{nn\_test\_icebergs}~$>$~0}]
1119  In this scheme, the value of \np{nn_test_icebergs}{nn\_test\_icebergs} represents the class of iceberg to generate
1120  (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
1121  which an iceberg is generated at the beginning of the run.
1122  (Note that this happens each time the timestep equals \np{nn_nit000}{nn\_nit000}.)
1123  \np{nn_test_icebergs}{nn\_test\_icebergs} is defined by four numbers in \np{nn_test_box}{nn\_test\_box} representing the corners of
1124  the geographical box: lonmin,lonmax,latmin,latmax
1125\item [{\np[=-1]{nn_test_icebergs}{nn\_test\_icebergs}}]
1126  In this scheme, the model reads a calving file supplied in the \np{sn_icb}{sn\_icb} parameter.
1127  This should be a file with a field on the configuration grid (typically ORCA)
1128  representing ice accumulation rate at each model point.
1129  These should be ocean points adjacent to land where icebergs are known to calve.
1130  Most points in this input grid are going to have value zero.
1131  When the model runs, ice is accumulated at each grid point which has a non-zero source term.
1132  At each time step, a test is performed to see if there is enough ice mass to
1133  calve an iceberg of each class in order (1 to 10).
1134  Note that this is the initial mass multiplied by the number each particle represents (\ie\ the scaling).
1135  If there is enough ice, a new iceberg is spawned and the total available ice reduced accordingly.
1136\end{description}
1137
1138Icebergs are influenced by wind, waves and currents, bottom melt and erosion.
1139The latter act to disintegrate the iceberg.
1140This is either all melted freshwater,
1141or (if \np{rn_bits_erosion_fraction}{rn\_bits\_erosion\_fraction}~$>$~0) into melt and additionally small ice bits
1142which are assumed to propagate with their larger parent and thus delay fluxing into the ocean.
1143Melt water (and other variables on the configuration grid) are written into the main \NEMO\ model output files.
1144
1145Extensive diagnostics can be produced.
1146Separate output files are maintained for human-readable iceberg information.
1147A separate file is produced for each processor (independent of \np{ln_ctl}{ln\_ctl}).
1148The amount of information is controlled by two integer parameters:
1149\begin{description}
1150\item [{\np{nn_verbose_level}{nn\_verbose\_level}}] takes a value between one and four and
1151  represents an increasing number of points in the code at which variables are written,
1152  and an increasing level of obscurity.
1153\item [{\np{nn_verbose_write}{nn\_verbose\_write}}] is the number of timesteps between writes
1154\end{description}
1155
1156Iceberg trajectories can also be written out and this is enabled by setting \np{nn_sample_rate}{nn\_sample\_rate}~$>$~0.
1157A non-zero value represents how many timesteps between writes of information into the output file.
1158These output files are in NETCDF format.
1159When \key{mpp\_mpi} is defined, each output file contains only those icebergs in the corresponding processor.
1160Trajectory points are written out in the order of their parent iceberg in the model's "linked list" of icebergs.
1161So care is needed to recreate data for individual icebergs,
1162since its trajectory data may be spread across multiple files.
1163
1164\section[Interactions with waves (\textit{sbcwave.F90}, \forcode{ln_wave})]{Interactions with waves (\protect\mdl{sbcwave}, \protect\np{ln_wave}{ln\_wave})}
1165\label{sec:SBC_wave}
1166%------------------------------------------namsbc_wave--------------------------------------------------------
1167
1168\begin{listing}
1169  \nlst{namsbc_wave}
1170  \caption{\forcode{&namsbc_wave}}
1171  \label{lst:namsbc_wave}
1172\end{listing}
1173%-------------------------------------------------------------------------------------------------------------
1174
1175Ocean waves represent the interface between the ocean and the atmosphere, so \NEMO\ is extended to incorporate
1176physical processes related to ocean surface waves, namely the surface stress modified by growth and
1177dissipation of the oceanic wave field, the Stokes-Coriolis force and the Stokes drift impact on mass and
1178tracer advection; moreover the neutral surface drag coefficient from a wave model can be used to evaluate
1179the wind stress.
1180
1181Physical processes related to ocean surface waves can be accounted by setting the logical variable
1182\np[=.true.]{ln_wave}{ln\_wave} in \nam{sbc}{sbc} namelist. In addition, specific flags accounting for
1183different processes should be activated as explained in the following sections.
1184
1185Wave fields can be provided either in forced or coupled mode:
1186\begin{description}
1187\item [forced mode]: wave fields should be defined through the \nam{sbc_wave}{sbc\_wave} namelist
1188for external data names, locations, frequency, interpolation and all the miscellanous options allowed by
1189Input Data generic Interface (see \autoref{sec:SBC_input}).
1190\item [coupled mode]: \NEMO\ and an external wave model can be coupled by setting \np[=.true.]{ln_cpl}{ln\_cpl}
1191in \nam{sbc}{sbc} namelist and filling the \nam{sbc_cpl}{sbc\_cpl} namelist.
1192\end{description}
1193
1194% ----------------------------------------------------------------
1195% Neutral drag coefficient from wave model (ln_cdgw)
1196
1197% ----------------------------------------------------------------
1198\subsection[Neutral drag coefficient from wave model (\forcode{ln_cdgw})]{Neutral drag coefficient from wave model (\protect\np{ln_cdgw}{ln\_cdgw})}
1199\label{subsec:SBC_wave_cdgw}
1200
1201The neutral surface drag coefficient provided from an external data source (\ie\ a wave model),
1202can be used by setting the logical variable \np[=.true.]{ln_cdgw}{ln\_cdgw} in \nam{sbc}{sbc} namelist.
1203Then using the routine \rou{sbcblk\_algo\_ncar} and starting from the neutral drag coefficent provided,
1204the drag coefficient is computed according to the stable/unstable conditions of the
1205air-sea interface following \citet{large.yeager_rpt04}.
1206
1207% ----------------------------------------------------------------
1208% 3D Stokes Drift (ln_sdw, nn_sdrift)
1209% ----------------------------------------------------------------
1210\subsection[3D Stokes Drift (\forcode{ln_sdw} \& \forcode{nn_sdrift})]{3D Stokes Drift (\protect\np{ln_sdw}{ln\_sdw} \& \np{nn_sdrift}{nn\_sdrift})}
1211\label{subsec:SBC_wave_sdw}
1212
1213The Stokes drift is a wave driven mechanism of mass and momentum transport \citep{stokes_ibk09}.
1214It is defined as the difference between the average velocity of a fluid parcel (Lagrangian velocity)
1215and the current measured at a fixed point (Eulerian velocity).
1216As waves travel, the water particles that make up the waves travel in orbital motions but
1217without a closed path. Their movement is enhanced at the top of the orbit and slowed slightly
1218at the bottom, so the result is a net forward motion of water particles, referred to as the Stokes drift.
1219An accurate evaluation of the Stokes drift and the inclusion of related processes may lead to improved
1220representation of surface physics in ocean general circulation models. %GS: reference needed
1221The Stokes drift velocity $\mathbf{U}_{st}$ in deep water can be computed from the wave spectrum and may be written as:
1222
1223\[
1224  % \label{eq:SBC_wave_sdw}
1225  \mathbf{U}_{st} = \frac{16{\pi^3}} {g}
1226  \int_0^\infty \int_{-\pi}^{\pi} (cos{\theta},sin{\theta}) {f^3}
1227  \mathrm{S}(f,\theta) \mathrm{e}^{2kz}\,\mathrm{d}\theta {d}f
1228\]
1229
1230where: ${\theta}$ is the wave direction, $f$ is the wave intrinsic frequency,
1231$\mathrm{S}($f$,\theta)$ is the 2D frequency-direction spectrum,
1232$k$ is the mean wavenumber defined as:
1233$k=\frac{2\pi}{\lambda}$ (being $\lambda$ the wavelength). \\
1234
1235In order to evaluate the Stokes drift in a realistic ocean wave field, the wave spectral shape is required
1236and its computation quickly becomes expensive as the 2D spectrum must be integrated for each vertical level.
1237To simplify, it is customary to use approximations to the full Stokes profile.
1238Three possible parameterizations for the calculation for the approximate Stokes drift velocity profile
1239are included in the code through the \np{nn_sdrift}{nn\_sdrift} parameter once provided the surface Stokes drift
1240$\mathbf{U}_{st |_{z=0}}$ which is evaluated by an external wave model that accurately reproduces the wave spectra
1241and makes possible the estimation of the surface Stokes drift for random directional waves in
1242realistic wave conditions:
1243
1244\begin{description}
1245\item [{\np{nn_sdrift}{nn\_sdrift} = 0}]: exponential integral profile parameterization proposed by
1246\citet{breivik.janssen.ea_JPO14}:
1247
1248\[
1249  % \label{eq:SBC_wave_sdw_0a}
1250  \mathbf{U}_{st} \cong \mathbf{U}_{st |_{z=0}} \frac{\mathrm{e}^{-2k_ez}} {1-8k_ez}
1251\]
1252
1253where $k_e$ is the effective wave number which depends on the Stokes transport $T_{st}$ defined as follows:
1254
1255\[
1256  % \label{eq:SBC_wave_sdw_0b}
1257  k_e = \frac{|\mathbf{U}_{\left.st\right|_{z=0}}|} {|T_{st}|}
1258  \quad \text{and }\
1259  T_{st} = \frac{1}{16} \bar{\omega} H_s^2
1260\]
1261
1262where $H_s$ is the significant wave height and $\omega$ is the wave frequency.
1263
1264\item [{\np{nn_sdrift}{nn\_sdrift} = 1}]: velocity profile based on the Phillips spectrum which is considered to be a
1265reasonable estimate of the part of the spectrum mostly contributing to the Stokes drift velocity near the surface
1266\citep{breivik.bidlot.ea_OM16}:
1267
1268\[
1269  % \label{eq:SBC_wave_sdw_1}
1270  \mathbf{U}_{st} \cong \mathbf{U}_{st |_{z=0}} \Big[exp(2k_pz)-\beta \sqrt{-2 \pi k_pz}
1271  \textit{ erf } \Big(\sqrt{-2 k_pz}\Big)\Big]
1272\]
1273
1274where $erf$ is the complementary error function and $k_p$ is the peak wavenumber.
1275
1276\item [{\np{nn_sdrift}{nn\_sdrift} = 2}]: velocity profile based on the Phillips spectrum as for \np{nn_sdrift}{nn\_sdrift} = 1
1277but using the wave frequency from a wave model.
1278
1279\end{description}
1280
1281The Stokes drift enters the wave-averaged momentum equation, as well as the tracer advection equations
1282and its effect on the evolution of the sea-surface height ${\eta}$ is considered as follows:
1283
1284\[
1285  % \label{eq:SBC_wave_eta_sdw}
1286  \frac{\partial{\eta}}{\partial{t}} =
1287  -\nabla_h \int_{-H}^{\eta} (\mathbf{U} + \mathbf{U}_{st}) dz
1288\]
1289
1290The tracer advection equation is also modified in order for Eulerian ocean models to properly account
1291for unresolved wave effect. The divergence of the wave tracer flux equals the mean tracer advection
1292that is induced by the three-dimensional Stokes velocity.
1293The advective equation for a tracer $c$ combining the effects of the mean current and sea surface waves
1294can be formulated as follows:
1295
1296\[
1297  % \label{eq:SBC_wave_tra_sdw}
1298  \frac{\partial{c}}{\partial{t}} =
1299  - (\mathbf{U} + \mathbf{U}_{st}) \cdot \nabla{c}
1300\]
1301
1302% ----------------------------------------------------------------
1303% Stokes-Coriolis term (ln_stcor)
1304% ----------------------------------------------------------------
1305\subsection[Stokes-Coriolis term (\forcode{ln_stcor})]{Stokes-Coriolis term (\protect\np{ln_stcor}{ln\_stcor})}
1306\label{subsec:SBC_wave_stcor}
1307
1308In a rotating ocean, waves exert a wave-induced stress on the mean ocean circulation which results
1309in a force equal to $\mathbf{U}_{st}$×$f$, where $f$ is the Coriolis parameter.
1310This additional force may have impact on the Ekman turning of the surface current.
1311In order to include this term, once evaluated the Stokes drift (using one of the 3 possible
1312approximations described in \autoref{subsec:SBC_wave_sdw}),
1313\np[=.true.]{ln_stcor}{ln\_stcor} has to be set.
1314
1315% ----------------------------------------------------------------
1316% Waves modified stress (ln_tauwoc, ln_tauw)
1317% ----------------------------------------------------------------
1318\subsection[Wave modified stress (\forcode{ln_tauwoc} \& \forcode{ln_tauw})]{Wave modified sress (\protect\np{ln_tauwoc}{ln\_tauwoc} \& \np{ln_tauw}{ln\_tauw})}
1319\label{subsec:SBC_wave_tauw}
1320
1321The surface stress felt by the ocean is the atmospheric stress minus the net stress going
1322into the waves \citep{janssen.breivik.ea_rpt13}. Therefore, when waves are growing, momentum and energy is spent and is not
1323available for forcing the mean circulation, while in the opposite case of a decaying sea
1324state, more momentum is available for forcing the ocean.
1325Only when the sea state is in equilibrium, the ocean is forced by the atmospheric stress,
1326but in practice, an equilibrium sea state is a fairly rare event.
1327So the atmospheric stress felt by the ocean circulation $\tau_{oc,a}$ can be expressed as:
1328
1329\[
1330  % \label{eq:SBC_wave_tauoc}
1331  \tau_{oc,a} = \tau_a - \tau_w
1332\]
1333
1334where $\tau_a$ is the atmospheric surface stress;
1335$\tau_w$ is the atmospheric stress going into the waves defined as:
1336
1337\[
1338  % \label{eq:SBC_wave_tauw}
1339  \tau_w = \rho g \int {\frac{dk}{c_p} (S_{in}+S_{nl}+S_{diss})}
1340\]
1341
1342where: $c_p$ is the phase speed of the gravity waves,
1343$S_{in}$, $S_{nl}$ and $S_{diss}$ are three source terms that represent
1344the physics of ocean waves. The first one, $S_{in}$, describes the generation
1345of ocean waves by wind and therefore represents the momentum and energy transfer
1346from air to ocean waves; the second term $S_{nl}$ denotes
1347the nonlinear transfer by resonant four-wave interactions; while the third term $S_{diss}$
1348describes the dissipation of waves by processes such as white-capping, large scale breaking
1349eddy-induced damping.
1350
1351The wave stress derived from an external wave model can be provided either through the normalized
1352wave stress into the ocean by setting \np[=.true.]{ln_tauwoc}{ln\_tauwoc}, or through the zonal and
1353meridional stress components by setting \np[=.true.]{ln_tauw}{ln\_tauw}.
1354
1355\section{Miscellaneous options}
1356\label{sec:SBC_misc}
1357
1358\subsection[Diurnal cycle (\textit{sbcdcy.F90})]{Diurnal cycle (\protect\mdl{sbcdcy})}
1359\label{subsec:SBC_dcy}
1360%------------------------------------------namsbc-------------------------------------------------------------
1361%
1362
1363%-------------------------------------------------------------------------------------------------------------
1364
1365\begin{figure}[!t]
1366  \centering
1367  \includegraphics[width=0.66\textwidth]{Fig_SBC_diurnal}
1368  \caption[Reconstruction of the diurnal cycle variation of short wave flux]{
1369    Example of reconstruction of the diurnal cycle variation of short wave flux from
1370    daily mean values.
1371    The reconstructed diurnal cycle (black line) is chosen as
1372    the mean value of the analytical cycle (blue line) over a time step,
1373    not as the mid time step value of the analytically cycle (red square).
1374    From \citet{bernie.guilyardi.ea_CD07}.}
1375  \label{fig:SBC_diurnal}
1376\end{figure}
1377
1378\cite{bernie.woolnough.ea_JC05} have shown that to capture 90$\%$ of the diurnal variability of SST requires a vertical resolution in upper ocean of 1~m or better and a temporal resolution of the surface fluxes of 3~h or less.
1379%Unfortunately high frequency forcing fields are rare, not to say inexistent. GS: not true anymore !
1380Nevertheless, it is possible to obtain a reasonable diurnal cycle of the SST knowning only short wave flux (SWF) at high frequency \citep{bernie.guilyardi.ea_CD07}.
1381Furthermore, only the knowledge of daily mean value of SWF is needed,
1382as higher frequency variations can be reconstructed from them,
1383assuming that the diurnal cycle of SWF is a scaling of the top of the atmosphere diurnal cycle of incident SWF.
1384The \cite{bernie.guilyardi.ea_CD07} reconstruction algorithm is available in \NEMO\ by
1385setting \np[=.true.]{ln_dm2dc}{ln\_dm2dc} (a \textit{\nam{sbc}{sbc}} namelist variable) when
1386using a bulk formulation (\np[=.true.]{ln_blk}{ln\_blk}) or
1387the flux formulation (\np[=.true.]{ln_flx}{ln\_flx}).
1388The reconstruction is performed in the \mdl{sbcdcy} module.
1389The detail of the algoritm used can be found in the appendix~A of \cite{bernie.guilyardi.ea_CD07}.
1390The algorithm preserves the daily mean incoming SWF as the reconstructed SWF at
1391a given time step is the mean value of the analytical cycle over this time step (\autoref{fig:SBC_diurnal}).
1392The use of diurnal cycle reconstruction requires the input SWF to be daily
1393(\ie\ a frequency of 24 hours and a time interpolation set to true in \np{sn_qsr}{sn\_qsr} namelist parameter).
1394Furthermore, it is recommended to have a least 8 surface module time steps per day,
1395that is  $\rdt \ nn\_fsbc < 10,800~s = 3~h$.
1396An example of recontructed SWF is given in \autoref{fig:SBC_dcy} for a 12 reconstructed diurnal cycle,
1397one every 2~hours (from 1am to 11pm).
1398
1399\begin{figure}[!t]
1400  \centering
1401  \includegraphics[width=0.66\textwidth]{Fig_SBC_dcy}
1402  \caption[Reconstruction of the diurnal cycle variation of short wave flux on an ORCA2 grid]{
1403    Example of reconstruction of the diurnal cycle variation of short wave flux from
1404    daily mean values on an ORCA2 grid with a time sampling of 2~hours (from 1am to 11pm).
1405    The display is on (i,j) plane.}
1406  \label{fig:SBC_dcy}
1407\end{figure}
1408
1409Note also that the setting a diurnal cycle in SWF is highly recommended when
1410the top layer thickness approach 1~m or less, otherwise large error in SST can appear due to
1411an inconsistency between the scale of the vertical resolution and the forcing acting on that scale.
1412
1413\subsection{Rotation of vector pairs onto the model grid directions}
1414\label{subsec:SBC_rotation}
1415
1416When using a flux (\np[=.true.]{ln_flx}{ln\_flx}) or bulk (\np[=.true.]{ln_blk}{ln\_blk}) formulation,
1417pairs of vector components can be rotated from east-north directions onto the local grid directions.
1418This is particularly useful when interpolation on the fly is used since here any vectors are likely to
1419be defined relative to a rectilinear grid.
1420To activate this option, a non-empty string is supplied in the rotation pair column of the relevant namelist.
1421The eastward component must start with "U" and the northward component with "V".
1422The remaining characters in the strings are used to identify which pair of components go together.
1423So for example, strings "U1" and "V1" next to "utau" and "vtau" would pair the wind stress components together and
1424rotate them on to the model grid directions;
1425"U2" and "V2" could be used against a second pair of components, and so on.
1426The extra characters used in the strings are arbitrary.
1427The rot\_rep routine from the \mdl{geo2ocean} module is used to perform the rotation.
1428
1429\subsection[Surface restoring to observed SST and/or SSS (\textit{sbcssr.F90})]{Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})}
1430\label{subsec:SBC_ssr}
1431%------------------------------------------namsbc_ssr----------------------------------------------------
1432
1433\begin{listing}
1434  \nlst{namsbc_ssr}
1435  \caption{\forcode{&namsbc_ssr}}
1436  \label{lst:namsbc_ssr}
1437\end{listing}
1438%-------------------------------------------------------------------------------------------------------------
1439
1440Options are defined through the \nam{sbc_ssr}{sbc\_ssr} namelist variables.
1441On forced mode using a flux formulation (\np[=.true.]{ln_flx}{ln\_flx}),
1442a feedback term \emph{must} be added to the surface heat flux $Q_{ns}^o$:
1443\[
1444  % \label{eq:SBC_dmp_q}
1445  Q_{ns} = Q_{ns}^o + \frac{dQ}{dT} \left( \left. T \right|_{k=1} - SST_{Obs} \right)
1446\]
1447where SST is a sea surface temperature field (observed or climatological),
1448$T$ is the model surface layer temperature and
1449$\frac{dQ}{dT}$ is a negative feedback coefficient usually taken equal to $-40~W/m^2/K$.
1450For a $50~m$ mixed-layer depth, this value corresponds to a relaxation time scale of two months.
1451This term ensures that if $T$ perfectly matches the supplied SST, then $Q$ is equal to $Q_o$.
1452
1453In the fresh water budget, a feedback term can also be added.
1454Converted into an equivalent freshwater flux, it takes the following expression :
1455
1456\begin{equation}
1457  \label{eq:SBC_dmp_emp}
1458  \textit{emp} = \textit{emp}_o + \gamma_s^{-1} e_{3t}  \frac{  \left(\left.S\right|_{k=1}-SSS_{Obs}\right)}
1459  {\left.S\right|_{k=1}}
1460\end{equation}
1461
1462where $\textit{emp}_{o }$ is a net surface fresh water flux
1463(observed, climatological or an atmospheric model product),
1464\textit{SSS}$_{Obs}$ is a sea surface salinity
1465(usually a time interpolation of the monthly mean Polar Hydrographic Climatology \citep{steele.morley.ea_JC01}),
1466$\left.S\right|_{k=1}$ is the model surface layer salinity and
1467$\gamma_s$ is a negative feedback coefficient which is provided as a namelist parameter.
1468Unlike heat flux, there is no physical justification for the feedback term in \autoref{eq:SBC_dmp_emp} as
1469the atmosphere does not care about ocean surface salinity \citep{madec.delecluse_IWN97}.
1470The SSS restoring term should be viewed as a flux correction on freshwater fluxes to
1471reduce the uncertainties we have on the observed freshwater budget.
1472
1473\subsection{Handling of ice-covered area  (\textit{sbcice\_...})}
1474\label{subsec:SBC_ice-cover}
1475
1476The presence at the sea surface of an ice covered area modifies all the fluxes transmitted to the ocean.
1477There are several way to handle sea-ice in the system depending on
1478the value of the \np{nn_ice}{nn\_ice} namelist parameter found in \nam{sbc}{sbc} namelist.
1479\begin{description}
1480\item [nn\_ice = 0]
1481  there will never be sea-ice in the computational domain.
1482  This is a typical namelist value used for tropical ocean domain.
1483  The surface fluxes are simply specified for an ice-free ocean.
1484  No specific things is done for sea-ice.
1485\item [nn\_ice = 1]
1486  sea-ice can exist in the computational domain, but no sea-ice model is used.
1487  An observed ice covered area is read in a file.
1488  Below this area, the SST is restored to the freezing point and
1489  the heat fluxes are set to $-4~W/m^2$ ($-2~W/m^2$) in the northern (southern) hemisphere.
1490  The associated modification of the freshwater fluxes are done in such a way that
1491  the change in buoyancy fluxes remains zero.
1492  This prevents deep convection to occur when trying to reach the freezing point
1493  (and so ice covered area condition) while the SSS is too large.
1494  This manner of managing sea-ice area, just by using a IF case,
1495  is usually referred as the \textit{ice-if} model.
1496  It can be found in the \mdl{sbcice\_if} module.
1497\item [nn\_ice = 2 or more]
1498  A full sea ice model is used.
1499  This model computes the ice-ocean fluxes,
1500  that are combined with the air-sea fluxes using the ice fraction of each model cell to
1501  provide the surface averaged ocean fluxes.
1502  Note that the activation of a sea-ice model is done by defining a CPP key (\key{si3} or \key{cice}).
1503  The activation automatically overwrites the read value of nn\_ice to its appropriate value
1504  (\ie\ $2$ for SI3 or $3$ for CICE).
1505\end{description}
1506
1507% {Description of Ice-ocean interface to be added here or in LIM 2 and 3 doc ?}
1508%GS: ocean-ice (SI3) interface is not located in SBC directory anymore, so it should be included in SI3 doc
1509
1510\subsection[Interface to CICE (\textit{sbcice\_cice.F90})]{Interface to CICE (\protect\mdl{sbcice\_cice})}
1511\label{subsec:SBC_cice}
1512
1513It is possible to couple a regional or global \NEMO\ configuration (without AGRIF)
1514to the CICE sea-ice model by using \key{cice}.
1515The CICE code can be obtained from \href{http://oceans11.lanl.gov/trac/CICE/}{LANL} and
1516the additional 'hadgem3' drivers will be required, even with the latest code release.
1517Input grid files consistent with those used in \NEMO\ will also be needed,
1518and CICE CPP keys \textbf{ORCA\_GRID}, \textbf{CICE\_IN\_NEMO} and \textbf{coupled} should be used
1519(seek advice from UKMO if necessary).
1520Currently, the code is only designed to work when using the NCAR forcing option for \NEMO\ %GS: still true ?
1521(with \textit{calc\_strair}\forcode{=.true.} and \textit{calc\_Tsfc}\forcode{=.true.} in the CICE name-list),
1522or alternatively when \NEMO\ is coupled to the HadGAM3 atmosphere model
1523(with \textit{calc\_strair}\forcode{=.false.} and \textit{calc\_Tsfc}\forcode{=false}).
1524The code is intended to be used with \np{nn_fsbc}{nn\_fsbc} set to 1
1525(although coupling ocean and ice less frequently should work,
1526it is possible the calculation of some of the ocean-ice fluxes needs to be modified slightly -
1527the user should check that results are not significantly different to the standard case).
1528
1529There are two options for the technical coupling between \NEMO\ and CICE.
1530The standard version allows complete flexibility for the domain decompositions in the individual models,
1531but this is at the expense of global gather and scatter operations in the coupling which
1532become very expensive on larger numbers of processors.
1533The alternative option (using \key{nemocice\_decomp} for both \NEMO\ and CICE) ensures that
1534the domain decomposition is identical in both models (provided domain parameters are set appropriately,
1535and \textit{processor\_shape~=~square-ice} and \textit{distribution\_wght~=~block} in the CICE name-list) and
1536allows much more efficient direct coupling on individual processors.
1537This solution scales much better although it is at the expense of having more idle CICE processors in areas where
1538there is no sea ice.
1539
1540\subsection[Freshwater budget control (\textit{sbcfwb.F90})]{Freshwater budget control (\protect\mdl{sbcfwb})}
1541\label{subsec:SBC_fwb}
1542
1543For global ocean simulation, it can be useful to introduce a control of the mean sea level in order to
1544prevent unrealistic drift of the sea surface height due to inaccuracy in the freshwater fluxes.
1545In \NEMO, two way of controlling the freshwater budget are proposed:
1546
1547\begin{description}
1548\item [{\np[=0]{nn_fwb}{nn\_fwb}}]
1549  no control at all.
1550  The mean sea level is free to drift, and will certainly do so.
1551\item [{\np[=1]{nn_fwb}{nn\_fwb}}]
1552  global mean \textit{emp} set to zero at each model time step.
1553  %GS: comment below still relevant ?
1554  %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).
1555\item [{\np[=2]{nn_fwb}{nn\_fwb}}]
1556  freshwater budget is adjusted from the previous year annual mean budget which
1557  is read in the \textit{EMPave\_old.dat} file.
1558  As the model uses the Boussinesq approximation, the annual mean fresh water budget is simply evaluated from
1559  the change in the mean sea level at January the first and saved in the \textit{EMPav.dat} file.
1560\end{description}
1561
1562% Griffies doc:
1563% When running ocean-ice simulations, we are not explicitly representing land processes,
1564% such as rivers, catchment areas, snow accumulation, etc. However, to reduce model drift,
1565% it is important to balance the hydrological cycle in ocean-ice models.
1566% We thus need to prescribe some form of global normalization to the precipitation minus evaporation plus river runoff.
1567% The result of the normalization should be a global integrated zero net water input to the ocean-ice system over
1568% a chosen time scale.
1569% How often the normalization is done is a matter of choice. In mom4p1, we choose to do so at each model time step,
1570% so that there is always a zero net input of water to the ocean-ice system.
1571% Others choose to normalize over an annual cycle, in which case the net imbalance over an annual cycle is used
1572% to alter the subsequent year�s water budget in an attempt to damp the annual water imbalance.
1573% Note that the annual budget approach may be inappropriate with interannually varying precipitation forcing.
1574% When running ocean-ice coupled models, it is incorrect to include the water transport between the ocean
1575% and ice models when aiming to balance the hydrological cycle.
1576% The reason is that it is the sum of the water in the ocean plus ice that should be balanced when running ocean-ice models,
1577% not the water in any one sub-component. As an extreme example to illustrate the issue,
1578% consider an ocean-ice model with zero initial sea ice. As the ocean-ice model spins up,
1579% there should be a net accumulation of water in the growing sea ice, and thus a net loss of water from the ocean.
1580% The total water contained in the ocean plus ice system is constant, but there is an exchange of water between
1581% the subcomponents. This exchange should not be part of the normalization used to balance the hydrological cycle
1582% in ocean-ice models.
1583
1584\onlyinsubfile{\input{../../global/epilogue}}
1585
1586\end{document}
Note: See TracBrowser for help on using the repository browser.