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 24 and Version 25 of WorkingGroups/TOP/TOP-UserQuickGuide


Ignore:
Timestamp:
2018-01-17T12:45:24+01:00 (6 years ago)
Author:
lovato
Comment:

--

Legend:

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

    v24 v25  
    22The present Quick Guide applies to NEMO 4.0+ releases. 
    33 
    4 [[=#TOPStructure TOP interface structure]] 
     4[#Sect1 TOP interface Structure] 
     5 
     6[#Sect2 TOP synthetic Workflow] 
     7 
     8[#Sect3 TOP namelists Walkthrough] 
     9 
     10[#Sect4 MY_TRC interface for coupling external BGC models] 
     11 
     12[#Sect5 Coupling an external BGC model using NEMO framework] 
     13 
    514 
    615=  = 
     
    817[[BR]] 
    918 
    10 == TOP interface structure == #TOPStructure 
     19[=#Sect1] 
     20== TOP interface Structure == 
     21 
    1122TOP (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 
    1223 
     
    4556[[BR]] 
    4657 
    47 == TOP synthetic Workflow == #TOPWorkflow 
     58[=#Sect2] 
     59== TOP synthetic Workflow == 
    4860A 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. 
    4961 
     
    98110[[BR]] 
    99111 
    100 == TOP namelist Walkthrough == #TOPnamelists 
     112[=#Sect3] 
     113== TOP namelists Walkthrough == 
    101114 
    102115=== namelist_top === 
     
    235248[[BR]] 
    236249 
    237 == MY_TRC interface for coupling external BGC models == #TOPmytrc 
     250[=#Sect4] 
     251== MY_TRC interface for coupling external BGC models == 
    238252 
    239253The generalized interface is pivoted on MY_TRC module that contains template files to build the coupling between NEMO and any external BGC model. 
     
    271285[[BR]] 
    272286 
    273 == Coupling an external BGC model using NEMO framework == #TOPexternalcoupling 
     287[=#Sect5] 
     288== Coupling an external BGC model using NEMO framework == 
    274289 
    275290The coupling with an external BGC model through the NEMO compilation framework can be achieved in different ways according to the degree of coding complexity (e.g., code is only in one file or it has multiple modules and interfaces) of the BGC model itself.