1 |
C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_PARAMS.h,v 1.1 2011/05/24 14:22:40 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 |
|
23 |
C useOrlanskiNorth/South/East/West |
24 |
C :: specify Orlanski boundary conditions for northern/ |
25 |
C southern/eastern/Western |
26 |
C useStevensNorth/South/East/West |
27 |
C :: use open boundary computations following Stevens (1990) |
28 |
C T/SrelaxStevens :: relaxation time scale (in seconds) for T/S-points |
29 |
C for Stevens boundary conditions |
30 |
C useStevensPhaseVel |
31 |
C :: use phase velocity contribution for open boundary |
32 |
C computations following Stevens (1990), default = true |
33 |
C useStevensAdvection |
34 |
C :: use advective contribution for open boundary |
35 |
C computations following Stevens (1990), default = true |
36 |
C useOBCSsponge :: turns on sponge layer along boundary (def=false) |
37 |
C spongeThickness :: number grid points that make up the sponge layer (def=0) |
38 |
C U/Vrelaxobcsinner/bound :: relaxation time scale (in seconds) for U/V-points |
39 |
C on the boundary (bound) and at the innermost grid point |
40 |
C of the sponge layer (inner); relaxation time scales |
41 |
C in-between are linearly interpolated from these values |
42 |
C useOBCSbalance :: balance the volume flux through boundary |
43 |
C at every time step |
44 |
C useOBCSprescribe :: read boundary conditions from a file |
45 |
C (overrides Orlanski and other boundary values) |
46 |
C OBCSprintDiags :: print boundary values to STDOUT (def=true) |
47 |
C OBCSfixTopo :: check and adjust topography for problematic gradients |
48 |
C across boundaries (def=true) |
49 |
C tileHasOB[N,S,E,W] :: this tile has OB at Northern/Southern/Eastern/Western edge |
50 |
C insideOBmaskFile :: File to specify Inside OB region mask (zero beyond OB). |
51 |
C OB[N,S,E,W][u,v,t,s,a,h,sn,sl,uice,vice]File :: Files with boundary conditions, |
52 |
C the letter combinations mean: |
53 |
C N/S/E/W :: northern/southern/eastern/western boundary |
54 |
C u/v/t/s :: ocean u/v velocities, temperature/salinity |
55 |
C a/h :: sea ice concentration/effective thickness |
56 |
C sn/sl :: effective snow thickness/sea ice salinity |
57 |
C uice/vice :: sea ice u/v drift velocities |
58 |
|
59 |
COMMON /OBC_PARM_I/ |
60 |
& OBCS_monSelect, |
61 |
& spongeThickness |
62 |
INTEGER OBCS_monSelect |
63 |
INTEGER spongeThickness |
64 |
|
65 |
COMMON /OBC_PARM_L/ |
66 |
& useOrlanskiNorth,useOrlanskiSouth, |
67 |
& useOrlanskiEast,useOrlanskiWest, |
68 |
& useStevensNorth,useStevensSouth, |
69 |
& useStevensEast,useStevensWest, |
70 |
& useStevensPhaseVel, useStevensAdvection, |
71 |
& useOBCSsponge, useOBCSbalance, useOBCSprescribe, |
72 |
& OBCSprintDiags, |
73 |
& OBCSfixTopo |
74 |
LOGICAL useOrlanskiNorth |
75 |
LOGICAL useOrlanskiSouth |
76 |
LOGICAL useOrlanskiEast |
77 |
LOGICAL useOrlanskiWest |
78 |
LOGICAL useStevensNorth |
79 |
LOGICAL useStevensSouth |
80 |
LOGICAL useStevensEast |
81 |
LOGICAL useStevensWest |
82 |
LOGICAL useStevensPhaseVel |
83 |
LOGICAL useStevensAdvection |
84 |
LOGICAL useOBCSsponge |
85 |
LOGICAL useOBCSbalance |
86 |
LOGICAL useOBCSprescribe |
87 |
LOGICAL OBCSprintDiags |
88 |
LOGICAL OBCSfixTopo |
89 |
|
90 |
C OBCS_balanceFacN/S/E/W :: weighting factor for balancing OB normal flow |
91 |
C OBCS_uvApplyFac :: multiplying factor to U,V normal comp. when applying |
92 |
C OBC to 2nd column/row (for backward compatibility). |
93 |
C OBCS_monitorFreq :: monitor output frequency (s) for OB statistics |
94 |
C OBCS_monSelect :: select group of variables to monitor |
95 |
COMMON /OBC_PARM_R/ |
96 |
& OBCS_balanceFacN, OBCS_balanceFacS, |
97 |
& OBCS_balanceFacE, OBCS_balanceFacW, |
98 |
& OBCS_uvApplyFac, |
99 |
& OBCS_monitorFreq, |
100 |
& Urelaxobcsinner,Urelaxobcsbound, |
101 |
& Vrelaxobcsinner,Vrelaxobcsbound, |
102 |
& TrelaxStevens, SrelaxStevens |
103 |
_RL OBCS_balanceFacN, OBCS_balanceFacS |
104 |
_RL OBCS_balanceFacE, OBCS_balanceFacW |
105 |
_RL OBCS_uvApplyFac |
106 |
_RL OBCS_monitorFreq |
107 |
_RS Urelaxobcsinner |
108 |
_RS Urelaxobcsbound |
109 |
_RS Vrelaxobcsinner |
110 |
_RS Vrelaxobcsbound |
111 |
_RS TrelaxStevens |
112 |
_RS SrelaxStevens |
113 |
|
114 |
COMMON /OBC_FILES/ |
115 |
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
116 |
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
117 |
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
118 |
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
119 |
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
120 |
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
121 |
& insideOBmaskFile |
122 |
CHARACTER*(MAX_LEN_FNAM) |
123 |
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
124 |
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
125 |
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
126 |
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
127 |
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
128 |
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
129 |
& insideOBmaskFile |
130 |
|
131 |
#endif /* ALLOW_OBCS */ |