New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 9393 for branches/2017/dev_merge_2017/DOC/tex_sub/chap_SBC.tex – NEMO

Ignore:
Timestamp:
2018-03-13T15:00:56+01:00 (6 years ago)
Author:
nicolasmartin
Message:

Cleaning of section headings, reinstating the index by mixing \np and \forcode macros, continued conversion of source code inclusions

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/2017/dev_merge_2017/DOC/tex_sub/chap_SBC.tex

    r9392 r9393  
    2828 
    2929Five different ways to provide the first six fields to the ocean are available which  
    30 are controlled by namelist \ngn{namsbc} variables: an analytical formulation (\np{ln_ana}~=~true),  
    31 a flux formulation (\np{ln_flx}~=~true), a bulk formulae formulation (CORE  
    32 (\np{ln_blk_core}~=~true), CLIO (\np{ln_blk_clio}~=~true) or MFS 
     30are controlled by namelist \ngn{namsbc} variables: an analytical formulation (\np{ln\_ana}\forcode{ = .true.}),  
     31a flux formulation (\np{ln\_flx}\forcode{ = .true.}), a bulk formulae formulation (CORE  
     32(\np{ln\_blk\_core}\forcode{ = .true.}), CLIO (\np{ln\_blk\_clio}\forcode{ = .true.}) or MFS 
    3333\footnote { Note that MFS bulk formulae compute fluxes only for the ocean component} 
    34 (\np{ln_blk_mfs}~=~true) bulk formulae) and a coupled or mixed forced/coupled formulation  
    35 (exchanges with a atmospheric model via the OASIS coupler) (\np{ln_cpl} or \np{ln_mixcpl}~=~true).  
    36 When used ($i.e.$ \np{ln_apr_dyn}~=~true), the atmospheric pressure forces both ocean and ice dynamics. 
    37  
    38 The frequency at which the forcing fields have to be updated is given by the \np{nn_fsbc} namelist parameter.  
     34(\np{ln\_blk\_mfs}\forcode{ = .true.}) bulk formulae) and a coupled or mixed forced/coupled formulation  
     35(exchanges with a atmospheric model via the OASIS coupler) (\np{ln\_cpl} or \np{ln\_mixcpl}\forcode{ = .true.}).  
     36When used ($i.e.$ \np{ln\_apr\_dyn}\forcode{ = .true.}), the atmospheric pressure forces both ocean and ice dynamics. 
     37 
     38The frequency at which the forcing fields have to be updated is given by the \np{nn\_fsbc} namelist parameter.  
    3939When the fields are supplied from data files (flux and bulk formulations), the input fields  
    4040need not be supplied on the model grid. Instead a file of coordinates and weights can  
     
    5050\item the rotation of vector components supplied relative to an east-north  
    5151coordinate system onto the local grid directions in the model ;  
    52 \item the addition of a surface restoring term to observed SST and/or SSS (\np{ln_ssr}~=~true) ;  
    53 \item the modification of fluxes below ice-covered areas (using observed ice-cover or a sea-ice model) (\np{nn_ice}~=~0,1, 2 or 3) ;  
    54 \item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np{ln_rnf}~=~true) ;  
    55 \item the addition of isf melting as lateral inflow (parameterisation) or as fluxes applied at the land-ice ocean interface (\np{ln_isf}) ;  
    56 \item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn_fwb}~=~0,~1~or~2) ;  
    57 \item the transformation of the solar radiation (if provided as daily mean) into a diurnal cycle (\np{ln_dm2dc}~=~true) ;  
    58 and a neutral drag coefficient can be read from an external wave model (\np{ln_cdgw}~=~true).  
     52\item the addition of a surface restoring term to observed SST and/or SSS (\np{ln\_ssr}\forcode{ = .true.}) ;  
     53\item the modification of fluxes below ice-covered areas (using observed ice-cover or a sea-ice model) (\np{nn\_ice}\forcode{ = 0..3}) ;  
     54\item the addition of river runoffs as surface freshwater fluxes or lateral inflow (\np{ln\_rnf}\forcode{ = .true.}) ;  
     55\item the addition of isf melting as lateral inflow (parameterisation) or as fluxes applied at the land-ice ocean interface (\np{ln\_isf}) ;  
     56\item the addition of a freshwater flux adjustment in order to avoid a mean sea-level drift (\np{nn\_fwb}\forcode{ = 0..2}) ;  
     57\item the transformation of the solar radiation (if provided as daily mean) into a diurnal cycle (\np{ln\_dm2dc}\forcode{ = .true.}) ;  
     58and a neutral drag coefficient can be read from an external wave model (\np{ln\_cdgw}\forcode{ = .true.}).  
    5959\end{itemize} 
    6060The latter option is possible only in case core or mfs bulk formulas are selected. 
     
    9191and \eqref{Eq_tra_sbc_lin} in \S\ref{TRA_sbc}).  
    9292The latter is the penetrative part of the heat flux. It is applied as a 3D  
    93 trends of the temperature equation (\mdl{traqsr} module) when \np{ln_traqsr}=\textit{true}. 
     93trends of the temperature equation (\mdl{traqsr} module) when \np{ln\_traqsr}\forcode{ = .true.}. 
    9494The way the light penetrates inside the water column is generally a sum of decreasing  
    9595exponentials (see \S\ref{TRA_qsr}).  
     
    110110%created!) 
    111111% 
    112 %Especially the \np{nn_fsbc}, the \mdl{sbc\_oce} module (fluxes + mean sst sss ssu  
     112%Especially the \np{nn\_fsbc}, the \mdl{sbc\_oce} module (fluxes + mean sst sss ssu  
    113113%ssv) i.e. information required by flux computation or sea-ice 
    114114% 
     
    130130The ocean model provides, at each time step, to the surface module (\mdl{sbcmod})  
    131131the surface currents, temperature and salinity.   
    132 These variables are averaged over \np{nn_fsbc} time-step (\ref{Tab_ssm}),  
     132These variables are averaged over \np{nn\_fsbc} time-step (\ref{Tab_ssm}),  
    133133and it is these averaged fields which are used to computes the surface fluxes  
    134 at a frequency of \np{nn_fsbc} time-step. 
     134at a frequency of \np{nn\_fsbc} time-step. 
    135135 
    136136 
     
    157157%       Input Data  
    158158% ================================================================ 
    159 \section{Input Data generic interface} 
     159\section{Input data generic interface} 
    160160\label{SBC_input} 
    161161 
     
    185185 
    186186Note that when an input data is archived on a disc which is accessible directly  
    187 from the workspace where the code is executed, then the use can set the \np{cn_dir}  
     187from the workspace where the code is executed, then the use can set the \np{cn\_dir}  
    188188to the pathway leading to the data. By default, the data are assumed to have been  
    189189copied so that cn\_dir='./'. 
     
    192192% Input Data specification (\mdl{fldread}) 
    193193% ------------------------------------------------------------------------------------------------------------- 
    194 \subsection{Input Data specification (\protect\mdl{fldread})} 
     194\subsection{Input data specification (\protect\mdl{fldread})} 
    195195\label{SBC_fldread} 
    196196 
     
    214214\hline 
    215215                         & daily or weekLLL          & monthly                   &   yearly          \\   \hline 
    216 clim = false   & \ifile{fn\_yYYYYmMMdDD}  &   \ifile{fn\_yYYYYmMM}   &   \ifile{fn\_yYYYY}  \\   \hline 
    217 clim = true       & not possible                  &  \ifile{fn\_m??}             &   fn                \\   \hline 
     216\np{clim}\forcode{ = .false.} & fn\_yYYYYmMMdDD.nc  &   fn\_yYYYYmMM.nc   &   fn\_yYYYY.nc  \\   \hline 
     217\np{clim}\forcode{ = .true.}        & not possible                  &  fn\_m??.nc             &   fn                \\   \hline 
    218218\end{tabular} 
    219219\end{center} 
     
    271271a time interpolation will be performed at the following time: 0h30'00", 1h30'00", 2h30'00", etc. 
    272272However, for forcing data related to the surface module, values are not needed at every  
    273 time-step but at every \np{nn_fsbc} time-step. For example with \np{nn_fsbc}~=~3,  
     273time-step but at every \np{nn\_fsbc} time-step. For example with \np{nn\_fsbc}\forcode{ = 3},  
    274274the surface module will be called at time-steps 1, 4, 7, etc. The date used for the time interpolation  
    275 is thus redefined to be at the middle of \np{nn_fsbc} time-step period. In the previous example,  
     275is thus redefined to be at the middle of \np{nn\_fsbc} time-step period. In the previous example,  
    276276this leads to: 1h30'00", 4h30'00", 7h30'00", etc. \\  
    277277(2) For code readablility and maintenance issues, we don't take into account the NetCDF input file  
     
    300300% Interpolation on the Fly 
    301301% ------------------------------------------------------------------------------------------------------------- 
    302 \subsection [Interpolation on-the-Fly] {Interpolation on-the-Fly} 
     302\subsection{Interpolation on-the-fly} 
    303303\label{SBC_iof} 
    304304 
     
    324324Note that nn\_lsm=0 forces the code to not apply the procedure even if a file for land/sea mask is supplied. 
    325325 
    326 \subsubsection{Bilinear Interpolation} 
     326\subsubsection{Bilinear interpolation} 
    327327\label{SBC_iof_bilinear} 
    328328 
     
    346346and wgt(1) corresponds to variable "wgt01" for example. 
    347347 
    348 \subsubsection{Bicubic Interpolation} 
     348\subsubsection{Bicubic interpolation} 
    349349\label{SBC_iof_bicubic} 
    350350 
     
    421421% Standalone Surface Boundary Condition Scheme 
    422422% ------------------------------------------------------------------------------------------------------------- 
    423 \subsection [Standalone Surface Boundary Condition Scheme] {Standalone Surface Boundary Condition Scheme} 
     423\subsection{Standalone surface boundary condition scheme} 
    424424\label{SAS_iof} 
    425425 
     
    438438\item  Development of sea-ice algorithms or parameterizations. 
    439439\item  spinup of the iceberg floats 
    440 \item  ocean/sea-ice simulation with both media running in parallel (\np{ln_mixcpl}~=~\textit{true}) 
     440\item  ocean/sea-ice simulation with both media running in parallel (\np{ln\_mixcpl}\forcode{ = .true.}) 
    441441\end{itemize} 
    442442 
     
    481481% Analytical formulation (sbcana module)  
    482482% ================================================================ 
    483 \section  [Analytical formulation (\textit{sbcana}) ] 
    484       {Analytical formulation (\protect\mdl{sbcana} module) } 
     483\section{Analytical formulation (\protect\mdl{sbcana})} 
    485484\label{SBC_ana} 
    486485 
     
    492491In this case, all the six fluxes needed by the ocean are assumed to  
    493492be uniform in space. They take constant values given in the namelist  
    494 \ngn{namsbc{\_}ana} by the variables \np{rn_utau0}, \np{rn_vtau0}, \np{rn_qns0},  
    495 \np{rn_qsr0}, and \np{rn_emp0} ($\textit{emp}=\textit{emp}_S$). The runoff is set to zero.  
     493\ngn{namsbc{\_}ana} by the variables \np{rn\_utau0}, \np{rn\_vtau0}, \np{rn\_qns0},  
     494\np{rn\_qsr0}, and \np{rn\_emp0} ($\textit{emp}=\textit{emp}_S$). The runoff is set to zero.  
    496495In addition, the wind is allowed to reach its nominal value within a given number  
    497 of time steps (\np{nn_tau000}). 
     496of time steps (\np{nn\_tau000}). 
    498497 
    499498If a user wants to apply a different analytical forcing, the \mdl{sbcana}  
     
    506505% Flux formulation  
    507506% ================================================================ 
    508 \section  [Flux formulation (\textit{sbcflx}) ] 
    509       {Flux formulation (\protect\mdl{sbcflx} module) } 
     507\section{Flux formulation (\protect\mdl{sbcflx})} 
    510508\label{SBC_flx} 
    511509%------------------------------------------namsbc_flx---------------------------------------------------- 
     
    513511%------------------------------------------------------------------------------------------------------------- 
    514512 
    515 In the flux formulation (\forcode{ln_flx = .true.}), the surface boundary  
     513In the flux formulation (\np{ln\_flx}\forcode{ = .true.}), the surface boundary  
    516514condition fields are directly read from input files. The user has to define  
    517515in the namelist \ngn{namsbc{\_}flx} the name of the file, the name of the variable  
     
    528526% Bulk formulation 
    529527% ================================================================ 
    530 \section  [Bulk formulation (\textit{sbcblk\_core}, \textit{sbcblk\_clio} or \textit{sbcblk\_mfs}) ] 
    531       {Bulk formulation \small{(\protect\mdl{sbcblk\_core} \protect\mdl{sbcblk\_clio} \protect\mdl{sbcblk\_mfs} modules)} } 
     528\section[Bulk formulation {(\textit{sbcblk\{\_core,\_clio,\_mfs\}.F90})}] 
     529         {Bulk formulation {(\protect\mdl{sbcblk\_core}, \protect\mdl{sbcblk\_clio}, \protect\mdl{sbcblk\_mfs})}} 
    532530\label{SBC_blk} 
    533531 
     
    537535The atmospheric fields used depend on the bulk formulae used. Three bulk formulations  
    538536are available : the CORE, the CLIO and the MFS bulk formulea. The choice is made by setting to true 
    539 one of the following namelist variable : \np{ln_core} ; \np{ln_clio} or  \np{ln_mfs}. 
     537one of the following namelist variable : \np{ln\_core} ; \np{ln\_clio} or  \np{ln\_mfs}. 
    540538 
    541539Note : in forced mode, when a sea-ice model is used, a bulk formulation (CLIO or CORE) have to be used.  
     
    546544%        CORE Bulk formulea 
    547545% ------------------------------------------------------------------------------------------------------------- 
    548 \subsection    [CORE Bulk formulea (\protect\forcode{ln_core = .true.})] 
    549             {CORE Bulk formulea (\protect\forcode{ln_core = .true.}, \protect\mdl{sbcblk\_core})} 
     546\subsection{CORE formulea (\protect\mdl{sbcblk\_core}, \protect\np{ln\_core}\forcode{ = .true.})} 
    550547\label{SBC_blk_core} 
    551548%------------------------------------------namsbc_core---------------------------------------------------- 
     
    592589or larger than the one of the input atmospheric fields. 
    593590 
    594 The \np{sn_wndi}, \np{sn_wndj}, \np{sn_qsr}, \np{sn_qlw}, \np{sn_tair}, \np{sn_humi}, 
    595 \np{sn_prec}, \np{sn_snow}, \np{sn_tdif} parameters describe the fields  
     591The \np{sn\_wndi}, \np{sn\_wndj}, \np{sn\_qsr}, \np{sn\_qlw}, \np{sn\_tair}, \np{sn\_humi}, 
     592\np{sn\_prec}, \np{sn\_snow}, \np{sn\_tdif} parameters describe the fields  
    596593and the way they have to be used (spatial and temporal interpolations).  
    597594 
    598 \np{cn_dir} is the directory of location of bulk files 
    599 \np{ln_taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.) 
    600 \np{rn_zqt}: is the height of humidity and temperature measurements (m) 
    601 \np{rn_zu}: is the height of wind measurements (m) 
     595\np{cn\_dir} is the directory of location of bulk files 
     596\np{ln\_taudif} is the flag to specify if we use Hight Frequency (HF) tau information (.true.) or not (.false.) 
     597\np{rn\_zqt}: is the height of humidity and temperature measurements (m) 
     598\np{rn\_zu}: is the height of wind measurements (m) 
    602599 
    603600Three multiplicative factors are availables :  
    604 \np{rn_pfac} and \np{rn_efac} allows to adjust (if necessary) the global freshwater budget  
     601\np{rn\_pfac} and \np{rn\_efac} allows to adjust (if necessary) the global freshwater budget  
    605602by increasing/reducing the precipitations (total and snow) and or evaporation, respectively. 
    606 The third one,\np{rn_vfac}, control to which extend the ice/ocean velocities are taken into account  
     603The third one,\np{rn\_vfac}, control to which extend the ice/ocean velocities are taken into account  
    607604in the calculation of surface wind stress. Its range should be between zero and one,  
    608605and it is recommended to set it to 0. 
     
    611608%        CLIO Bulk formulea 
    612609% ------------------------------------------------------------------------------------------------------------- 
    613 \subsection    [CLIO Bulk formulea (\protect\forcode{ln_clio = .true.})] 
    614             {CLIO Bulk formulea (\protect\forcode{ln_clio = .true.}, \protect\mdl{sbcblk\_clio})} 
     610\subsection{CLIO formulea (\protect\mdl{sbcblk\_clio}, \protect\np{ln\_clio}\forcode{ = .true.})} 
    615611\label{SBC_blk_clio} 
    616612%------------------------------------------namsbc_clio---------------------------------------------------- 
     
    652648%        MFS Bulk formulae 
    653649% ------------------------------------------------------------------------------------------------------------- 
    654 \subsection    [MFS Bulk formulea (\protect\forcode{ln_mfs = .true.})] 
    655             {MFS Bulk formulea (\protect\forcode{ln_mfs = .true.}, \protect\mdl{sbcblk\_mfs})} 
     650\subsection{MFS formulea (\protect\mdl{sbcblk\_mfs}, \protect\np{ln\_mfs}\forcode{ = .true.})} 
    656651\label{SBC_blk_mfs} 
    657652%------------------------------------------namsbc_mfs---------------------------------------------------- 
     
    679674The required 7 input fields must be provided on the model Grid-T and  are: 
    680675\begin{itemize} 
    681 \item          Zonal Component of the 10m wind ($ms^{-1}$)  (\np{sn_windi}) 
    682 \item          Meridional Component of the 10m wind ($ms^{-1}$)  (\np{sn_windj}) 
    683 \item          Total Claud Cover (\%)  (\np{sn_clc}) 
    684 \item          2m Air Temperature ($K$) (\np{sn_tair}) 
    685 \item          2m Dew Point Temperature ($K$)  (\np{sn_rhm}) 
    686 \item          Total Precipitation ${Kg} m^{-2} s^{-1}$ (\np{sn_prec}) 
    687 \item          Mean Sea Level Pressure (${Pa}$) (\np{sn_msl}) 
     676\item          Zonal Component of the 10m wind ($ms^{-1}$)  (\np{sn\_windi}) 
     677\item          Meridional Component of the 10m wind ($ms^{-1}$)  (\np{sn\_windj}) 
     678\item          Total Claud Cover (\%)  (\np{sn\_clc}) 
     679\item          2m Air Temperature ($K$) (\np{sn\_tair}) 
     680\item          2m Dew Point Temperature ($K$)  (\np{sn\_rhm}) 
     681\item          Total Precipitation ${Kg} m^{-2} s^{-1}$ (\np{sn\_prec}) 
     682\item          Mean Sea Level Pressure (${Pa}$) (\np{sn\_msl}) 
    688683\end{itemize} 
    689684% ------------------------------------------------------------------------------------------------------------- 
     
    691686% Coupled formulation 
    692687% ================================================================ 
    693 \section  [Coupled formulation (\textit{sbccpl}) ] 
    694       {Coupled formulation (\protect\mdl{sbccpl} module)} 
     688\section{Coupled formulation (\protect\mdl{sbccpl})} 
    695689\label{SBC_cpl} 
    696690%------------------------------------------namsbc_cpl---------------------------------------------------- 
     
    709703as well as to \href{http://wrf-model.org/}{WRF} (Weather Research and Forecasting Model). 
    710704 
    711 Note that in addition to the setting of \np{ln_cpl} to true, the \key{coupled} have to be defined.  
     705Note that in addition to the setting of \np{ln\_cpl} to true, the \key{coupled} have to be defined.  
    712706The CPP key is mainly used in sea-ice to ensure that the atmospheric fluxes are  
    713707actually recieved by the ice-ocean system (no calculation of ice sublimation in coupled mode). 
     
    730724%        Atmospheric pressure 
    731725% ================================================================ 
    732 \section   [Atmospheric pressure (\textit{sbcapr})] 
    733          {Atmospheric pressure (\protect\mdl{sbcapr})} 
     726\section{Atmospheric pressure (\protect\mdl{sbcapr})} 
    734727\label{SBC_apr} 
    735728%------------------------------------------namsbc_apr---------------------------------------------------- 
     
    738731 
    739732The optional atmospheric pressure can be used to force ocean and ice dynamics  
    740 (\np{ln_apr_dyn}~=~true, \textit{\ngn{namsbc}} namelist ). 
    741 The input atmospheric forcing defined via \np{sn_apr} structure (\textit{namsbc\_apr} namelist)  
     733(\np{ln\_apr\_dyn}\forcode{ = .true.}, \textit{\ngn{namsbc}} namelist ). 
     734The input atmospheric forcing defined via \np{sn\_apr} structure (\textit{namsbc\_apr} namelist)  
    742735can be interpolated in time to the model time step, and even in space when the  
    743736interpolation on-the-fly is used. When used to force the dynamics, the atmospheric  
     
    748741\end{equation} 
    749742where $P_{atm}$ is the atmospheric pressure and $P_o$ a reference atmospheric pressure. 
    750 A value of $101,000~N/m^2$ is used unless \np{ln_ref_apr} is set to true. In this case $P_o$  
     743A value of $101,000~N/m^2$ is used unless \np{ln\_ref\_apr} is set to true. In this case $P_o$  
    751744is set to the value of $P_{atm}$ averaged over the ocean domain, $i.e.$ the mean value of  
    752745$\eta_{ib}$ is kept to zero at all time step. 
     
    760753When using time-splitting and BDY package for open boundaries conditions, the equivalent  
    761754inverse barometer sea surface height $\eta_{ib}$ can be added to BDY ssh data:  
    762 \np{ln_apr_obc}  might be set to true. 
     755\np{ln\_apr\_obc}  might be set to true. 
    763756 
    764757% ================================================================ 
    765758%        Tidal Potential 
    766759% ================================================================ 
    767 \section   [Tidal Potential (\textit{sbctide})] 
    768                         {Tidal Potential (\protect\mdl{sbctide})} 
     760\section{Tidal potential (\protect\mdl{sbctide})} 
    769761\label{SBC_tide} 
    770762 
     
    774766 
    775767A module is available to compute the tidal potential and use it in the momentum equation. 
    776 This option is activated when \np{ln_tide} is set to true in \ngn{nam\_tide}. 
     768This option is activated when \np{ln\_tide} is set to true in \ngn{nam\_tide}. 
    777769 
    778770Some parameters are available in namelist \ngn{nam\_tide}: 
    779771 
    780 - \np{ln_tide_load} activate the load potential forcing and \np{filetide_load} is  the associated file  
    781  
    782 - \np{ln_tide_pot} activate the tidal potential forcing 
    783  
    784 - \np{nb_harmo} is the number of constituent used 
     772- \np{ln\_tide\_load} activate the load potential forcing and \np{filetide\_load} is  the associated file  
     773 
     774- \np{ln\_tide\_pot} activate the tidal potential forcing 
     775 
     776- \np{nb\_harmo} is the number of constituent used 
    785777 
    786778- \np{clname} is the name of constituent 
     
    821813%        River runoffs 
    822814% ================================================================ 
    823 \section   [River runoffs (\textit{sbcrnf})] 
    824          {River runoffs (\protect\mdl{sbcrnf})} 
     815\section{River runoffs (\protect\mdl{sbcrnf})} 
    825816\label{SBC_rnf} 
    826817%------------------------------------------namsbc_rnf---------------------------------------------------- 
     
    863854depth (in metres) which the river should be added to. 
    864855 
    865 Namelist variables in \ngn{namsbc\_rnf}, \np{ln_rnf_depth}, \np{ln_rnf_sal} and \np{ln_rnf_temp} control whether  
     856Namelist variables in \ngn{namsbc\_rnf}, \np{ln\_rnf\_depth}, \np{ln\_rnf\_sal} and \np{ln\_rnf\_temp} control whether  
    866857the river attributes (depth, salinity and temperature) are read in and used.  If these are set  
    867858as false the river is added to the surface box only, assumed to be fresh (0~psu), and/or  
     
    876867to give the heat and salt content of the river runoff. 
    877868After the user specified depth is read ini, the number of grid boxes this corresponds to is  
    878 calculated and stored in the variable \np{nz_rnf}. 
     869calculated and stored in the variable \np{nz\_rnf}. 
    879870The variable \textit{h\_dep} is then calculated to be the depth (in metres) of the bottom of the  
    880871lowest box the river water is being added to (i.e. the total depth that river water is being added to in the model). 
     
    937928%        Ice shelf melting 
    938929% ================================================================ 
    939 \section   [Ice shelf melting (\textit{sbcisf})] 
    940                         {Ice shelf melting (\protect\mdl{sbcisf})} 
     930\section{Ice shelf melting (\protect\mdl{sbcisf})} 
    941931\label{SBC_isf} 
    942932%------------------------------------------namsbc_isf---------------------------------------------------- 
    943933\forfile{../namelists/namsbc_isf} 
    944934%-------------------------------------------------------------------------------------------------------- 
    945 Namelist variable in \ngn{namsbc}, \np{nn_isf}, controls the ice shelf representation used.  
     935Namelist variable in \ngn{namsbc}, \np{nn\_isf}, controls the ice shelf representation used.  
    946936\begin{description} 
    947 \item[\np{nn_isf}~=~1] 
    948 The ice shelf cavity is represented (\np{ln_isfcav}~=~true needed). The fwf and heat flux are computed.  
     937\item[\np{nn\_isf}\forcode{ = 1}] 
     938The ice shelf cavity is represented (\np{ln\_isfcav}\forcode{ = .true.} needed). The fwf and heat flux are computed.  
    949939Two different bulk formula are available: 
    950940   \begin{description} 
    951    \item[\np{nn_isfblk}~=~1] 
     941   \item[\np{nn\_isfblk}\forcode{ = 1}] 
    952942   The bulk formula used to compute the melt is based the one described in \citet{Hunter2006}. 
    953943        This formulation is based on a balance between the upward ocean heat flux and the latent heat flux at the ice shelf base. 
    954944 
    955    \item[\np{nn_isfblk}~=~2]  
     945   \item[\np{nn\_isfblk}\forcode{ = 2}]  
    956946   The bulk formula used to compute the melt is based the one described in \citet{Jenkins1991}. 
    957947        This formulation is based on a 3 equations formulation (a heat flux budget, a salt flux budget 
     
    961951For this 2 bulk formulations, there are 3 different ways to compute the exchange coeficient: 
    962952   \begin{description} 
    963         \item[\np{nn\_gammablk~=~0~}] 
    964    The salt and heat exchange coefficients are constant and defined by \np{rn_gammas0} and \np{rn_gammat0} 
    965  
    966    \item[\np{nn\_gammablk~=~1~}] 
    967    The salt and heat exchange coefficients are velocity dependent and defined as $rn\_gammas0 \times u_{*}$ and $rn\_gammat0 \times u_{*}$ 
    968         where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn_hisf_tbl} meters). 
     953        \item[\np{nn\_gammablk}\forcode{ = 0}] 
     954   The salt and heat exchange coefficients are constant and defined by \np{rn\_gammas0} and \np{rn\_gammat0} 
     955 
     956   \item[\np{nn\_gammablk}\forcode{ = 1}] 
     957   The salt and heat exchange coefficients are velocity dependent and defined as \np{rn\_gammas0}$ \times u_{*}$ and \np{rn\_gammat0}$ \times u_{*}$ 
     958        where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters). 
    969959        See \citet{Jenkins2010} for all the details on this formulation. 
    970960    
    971    \item[\np{nn\_gammablk~=~2~}] 
     961   \item[\np{nn\_gammablk}\forcode{ = 2}] 
    972962   The salt and heat exchange coefficients are velocity and stability dependent and defined as  
    973963        $\gamma_{T,S} = \frac{u_{*}}{\Gamma_{Turb} + \Gamma^{T,S}_{Mole}}$ 
    974         where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn_hisf_tbl} meters),  
     964        where $u_{*}$ is the friction velocity in the top boundary layer (ie first \np{rn\_hisf\_tbl} meters),  
    975965        $\Gamma_{Turb}$ the contribution of the ocean stability and  
    976966        $\Gamma^{T,S}_{Mole}$ the contribution of the molecular diffusion. 
     
    978968        \end{description} 
    979969 
    980 \item[\np{nn_isf}~=~2] 
     970\item[\np{nn\_isf}\forcode{ = 2}] 
    981971A parameterisation of isf is used. The ice shelf cavity is not represented.  
    982972The fwf is distributed along the ice shelf edge between the depth of the average grounding line (GL) 
    983 (\np{sn_depmax_isf}) and the base of the ice shelf along the calving front (\np{sn_depmin_isf}) as in (\np{nn_isf}~=~3).  
     973(\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}) as in (\np{nn\_isf}\forcode{ = 3}).  
    984974Furthermore the fwf and heat flux are computed using the \citet{Beckmann2003} parameterisation of isf melting.  
    985 The effective melting length (\np{sn_Leff_isf}) is read from a file. 
    986  
    987 \item[\np{nn_isf}~=~3] 
     975The effective melting length (\np{sn\_Leff\_isf}) is read from a file. 
     976 
     977\item[\np{nn\_isf}\forcode{ = 3}] 
    988978A simple parameterisation of isf is used. The ice shelf cavity is not represented.  
    989 The fwf (\np{sn_rnfisf}) is prescribed and distributed along the ice shelf edge between the depth of the average grounding line (GL) 
    990 (\np{sn_depmax_isf}) and the base of the ice shelf along the calving front (\np{sn_depmin_isf}).  
     979The fwf (\np{sn\_rnfisf}) is prescribed and distributed along the ice shelf edge between the depth of the average grounding line (GL) 
     980(\np{sn\_depmax\_isf}) and the base of the ice shelf along the calving front (\np{sn\_depmin\_isf}).  
    991981The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$. 
    992982 
    993 \item[\np{nn_isf}~=~4] 
    994 The ice shelf cavity is opened (\np{ln_isfcav}~=~true needed). However, the fwf is not computed but specified from file \np{sn_fwfisf}).  
     983\item[\np{nn\_isf}\forcode{ = 4}] 
     984The ice shelf cavity is opened (\np{ln\_isfcav}\forcode{ = .true.} needed). However, the fwf is not computed but specified from file \np{sn\_fwfisf}).  
    995985The heat flux ($Q_h$) is computed as $Q_h = fwf \times L_f$.\\ 
    996986\end{description} 
    997987 
    998988 
    999 $\bullet$ \np{nn_isf}~=~1 and \np{nn_isf}~=~2 compute a melt rate based on the water mass properties, ocean velocities and depth. 
     989$\bullet$ \np{nn\_isf}\forcode{ = 1} and \np{nn\_isf}\forcode{ = 2} compute a melt rate based on the water mass properties, ocean velocities and depth. 
    1000990 This flux is thus highly dependent of the model resolution (horizontal and vertical), realism of the water masses onto the shelf ...\\ 
    1001991 
    1002992 
    1003 $\bullet$ \np{nn_isf}~=~3 and \np{nn_isf}~=~4 read the melt rate from a file. You have total control of the fwf forcing. 
     993$\bullet$ \np{nn\_isf}\forcode{ = 3} and \np{nn\_isf}\forcode{ = 4} read the melt rate from a file. You have total control of the fwf forcing. 
    1004994This can be usefull if the water masses on the shelf are not realistic or the resolution (horizontal/vertical) are too  
    1005995coarse to have realistic melting or for studies where you need to control your heat and fw input.\\  
    1006996 
    1007997A namelist parameters control over how many meters the heat and fw fluxes are spread.  
    1008 \np{rn_hisf_tbl}] is the top boundary layer thickness as defined in \citet{Losch2008}.  
    1009 This parameter is only used if \np{nn_isf}~=~1 or \np{nn_isf}~=~4 
    1010  
    1011 If \np{rn_hisf_tbl} = 0., the fluxes are put in the top level whatever is its tickness.  
    1012  
    1013 If \np{rn_hisf_tbl} $>$ 0., the fluxes are spread over the first \np{rn_hisf_tbl} m (ie over one or several cells).\\ 
     998\np{rn\_hisf\_tbl}] is the top boundary layer thickness as defined in \citet{Losch2008}.  
     999This parameter is only used if \np{nn\_isf}\forcode{ = 1} or \np{nn\_isf}\forcode{ = 4} 
     1000 
     1001If \np{rn\_hisf\_tbl}\forcode{ = 0}., the fluxes are put in the top level whatever is its tickness.  
     1002 
     1003If \np{rn\_hisf\_tbl} $>$ 0., the fluxes are spread over the first \np{rn\_hisf\_tbl} m (ie over one or several cells).\\ 
    10141004 
    10151005The ice shelf melt is implemented as a volume flux with in the same way as for the runoff. 
     
    10191009 
    10201010 
    1021 \section{ Ice sheet coupling} 
     1011\section{Ice sheet coupling} 
    10221012\label{SBC_iscpl} 
    10231013%------------------------------------------namsbc_iscpl---------------------------------------------------- 
     
    10261016Ice sheet/ocean coupling is done through file exchange at the restart step. NEMO, at each restart step,  
    10271017read the bathymetry and ice shelf draft variable in a netcdf file.  
    1028 If \np{ln\_iscpl = ~true}, the isf draft is assume to be different at each restart step  
     1018If \np{ln\_iscpl}\forcode{ = .true.}, the isf draft is assume to be different at each restart step  
    10291019with potentially some new wet/dry cells due to the ice sheet dynamics/thermodynamics. 
    10301020The wetting and drying scheme applied on the restart is very simple and described below for the 6 different cases: 
     
    10431033   set mask to 1, T/S is extrapolated from neighbours, ssh is extrapolated from neighbours and U/V set to 0. If no neighbour, T/S/U/V and mask set to 0. 
    10441034\end{description} 
    1045 The extrapolation is call \np{nn_drown} times. It means that if the grounding line retreat by more than \np{nn_drown} cells between 2 coupling steps, 
     1035The extrapolation is call \np{nn\_drown} times. It means that if the grounding line retreat by more than \np{nn\_drown} cells between 2 coupling steps, 
    10461036 the code will be unable to fill all the new wet cells properly. The default number is set up for the MISOMIP idealised experiments.\\ 
    10471037This coupling procedure is able to take into account grounding line and calving front migration. However, it is a non-conservative processe.  
    10481038This could lead to a trend in heat/salt content and volume. In order to remove the trend and keep the conservation level as close to 0 as possible, 
    1049  a simple conservation scheme is available with \np{ln\_hsb = ~true}. The heat/salt/vol. gain/loss is diagnose, as well as the location.  
     1039 a simple conservation scheme is available with \np{ln\_hsb}\forcode{ = .true.}. The heat/salt/vol. gain/loss is diagnose, as well as the location.  
    10501040Based on what is done on sbcrnf to prescribed a source of heat/salt/vol., the heat/salt/vol. gain/loss is removed/added, 
    1051  over a period of \np{rn_fiscpl} time step, into the system.  
    1052 So after \np{rn_fiscpl} time step, all the heat/salt/vol. gain/loss due to extrapolation process is canceled.\\ 
     1041 over a period of \np{rn\_fiscpl} time step, into the system.  
     1042So after \np{rn\_fiscpl} time step, all the heat/salt/vol. gain/loss due to extrapolation process is canceled.\\ 
    10531043 
    10541044As the before and now fields are not compatible (modification of the geometry), the restart time step is prescribed to be an euler time step instead of a leap frog and $fields_b = fields_n$. 
     
    10681058Icebergs are initially spawned into one of ten classes which have specific mass and thickness as described  
    10691059in the \ngn{namberg} namelist:  
    1070 \np{rn_initial_mass} and \np{rn_initial_thickness}. 
    1071 Each class has an associated scaling (\np{rn_mass_scaling}), which is an integer representing how many icebergs  
     1060\np{rn\_initial\_mass} and \np{rn\_initial\_thickness}. 
     1061Each class has an associated scaling (\np{rn\_mass\_scaling}), which is an integer representing how many icebergs  
    10721062of this class are being described as one lagrangian point (this reduces the numerical problem of tracking every single iceberg). 
    1073 They are enabled by setting \np{ln_icebergs}~=~true. 
     1063They are enabled by setting \np{ln\_icebergs}\forcode{ = .true.}. 
    10741064 
    10751065Two initialisation schemes are possible. 
    10761066\begin{description} 
    1077 \item[\np{nn_test_icebergs}~$>$~0] 
    1078 In this scheme, the value of \np{nn_test_icebergs} represents the class of iceberg to generate  
    1079 (so between 1 and 10), and \np{nn_test_icebergs} provides a lon/lat box in the domain at each  
     1067\item[\np{nn\_test\_icebergs}~$>$~0] 
     1068In this scheme, the value of \np{nn\_test\_icebergs} represents the class of iceberg to generate  
     1069(so between 1 and 10), and \np{nn\_test\_icebergs} provides a lon/lat box in the domain at each  
    10801070grid point of which an iceberg is generated at the beginning of the run.  
    1081 (Note that this happens each time the timestep equals \np{nn_nit000}.) 
    1082 \np{nn_test_icebergs} is defined by four numbers in \np{nn_test_box} representing the corners  
     1071(Note that this happens each time the timestep equals \np{nn\_nit000}.) 
     1072\np{nn\_test\_icebergs} is defined by four numbers in \np{nn\_test\_box} representing the corners  
    10831073of the geographical box: lonmin,lonmax,latmin,latmax 
    1084 \item[\np{nn_test_icebergs}~=~-1] 
    1085 In this scheme the model reads a calving file supplied in the \np{sn_icb} parameter. 
     1074\item[\np{nn\_test\_icebergs}\forcode{ = -1}] 
     1075In this scheme the model reads a calving file supplied in the \np{sn\_icb} parameter. 
    10861076This should be a file with a field on the configuration grid (typically ORCA) representing ice accumulation rate at each model point.  
    10871077These should be ocean points adjacent to land where icebergs are known to calve. 
     
    10951085Icebergs are influenced by wind, waves and currents, bottom melt and erosion. 
    10961086The latter act to disintegrate the iceberg. This is either all melted freshwater, or  
    1097 (if \np{rn_bits_erosion_fraction}~$>$~0) into melt and additionally small ice bits 
     1087(if \np{rn\_bits\_erosion\_fraction}~$>$~0) into melt and additionally small ice bits 
    10981088which are assumed to propagate with their larger parent and thus delay fluxing into the ocean. 
    10991089Melt water (and other variables on the configuration grid) are written into the main NEMO model output files. 
     
    11011091Extensive diagnostics can be produced. 
    11021092Separate output files are maintained for human-readable iceberg information. 
    1103 A separate file is produced for each processor (independent of \np{ln_ctl}). 
     1093A separate file is produced for each processor (independent of \np{ln\_ctl}). 
    11041094The amount of information is controlled by two integer parameters: 
    11051095\begin{description} 
    1106 \item[\np{nn_verbose_level}]  takes a value between one and four and represents  
     1096\item[\np{nn\_verbose\_level}]  takes a value between one and four and represents  
    11071097an increasing number of points in the code at which variables are written, and an  
    11081098increasing level of obscurity. 
    1109 \item[\np{nn_verbose_write}] is the number of timesteps between writes 
     1099\item[\np{nn\_verbose\_write}] is the number of timesteps between writes 
    11101100\end{description} 
    11111101 
    1112 Iceberg trajectories can also be written out and this is enabled by setting \np{nn_sample_rate}~$>$~0. 
     1102Iceberg trajectories can also be written out and this is enabled by setting \np{nn\_sample\_rate}~$>$~0. 
    11131103A non-zero value represents how many timesteps between writes of information into the output file. 
    11141104These output files are in NETCDF format. 
     
    11281118%        Diurnal cycle 
    11291119% ------------------------------------------------------------------------------------------------------------- 
    1130 \subsection   [Diurnal  cycle (\textit{sbcdcy})] 
    1131          {Diurnal cycle (\protect\mdl{sbcdcy})} 
     1120\subsection{Diurnal cycle (\protect\mdl{sbcdcy})} 
    11321121\label{SBC_dcy} 
    11331122%------------------------------------------namsbc_rnf---------------------------------------------------- 
     
    11551144the diurnal cycle of SWF is a scaling of the top of the atmosphere diurnal cycle  
    11561145of incident SWF. The \cite{Bernie_al_CD07} reconstruction algorithm is available 
    1157 in \NEMO by setting \np{ln_dm2dc}~=~true (a \textit{\ngn{namsbc}} namelist variable) when using  
    1158 CORE bulk formulea (\np{ln_blk_core}~=~true) or the flux formulation (\np{ln_flx}~=~true).  
     1146in \NEMO by setting \np{ln\_dm2dc}\forcode{ = .true.} (a \textit{\ngn{namsbc}} namelist variable) when using  
     1147CORE bulk formulea (\np{ln\_blk\_core}\forcode{ = .true.}) or the flux formulation (\np{ln\_flx}\forcode{ = .true.}).  
    11591148The reconstruction is performed in the \mdl{sbcdcy} module. The detail of the algoritm used  
    11601149can be found in the appendix~A of \cite{Bernie_al_CD07}. The algorithm preserve the daily  
     
    11621151of the analytical cycle over this time step (Fig.\ref{Fig_SBC_diurnal}).  
    11631152The use of diurnal cycle reconstruction requires the input SWF to be daily  
    1164 ($i.e.$ a frequency of 24 and a time interpolation set to true in \np{sn_qsr} namelist parameter). 
     1153($i.e.$ a frequency of 24 and a time interpolation set to true in \np{sn\_qsr} namelist parameter). 
    11651154Furthermore, it is recommended to have a least 8 surface module time step per day, 
    11661155that is  $\rdt \ nn\_fsbc < 10,800~s = 3~h$. An example of recontructed SWF  
     
    11891178\label{SBC_rotation} 
    11901179 
    1191 When using a flux (\forcode{ln_flx = .true.}) or bulk (\forcode{ln_clio = .true.} or \forcode{ln_core = .true.}) formulation,  
     1180When using a flux (\np{ln\_flx}\forcode{ = .true.}) or bulk (\np{ln\_clio}\forcode{ = .true.} or \np{ln\_core}\forcode{ = .true.}) formulation,  
    11921181pairs of vector components can be rotated from east-north directions onto the local grid directions.   
    11931182This is particularly useful when interpolation on the fly is used since here any vectors are likely to be defined  
     
    12051194%        Surface restoring to observed SST and/or SSS 
    12061195% ------------------------------------------------------------------------------------------------------------- 
    1207 \subsection    [Surface restoring to observed SST and/or SSS (\textit{sbcssr})] 
    1208          {Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})} 
     1196\subsection{Surface restoring to observed SST and/or SSS (\protect\mdl{sbcssr})} 
    12091197\label{SBC_ssr} 
    12101198%------------------------------------------namsbc_ssr---------------------------------------------------- 
     
    12131201 
    12141202IOptions are defined through the  \ngn{namsbc\_ssr} namelist variables. 
    1215 n forced mode using a flux formulation (\np{ln_flx}~=~true), a  
     1203n forced mode using a flux formulation (\np{ln\_flx}\forcode{ = .true.}), a  
    12161204feedback term \emph{must} be added to the surface heat flux $Q_{ns}^o$: 
    12171205\begin{equation} \label{Eq_sbc_dmp_q} 
     
    12511239The presence at the sea surface of an ice covered area modifies all the fluxes  
    12521240transmitted to the ocean. There are several way to handle sea-ice in the system  
    1253 depending on the value of the \np{nn_ice} namelist parameter found in \ngn{namsbc} namelist.   
     1241depending on the value of the \np{nn\_ice} namelist parameter found in \ngn{namsbc} namelist.   
    12541242\begin{description} 
    12551243\item[nn{\_}ice = 0]  there will never be sea-ice in the computational domain.  
     
    12751263% {Description of Ice-ocean interface to be added here or in LIM 2 and 3 doc ?} 
    12761264 
    1277 \subsection   [Interface to CICE (\textit{sbcice\_cice})] 
    1278          {Interface to CICE (\protect\mdl{sbcice\_cice})} 
     1265\subsection{Interface to CICE (\protect\mdl{sbcice\_cice})} 
    12791266\label{SBC_cice} 
    12801267 
     
    12871274\textit{calc\_strair~=~true} and \textit{calc\_Tsfc~=~true} in the CICE name-list), or alternatively when NEMO  
    12881275is coupled to the HadGAM3 atmosphere model (with \textit{calc\_strair~=~false} and \textit{calc\_Tsfc~=~false}). 
    1289 The code is intended to be used with \np{nn_fsbc} set to 1 (although coupling ocean and ice less frequently  
     1276The code is intended to be used with \np{nn\_fsbc} set to 1 (although coupling ocean and ice less frequently  
    12901277should work, it is possible the calculation of some of the ocean-ice fluxes needs to be modified slightly - the 
    12911278user should check that results are not significantly different to the standard case). 
     
    13031290%        Freshwater budget control  
    13041291% ------------------------------------------------------------------------------------------------------------- 
    1305 \subsection   [Freshwater budget control (\textit{sbcfwb})] 
    1306          {Freshwater budget control (\protect\mdl{sbcfwb})} 
     1292\subsection{Freshwater budget control (\protect\mdl{sbcfwb})} 
    13071293\label{SBC_fwb} 
    13081294 
     
    13111297in the freshwater fluxes. In \NEMO, two way of controlling the the freshwater budget.  
    13121298\begin{description} 
    1313 \item[\forcode{nn_fwb = 0}]  no control at all. The mean sea level is free to drift, and will  
     1299\item[\np{nn\_fwb}\forcode{ = 0}]  no control at all. The mean sea level is free to drift, and will  
    13141300certainly do so. 
    1315 \item[\forcode{nn_fwb = 1}]  global mean \textit{emp} set to zero at each model time step.  
     1301\item[\np{nn\_fwb}\forcode{ = 1}]  global mean \textit{emp} set to zero at each model time step.  
    13161302%Note that with a sea-ice model, this technique only control the mean sea level with linear free surface (\key{vvl} not defined) and no mass flux between ocean and ice (as it is implemented in the current ice-ocean coupling).  
    1317 \item[\forcode{nn_fwb = 2}]  freshwater budget is adjusted from the previous year annual  
     1303\item[\np{nn\_fwb}\forcode{ = 2}]  freshwater budget is adjusted from the previous year annual  
    13181304mean budget which is read in the \textit{EMPave\_old.dat} file. As the model uses the  
    13191305Boussinesq approximation, the annual mean fresh water budget is simply evaluated  
     
    13251311%        Neutral Drag Coefficient from external wave model 
    13261312% ------------------------------------------------------------------------------------------------------------- 
    1327 \subsection   [Neutral drag coefficient from external wave model (\textit{sbcwave})] 
    1328               {Neutral drag coefficient from external wave model (\protect\mdl{sbcwave})} 
     1313\subsection[Neutral drag coeff. from external wave model (\protect\mdl{sbcwave})] 
     1314            {Neutral drag coefficient from external wave model (\protect\mdl{sbcwave})} 
    13291315\label{SBC_wave} 
    13301316%------------------------------------------namwave---------------------------------------------------- 
     
    13321318%------------------------------------------------------------------------------------------------------------- 
    13331319 
    1334 In order to read a neutral drag coeff, from an external data source ($i.e.$ a wave model), the  
    1335 logical variable \np{ln_cdgw} in \ngn{namsbc} namelist must be set to \textit{true}.  
    1336 The \mdl{sbcwave} module containing the routine \np{sbc_wave} reads the 
     1320In order to read a neutral drag coefficient, from an external data source ($i.e.$ a wave model), the  
     1321logical variable \np{ln\_cdgw} in \ngn{namsbc} namelist must be set to \forcode{.true.}.  
     1322The \mdl{sbcwave} module containing the routine \np{sbc\_wave} reads the 
    13371323namelist \ngn{namsbc\_wave} (for external data names, locations, frequency, interpolation and all  
    13381324the miscellanous options allowed by Input Data generic Interface see \S\ref{SBC_input})  
Note: See TracChangeset for help on using the changeset viewer.