C $Header: /home/ubuntu/mnt/e9_copy/MITgcm_contrib/sciascia/rbcs/RBCS_PARAMS.h,v 1.1 2012/08/08 01:57:13 heimbach Exp $
C $Name:  $

#ifdef ALLOW_RBCS

CBOP
C    !ROUTINE: RBCS_PARAMS.h
C    !INTERFACE:

C    !DESCRIPTION:
C Contains RBCS parameters and input files for 3-D relaxation
C Some of these can be read in from data.rbcs
CEOP

C---  RBCS Parameters:
C     rbcsForcingPeriod :: period of rbc data (in seconds)
C     rbcsForcingCycle  :: cycle of rbc data (in seconds)
C     rbcsForcingOffset :: model time at beginning of first rbc period
C     rbcsSingleTimeFiles :: if .TRUE., rbc fields are given 1 file per time
C                         :: labeled by iteration number (see rbcsIter0,deltaTrbcs)
C     deltaTrbcs :: time step used to compute iteration numbers for singleTimeFiles
C     rbcsIter0  :: singleTimeFile iteration number corresponding to rbcsForcingOffset
C     rbcsVanishingTime :: when rbcsVanishingTime .NE. 0. the relaxation strength reduces
C                       :: linearly to vanish at myTime .EQ. rbcsVanishingTime
C
      _RL tauRelaxU(UmLEN)
      _RL tauRelaxV(VmLEN)
      _RL tauRelaxT
      _RL tauRelaxS
      _RL rbcsForcingPeriod
      _RL rbcsForcingCycle
      _RL rbcsForcingOffset
      _RL rbcsForcingUPeriod(UmLEN)
      _RL rbcsForcingUCycle(UmLEN)
      _RL rbcsForcingUOffset(UmLEN)
      _RL rbcsForcingVPeriod(VmLEN)
      _RL rbcsForcingVCycle(VmLEN)
      _RL rbcsForcingVOffset(VmLEN)
#ifdef ALLOW_NONHYDROSTATIC
      _RL tauRelaxW(WmLEN)
      _RL rbcsForcingWPeriod(WmLEN)
      _RL rbcsForcingWCycle(WmLEN)
      _RL rbcsForcingWOffset(WmLEN)
      LOGICAL useRBCwVel(WmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxMaskWFile(WmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxWFile(WmLEN)
#endif
      _RL deltaTrbcs
      _RL rbcsVanishingTime
      INTEGER rbcsIniter
      INTEGER rbcsIter0
      LOGICAL rbcsSingleTimeFiles
      LOGICAL useRBCuVel(UmLEN)
      LOGICAL useRBCvVel(VmLEN)
      LOGICAL useRBCtemp
      LOGICAL useRBCsalt
      CHARACTER*(MAX_LEN_FNAM) relaxMaskUFile(UmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxMaskVFile(VmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxMaskFile(maskLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxUFile(UmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxVFile(VmLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxTFile
      CHARACTER*(MAX_LEN_FNAM) relaxSFile

#ifdef ALLOW_NONHYDROSTATIC
      COMMON /RBCS_PARM01_R/
     &          tauRelaxW,
     &          rbcsForcingWPeriod,
     &          rbcsForcingWCycle,
     &          rbcsForcingWOffset
      COMMON /RBCS_PARM01_L/
     &          useRBCwVel
      COMMON /RBCS_PARM01_C/
     &          relaxMaskWFile,
     &          relaxWFile
#endif
      COMMON /RBCS_PARM01_R/
     &          tauRelaxU,
     &          tauRelaxV,
     &          tauRelaxT,
     &          tauRelaxS,
     &          rbcsForcingPeriod,
     &          rbcsForcingCycle,
     &          rbcsForcingOffset,
     &          rbcsForcingUPeriod,
     &          rbcsForcingUCycle,
     &          rbcsForcingUOffset,
     &          rbcsForcingVPeriod,
     &          rbcsForcingVCycle,
     &          rbcsForcingVOffset,
     &          rbcsVanishingTime,
     &          deltaTrbcs
      COMMON /RBCS_PARM01_I/
     &          rbcsIniter,
     &          rbcsIter0
      COMMON /RBCS_PARM01_L/
     &          rbcsSingleTimeFiles,
     &          useRBCuVel,
     &          useRBCvVel,
     &          useRBCtemp,
     &          useRBCsalt
      COMMON /RBCS_PARM01_C/
     &          relaxMaskUFile,
     &          relaxMaskVFile,
     &          relaxMaskFile,
     &          relaxUFile,
     &          relaxVFile,
     &          relaxTFile,
     &          relaxSFile

#ifdef ALLOW_PTRACERS
      LOGICAL useRBCptrnum(PTRACERS_num)
      _RL tauRelaxPTR(PTRACERS_num)
      CHARACTER*(MAX_LEN_FNAM) relaxPtracerFile(PTRACERS_num)

      COMMON /RBCS_PARM02_L/
     &          useRBCptrnum
      COMMON /RBCS_PARM02_R/
     &          tauRelaxPTR
      COMMON /RBCS_PARM02_C/
     &          relaxPtracerFile
#endif /* ALLOW_PTRACERS */

#endif /* ALLOW_RBCS */