Changes between Version 2 and Version 3 of WorkingGroups/TOP/NEMO36_TOP_BDY

Timestamp:

2018-10-29T19:13:38+01:00 (6 years ago)

Author:

lovato

Comment:

--

WorkingGroups/TOP/NEMO36_TOP_BDY

@@ -6 +6 @@
 Last edition: '''[[Wikinfo(changed_ts)]]''' by '''[[Wikinfo(changed_by)]]'''
 
-'''BEFORE USE''' : this patch is meant to provide only the core functionality for TOP BDY. 
+'''BEFORE USE''' : this patch is meant to provide only the core functionality for TOP BDY under NEMO v3.6. 
 Official support for tracers BDY will be given only for versions after NEMO v4.0.
 
@@ -14 +14 @@
 Note that in this patch, routines that provide to initialization/reading of all Boundary conditions (trcbc.f90) were also updated.
 
-''BDY schemes'' included in this version are the following (see trcbdy.F90): 
+__BDY schemes__ included in this version are the following (see trcbdy.F90): 
 * '''frs''' : Flow Relaxation Scheme 
 * '''specified''' : Specified value
@@ -33 +33 @@
    cn_dir_obc        =  './'      !  root directory for the location of OPEN data files
 /
+
 !----------------------------------------------------------------------
 !namtrc_bdy       !   Setup of tracer boundary conditions
@@ -56 +57 @@
 These files have to be unpacked in the MY_SRC folder of your configuration in order to be used.
 
-''REMINDER'': MY_SRC contains user modified versions of NEMO routines or new pieces of code that are used at compilation time to supersede at original ones.
+__REMINDER__: MY_SRC contains user modified versions of NEMO routines or new pieces of code that are used at compilation time to supersede at original ones.
+
+In the following example the user defined tracer module MY_TRC is used to setup a simple one passive tracer case (need to add ''key_my_trc'' in the configuration cpp file)
+and specific modified files are also available in the tarball.
 
 Note that '''namelist_top_ref''' has to be modified by the user in <NEMODIR>/NEMOGCM/CONFIG/SHARED according to the description above (or the sample file provided in the tarball).
 
 All boundary conditions are controlled within the namelist '''namtrc''' in namelist_top_(cfg/ref).
-A modified fortran data structure of namtrc was here developed to set the different boundary conditions of passive tracers, as in the following example of namelist_top_cfg :
+A modified fortran data structure of namtrc was here developed to set the different boundary conditions of passive tracers, as in the following example of namelist_top_cfg for one tracer :
 
 {{{
@@ -77 +81 @@
 where the new options relates to the provision of SURFACE (sbc), COASTAL (cbc), or  OPEN lateral Boundaries (obc) data for  sn_tracer(1)  named TRACER1.
 
-In '''namtrc_bc''' are provided the different boundary conditions for passive tracers, see the example below of namelist_top_cfg
-
+In '''namtrc_bc''' are provided the different boundary conditions for passive tracers, see the example below of namelist_top_cfg:
 
 {{{
@@ -99 +102 @@
 }}}
 
-Input files are provided using the standard NEMO fldread structure and follow the convention sn_trcsbc = surface, sn_trccbc = coastal, sn_trcobc = open lateral,
-with the correspondig scaling factors rn_trsfac = surface, rn_trcfac = coastal, rn_trofac = open lateral.
+Input files are provided using the standard NEMO fldread structure and it follows the convention sn_trcsbc = surface, sn_trccbc = coastal, sn_trcobc = open lateral,
+with the corresponding scaling factors rn_trsfac = surface, rn_trcfac = coastal, rn_trofac = open lateral.
+
+BDY schemes are setup in the namelist '''namtrc_bdy'''.  In the following example for 1 tracer, we set the use of orlanski_npo scheme and no tracer damping:
+
+{{{
+!----------------------------------------------------------------------
+!namtrc_bdy       !   Setup of tracer boundary conditions
+!-----------------------------------------------------------------------
+$namtrc_bdy
+   cn_trc_dflt     =  'neumann'    !  OBC applied by default to all tracers
+   cn_trc          =  'orlanski_npo'       !  Boundary conditions applied to the passive tracers (selected in namtrc)
+
+   nn_trcdmp_bdy   = 0     !  Use damping timescales defined in nambdy of namelist
+ /
+}}}
 
 
-
-
-namtrc_bc : here are provided the different boundary conditions for passive tracers, namely surface, coastal, and open lateral boundaries (see the example below for usage).
-namtrc_bdy : here set the BDY schemes to be used for those tracers that BDY inputs are provided (according to namtrc options)
+Here below a summary of available options
+|| cn_trc_dflt || Default BDY scheme for all passive tracers ||
+|| cn_trc || Specific BDY scheme to be applied for tracers that are forced with external data files, setup via namtrc ||
+||nn_trcdmp_bdy || tracer damping, with timescales defined in nambdy of namelist_(ref/cfg) ||
+|| || 0 : NO damping of tracers at open boundaries  ||
+|| || 1 : Only for tracers forced with external data ||
+|| || 2 : Damping applied to all tracers ||