Changes between Version 5 and Version 6 of Working Groups/TOP/TOP-User Quick Guide


Ignore:
Timestamp:
2018-01-17T11:41:55+01:00 (3 years ago)
Author:
lovato
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Working Groups/TOP/TOP-User Quick Guide

    v5 v6  
    1616|| '''PISCES''' || Built in BGC model || 
    1717 
    18 The usage of TOP is done by i) including in the configuration definition the component “TOP_SRC” and ii) adding the macro key_top in the configuration cpp file. 
     18The usage of TOP is activated by i) including in the configuration definition the component “TOP_SRC” and ii) adding the macro key_top in the configuration cpp file. 
    1919 
    2020As an example, the user can refer to simplest configurations already available in the code GYRE_BFM or GYRE_PISCES. 
    2121 
    22 '''Note that''', since version 4.0, TOP interface core functionalities are activated by means of logical keys and all sub-module preprocessing macros from previous versions were removed. 
    23  
    24 [[BR]] 
     22Note that, since version 4.0, TOP interface core functionalities are activated by means of logical keys and all sub-module preprocessing macros from previous versions were removed. 
    2523 
    2624Here below the list of preprocessing keys that applies to the TOP interface (beside key_top): 
     
    2826key_iomput : use XIOS I/O 
    2927 
    30 key_zdfddm & key_zdftke & key_zdfgls: vertial schemes (need to be updated after Merge2017) 
     28key_zdfddm & key_zdftke & key_zdfgls: vertical schemes (need to be updated after Merge2017 finalization) 
    3129 
    3230key_trabbl : bottom boundary layer parameterization 
     
    3836[[BR]] 
    3937 
     38== TOP synthetic Workflow == 
     39A synthetic description of the TOP interface workflow is given below to summarize the steps involved in the computation of biogeochemical and physical trends and their time integration and outputs, by reporting also the principal Fortran subroutine herein involved. 
     40 
     41[[BR]] 
     42 
     43'''Model initialization (nemogcm.F90)''' 
     44 
     45call to trc_init (trcini.F90) 
     46 
     47        ↳ call trc_nam (trcnam.F90) to initialize TOP tracers and run setting 
     48 
     49        ↳ call trc_ini_sms, to initialize all modules  
     50 
     51        ↳ call trc_ini_trp, to initialize transport for tracers 
     52 
     53        ↳ call trc_ice_ini, to initialize tracers in seaice 
     54 
     55        ↳ call trc_ini_state, read passive tracers from a restart or input data 
     56 
     57        ↳ call trc_sub_ini, setup substepping if nn_dttrc /= 1 
     58 
     59[[BR]] 
     60 
     61'''Time marching procedure (OPA_SRC/stp.F90)''' 
     62 
     63call to trc_stp.F90 (trcstp.F90) 
     64 
     65        ↳ call trc_sub_stp, averaging physical variables for sub-stepping 
     66 
     67        ↳ call trc_wri, call XIOS for output of data  
     68 
     69        ↳ call trc_sms, compute BGC trends for all modules 
     70 
     71        ↳ call trc_sms_my_trc, includes also surface and coastal BCs trends 
     72 
     73        ↳ call trc_trp (TRP/trctrp.F90), compute physical trends 
     74 
     75        ↳ call trc_sbc, get trend due to surface concentration/dilution 
     76 
     77        ↳ call trc_adv, compute tracers advection 
     78 
     79                        ↳ call to trc_ldf, compute tracers lateral diffusion 
     80 
     81                        ↳ call to trc_zdf, vertical mixing and after tracer fields 
     82 
     83                        ↳ call to trc_nxt, tracer fields at next time step     
     84 
     85                        ↳ call to trc_rad, Correct artificial negative concentrations 
     86 
     87        ↳ call trc_rst_wri, output tracers restart files 
     88 
     89[[BR]] 
     90 
    4091== TOP namelist Walkthrough == 
    4192Here below are listed the features/options of the TOP interface accessible through the '''namelist_top_ref''' and modifiable by means of '''namelist_top_cfg''' (as for NEMO physical ones).