pkg/rbcs/RBCS_PARAMS.h

C $Header: /u/gcmpack/MITgcm/pkg/rbcs/RBCS_PARAMS.h,v 1.3 2013/12/31 22:21:47 jmc 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
      _RL tauRelaxV
      _RL tauRelaxT
      _RL tauRelaxS
      _RL rbcsForcingPeriod
      _RL rbcsForcingCycle
      _RL rbcsForcingOffset
      _RL deltaTrbcs
      _RL rbcsVanishingTime
      INTEGER rbcsIter0
      LOGICAL rbcsSingleTimeFiles
      LOGICAL useRBCuVel
      LOGICAL useRBCvVel
      LOGICAL useRBCtemp
      LOGICAL useRBCsalt
      CHARACTER*(MAX_LEN_FNAM) relaxMaskUFile
      CHARACTER*(MAX_LEN_FNAM) relaxMaskVFile
      CHARACTER*(MAX_LEN_FNAM) relaxMaskTrFile(maskLEN)
      CHARACTER*(MAX_LEN_FNAM) relaxUFile
      CHARACTER*(MAX_LEN_FNAM) relaxVFile
      CHARACTER*(MAX_LEN_FNAM) relaxTFile
      CHARACTER*(MAX_LEN_FNAM) relaxSFile

      COMMON /RBCS_PARM01_R/
     &          tauRelaxU,
     &          tauRelaxV,
     &          tauRelaxT,
     &          tauRelaxS,
     &          rbcsForcingPeriod,
     &          rbcsForcingCycle,
     &          rbcsForcingOffset,
     &          rbcsVanishingTime,
     &          deltaTrbcs
      COMMON /RBCS_PARM01_I/
     &          rbcsIter0
      COMMON /RBCS_PARM01_L/
     &          rbcsSingleTimeFiles,
     &          useRBCuVel,
     &          useRBCvVel,
     &          useRBCtemp,
     &          useRBCsalt
      COMMON /RBCS_PARM01_C/
     &          relaxMaskUFile,
     &          relaxMaskVFile,
     &          relaxMaskTrFile,
     &          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 */
1	C $Header: /u/gcmpack/MITgcm/pkg/rbcs/RBCS_PARAMS.h,v 1.3 2013/12/31 22:21:47 jmc Exp $
2	C $Name: $
3
4	#ifdef ALLOW_RBCS
5
6	CBOP
7	C !ROUTINE: RBCS_PARAMS.h
8	C !INTERFACE:
9
10	C !DESCRIPTION:
11	C Contains RBCS parameters and input files for 3-D relaxation
12	C Some of these can be read in from data.rbcs
13	CEOP
14
15	C--- RBCS Parameters:
16	C rbcsForcingPeriod :: period of rbc data (in seconds)
17	C rbcsForcingCycle :: cycle of rbc data (in seconds)
18	C rbcsForcingOffset :: model time at beginning of first rbc period
19	C rbcsSingleTimeFiles :: if .TRUE., rbc fields are given 1 file per time
20	C :: labeled by iteration number (see rbcsIter0,deltaTrbcs)
21	C deltaTrbcs :: time step used to compute iteration numbers for singleTimeFiles
22	C rbcsIter0 :: singleTimeFile iteration number corresponding to rbcsForcingOffset
23	C rbcsVanishingTime :: when rbcsVanishingTime .NE. 0. the relaxation strength reduces
24	C :: linearly to vanish at myTime .EQ. rbcsVanishingTime
25	C
26	_RL tauRelaxU
27	_RL tauRelaxV
28	_RL tauRelaxT
29	_RL tauRelaxS
30	_RL rbcsForcingPeriod
31	_RL rbcsForcingCycle
32	_RL rbcsForcingOffset
33	_RL deltaTrbcs
34	_RL rbcsVanishingTime
35	INTEGER rbcsIter0
36	LOGICAL rbcsSingleTimeFiles
37	LOGICAL useRBCuVel
38	LOGICAL useRBCvVel
39	LOGICAL useRBCtemp
40	LOGICAL useRBCsalt
41	CHARACTER*(MAX_LEN_FNAM) relaxMaskUFile
42	CHARACTER*(MAX_LEN_FNAM) relaxMaskVFile
43	CHARACTER*(MAX_LEN_FNAM) relaxMaskTrFile(maskLEN)
44	CHARACTER*(MAX_LEN_FNAM) relaxUFile
45	CHARACTER*(MAX_LEN_FNAM) relaxVFile
46	CHARACTER*(MAX_LEN_FNAM) relaxTFile
47	CHARACTER*(MAX_LEN_FNAM) relaxSFile
48
49	COMMON /RBCS_PARM01_R/
50	& tauRelaxU,
51	& tauRelaxV,
52	& tauRelaxT,
53	& tauRelaxS,
54	& rbcsForcingPeriod,
55	& rbcsForcingCycle,
56	& rbcsForcingOffset,
57	& rbcsVanishingTime,
58	& deltaTrbcs
59	COMMON /RBCS_PARM01_I/
60	& rbcsIter0
61	COMMON /RBCS_PARM01_L/
62	& rbcsSingleTimeFiles,
63	& useRBCuVel,
64	& useRBCvVel,
65	& useRBCtemp,
66	& useRBCsalt
67	COMMON /RBCS_PARM01_C/
68	& relaxMaskUFile,
69	& relaxMaskVFile,
70	& relaxMaskTrFile,
71	& relaxUFile,
72	& relaxVFile,
73	& relaxTFile,
74	& relaxSFile
75
76	#ifdef ALLOW_PTRACERS
77	LOGICAL useRBCpTrNum(PTRACERS_num)
78	_RL tauRelaxPTR(PTRACERS_num)
79	CHARACTER*(MAX_LEN_FNAM) relaxPtracerFile(PTRACERS_num)
80
81	COMMON /RBCS_PARM02_L/
82	& useRBCpTrNum
83	COMMON /RBCS_PARM02_R/
84	& tauRelaxPTR
85	COMMON /RBCS_PARM02_C/
86	& relaxPtracerFile
87	#endif /* ALLOW_PTRACERS */
88
89	#endif /* ALLOW_RBCS */