| 1 | C $Header: /u/u0/gcmpack/MITgcm/model/inc/FFIELDS.h,v 1.16 2003/02/18 05:33:53 dimitri Exp $ | 
| 2 | C $Name:  $ | 
| 3 | CBOP | 
| 4 | C     !ROUTINE: FFIELDS.h | 
| 5 | C     !INTERFACE: | 
| 6 | C     include "FFIELDS.h" | 
| 7 | C     !DESCRIPTION: | 
| 8 | C     \bv | 
| 9 | C     *==========================================================* | 
| 10 | C     | FFIELDS.h | 
| 11 | C     | o Model forcing fields | 
| 12 | C     *==========================================================* | 
| 13 | C     | More flexible surface forcing configurations are | 
| 14 | C     | available via pkg/exf and pkg/seaice | 
| 15 | C     *==========================================================* | 
| 16 | C     \ev | 
| 17 | CEOP | 
| 18 | C | 
| 19 | C     fu    :: Zonal surface wind stress in N/m^2 | 
| 20 | C              > 0 for increase in uVel, which is west to | 
| 21 | C                  east for cartesian and spherical polar grids | 
| 22 | C              Typical range: -0.5 < fu < 0.5 | 
| 23 | C              Southwest C-grid U point | 
| 24 | C | 
| 25 | C     fv    :: Meridional surface wind stress in N/m^2 | 
| 26 | C              > 0 for increase in vVel, which is south to | 
| 27 | C                  north for cartesian and spherical polar grids | 
| 28 | C              Typical range: -0.5 < fv < 0.5 | 
| 29 | C              Southwest C-grid V point | 
| 30 | C | 
| 31 | C     EmPmR :: Net upward freshwater flux in m/s | 
| 32 | C              EmPmR = Evaporation - precipitation - runoff | 
| 33 | C              > 0 for increase in salt (ocean salinity) | 
| 34 | C              Typical range: -1e-7 < EmPmR < 1e-7 | 
| 35 | C              Southwest C-grid tracer point | 
| 36 | C | 
| 37 | C     Qnet  :: Net upward surface heat flux excluding shortwave in W/m^2 | 
| 38 | C              Qnet = latent + sensible + net longwave | 
| 39 | C              > 0 for decrease in theta (ocean cooling) | 
| 40 | C              Typical range: -250 < Qnet < 600 | 
| 41 | C              Southwest C-grid tracer point | 
| 42 | C | 
| 43 | C              NOTE: #ifndef SHORTWAVE_HEATING, | 
| 44 | C              Qnet = latent + sensible + net longwave + net shortwave | 
| 45 | C | 
| 46 | C     Qsw   :: Net upward shortwave radiation in W/m^2 | 
| 47 | C              Qsw = - ( downward - ice and snow absorption - reflected ) | 
| 48 | C              > 0 for decrease in theta (ocean cooling) | 
| 49 | C              Typical range: -350 < Qsw < 0 | 
| 50 | C              Southwest C-grid tracer point | 
| 51 | C | 
| 52 | C     dQdT  :: Thermal relaxation coefficient in W/m^2/degrees | 
| 53 | C              Southwest C-grid tracer point | 
| 54 | C | 
| 55 | C     SST   :: Sea surface temperature in degrees C for relaxation | 
| 56 | C              Southwest C-grid tracer point | 
| 57 | C | 
| 58 | C     SSS   :: Sea surface salinity in psu for relaxation | 
| 59 | C              Southwest C-grid tracer point | 
| 60 | C | 
| 61 | C     pload :: for the ocean:      atmospheric pressure at z=eta | 
| 62 | C                Units are           Pa=N/m^2 | 
| 63 | C              for the atmosphere: geopotential of the orography | 
| 64 | C                Units are           meters (converted) | 
| 65 | C | 
| 66 | C    thetaRef :: Three dimensional reference theta for boundary relaxation | 
| 67 | C    saltRef  :: Three dimensional reference salinity for boundary relaxation | 
| 68 |  | 
| 69 | COMMON /FFIELDS/ | 
| 70 | &                 fu | 
| 71 | &               , fv | 
| 72 | &               , Qnet | 
| 73 | &               , Qsw | 
| 74 | &               , dQdT | 
| 75 | &               , EmPmR | 
| 76 | &               , SST | 
| 77 | &               , SSS | 
| 78 | #ifdef ATMOSPHERIC_LOADING | 
| 79 | &               , pload | 
| 80 | #endif | 
| 81 | &               , thetaRef | 
| 82 | &               , saltRef | 
| 83 |  | 
| 84 | _RS fu       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 85 | _RS fv       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 86 | _RS Qnet     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 87 | #ifdef SHORTWAVE_HEATING | 
| 88 | _RS Qsw      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 89 | #else | 
| 90 | _RS Qsw      (1,1,1,1) | 
| 91 | #endif | 
| 92 | _RS dQdT     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 93 | _RS EmPmR    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 94 | _RS SST      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 95 | _RS SSS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 96 | #ifdef ATMOSPHERIC_LOADING | 
| 97 | _RS pload    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 98 | #endif | 
| 99 | _RS thetaRef (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) | 
| 100 | _RS saltRef  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) | 
| 101 |  | 
| 102 | #ifndef INCLUDE_EXTERNAL_FORCING_PACKAGE | 
| 103 | C     taux[01]  :: Temp. for zonal wind stress | 
| 104 | C     tauy[01]  :: Temp. for merid. wind stress | 
| 105 | C     qnet[01]  :: Temp. for heat flux | 
| 106 | C     empmr[01] :: Temp. for fresh water flux | 
| 107 | C     sst[01]   :: Temp. for theta climatalogy | 
| 108 | C     sss[01]   :: Temp. for theta climatalogy | 
| 109 | C     qsw[01]   :: Temp. for short wave component of heat flux | 
| 110 | C     [01]      :: End points for interpolation | 
| 111 | C     Above use static heap storage to allow exchange. | 
| 112 |  | 
| 113 | COMMON /TDFIELDS/ | 
| 114 | &                 taux0, tauy0, Qnet0, EmPmR0, SST0, SSS0, | 
| 115 | &                 taux1, tauy1, Qnet1, EmPmR1, SST1, SSS1 | 
| 116 | #ifdef SHORTWAVE_HEATING | 
| 117 | &               , Qsw0, Qsw1 | 
| 118 | #endif | 
| 119 | #ifdef ATMOSPHERIC_LOADING | 
| 120 | &               , pload0, pload1 | 
| 121 | #endif | 
| 122 |  | 
| 123 | _RS  taux0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 124 | _RS  tauy0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 125 | _RS  Qnet0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 126 | _RS  EmPmR0   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 127 | _RS  SST0     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 128 | _RS  SSS0     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 129 | _RS  taux1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 130 | _RS  tauy1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 131 | _RS  Qnet1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 132 | _RS  EmPmR1   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 133 | _RS  SST1     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 134 | _RS  SSS1     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 135 | #ifdef ATMOSPHERIC_LOADING | 
| 136 | _RS  pload0   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 137 | _RS  pload1   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 138 | #endif | 
| 139 | #ifdef SHORTWAVE_HEATING | 
| 140 | _RS  Qsw1     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 141 | _RS  Qsw0     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 142 | #endif | 
| 143 | #endif /* INCLUDE_EXTERNAL_FORCING_PACKAGE undef */ | 
| 144 |  | 
| 145 | C     surfaceTendencyU       (units are  m/s^2) | 
| 146 | C                -> usage in gU:     gU = gU + surfaceTendencyU[m/s^2] | 
| 147 | C | 
| 148 | C     surfaceTendencyV       (units are  m/s^2) | 
| 149 | C                -> usage in gV:     gV = gV + surfaceTendencyV[m/s^2] | 
| 150 | C | 
| 151 | C     surfaceTendencyS       (units are  psu/s) | 
| 152 | C            - EmPmR plus salinity relaxation term | 
| 153 | C                -> calculate        -lambda*(S(model)-S(clim)) | 
| 154 | C                -> usage in gS:     gS = gS + surfaceTendencyS[psu/s] | 
| 155 | C | 
| 156 | C     surfaceTendencyT       (units are  degrees/s) | 
| 157 | C            - Qnet plus temp. relaxation | 
| 158 | C                -> calculate        -lambda*(T(model)-T(clim)) | 
| 159 | C            >>> Qnet assumed to be total flux minus s/w rad. <<< | 
| 160 | C                -> usage in gT:     gT = gT + surfaceTendencyT[K/s] | 
| 161 | C | 
| 162 | COMMON /TENDENCY_FORCING/ | 
| 163 | &                         surfaceTendencyU, | 
| 164 | &                         surfaceTendencyV, | 
| 165 | &                         surfaceTendencyT, | 
| 166 | &                         surfaceTendencyS, | 
| 167 | &                         tempQsw | 
| 168 | _RS  surfaceTendencyU  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 169 | _RS  surfaceTendencyV  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 170 | _RS  surfaceTendencyT  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 171 | _RS  surfaceTendencyS  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 172 | _RS  tempQsw           (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |