source: branches/dev_001_GM/NEMO/TOP_SRC/MY_TRC/par_MY_TRC.F90 @ 767

MODULE par_MY_TRC
   !!======================================================================
   !!                        ***  par_MY_TRC  ***
   !! TOP :   set the MY_TRC parameters
   !!======================================================================
   !! History :   2.0  !  2007-12  (C. Ethe, G. Madec)  revised architecture
   !!----------------------------------------------------------------------
   !! NEMO/TOP 2.0 , LOCEAN-IPSL (2007) 
   !! $Id:$ 
   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
   !!----------------------------------------------------------------------
   USE par_LOBSTER, ONLY : jp_lobster   !: number of tracers in LOBSTER
   USE par_PISCES , ONLY : jp_pisces    !: number of tracers in PISCES
   USE par_CFC    , ONLY : jp_cfc       !: number of tracers in CFC

   IMPLICIT NONE
   PUBLIC

#if defined key_trc_my_trc
   !!---------------------------------------------------------------------
   !!   'key_trc_my_trc'                     user defined tracers (MY_TRC)
   !!---------------------------------------------------------------------
   LOGICAL, PUBLIC, PARAMETER ::   lk_my_trc     = .TRUE.   !: PTS flag 
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc     =  3       !: number of PTS tracers
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_2d  =  1       !: additional 2d output arrays ('key_trc_diaadd')
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_3d  =  1       !: additional 3d output arrays ('key_trc_diaadd')
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_trd =  0       !: number of sms trends for MY_TRC

   ! assign an index in trc arrays for each PTS prognostic variables
   INTEGER, PUBLIC, PARAMETER ::   jp_lpc  = jp_lobster + jp_pisces + jp_cfc   !: cumulative number of TRC
   INTEGER, PUBLIC, PARAMETER ::   jp_myt1 = jp_lpc + 1                        !: 1st MY_TRC tracer
   INTEGER, PUBLIC, PARAMETER ::   jp_myt2 = jp_lpc + 1                        !: 2nd MY_TRC tracer
   INTEGER, PUBLIC, PARAMETER ::   jp_myt3 = jp_lpc + 1                        !: 3rd MY_TRC tracer

#else
   !!---------------------------------------------------------------------
   !!   Default                           No user defined tracers (MY_TRC)
   !!---------------------------------------------------------------------
   LOGICAL, PUBLIC, PARAMETER ::   lk_my_trc     = .FALSE.  !: MY_TRC flag 
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc     =  0       !: No MY_TRC tracers
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_2d  =  0       !: No MY_TRC additional 2d output arrays 
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_3d  =  0       !: No MY_TRC additional 3d output arrays 
   INTEGER, PUBLIC, PARAMETER ::   jp_my_trc_trd =  0       !: number of sms trends for MY_TRC
#endif

   ! Starting/ending PISCES do-loop indices (N.B. no PISCES : jpl_pcs < jpf_pcs the do-loop are never done)
   INTEGER, PUBLIC, PARAMETER ::   jpf_myt = jp_l + 1           !: First index of CFC passive tracers
   INTEGER, PUBLIC, PARAMETER ::   jpl_myt = jp_l + jp_my_trc   !: Last  index of CFC passive tracers

   !!======================================================================
END MODULE par_MY_TRC