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