sciascia/rbcs/RBCS_PARAMS.h

C $Header: /u/gcmpack/MITgcm/pkg/rbcs/RBCS_PARAMS.h,v 1.2 2012/06/26 22:19:17 gforget 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 */
1	heimbach	1.1	C $Header: /u/gcmpack/MITgcm/pkg/rbcs/RBCS_PARAMS.h,v 1.2 2012/06/26 22:19:17 gforget 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(UmLEN)
27			_RL tauRelaxV(VmLEN)
28			_RL tauRelaxT
29			_RL tauRelaxS
30			_RL rbcsForcingPeriod
31			_RL rbcsForcingCycle
32			_RL rbcsForcingOffset
33			_RL rbcsForcingUPeriod(UmLEN)
34			_RL rbcsForcingUCycle(UmLEN)
35			_RL rbcsForcingUOffset(UmLEN)
36			_RL rbcsForcingVPeriod(VmLEN)
37			_RL rbcsForcingVCycle(VmLEN)
38			_RL rbcsForcingVOffset(VmLEN)
39			#ifdef ALLOW_NONHYDROSTATIC
40			_RL tauRelaxW(WmLEN)
41			_RL rbcsForcingWPeriod(WmLEN)
42			_RL rbcsForcingWCycle(WmLEN)
43			_RL rbcsForcingWOffset(WmLEN)
44			LOGICAL useRBCwVel(WmLEN)
45			CHARACTER*(MAX_LEN_FNAM) relaxMaskWFile(WmLEN)
46			CHARACTER*(MAX_LEN_FNAM) relaxWFile(WmLEN)
47			#endif
48			_RL deltaTrbcs
49			_RL rbcsVanishingTime
50			INTEGER rbcsIniter
51			INTEGER rbcsIter0
52			LOGICAL rbcsSingleTimeFiles
53			LOGICAL useRBCuVel(UmLEN)
54			LOGICAL useRBCvVel(VmLEN)
55			LOGICAL useRBCtemp
56			LOGICAL useRBCsalt
57			CHARACTER*(MAX_LEN_FNAM) relaxMaskUFile(UmLEN)
58			CHARACTER*(MAX_LEN_FNAM) relaxMaskVFile(VmLEN)
59			CHARACTER*(MAX_LEN_FNAM) relaxMaskFile(maskLEN)
60			CHARACTER*(MAX_LEN_FNAM) relaxUFile(UmLEN)
61			CHARACTER*(MAX_LEN_FNAM) relaxVFile(VmLEN)
62			CHARACTER*(MAX_LEN_FNAM) relaxTFile
63			CHARACTER*(MAX_LEN_FNAM) relaxSFile
64
65			#ifdef ALLOW_NONHYDROSTATIC
66			COMMON /RBCS_PARM01_R/
67			& tauRelaxW,
68			& rbcsForcingWPeriod,
69			& rbcsForcingWCycle,
70			& rbcsForcingWOffset
71			COMMON /RBCS_PARM01_L/
72			& useRBCwVel
73			COMMON /RBCS_PARM01_C/
74			& relaxMaskWFile,
75			& relaxWFile
76			#endif
77			COMMON /RBCS_PARM01_R/
78			& tauRelaxU,
79			& tauRelaxV,
80			& tauRelaxT,
81			& tauRelaxS,
82			& rbcsForcingPeriod,
83			& rbcsForcingCycle,
84			& rbcsForcingOffset,
85			& rbcsForcingUPeriod,
86			& rbcsForcingUCycle,
87			& rbcsForcingUOffset,
88			& rbcsForcingVPeriod,
89			& rbcsForcingVCycle,
90			& rbcsForcingVOffset,
91			& rbcsVanishingTime,
92			& deltaTrbcs
93			COMMON /RBCS_PARM01_I/
94			& rbcsIniter,
95			& rbcsIter0
96			COMMON /RBCS_PARM01_L/
97			& rbcsSingleTimeFiles,
98			& useRBCuVel,
99			& useRBCvVel,
100			& useRBCtemp,
101			& useRBCsalt
102			COMMON /RBCS_PARM01_C/
103			& relaxMaskUFile,
104			& relaxMaskVFile,
105			& relaxMaskFile,
106			& relaxUFile,
107			& relaxVFile,
108			& relaxTFile,
109			& relaxSFile
110
111			#ifdef ALLOW_PTRACERS
112			LOGICAL useRBCptrnum(PTRACERS_num)
113			_RL tauRelaxPTR(PTRACERS_num)
114			CHARACTER*(MAX_LEN_FNAM) relaxPtracerFile(PTRACERS_num)
115
116			COMMON /RBCS_PARM02_L/
117			& useRBCptrnum
118			COMMON /RBCS_PARM02_R/
119			& tauRelaxPTR
120			COMMON /RBCS_PARM02_C/
121			& relaxPtracerFile
122			#endif /* ALLOW_PTRACERS */
123
124			#endif /* ALLOW_RBCS */