C $Header: /home/ubuntu/mnt/e9_copy/MITgcm_contrib/ocean_inversion_project/code_ecco1x1/PTRACERS.h,v 1.1 2004/10/06 20:26:55 dimitri Exp $
C $Name:  $

#ifdef ALLOW_PTRACERS

CBOP
C    !ROUTINE: PTRACERS.h
C    !INTERFACE:
C #include PTRACERS.h
 
C    !DESCRIPTION:
C Contains passive tracer fields and parameters.
C This file is customized to compute CO2 perturbations from
C 30 ocean regions for Gruber's ocean inversion project.

C     Package flag
      logical PTRACERSisON
      COMMON /PTRACERS_PACKAGE/ PTRACERSisON

C NUMBER_OF_PTRACERS defines how many passive tracers are allocated/exist.
C This CPP macro is *only* used in PTRACERS.h to set an integer parameter.
C <Please> do not make use of it elsewhere.
C
C NUMBER_OF_PTRACERS can also be defined in CPP_OPTIONS.h, or in the
C Makefile with DEFINES=-DNUMBER_OF_PTRACERS=4
C
C If NUMBER_OF_PTRACERS is not specified elsewhere and ALLOW_PTRACERS
C is set then NUMBER_OF_PTRACERS is set here (default 1)
#ifndef NUMBER_OF_PTRACERS
#define NUMBER_OF_PTRACERS 30
#endif

C     Number of tracers
      INTEGER PTRACERS_num
      PARAMETER(PTRACERS_num = NUMBER_OF_PTRACERS)

C     PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
C                          are written to post-processing files.

C     PTRACERS parameters
      _RL PTRACERS_taveFreq
      _RL PTRACERS_diffKh(PTRACERS_num)
      _RL PTRACERS_diffK4(PTRACERS_num)
      _RL PTRACERS_diffKr(PTRACERS_num)
      INTEGER PTRACERS_advScheme(PTRACERS_num)
      INTEGER PTRACERS_numInUse
      LOGICAL PTRACERS_useGMRedi(PTRACERS_num)
      LOGICAL PTRACERS_useKPP(PTRACERS_num)
      LOGICAL PTRACERS_useRecords
      CHARACTER*(MAX_LEN_FNAM) PTRACERS_initialFile(PTRACERS_num)
      COMMON /PTRACERS_PARAMS/
     &                   PTRACERS_taveFreq,
     &                   PTRACERS_diffKh,
     &                   PTRACERS_diffK4,
     &                   PTRACERS_diffKr,
     &                   PTRACERS_numInUse,
     &                   PTRACERS_advScheme,
     &                   PTRACERS_initialFile,
     &                   PTRACERS_useGMRedi,
     &                   PTRACERS_useKPP,
     &                   PTRACERS_useRecords
      NAMELIST /PTRACERS_PARM01/
     &                   PTRACERS_taveFreq,
     &                   PTRACERS_advScheme,
     &                   PTRACERS_diffKh,
     &                   PTRACERS_diffK4,
     &                   PTRACERS_diffKr,
     &                   PTRACERS_useGMRedi,
     &                   PTRACERS_useKPP,
     &                   PTRACERS_numInUse,
     &                   PTRACERS_initialFile,
     &                   PTRACERS_useRecords

C     pTracer  :: passive tracer concentration (tr per unit volume).
C     gPtr     :: work-space for time-stepping
C     gPtrNM1  :: work-space for time-stepping
      _RL  pTracer (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,
     &              PTRACERS_num)
      _RL  gPtr    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,
     &              PTRACERS_num)
      _RL  gPtrNM1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,
     &              PTRACERS_num)
      _RL  surfaceTendencyPtr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy,
     &              PTRACERS_num)
      COMMON /PTRACERS_FIELDS/
     &              pTracer, gPtr, gPtrNM1, surfaceTendencyPtr

C     pTracerMasks :: masks used to define 30 ocean regions
C                     for Gruber's ocean inversion project
      INTEGER pTracerMasks(1-OLx:sNx+OLx,1-OLy:sNy+OLy,
     &                     PTRACERS_num,nSx,nSy)
      COMMON /PTRACERS_MASKS/ pTracerMasks

C     pTracerTakahashi :: variable containing monthly mean
C                         Takahashi CO2 flux climatology
      _RS pTracerTakahashi(1-OLx:sNx+OLx,1-OLy:sNy+OLy,12,nSx,nSy)
      COMMON /PTRACERS_Takahashi/ pTracerTakahashi

C     pTracerAtmCO2 :: arrays containing atmospheric CO2 concentration
      integer   pTracerAtm_Nrec
      PARAMETER(pTracerAtm_Nrec = 492)
      _RS pTracerAtmYear(pTracerAtm_Nrec)
      _RS pTracerAtmCO2 (pTracerAtm_Nrec)
      COMMON /PTRACERS_AtmCO2/ pTracerAtmYear, pTracerAtmCO2

CEOP
#endif /* ALLOW_PTRACERS */