Changes between Version 42 and Version 43 of WorkingGroups/TOP/TOP-UserQuickGuide

Timestamp:

2018-08-31T20:40:44+02:00 (6 years ago)

Author:

nicolasmartin

Comment:

--

WorkingGroups/TOP/TOP-UserQuickGuide

@@ -124 +124 @@
 [[BR]]
 
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=13, end=26, line_numbers=0)]]
 |||| &'''namtrc_run'''      !   run information ||
 || nn_dttrc || Time step frequency for TOP computation (if >1 substepping is used) ||
@@ -131 +132 @@
 || cn_trcrst_in [[BR]]cn_trcrst_indir || Suffix of tracers INPUT restart file[[BR]]Root directory for the location of INPUT restart files ||
 || cn_trcrst_out[[BR]]cn_trcrst_outdir || suffix of tracers OUTPUT restart file[[BR]]Root directory for the location of OUTPUT restart files ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=27, end=49, line_numbers=0)]]
 |||| &'''namtrc'''          !   tracers definition ||
 || jp_bgc || Number of passive tracers of the BGC model ||
@@ -139 +142 @@
 || jp_dia3d, jp_dia2d || Number of 3D/2D diagnostic variables to populate dedicated array beside the direct usage of iom_put calls. ||
 || sn_tracer(''##'') || Data structure to specify tracer name and metadata for the chosen BGC module. Here set initialization and Boundary conditions. See structure description after this table. ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=56, end=64, line_numbers=0)]]
 |||| &'''namtrc_dta'''      !    Initialisation from data input file ||
 || sn_trcdta(##) || Data structure to read tracers Initial conditions according to sn_tracer%llinit option. See structure description after this table. ||
 || rf_trfac(''##'') || Multiplicative factor for initialized tracer. If omitted default is 1.0. ||
 || cn_dir || Root directory for the location of INPUT data files ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=65, end=80, line_numbers=0)]]
 |||| &'''namtrc_adv'''      !   advection scheme for passive tracer ||
 || ln_trcadv_OFF || No passive tracer advection ||
@@ -150 +157 @@
 || ln_trcadv_ubs[[BR]]nn_ubs_v || UBS scheme[[BR]]= 2 , vertical 2nd order FCT ||
 || ln_trcadv_qck || QUICKEST scheme ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=81, end=90, line_numbers=0)]]
 |||| &'''namtrc_ldf'''      !   lateral diffusion scheme for passive tracer ||
 || ln_trcldf_OFF || No passive tracer diffusion  ||
@@ -155 +164 @@
 || rn_ldf_multi || Multiplier of active tracers mixing coefficient (aht)  ||
 || rn_fact_lap || Equatorial enhanced zonal eddy diffusivity (laplacian only)  ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=91, end=95, line_numbers=0)]]
 |||| &'''namtrc_rad'''      !  treatment of negative concentrations ||
 || ln_trcrad || Artificially correct negative concentrations (T) or not (F) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=96, end=103, line_numbers=0)]]
 |||| &'''namtrc_dmp'''      !   passive tracer newtonian damping ||
 || nn_zdmp_tr || Vertical shape of damping term[[BR]]0 : damping throughout the water column[[BR]]1 : no damping in the mixing layer (kz  criteria)[[BR]]2 : no damping in the mixed layer (rho crieria) ||
 || cn_resto_tr || NetCDF filename with input damping coefficients ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=104, end=111, line_numbers=0)]]
 |||| &namtrc_ice      !    Representation of sea ice growth & melt effects ||
 || nn_ice_tr || Tracer concentration in sea ice. Available options[[BR]]-1 (no vvl: identical cc in ice and ocean / vvl: cc_ice = 0)[[BR]]0 (no vvl: cc_ice = zero / vvl: cc_ice = )[[BR]]1 prescribed to a namelist value (implemented in pisces or through user definition in trcice_my_trc) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=112, end=124, line_numbers=0)]]
 |||| &'''namtrc_trd'''      !   diagnostics on tracer trends                       ('key_trdtrc') ||
 || nn_trd_trc || Time step frequency and tracers trends ||
@@ -169 +186 @@
 || ln_trdmld_trc_instant || Diagnose trends of instantaneous (T) or mean (F) ML T/S ||
 || ln_trdtrc(##) || Compute trend for nth tracer. Array of logical values. ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=125, end=133, line_numbers=0)]]
 |||| &'''namtrc_bc'''       !   Forcing data for boundary conditions ||
 || sn_trcsbc(''##''), sn_trccbc(##), sn_trcobc(##) || Data structure to read tracers boundary conditions according to sn_tracer%llsbc,sn_tracer%llcbc, sn_tracer%llobc options. See structure description after this table. ||
@@ -175 +194 @@
 || ln_rnf_ctl || Remove runoff dilution on tracers with absent river load (only without VVL) ||
 || rn_bc_time || Time scaling factor for SBC and CBC data (seconds in a day) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=134         , line_numbers=0)]]
 |||| &'''namtrc_bdy'''      !   Setup of tracer boundary conditions ||
 || cn_trc_dflt || Open Boundary Condition applied by default to all tracers ||
 || cn_trc || Boundary conditions used for tracers with data files (selected in namtrc using sn_tracer%llobc) ||
 || nn_trcdmp_bdy || Use damping timescales defined in nambdy of namelist[[BR]]0 : NO damping of tracers at open boundaries[[BR]]1 : Only for tracers forced with external data[[BR]]2 : Damping applied to all tracers ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_top_ref, start=50, end=55, line_numbers=0)]]
 |||| &'''namage'''         !   Water Age module ||
 || rn_age_depth || Depth over which age tracer reset to zero ||
@@ -234 +257 @@
 Here below the description of namelist_trc_ref used to handle Carbon tracers modules, namely CFC and C14.
 
+source:/NEMO/trunk/cfgs/SHARED/namelist_trc_ref
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_trc_ref, start=6, end=14, line_numbers=0)]]
 |||| &'''namcfc'''     !   CFC ||
 || ndate_beg || Initial calendar date (yymmdd) for CFC ||
 || nyear_res ||Restoring time constant (year) ||
 || clname || Name of formatted file with annual hemisperic CFCs concentration in the atmosphere (ppt) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_trc_ref, start=16, end=23, line_numbers=0)]]
 |||| &'''namc14_typ'''     !  C14 - type of C14 tracer, default values of C14/C and pco2 ||
 || kc14typ || Type of C14 tracer (0=equilibrium; 1=bomb transient; 2=past transient) ||
@@ -243 +270 @@
 || pco2at || Default value for atmospheric pcO2 [atm] (used for equil run) ||
 || rc14init || Default value for initialization of ocean C14/C (when no restart) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_trc_ref, start=25, end=31, line_numbers=0)]]
 |||| &'''namc14_sbc'''     !  C14 - surface BC ||
 || ln_chemh || Use (T) or not (F) Chemical enhancement in piston velocity ||
 || xkwind || Coefficient for gas exchange velocity ||
 || xdicsur || Reference DIC surface concentration (mol/m3) ||
+
+[[IncludeSource(/NEMO/trunk/cfgs/SHARED/namelist_trc_ref, start=33, end=44, line_numbers=0)]]
 |||| &'''namc14_fcg'''     !  files & dates ||
 || cfileco2 || Name of formatted file with atmospheric co2 - Bomb ||