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

Ignore:
Timestamp:
2019-09-25T19:06:37+02:00 (5 years ago)
Author:
nicolasmartin
Message:

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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r11584 r11596  
    22 
    33\begin{document} 
    4 % ================================================================ 
    5 % Chapter — Lateral Boundary Condition (LBC) 
    6 % ================================================================ 
    74\chapter{Lateral Boundary Condition (LBC)} 
    85\label{chap:LBC} 
    … …  
    107\chaptertoc 
    118 
    12 \newpage 
    13  
    149%gm% add here introduction to this chapter 
    1510 
    16 % ================================================================ 
    17 % Boundary Condition at the Coast 
    18 % ================================================================ 
    1911\section[Boundary condition at the coast (\forcode{rn_shlat})]{Boundary condition at the coast (\protect\np{rn_shlat}{rn\_shlat})} 
    2012\label{sec:LBC_coast} 
    … …  
    6860(normal velocity $u$ remains zero at the coast) (\autoref{fig:LBC_uv}). 
    6961 
    70 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    7162\begin{figure}[!t] 
    7263  \centering 
    … …  
    7768  \label{fig:LBC_uv} 
    7869\end{figure} 
    79 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    8070 
    8171For momentum the situation is a bit more complex as two boundary conditions must be provided along the coast 
    … …  
    9585These are: 
    9686 
    97 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    9887\begin{figure}[!p] 
    9988  \centering 
    … …  
    10897  \label{fig:LBC_shlat} 
    10998\end{figure} 
    110 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    11199 
    112100\begin{description} 
    113101 
    114 \item[free-slip boundary condition ({\np[=0]{rn_shlat}{rn\_shlat}})] the tangential velocity at 
     102\item [free-slip boundary condition ({\np[=0]{rn_shlat}{rn\_shlat}})] the tangential velocity at 
    115103  the coastline is equal to the offshore velocity, 
    116104  \ie\ the normal derivative of the tangential velocity is zero at the coast, 
    … …  
    118106  (\autoref{fig:LBC_shlat}-a). 
    119107 
    120 \item[no-slip boundary condition ({\np[=2]{rn_shlat}{rn\_shlat}})] the tangential velocity vanishes at the coastline. 
     108\item [no-slip boundary condition ({\np[=2]{rn_shlat}{rn\_shlat}})] the tangential velocity vanishes at the coastline. 
    121109  Assuming that the tangential velocity decreases linearly from 
    122110  the closest ocean velocity grid point to the coastline, 
    … …  
    139127  \] 
    140128 
    141 \item["partial" free-slip boundary condition (0$<$\np{rn_shlat}{rn\_shlat}$<$2)] the tangential velocity at 
     129\item ["partial" free-slip boundary condition (0$<$\np{rn_shlat}{rn\_shlat}$<$2)] the tangential velocity at 
    142130  the coastline is smaller than the offshore velocity, \ie\ there is a lateral friction but 
    143131  not strong enough to make the tangential velocity at the coast vanish (\autoref{fig:LBC_shlat}-c). 
    144132  This can be selected by providing a value of mask$_{f}$ strictly inbetween $0$ and $2$. 
    145133 
    146 \item["strong" no-slip boundary condition (2$<$\np{rn_shlat}{rn\_shlat})] the viscous boundary layer is assumed to 
     134\item ["strong" no-slip boundary condition (2$<$\np{rn_shlat}{rn\_shlat})] the viscous boundary layer is assumed to 
    147135  be smaller than half the grid size (\autoref{fig:LBC_shlat}-d). 
    148136  The friction is thus larger than in the no-slip case. 
    … …  
    154142it is only applied next to the coast where the minimum water depth can be quite shallow. 
    155143 
    156  
    157 % ================================================================ 
    158 % Boundary Condition around the Model Domain 
    159 % ================================================================ 
    160144\section[Model domain boundary condition (\forcode{jperio})]{Model domain boundary condition (\protect\jp{jperio})} 
    161145\label{sec:LBC_jperio} 
    … …  
    166150The north-fold boundary condition is associated with the 3-pole ORCA mesh. 
    167151 
    168 % ------------------------------------------------------------------------------------------------------------- 
    169 %        Closed, cyclic (\jp{jperio}\forcode{ = 0..2}) 
    170 % ------------------------------------------------------------------------------------------------------------- 
    171152\subsection[Closed, cyclic (\forcode{=0,1,2,7})]{Closed, cyclic (\protect\jp{jperio}\forcode{=0,1,2,7})} 
    172153\label{subsec:LBC_jperio012} 
    … …  
    182163\begin{description} 
    183164 
    184 \item[For closed boundary (\jp{jperio}\forcode{=0})], 
     165\item [For closed boundary (\jp{jperio}\forcode{=0})], 
    185166  solid walls are imposed at all model boundaries: 
    186167  first and last rows and columns are set to zero. 
    187168 
    188 \item[For cyclic east-west boundary (\jp{jperio}\forcode{=1})], 
     169\item [For cyclic east-west boundary (\jp{jperio}\forcode{=1})], 
    189170  first and last rows are set to zero (closed) whilst the first column is set to 
    190171  the value of the last-but-one column and the last column to the value of the second one 
    … …  
    192173  Whatever flows out of the eastern (western) end of the basin enters the western (eastern) end. 
    193174 
    194 \item[For cyclic north-south boundary (\jp{jperio}\forcode{=2})], 
     175\item [For cyclic north-south boundary (\jp{jperio}\forcode{=2})], 
    195176  first and last columns are set to zero (closed) whilst the first row is set to 
    196177  the value of the last-but-one row and the last row to the value of the second one 
    … …  
    198179  Whatever flows out of the northern (southern) end of the basin enters the southern (northern) end. 
    199180 
    200 \item[Bi-cyclic east-west and north-south boundary (\jp{jperio}\forcode{=7})] combines cases 1 and 2. 
     181\item [Bi-cyclic east-west and north-south boundary (\jp{jperio}\forcode{=7})] combines cases 1 and 2. 
    201182 
    202183\end{description} 
    203184 
    204 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    205185\begin{figure}[!t] 
    206186  \centering 
    … …  
    210190  \label{fig:LBC_jperio} 
    211191\end{figure} 
    212 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    213  
    214 % ------------------------------------------------------------------------------------------------------------- 
    215 %        North fold (\textit{jperio = 3 }to $6)$ 
    216 % ------------------------------------------------------------------------------------------------------------- 
     192 
    217193\subsection[North-fold (\forcode{=3,6})]{North-fold (\protect\jp{jperio}\forcode{=3,6})} 
    218194\label{subsec:LBC_north_fold} 
    … …  
    224200Further information can be found in \mdl{lbcnfd} module which applies the north fold boundary condition. 
    225201 
    226 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    227202\begin{figure}[!t] 
    228203  \centering 
    … …  
    234209  \label{fig:LBC_North_Fold_T} 
    235210\end{figure} 
    236 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    237  
    238 % ==================================================================== 
    239 % Exchange with neighbouring processors 
    240 % ==================================================================== 
     211 
    241212\section[Exchange with neighbouring processors (\textit{lbclnk.F90}, \textit{lib\_mpp.F90})]{Exchange with neighbouring processors (\protect\mdl{lbclnk}, \protect\mdl{lib\_mpp})} 
    242213\label{sec:LBC_mpp} 
    … …  
    284255many communications during 1 time step of the model.\\ 
    285256 
    286 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    287257\begin{figure}[!t] 
    288258  \centering 
    … …  
    291261  \label{fig:LBC_mpp} 
    292262\end{figure} 
    293 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    294263 
    295264In \NEMO, the splitting is regular and arithmetic. 
    … …  
    339308When land processors are eliminated, the value corresponding to these locations in the model output files is undefined. \np{ln_mskland}{ln\_mskland} must be activated in order avoid Not a Number values in output files. Note that it is better to not eliminate land processors when creating a meshmask file (\ie\ when setting a non-zero value to \np{nn_msh}{nn\_msh}). 
    340309 
    341 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    342310\begin{figure}[!ht] 
    343311  \centering 
    … …  
    352320  \label{fig:LBC_mppini2} 
    353321\end{figure} 
    354 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    355  
    356  
    357 % ==================================================================== 
    358 % Unstructured open boundaries BDY 
    359 % ==================================================================== 
     322 
    360323\section{Unstructured open boundary conditions (BDY)} 
    361324\label{sec:LBC_bdy} 
    … …  
    411374 
    412375\begin{description} 
    413 \item[\forcode{'none'}:] No boundary condition applied. 
     376\item [\forcode{'none'}:] No boundary condition applied. 
    414377  So the solution will ``see'' the land points around the edge of the edge of the domain. 
    415 \item[\forcode{'specified'}:] Specified boundary condition applied (only available for baroclinic velocity and tracer variables). 
    416 \item[\forcode{'neumann'}:] Value at the boundary are duplicated (No gradient). Only available for baroclinic velocity and tracer variables. 
    417 \item[\forcode{'frs'}:] Flow Relaxation Scheme (FRS) available for all variables. 
    418 \item[\forcode{'Orlanski'}:] Orlanski radiation scheme (fully oblique) for barotropic, baroclinic and tracer variables. 
    419 \item[\forcode{'Orlanski_npo'}:] Orlanski radiation scheme for barotropic, baroclinic and tracer variables. 
    420 \item[\forcode{'flather'}:] Flather radiation scheme for the barotropic variables only. 
     378\item [\forcode{'specified'}:] Specified boundary condition applied (only available for baroclinic velocity and tracer variables). 
     379\item [\forcode{'neumann'}:] Value at the boundary are duplicated (No gradient). Only available for baroclinic velocity and tracer variables. 
     380\item [\forcode{'frs'}:] Flow Relaxation Scheme (FRS) available for all variables. 
     381\item [\forcode{'Orlanski'}:] Orlanski radiation scheme (fully oblique) for barotropic, baroclinic and tracer variables. 
     382\item [\forcode{'Orlanski_npo'}:] Orlanski radiation scheme for barotropic, baroclinic and tracer variables. 
     383\item [\forcode{'flather'}:] Flather radiation scheme for the barotropic variables only. 
    421384\end{description} 
    422385 
    … …  
    620583Only one mask file is used even if multiple boundary sets are defined. 
    621584 
    622 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    623585\begin{figure}[!t] 
    624586  \centering 
    … …  
    627589  \label{fig:LBC_bdy_geom} 
    628590\end{figure} 
    629 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    630591 
    631592%---------------------------------------------- 
    … …  
    657618will re-order the data in old BDY data files. 
    658619 
    659 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    660620\begin{figure}[!t] 
    661621  \centering 
    … …  
    665625  \label{fig:LBC_nc_header} 
    666626\end{figure} 
    667 %>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
    668627 
    669628%---------------------------------------------- 
Note: See TracChangeset for help on using the changeset viewer.