Changeset 6866

Timestamp:

2016-08-12T16:27:51+02:00 (8 years ago)

Author:

lovato

Message:

#1729 - trunk: Update manual description for BDY and tides usage.

Location:

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles

Files:

• Chapters/Chap_CFG.tex (modified) (2 diffs)
• Chapters/Chap_DYN.tex (modified) (1 diff)
• Chapters/Chap_LBC.tex (modified) (4 diffs)
• Chapters/Chap_SBC.tex (modified) (1 diff)
• Namelist/nam_tide (modified) (1 diff)
• Namelist/nambdy (modified) (1 diff)
• Namelist/nambdy_dta (modified) (1 diff)

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Chapters/Chap_CFG.tex

@@ -297 +297 @@
 In particular, the AMM uses $S$-coordinates in the vertical rather than
 $z$-coordinates and is forced with tidal lateral boundary conditions
-using a flather boundary condition from the BDY module (key\_bdy).
+using a flather boundary condition from the BDY module.
 The AMM configuration  uses the GLS (key\_zdfgls) turbulence scheme, the
 VVL non-linear free surface(key\_vvl) and time-splitting
@@ -304 +304 @@
 In addition to the tidal boundary condition the model may also take
 open boundary conditions from a North Atlantic model. Boundaries may be
-completely ommited by removing the BDY key (key\_bdy).
+completely omitted by setting \np{ln\_bdy} to false.
 Sample surface fluxes, river forcing and a sample initial restart file
 are included to test a realistic model run. The Baltic boundary is

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Chapters/Chap_DYN.tex

@@ -1207 +1207 @@
 into account when computing the surface pressure gradient.
 
-(2) When \np{ln\_tide\_pot}~=~true and \key{tide} is defined (see \S\ref{SBC_tide}), 
+(2) When \np{ln\_tide\_pot}~=~true and \np{ln\_tide}~=~true (see \S\ref{SBC_tide}), 
 the tidal potential is taken into account when computing the surface pressure gradient.
 

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Chapters/Chap_LBC.tex

@@ -348 +348 @@
 % Unstructured open boundaries BDY 
 % ====================================================================
-\section{Unstructured Open Boundary Conditions (\key{bdy}) (BDY)}
+\section{Unstructured Open Boundary Conditions (BDY)}
 \label{LBC_bdy}
 
@@ -366 +366 @@
 Options are defined through the \ngn{nambdy} \ngn{nambdy\_index} 
 \ngn{nambdy\_dta} \ngn{nambdy\_dta2} namelist variables.
-The BDY module is an alternative implementation of open boundary
+The BDY module is the core implementation of open boundary
 conditions for regional configurations. It implements the Flow
 Relaxation Scheme algorithm for temperature, salinity, velocities and
@@ -374 +374 @@
 an isobath or other irregular contour. 
 
-The BDY module was modelled on the OBC module and shares many features
-and a similar coding structure \citep{Chanut2005}.
-
-The BDY module is completely rewritten at NEMO 3.4 and there is a new
-set of namelists. Boundary data files used with earlier versions of
-NEMO may need to be re-ordered to work with this version. See the
+The BDY module was modelled on the OBC module (see NEMO 3.4) and shares many
+features and a similar coding structure \citep{Chanut2005}.
+
+Boundary data files used with earlier versions of NEMO may need
+to be re-ordered to work with this version. See the
 section on the Input Boundary Data Files for details.
 
@@ -386 +385 @@
 \label{BDY_namelist}
 
+The BDY module is activated by setting \np{ln\_bdy} to true.
 It is possible to define more than one boundary ``set'' and apply
 different boundary conditions to each set. The number of boundary

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Chapters/Chap_SBC.tex

@@ -774 +774 @@
 
 A module is available to compute the tidal potential and use it in the momentum equation.
-This option is activated when \key{tide} is defined.
+This option is activated when \np{ln\_tide} is set to true in \ngn{nam\_tide}.
 
 Some parameters are available in namelist \ngn{nam\_tide}:

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Namelist/nam_tide

@@ -1 +1 @@
 !-----------------------------------------------------------------------
-&nam_tide      !   tide parameters                                      ("key_tide")
+&nam_tide      !   tide parameters
 !-----------------------------------------------------------------------
+   ln_tide       = .true.   !  Activate tide module
    ln_tide_pot   = .true.   !  use tidal potential forcing
    ln_tide_ramp  = .false.  !

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Namelist/nambdy

@@ -1 +1 @@
 !-----------------------------------------------------------------------
-&nambdy        !  unstructured open boundaries                          ("key_bdy")
+&nambdy        !  unstructured open boundaries
 !-----------------------------------------------------------------------
+    ln_bdy         = .true.               !  Activate BDY module
     nb_bdy         = 0                    !  number of open boundary sets
     ln_coords_file = .true.               !  =T : read bdy coordinates from file

branches/2016/dev_r6522_SIMPLIF_3/DOC/TexFiles/Namelist/nambdy_dta

@@ -1 +1 @@
 !-----------------------------------------------------------------------
-&nambdy_dta    !  open boundaries - external data                       ("key_bdy")
+&nambdy_dta    !  open boundaries - external data
 !-----------------------------------------------------------------------
 !              !  file name      ! frequency (hours) ! variable  ! time interp. !  clim   ! 'yearly'/ ! weights  ! rotation ! land/sea mask !