| 1 |
jmc |
1.6 |
C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_PARAMS.h,v 1.5 2014/09/27 00:13:40 dimitri Exp $ |
| 2 |
jmc |
1.1 |
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 |
dimitri |
1.4 |
C tidalComponents :: number of tidal components to be applied |
| 23 |
jmc |
1.6 |
C OBCS_maxConnect :: maximum number of connected parts |
| 24 |
dimitri |
1.4 |
INTEGER tidalComponents |
| 25 |
jmc |
1.6 |
INTEGER OBCS_maxConnect |
| 26 |
dimitri |
1.4 |
PARAMETER ( tidalComponents = 10 ) |
| 27 |
jmc |
1.6 |
PARAMETER ( OBCS_maxConnect = sNx+sNy ) |
| 28 |
dimitri |
1.4 |
|
| 29 |
jmc |
1.3 |
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 |
jmc |
1.1 |
|
| 42 |
jmc |
1.3 |
C-- COMMON /OBC_PARM_L/ OBCS logical-type parameter |
| 43 |
jmc |
1.1 |
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 |
dimitri |
1.5 |
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 |
jmc |
1.1 |
C useOBCSbalance :: balance the volume flux through boundary |
| 69 |
|
|
C at every time step |
| 70 |
dimitri |
1.4 |
C useOBCStides :: modify OB normal flow to add tidal forcing |
| 71 |
jmc |
1.1 |
C useOBCSprescribe :: read boundary conditions from a file |
| 72 |
|
|
C (overrides Orlanski and other boundary values) |
| 73 |
|
|
C OBCSprintDiags :: print boundary values to STDOUT (def=true) |
| 74 |
|
|
C OBCSfixTopo :: check and adjust topography for problematic gradients |
| 75 |
|
|
C across boundaries (def=true) |
| 76 |
|
|
|
| 77 |
|
|
COMMON /OBC_PARM_L/ |
| 78 |
|
|
& useOrlanskiNorth,useOrlanskiSouth, |
| 79 |
|
|
& useOrlanskiEast,useOrlanskiWest, |
| 80 |
|
|
& useStevensNorth,useStevensSouth, |
| 81 |
|
|
& useStevensEast,useStevensWest, |
| 82 |
|
|
& useStevensPhaseVel, useStevensAdvection, |
| 83 |
dimitri |
1.5 |
& useOBCSsponge, |
| 84 |
|
|
& OBCSsponge_N, OBCSsponge_S, |
| 85 |
|
|
& OBCSsponge_E, OBCSsponge_W, |
| 86 |
|
|
& OBCSsponge_UatNS, OBCSsponge_UatEW, |
| 87 |
|
|
& OBCSsponge_VatNS, OBCSsponge_VatEW, |
| 88 |
|
|
& OBCSsponge_Theta, OBCSsponge_Salt, useLinearSponge, |
| 89 |
|
|
& useOBCSbalance, useOBCStides, useOBCSprescribe, |
| 90 |
jmc |
1.2 |
& OBCSprintDiags, |
| 91 |
jmc |
1.1 |
& OBCSfixTopo |
| 92 |
|
|
LOGICAL useOrlanskiNorth |
| 93 |
|
|
LOGICAL useOrlanskiSouth |
| 94 |
|
|
LOGICAL useOrlanskiEast |
| 95 |
|
|
LOGICAL useOrlanskiWest |
| 96 |
|
|
LOGICAL useStevensNorth |
| 97 |
|
|
LOGICAL useStevensSouth |
| 98 |
|
|
LOGICAL useStevensEast |
| 99 |
|
|
LOGICAL useStevensWest |
| 100 |
|
|
LOGICAL useStevensPhaseVel |
| 101 |
|
|
LOGICAL useStevensAdvection |
| 102 |
|
|
LOGICAL useOBCSsponge |
| 103 |
dimitri |
1.5 |
LOGICAL OBCSsponge_N |
| 104 |
|
|
LOGICAL OBCSsponge_S |
| 105 |
|
|
LOGICAL OBCSsponge_E |
| 106 |
|
|
LOGICAL OBCSsponge_W |
| 107 |
|
|
LOGICAL OBCSsponge_UatNS |
| 108 |
|
|
LOGICAL OBCSsponge_UatEW |
| 109 |
|
|
LOGICAL OBCSsponge_VatNS |
| 110 |
|
|
LOGICAL OBCSsponge_VatEW |
| 111 |
|
|
LOGICAL OBCSsponge_Theta |
| 112 |
|
|
LOGICAL OBCSsponge_Salt |
| 113 |
|
|
LOGICAL useLinearSponge |
| 114 |
jmc |
1.1 |
LOGICAL useOBCSbalance |
| 115 |
dimitri |
1.4 |
LOGICAL useOBCStides |
| 116 |
jmc |
1.1 |
LOGICAL useOBCSprescribe |
| 117 |
|
|
LOGICAL OBCSprintDiags |
| 118 |
|
|
LOGICAL OBCSfixTopo |
| 119 |
|
|
|
| 120 |
jmc |
1.3 |
C-- COMMON /OBC_PARM_R/ OBCS real-type parameter |
| 121 |
|
|
C OBCS_balanceFacN/S/E/W :: weighting factor for balancing OB normal flow |
| 122 |
|
|
C OBCS_uvApplyFac :: multiplying factor to U,V normal comp. when applying |
| 123 |
|
|
C OBC to 2nd column/row (for backward compatibility). |
| 124 |
|
|
C OBCS_monitorFreq :: monitor output frequency (s) for OB statistics |
| 125 |
|
|
C U/Vrelaxobcsinner/bound :: relaxation time scale (in seconds) on the boundary |
| 126 |
|
|
C (bound) and at the innermost grid point of the sponge |
| 127 |
|
|
C layer (inner); relaxation time scales in-between |
| 128 |
|
|
C are linearly interpolated from these values |
| 129 |
|
|
C T/SrelaxStevens :: relaxation time scale (in seconds) for T/S-points |
| 130 |
|
|
C for Stevens boundary conditions |
| 131 |
dimitri |
1.4 |
C tidalPeriod :: tidal period (s) |
| 132 |
jmc |
1.1 |
COMMON /OBC_PARM_R/ |
| 133 |
|
|
& OBCS_balanceFacN, OBCS_balanceFacS, |
| 134 |
|
|
& OBCS_balanceFacE, OBCS_balanceFacW, |
| 135 |
|
|
& OBCS_uvApplyFac, |
| 136 |
|
|
& OBCS_monitorFreq, |
| 137 |
dimitri |
1.4 |
& tidalPeriod, |
| 138 |
jmc |
1.1 |
& Urelaxobcsinner,Urelaxobcsbound, |
| 139 |
|
|
& Vrelaxobcsinner,Vrelaxobcsbound, |
| 140 |
|
|
& TrelaxStevens, SrelaxStevens |
| 141 |
|
|
_RL OBCS_balanceFacN, OBCS_balanceFacS |
| 142 |
|
|
_RL OBCS_balanceFacE, OBCS_balanceFacW |
| 143 |
|
|
_RL OBCS_uvApplyFac |
| 144 |
|
|
_RL OBCS_monitorFreq |
| 145 |
dimitri |
1.4 |
_RL tidalPeriod(tidalComponents) |
| 146 |
jmc |
1.1 |
_RS Urelaxobcsinner |
| 147 |
|
|
_RS Urelaxobcsbound |
| 148 |
|
|
_RS Vrelaxobcsinner |
| 149 |
|
|
_RS Vrelaxobcsbound |
| 150 |
|
|
_RS TrelaxStevens |
| 151 |
|
|
_RS SrelaxStevens |
| 152 |
|
|
|
| 153 |
jmc |
1.3 |
C-- COMMON /OBC_FILES/ OBCS character-type parameter |
| 154 |
dimitri |
1.4 |
C OB[N,S,E,W][u,v,w,t,s,eta,am,ph]File :: Files with boundary conditions, |
| 155 |
|
|
C the letter combinations mean: |
| 156 |
jmc |
1.3 |
C N/S/E/W :: northern/southern/eastern/western boundary |
| 157 |
dimitri |
1.4 |
C u/v/w/t/s :: ocean u/v/w velocities, temperature/salinity |
| 158 |
|
|
C eta :: sea surface height |
| 159 |
|
|
C am/ph :: tidal amplitude (m/s) / phase (s) |
| 160 |
jmc |
1.6 |
C OB[N,S,E,W]connectFile :: Files with connected piece Id for N/S/E/W OB grid pt |
| 161 |
|
|
C insideOBmaskFile :: File to specify Inside OB region mask (zero beyond OB) |
| 162 |
jmc |
1.1 |
COMMON /OBC_FILES/ |
| 163 |
|
|
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
| 164 |
|
|
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
| 165 |
|
|
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
| 166 |
|
|
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
| 167 |
|
|
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
| 168 |
|
|
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
| 169 |
dimitri |
1.4 |
& OBNamFile, OBSamFile, OBEamFile, OBWamFile, |
| 170 |
|
|
& OBNphFile, OBSphFile, OBEphFile, OBWphFile, |
| 171 |
jmc |
1.6 |
& OBNconnectFile, OBSconnectFile, |
| 172 |
|
|
& OBEconnectFile, OBWconnectFile, |
| 173 |
jmc |
1.1 |
& insideOBmaskFile |
| 174 |
|
|
CHARACTER*(MAX_LEN_FNAM) |
| 175 |
|
|
& OBNuFile, OBSuFile, OBEuFile, OBWuFile, |
| 176 |
|
|
& OBNvFile, OBSvFile, OBEvFile, OBWvFile, |
| 177 |
|
|
& OBNwFile, OBSwFile, OBEwFile, OBWwFile, |
| 178 |
|
|
& OBNtFile, OBStFile, OBEtFile, OBWtFile, |
| 179 |
|
|
& OBNsFile, OBSsFile, OBEsFile, OBWsFile, |
| 180 |
|
|
& OBNetaFile,OBSetaFile,OBEetaFile,OBWetaFile, |
| 181 |
dimitri |
1.4 |
& OBNamFile, OBSamFile, OBEamFile, OBWamFile, |
| 182 |
|
|
& OBNphFile, OBSphFile, OBEphFile, OBWphFile, |
| 183 |
jmc |
1.6 |
& OBNconnectFile, OBSconnectFile, |
| 184 |
|
|
& OBEconnectFile, OBWconnectFile, |
| 185 |
jmc |
1.1 |
& insideOBmaskFile |
| 186 |
|
|
|
| 187 |
|
|
#endif /* ALLOW_OBCS */ |
Parent Directory
| 
Revision Log
| 
Revision Graph