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 2308 – NEMO

Changeset 2308


Ignore:
Timestamp:
2010-10-25T16:41:57+02:00 (14 years ago)
Author:
davestorkey
Message:

Updates to BDY - DOCTOR naming standards

Location:
branches/DEV_r1826_DOC/DOC/TexFiles
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/DEV_r1826_DOC/DOC/TexFiles/Chapters/Chap_LBC.tex

    r2273 r2308  
    739739 
    740740%-----------------------------------------nambdy-------------------------------------------- 
    741 %-    filbdy_mask    =  ''                  !  name of mask file (if ln_bdy_mask=.TRUE.) 
    742 %-    filbdy_data_T  = 'bdydata_grid_T.nc'  !  name of data file for FRS condition (T-points) 
    743 %-    filbdy_data_U  = 'bdydata_grid_U.nc'  !  name of data file for FRS condition (U-points) 
    744 %-    filbdy_data_V  = 'bdydata_grid_V.nc'  !  name of data file for FRS condition (V-points) 
    745 %-    filbdy_data_bt_T  = 'bdydata_bt_grid_T.nc'  !  name of data file for Flather condition (T-points) 
    746 %-    filbdy_data_bt_U  = 'bdydata_bt_grid_U.nc'  !  name of data file for Flather condition (U-points) 
    747 %-    filbdy_data_bt_V  = 'bdydata_bt_grid_V.nc'  !  name of data file for Flather condition (V-points) 
    748 %-    ln_bdy_clim    = .false.              !  contain 1 (T) or 12 (F) time dumps and be cyclic 
    749 %-    ln_bdy_vol     = .true.               !  total volume correction (see volbdy parameter) 
    750 %-    ln_bdy_mask    = .false.              !  boundary mask from filbdy_mask (T) or boundaries are on edges of domain (F) 
    751 %-    ln_bdy_tides   = .true.               !  Apply tidal harmonic forcing with Flather condition 
    752 %-    ln_bdy_dyn_fla = .true.               !  Apply Flather condition to velocities 
    753 %-    ln_bdy_tra_frs = .false.              !  Apply FRS condition to temperature and salinity  
    754 %-    ln_bdy_dyn_frs = .false.              !  Apply FRS condition to velocities 
    755 %-    nbdy_dta       =  1                   !  = 0, bdy data are equal to the initial state 
    756 %-                                          !  = 1, bdy data are read in 'bdydata   .nc' files 
    757 %-    nb_rimwidth    = 9                    !  width of the relaxation zone 
    758 %-    volbdy         = 0                    !  = 0, the total water flux across open boundaries is zero 
     741%-    cn_mask    =  ''                        !  name of mask file (if ln_bdy_mask=.TRUE.) 
     742%-    cn_dta_frs_T  = 'bdydata_grid_T.nc'     !  name of data file (T-points) 
     743%-    cn_dta_frs_U  = 'bdydata_grid_U.nc'     !  name of data file (U-points) 
     744%-    cn_dta_frs_V  = 'bdydata_grid_V.nc'     !  name of data file (V-points) 
     745%-    cn_dta_fla_T  = 'bdydata_bt_grid_T.nc'  !  name of data file for Flather condition (T-points) 
     746%-    cn_dta_fla_U  = 'bdydata_bt_grid_U.nc'  !  name of data file for Flather condition (U-points) 
     747%-    cn_dta_fla_V  = 'bdydata_bt_grid_V.nc'  !  name of data file for Flather condition (V-points) 
     748%-    ln_clim    = .false.                    !  contain 1 (T) or 12 (F) time dumps and be cyclic 
     749%-    ln_vol     = .true.                     !  total volume correction (see volbdy parameter) 
     750%-    ln_mask    = .false.                    !  boundary mask from filbdy_mask (T) or boundaries are on edges of domain (F) 
     751%-    ln_tides   = .true.                     !  Apply tidal harmonic forcing with Flather condition 
     752%-    ln_dyn_fla = .true.                     !  Apply Flather condition to velocities 
     753%-    ln_tra_frs = .false.                    !  Apply FRS condition to temperature and salinity 
     754%-    ln_dyn_frs = .false.                    !  Apply FRS condition to velocities 
     755%-    nn_rimwidth    =  9                     !  width of the relaxation zone 
     756%-    nn_dtactl      =  1                     !  = 0, bdy data are equal to the initial state 
     757%-                                            !  = 1, bdy data are read in 'bdydata   .nc' files 
     758%-    nn_volctl      =  0                     !  = 0, the total water flux across open boundaries is zero 
     759%-                                            !  = 1, the total volume of the system is conserved 
    759760\namdisplay{nambdy}  
    760761%----------------------------------------------------------------------------------------------- 
     
    807808\end{equation} 
    808809The width of the FRS zone is specified in the namelist as  
    809 \np{nb\_rimwidth}. This is typically set to a value between 8 and 10.  
     810\np{nn\_rimwidth}. This is typically set to a value between 8 and 10.  
    810811 
    811812%---------------------------------------------- 
     
    837838 
    838839The Flow Relaxation Scheme may be applied separately to the 
    839 temperature and salinity (\np{ln\_bdy\_tra\_frs} = true) and 
    840 the velocity fields (\np{ln\_bdy\_dyn\_frs} = true). Flather 
     840temperature and salinity (\np{ln\_tra\_frs} = true) and 
     841the velocity fields (\np{ln\_dyn\_frs} = true). Flather 
    841842radiation conditions may be applied using externally defined 
    842 barotropic velocities and sea-surface height (\np{ln\_bdy\_dyn\_fla} = true)  
    843 or using tidal harmonics fields (\np{ln\_bdy\_tides} = true)  
     843barotropic velocities and sea-surface height (\np{ln\_dyn\_fla} = true)  
     844or using tidal harmonics fields (\np{ln\_tides} = true)  
    844845or both. FRS and Flather conditions may be applied simultaneously.  
    845846A typical configuration where all possible conditions might be used is a tidal,  
     
    888889 
    889890The input data files for the FRS conditions are defined in the 
    890 namelist as \np{filbdy\_data\_T}, \np{filbdy\_data\_U}, 
    891 \np{filbdy\_data\_V}. The input data files for the Flather conditions 
    892 are defined in the namelist as \np{filbdy\_data\_bt\_T}, 
    893 \np{filbdy\_data\_bt\_U}, \np{filbdy\_data\_bt\_V}. 
     891namelist as \np{cn\_dta\_frs\_T}, \np{cn\_dta\_frs\_U}, 
     892\np{cn\_dta\_frs\_V}. The input data files for the Flather conditions 
     893are defined in the namelist as \np{cn\_dta\_fla\_T}, 
     894\np{cn\_dta\_fla\_U}, \np{cn\_dta\_fla\_V}. 
    894895 
    895896The netcdf header of a typical input data file is shown in Figure 
     
    902903also have a depth dimension. 
    903904 
    904 If \np{ln\_bdy\_clim} is set to $false$, the model expects the 
     905If \np{ln\_clim} is set to $false$, the model expects the 
    905906units of the time axis to have the form shown in 
    906907\ref{Fig_bdy_input_file}, $i.e.$ {\it ``seconds since yyyy-mm-dd 
     
    908909time at each timestep. Note that for this option, the time axis of the 
    909910input files must completely span the time period of the model 
    910 integration. If \np{ln\_bdy\_clim} is set to $.true.$ (climatological 
     911integration. If \np{ln\_clim} is set to $.true.$ (climatological 
    911912boundary forcing), the model will expect either a single set of annual 
    912913mean fields (constant boundary forcing) or 12 sets of monthly mean 
     
    915916As in the OBC module there is an option to use initial conditions as 
    916917boundary conditions. This is chosen by setting 
    917 $\np{nb\_dta}=0$. However, since the model defines the boundary 
     918$\np{nn\_dtactl}=0$. However, since the model defines the boundary 
    918919geometry by reading the boundary index arrays from the input files, 
    919920it is still necessary to provide a set of input files in this 
     
    932933\label{BDY_vol_corr} 
    933934 
    934 There is an option to force the total volume in the regional model to be constant, similar to the option in the OBC module. This is controlled  by the \np{volbdy} parameter in the namelist. A value of $\np{volbdy} = 0$ indicates that this option is not used. If  $\np{volbdy} = 1$ then a correction is applied to the normal velocities around the boundary at each timestep to ensure that the integrated volume flow through the boundary is zero. If $\np{volbdy} = 2$ then the calculation of the volume change on the timestep includes the change due to the freshwater flux across the surface and the correction velocity corrects for this as well. 
     935There is an option to force the total volume in the regional model to be constant, similar to the option in the OBC module. This is controlled  by the \np{nn\_volctl} parameter in the namelist. A value of $\np{nn\_volctl} = 0$ indicates that this option is not used. If  $\np{nn\_volctl} = 1$ then a correction is applied to the normal velocities around the boundary at each timestep to ensure that the integrated volume flow through the boundary is zero. If $\np{nn\_volctl} = 2$ then the calculation of the volume change on the timestep includes the change due to the freshwater flux across the surface and the correction velocity corrects for this as well. 
    935936 
    936937 
  • branches/DEV_r1826_DOC/DOC/TexFiles/Namelist/nambdy

    r2213 r2308  
    22&nambdy        !  unstructured open boundaries                          ("key_bdy") 
    33!----------------------------------------------------------------------- 
    4     filbdy_mask    =  ''                  !  name of mask file (if ln_bdy_mask=.TRUE.) 
    5     filbdy_data_T  = 'bdydata_grid_T.nc'  !  name of data file (T-points) 
    6     filbdy_data_U  = 'bdydata_grid_U.nc'  !  name of data file (U-points) 
    7     filbdy_data_V  = 'bdydata_grid_V.nc'  !  name of data file (V-points) 
    8     filbdy_data_bt_T  = 'bdydata_bt_grid_T.nc'  !  name of data file for Flather condition (T-points) 
    9     filbdy_data_bt_U  = 'bdydata_bt_grid_U.nc'  !  name of data file for Flather condition (U-points) 
    10     filbdy_data_bt_V  = 'bdydata_bt_grid_V.nc'  !  name of data file for Flather condition (V-points) 
    11     ln_bdy_clim    = .false.              !  contain 1 (T) or 12 (F) time dumps and be cyclic 
    12     ln_bdy_vol     = .true.               !  total volume correction (see volbdy parameter) 
    13     ln_bdy_mask    = .false.              !  boundary mask from filbdy_mask (T) or boundaries are on edges of domain (F) 
    14     ln_bdy_tides   = .true.               !  Apply tidal harmonic forcing with Flather condition 
    15     ln_bdy_dyn_fla = .true.               !  Apply Flather condition to velocities 
    16     ln_bdy_tra_frs = .false.              !  Apply FRS condition to temperature and salinity  
    17     ln_bdy_dyn_frs = .false.              !  Apply FRS condition to velocities 
    18     nbdy_dta       =  1                   !  = 0, bdy data are equal to the initial state 
    19                                           !  = 1, bdy data are read in 'bdydata   .nc' files 
    20     nb_rimwidth    = 9                    !  width of the relaxation zone 
    21     volbdy         = 0                    !  = 0, the total water flux across open boundaries is zero 
    22                                           !  = 1, the total volume of the system is conserved 
     4    cn_mask    =  ''                        !  name of mask file (if ln_bdy_mask=.TRUE.) 
     5    cn_dta_frs_T  = 'bdydata_grid_T.nc'     !  name of data file (T-points) 
     6    cn_dta_frs_U  = 'bdydata_grid_U.nc'     !  name of data file (U-points) 
     7    cn_dta_frs_V  = 'bdydata_grid_V.nc'     !  name of data file (V-points) 
     8    cn_dta_fla_T  = 'bdydata_bt_grid_T.nc'  !  name of data file for Flather condition (T-points) 
     9    cn_dta_fla_U  = 'bdydata_bt_grid_U.nc'  !  name of data file for Flather condition (U-points) 
     10    cn_dta_fla_V  = 'bdydata_bt_grid_V.nc'  !  name of data file for Flather condition (V-points) 
     11    ln_clim    = .false.                    !  contain 1 (T) or 12 (F) time dumps and be cyclic 
     12    ln_vol     = .true.                     !  total volume correction (see volbdy parameter) 
     13    ln_mask    = .false.                    !  boundary mask from filbdy_mask (T) or boundaries are on edges of domain (F) 
     14    ln_tides   = .true.                     !  Apply tidal harmonic forcing with Flather condition 
     15    ln_dyn_fla = .true.                     !  Apply Flather condition to velocities 
     16    ln_tra_frs = .false.                    !  Apply FRS condition to temperature and salinity  
     17    ln_dyn_frs = .false.                    !  Apply FRS condition to velocities 
     18    nn_rimwidth    =  9                     !  width of the relaxation zone 
     19    nn_dtactl      =  1                     !  = 0, bdy data are equal to the initial state 
     20                                            !  = 1, bdy data are read in 'bdydata   .nc' files 
     21    nn_volctl      =  0                     !  = 0, the total water flux across open boundaries is zero 
     22                                            !  = 1, the total volume of the system is conserved 
    2323/ 
    2424 
Note: See TracChangeset for help on using the changeset viewer.