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.
WorkingGroups/TOP/TOP-UserQuickGuide (diff) – NEMO

Changes between Version 35 and Version 36 of WorkingGroups/TOP/TOP-UserQuickGuide


Ignore:
Timestamp:
2018-03-13T23:54:46+01:00 (6 years ago)
Author:
lovato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WorkingGroups/TOP/TOP-UserQuickGuide

    v35 v36  
    2020== TOP interface Structure == 
    2121 
    22 TOP (Tracers in the Ocean Paradigm) is the NEMO hardwired interface toward biogeochemical models and provide the physical constraints/boundaries for oceanic tracers.  It consists of a modular framework to handle multiple ocean tracers, including also a variety of built-in modules.  TOP interfaces has the following location in the code repository 
     22TOP (Tracers in the Ocean Paradigm) is the NEMO hardwired interface toward biogeochemical models and provide the physical constraints/boundaries for oceanic tracers.  It consists of a modular framework to handle multiple ocean tracers, including also a variety of built-in modules. 
     23 
     24This component of the NEMO framework allows one to exploit available modules (see below) and further develop a range of applications, spanning from the implementation of a dye passive tracer to evaluate dispersion processes (by means of MY_TRC), track water masses age (AGE module), assess the ocean interior penetration of persistent chemical compounds (e.g., gases like CFC or even PCBs), up to the full set of equations involving marine biogeochemical cycles. 
     25 
     26TOP interface has the following location in the code repository 
    2327 
    2428{{{ 
     
    3438|| '''PISCES''' || Built in BGC model. See [https://www.geosci-model-dev.net/8/2465/2015/gmd-8-2465-2015-discussion.html Aumont et al. (2015)] for a throughout description. || 
    3539 
    36 The 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. 
    37  
    38 As an example, the user can refer to simplest configurations already available in the code GYRE_BFM or GYRE_PISCES. 
     40The 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 (see for more details [http://forge.ipsl.jussieu.fr/nemo/wiki/Users "Learn more about the model"]). 
     41 
     42As an example, the user can refer to already available configurations in the code '''GYRE_PISCES''' as the NEMO biogeochemical demonstrator and '''GYRE_BFM''' to see the required configuration elements to couple with an external biogeochemical model (see also in Section 4) . 
    3943 
    4044Note that, since version 4.0, TOP interface core functionalities are activated by means of logical keys and all submodules preprocessing macros from previous versions were removed.