1 |
C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_PARAMS.h,v 1.6 2014/11/25 01:07:23 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#ifdef ALLOW_OBCS |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: OBCS_PARAMS.h |
8 |
C !INTERFACE: |
9 |
C #include "OBCS_PARAMS.h" |
10 |
|
11 |
C !DESCRIPTION: |
12 |
C *==========================================================* |
13 |
C | OBCS_PARAMS.h |
14 |
C | o Header file containing OBCS parameters |
15 |
C *==========================================================* |
16 |
C | o Note: does not (and should not) contain any conditional |
17 |
C | statement that depends on OBCS options ; therefore |
18 |
C | can be safely included without OBCS_OPTIONS.h |
19 |
C *==========================================================* |
20 |
CEOP |
21 |
|
22 |
C tidalComponents :: number of tidal components to be applied |
23 |
C OBCS_maxConnect :: maximum number of connected parts |
24 |
INTEGER tidalComponents |
25 |
INTEGER OBCS_maxConnect |
26 |
PARAMETER ( tidalComponents = 10 ) |
27 |
PARAMETER ( OBCS_maxConnect = sNx+sNy ) |
28 |
|
29 |
C-- COMMON /OBC_PARM_I/ OBCS integer-type parameter |
30 |
C OBCS_u1_adv_T :: >0: use 1rst O. upwind adv-scheme @ OB (=1: only if outflow) |
31 |
C OBCS_u1_adv_S :: >0: use 1rst O. upwind adv-scheme @ OB (=1: only if outflow) |
32 |
C OBCS_monSelect :: select group of variables to monitor |
33 |
C spongeThickness :: number grid points that make up the sponge layer (def=0) |
34 |
COMMON /OBC_PARM_I/ |
35 |
& OBCS_u1_adv_T, OBCS_u1_adv_S, |
36 |
& OBCS_monSelect, |
37 |
& spongeThickness |
38 |
INTEGER OBCS_u1_adv_T, OBCS_u1_adv_S |
39 |
INTEGER OBCS_monSelect |
40 |
INTEGER spongeThickness |
41 |
|
42 |
C-- COMMON /OBC_PARM_L/ OBCS logical-type parameter |
43 |
C useOrlanskiNorth/South/East/West |
44 |
C :: specify Orlanski boundary conditions for northern/ |
45 |
C southern/eastern/Western |
46 |
C useStevensNorth/South/East/West |
47 |
C :: use open boundary computations following Stevens (1990) |
48 |
C useStevensPhaseVel |
49 |
C :: use phase velocity contribution for open boundary |
50 |
C computations following Stevens (1990), default = true |
51 |
C useStevensAdvection |
52 |
C :: use advective contribution for open boundary |
53 |
C computations following Stevens (1990), default = true |
54 |
C |
55 |
C useOBCSsponge :: turns on sponge layer along boundaries (def=false) |
56 |
C OBCSsponge_N :: turns on sponge layer along North boundary (def=true) |
57 |
C OBCSsponge_S :: turns on sponge layer along South boundary (def=true) |
58 |
C OBCSsponge_E :: turns on sponge layer along East boundary (def=true) |
59 |
C OBCSsponge_W :: turns on sponge layer along West boundary (def=true) |
60 |
C OBCSsponge_UatNS :: turns on uVel sponge at North/South boundaries (def=true) |
61 |
C OBCSsponge_UatEW :: turns on uVel sponge at East/West boundaries (def=true) |
62 |
C OBCSsponge_VatNS :: turns on vVel sponge at North/South boundaries (def=true) |
63 |
C OBCSsponge_VatEW :: turns on vVel sponge at East/West boundaries (def=true) |
64 |
C OBCSsponge_Theta :: turns on Theta sponge along boundaries (def=true) |
65 |
C OBCSsponge_Salt :: turns on Salt sponge along boundaries (def=true) |
66 |
C useLinearSponge :: use linear instead of exponential sponge (def=false) |
67 |
C |
68 |
C useOBCSbalance :: balance the volume flux through boundary |
69 |
C at every time step |
70 |
C useOBCStides :: modify OB normal flow to add tidal forcing |
71 |
C NOTE that at the moment tidal forcing is applied |
72 |
C only to "normal" flow. |
73 |
C useOBCSprescribe :: read boundary conditions from a file |
74 |
C (overrides Orlanski and other boundary values) |
75 |
C OBCSprintDiags :: print boundary values to STDOUT (def=true) |
76 |
C OBCSfixTopo :: check and adjust topography for problematic gradients |
77 |
C across boundaries (def=true) |
78 |
|
79 |
COMMON /OBC_PARM_L/ |
80 |
& useOrlanskiNorth,useOrlanskiSouth, |
81 |
& useOrlanskiEast,useOrlanskiWest, |
82 |
& useStevensNorth,useStevensSouth, |
83 |
& useStevensEast,useStevensWest, |
84 |
& useStevensPhaseVel, useStevensAdvection, |
85 |
& useOBCSsponge, |
86 |
& OBCSsponge_N, OBCSsponge_S, |
87 |
& OBCSsponge_E, OBCSsponge_W, |
88 |
& OBCSsponge_UatNS, OBCSsponge_UatEW, |
89 |
& OBCSsponge_VatNS, OBCSsponge_VatEW, |
90 |
& OBCSsponge_Theta, OBCSsponge_Salt, useLinearSponge, |
91 |
& useOBCSbalance, useOBCStides, useOBCSprescribe, |
92 |
& OBCSprintDiags, |
93 |
& OBCSfixTopo |
94 |
LOGICAL useOrlanskiNorth |
95 |
LOGICAL useOrlanskiSouth |
96 |
LOGICAL useOrlanskiEast |
97 |
LOGICAL useOrlanskiWest |
98 |
LOGICAL useStevensNorth |
99 |
LOGICAL useStevensSouth |
100 |
LOGICAL useStevensEast |
101 |
LOGICAL useStevensWest |
102 |
LOGICAL useStevensPhaseVel |
103 |
LOGICAL useStevensAdvection |
104 |
LOGICAL useOBCSsponge |
105 |
LOGICAL OBCSsponge_N |
106 |
LOGICAL OBCSsponge_S |
107 |
LOGICAL OBCSsponge_E |
108 |
LOGICAL OBCSsponge_W |
109 |
LOGICAL OBCSsponge_UatNS |
110 |
LOGICAL OBCSsponge_UatEW |
111 |
LOGICAL OBCSsponge_VatNS |
112 |
LOGICAL OBCSsponge_VatEW |
113 |
LOGICAL OBCSsponge_Theta |
114 |
LOGICAL OBCSsponge_Salt |
115 |
LOGICAL useLinearSponge |
116 |
LOGICAL useOBCSbalance |
117 |
LOGICAL useOBCStides |
118 |
LOGICAL useOBCSprescribe |
119 |
LOGICAL OBCSprintDiags |
120 |
LOGICAL OBCSfixTopo |
121 |
|
122 |
C-- COMMON /OBC_PARM_R/ OBCS real-type parameter |
123 |
C OBCS_balanceFacN/S/E/W :: weighting factor for balancing OB normal flow |
124 |
C OBCS_uvApplyFac :: multiplying factor to U,V normal comp. when applying |
125 |
C OBC to 2nd column/row (for backward compatibility). |
126 |
C OBCS_monitorFreq :: monitor output frequency (s) for OB statistics |
127 |
C U/Vrelaxobcsinner/bound :: relaxation time scale (in seconds) on the boundary |
128 |
C (bound) and at the innermost grid point of the sponge |
129 |
C layer (inner); relaxation time scales in-between |
130 |
C are linearly interpolated from these values |
131 |
C T/SrelaxStevens :: relaxation time scale (in seconds) for T/S-points |
132 |
C for Stevens boundary conditions |
133 |
C tidalPeriod :: tidal period (s) |
134 |
COMMON /OBC_PARM_R/ |
135 |
& OBCS_balanceFacN, OBCS_balanceFacS, |
136 |
& OBCS_balanceFacE, OBCS_balanceFacW, |
137 |
& OBCS_uvApplyFac, |
138 |
& OBCS_monitorFreq, |
139 |
& tidalPeriod, |
140 |
& Urelaxobcsinner,Urelaxobcsbound, |
141 |
& Vrelaxobcsinner,Vrelaxobcsbound, |
142 |
& TrelaxStevens, SrelaxStevens |
143 |
_RL OBCS_balanceFacN, OBCS_balanceFacS |
144 |
_RL OBCS_balanceFacE, OBCS_balanceFacW |
145 |
_RL OBCS_uvApplyFac |
146 |
_RL OBCS_monitorFreq |
147 |
_RL tidalPeriod(tidalComponents) |
148 |
_RS Urelaxobcsinner |
149 |
_RS Urelaxobcsbound |
150 |
_RS Vrelaxobcsinner |
151 |
_RS Vrelaxobcsbound |
152 |
_RS TrelaxStevens |
153 |
_RS SrelaxStevens |
154 |
|
155 |
C-- COMMON /OBC_FILES/ OBCS character-type parameter |
156 |
C OB[N,S,E,W][u,v,w,t,s,eta,am,ph]File :: Files with boundary conditions, |
157 |
C the letter combinations mean: |
158 |
C N/S/E/W :: northern/southern/eastern/western boundary |
159 |
C u/v/w/t/s :: ocean u/v/w velocities, temperature/salinity |
160 |
C eta :: sea surface height |
161 |
C am/ph :: tidal amplitude (m/s) / phase (s) |
162 |
C OB[N,S,E,W]connectFile :: Files with connected piece Id for N/S/E/W OB grid pt |
163 |
C insideOBmaskFile :: File to specify Inside OB region mask (zero beyond OB) |
164 |
COMMON /OBC_FILES/ |
165 |
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
166 |
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
167 |
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
168 |
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
169 |
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
170 |
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
171 |
& OBNamFile, OBSamFile, OBEamFile, OBWamFile, |
172 |
& OBNphFile, OBSphFile, OBEphFile, OBWphFile, |
173 |
& OBNconnectFile, OBSconnectFile, |
174 |
& OBEconnectFile, OBWconnectFile, |
175 |
& insideOBmaskFile |
176 |
CHARACTER*(MAX_LEN_FNAM) |
177 |
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
178 |
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
179 |
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
180 |
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
181 |
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
182 |
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
183 |
& OBNamFile, OBSamFile, OBEamFile, OBWamFile, |
184 |
& OBNphFile, OBSphFile, OBEphFile, OBWphFile, |
185 |
& OBNconnectFile, OBSconnectFile, |
186 |
& OBEconnectFile, OBWconnectFile, |
187 |
& insideOBmaskFile |
188 |
|
189 |
#endif /* ALLOW_OBCS */ |