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 9392 for branches/2017/dev_merge_2017/DOC/tex_sub/chap_LBC.tex – NEMO

Ignore:
Timestamp:
2018-03-09T16:57:00+01:00 (6 years ago)
Author:
nicolasmartin
Message:

Global replacement of patterns \np{id}=value by \forcode{id = value} for integer and booleans

File:
1 edited

Legend:

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

    r9389 r9392  
    1717% Boundary Condition at the Coast 
    1818% ================================================================ 
    19 \section{Boundary Condition at the Coast (\protect\np{rn\_shlat})} 
     19\section{Boundary Condition at the Coast (\protect\np{rn_shlat})} 
    2020\label{LBC_coast} 
    2121%--------------------------------------------nam_lbc------------------------------------------------------- 
     
    7272condition influences the relative vorticity and momentum diffusive trends, and is  
    7373required in order to compute the vorticity at the coast. Four different types of  
    74 lateral boundary condition are available, controlled by the value of the \np{rn\_shlat}  
     74lateral boundary condition are available, controlled by the value of the \np{rn_shlat}  
    7575namelist parameter. (The value of the mask$_{f}$ array along the coastline is set  
    7676equal to this parameter.) These are: 
     
    8888\begin{description} 
    8989 
    90 \item[free-slip boundary condition (\np{rn\_shlat}=0): ]  the tangential velocity at the  
     90\item[free-slip boundary condition (\forcode{rn_shlat = 0}): ]  the tangential velocity at the  
    9191coastline is equal to the offshore velocity, $i.e.$ the normal derivative of the  
    9292tangential velocity is zero at the coast, so the vorticity: mask$_{f}$ array is set  
    9393to zero inside the land and just at the coast (Fig.~\ref{Fig_LBC_shlat}-a). 
    9494 
    95 \item[no-slip boundary condition (\np{rn\_shlat}=2): ] the tangential velocity vanishes  
     95\item[no-slip boundary condition (\forcode{rn_shlat = 2}): ] the tangential velocity vanishes  
    9696at the coastline. Assuming that the tangential velocity decreases linearly from  
    9797the closest ocean velocity grid point to the coastline, the normal derivative is  
     
    112112\end{equation} 
    113113 
    114 \item["partial" free-slip boundary condition (0$<$\np{rn\_shlat}$<$2): ] the tangential  
     114\item["partial" free-slip boundary condition (0$<$\np{rn_shlat}$<$2): ] the tangential  
    115115velocity at the coastline is smaller than the offshore velocity, $i.e.$ there is a lateral  
    116116friction but not strong enough to make the tangential velocity at the coast vanish  
     
    118118strictly inbetween $0$ and $2$. 
    119119 
    120 \item["strong" no-slip boundary condition (2$<$\np{rn\_shlat}): ] the viscous boundary  
     120\item["strong" no-slip boundary condition (2$<$\np{rn_shlat}): ] the viscous boundary  
    121121layer is assumed to be smaller than half the grid size (Fig.~\ref{Fig_LBC_shlat}-d).  
    122122The friction is thus larger than in the no-slip case. 
     
    331331the model output files is undefined. Note that this is a problem for the meshmask file  
    332332which requires to be defined over the whole domain. Therefore, user should not eliminate  
    333 land processors when creating a meshmask file ($i.e.$ when setting a non-zero value to \np{nn\_msh}). 
     333land processors when creating a meshmask file ($i.e.$ when setting a non-zero value to \np{nn_msh}). 
    334334 
    335335%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    387387\label{BDY_namelist} 
    388388 
    389 The BDY module is activated by setting \np{ln\_bdy} to true. 
     389The BDY module is activated by setting \np{ln_bdy} to true. 
    390390It is possible to define more than one boundary ``set'' and apply 
    391391different boundary conditions to each set. The number of boundary 
    392 sets is defined by \np{nb\_bdy}.  Each boundary set may be defined 
     392sets is defined by \np{nb_bdy}.  Each boundary set may be defined 
    393393as a set of straight line segments in a namelist 
    394 (\np{ln\_coords\_file}=.false.) or read in from a file 
    395 (\np{ln\_coords\_file}=.true.). If the set is defined in a namelist, 
     394(\np{ln_coords_file}=.false.) or read in from a file 
     395(\np{ln_coords_file}=.true.). If the set is defined in a namelist, 
    396396then the namelists nambdy\_index must be included separately, one for 
    397397each set. If the set is defined by a file, then a 
    398 ``coordinates.bdy.nc'' file must be provided. The coordinates.bdy file 
    399 is analagous to the usual NEMO ``coordinates.nc'' file. In the example 
     398``\ifile{coordinates.bdy}'' file must be provided. The coordinates.bdy file 
     399is analagous to the usual NEMO ``\ifile{coordinates}'' file. In the example 
    400400above, there are two boundary sets, the first of which is defined via 
    401401a file and the second is defined in a namelist. For more details of 
     
    410410(``tra''). For each set of variables there is a choice of algorithm 
    411411and a choice for the data, eg. for the active tracers the algorithm is 
    412 set by \np{nn\_tra} and the choice of data is set by 
    413 \np{nn\_tra\_dta}.  
     412set by \np{nn_tra} and the choice of data is set by 
     413\np{nn_tra_dta}.  
    414414 
    415415The choice of algorithm is currently as follows: 
     
    429429 
    430430The main choice for the boundary data is 
    431 to use initial conditions as boundary data (\np{nn\_tra\_dta}=0) or to 
    432 use external data from a file (\np{nn\_tra\_dta}=1). For the 
     431to use initial conditions as boundary data (\forcode{nn_tra_dta = 0}) or to 
     432use external data from a file (\forcode{nn_tra_dta = 1}). For the 
    433433barotropic solution there is also the option to use tidal 
    434434harmonic forcing either by itself or in addition to other external 
     
    492492\end{equation} 
    493493The width of the FRS zone is specified in the namelist as  
    494 \np{nn\_rimwidth}. This is typically set to a value between 8 and 10.  
     494\np{nn_rimwidth}. This is typically set to a value between 8 and 10.  
    495495 
    496496%---------------------------------------------- 
     
    534534 
    535535The boundary geometry for each set may be defined in a namelist 
    536 nambdy\_index or by reading in a ``coordinates.bdy.nc'' file. The 
     536nambdy\_index or by reading in a ``\ifile{coordinates.bdy}'' file. The 
    537537nambdy\_index namelist defines a series of straight-line segments for 
    538538north, east, south and west boundaries. For the northern boundary, 
     
    546546 
    547547The boundary geometry may also be defined from a 
    548 ``coordinates.bdy.nc'' file. Figure \ref{Fig_LBC_nc_header} 
     548``\ifile{coordinates.bdy}'' file. Figure \ref{Fig_LBC_nc_header} 
    549549gives an example of the header information from such a file. The file 
    550550should contain the index arrays for each of the $T$, $U$ and $V$ 
     
    561561shelf break, then the areas of ocean outside of this boundary will 
    562562need to be masked out. This can be done by reading a mask file defined 
    563 as \np{cn\_mask\_file} in the nam\_bdy namelist. Only one mask file is 
     563as \np{cn_mask_file} in the nam\_bdy namelist. Only one mask file is 
    564564used even if multiple boundary sets are defined. 
    565565 
     
    609609\includegraphics[width=1.0\textwidth]{Fig_LBC_nc_header} 
    610610\caption {     \protect\label{Fig_LBC_nc_header}  
    611 Example of the header for a coordinates.bdy.nc file} 
     611Example of the header for a \ifile{coordinates.bdy} file} 
    612612\end{center}   \end{figure} 
    613613%>>>>>>>>>>>>>>>>>>>>>>>>>>>> 
     
    618618 
    619619There is an option to force the total volume in the regional model to be constant,  
    620 similar to the option in the OBC module. This is controlled  by the \np{nn\_volctl}  
    621 parameter in the namelist. A value of \np{nn\_volctl}~=~0 indicates that this option is not used.  
    622 If  \np{nn\_volctl}~=~1 then a correction is applied to the normal velocities  
     620similar to the option in the OBC module. This is controlled  by the \np{nn_volctl}  
     621parameter in the namelist. A value of \np{nn_volctl}~=~0 indicates that this option is not used.  
     622If  \np{nn_volctl}~=~1 then a correction is applied to the normal velocities  
    623623around the boundary at each timestep to ensure that the integrated volume flow  
    624 through the boundary is zero. If \np{nn\_volctl}~=~2 then the calculation of  
     624through the boundary is zero. If \np{nn_volctl}~=~2 then the calculation of  
    625625the volume change on the timestep includes the change due to the freshwater  
    626626flux across the surface and the correction velocity corrects for this as well. 
Note: See TracChangeset for help on using the changeset viewer.