1 |
jmc |
1.219 |
C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.218 2008/07/18 22:19:26 jmc Exp $ |
2 |
mlosch |
1.74 |
C $Name: $ |
3 |
cnh |
1.1 |
C |
4 |
edhill |
1.124 |
|
5 |
cnh |
1.63 |
CBOP |
6 |
edhill |
1.124 |
C !ROUTINE: PARAMS.h |
7 |
|
|
C !INTERFACE: |
8 |
|
|
C #include PARAMS.h |
9 |
|
|
|
10 |
|
|
C !DESCRIPTION: |
11 |
|
|
C Header file defining model "parameters". The values from the |
12 |
|
|
C model standard input file are stored into the variables held |
13 |
|
|
C here. Notes describing the parameters can also be found here. |
14 |
|
|
|
15 |
cnh |
1.63 |
CEOP |
16 |
cnh |
1.13 |
|
17 |
|
|
C Macros for special grid options |
18 |
|
|
#include "PARAMS_MACROS.h" |
19 |
cnh |
1.1 |
|
20 |
|
|
C-- Contants |
21 |
|
|
C Useful physical values |
22 |
|
|
Real*8 PI |
23 |
|
|
PARAMETER ( PI = 3.14159265358979323844D0 ) |
24 |
|
|
Real*8 deg2rad |
25 |
|
|
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
26 |
|
|
|
27 |
|
|
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
28 |
jmc |
1.205 |
C buoyancyRelation :: Flag used to indicate which relation to use to |
29 |
|
|
C get buoyancy. |
30 |
|
|
C eosType :: choose the equation of state: |
31 |
|
|
C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS |
32 |
|
|
C pickupSuff :: force to start from pickup files (even if nIter0=0) |
33 |
|
|
C and read pickup files with this suffix (max 10 Char.) |
34 |
|
|
C mdsioLocalDir :: read-write tiled file from/to this directory name |
35 |
|
|
C (+ 4 digits Processor-Rank) instead of current dir. |
36 |
jmc |
1.191 |
C tRefFile :: File containing reference Potential Temperat. tRef (1.D) |
37 |
|
|
C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D) |
38 |
|
|
C rhoRefFile :: File containing reference density profile rhoRef (1.D) |
39 |
|
|
C delRFile :: File containing vertical grid spacing delR (1.D array) |
40 |
|
|
C delRcFile :: File containing vertical grid spacing delRc (1.D array) |
41 |
jmc |
1.162 |
C delXFile :: File containing X-spacing grid definition (1.D array) |
42 |
|
|
C delYFile :: File containing Y-spacing grid definition (1.D array) |
43 |
jmc |
1.191 |
C horizGridFile :: File containing horizontal-grid definition |
44 |
jmc |
1.162 |
C (only when using curvilinear_grid) |
45 |
jmc |
1.205 |
C bathyFile :: File containing bathymetry. If not defined bathymetry |
46 |
|
|
C is taken from inline function. |
47 |
|
|
C topoFile :: File containing the topography of the surface (unit=m) |
48 |
|
|
C (mainly used for the atmosphere = ground height). |
49 |
|
|
C shelfIceFile :: File containing the topography of the shelfice draught |
50 |
|
|
C (unit=m) |
51 |
|
|
C hydrogThetaFile :: File containing initial hydrographic data (3-D) |
52 |
|
|
C for potential temperature. |
53 |
|
|
C hydrogSaltFile :: File containing initial hydrographic data (3-D) |
54 |
|
|
C for salinity. |
55 |
dimitri |
1.199 |
C diffKrFile :: File containing 3D specification of vertical diffusivity |
56 |
cnh |
1.63 |
C zonalWindFile :: File containing zonal wind data |
57 |
|
|
C meridWindFile :: File containing meridional wind data |
58 |
jmc |
1.205 |
C thetaClimFile :: File containing surface theta climataology used |
59 |
cnh |
1.18 |
C in relaxation term -lambda(theta-theta*) |
60 |
jmc |
1.205 |
C saltClimFile :: File containing surface salt climataology used |
61 |
cnh |
1.18 |
C in relaxation term -lambda(salt-salt*) |
62 |
jmc |
1.120 |
C surfQfile :: File containing surface heat flux, excluding SW |
63 |
|
|
C (old version, kept for backward compatibility) |
64 |
|
|
C surfQnetFile :: File containing surface net heat flux |
65 |
|
|
C surfQswFile :: File containing surface shortwave radiation |
66 |
cnh |
1.63 |
C dQdTfile :: File containing thermal relaxation coefficient |
67 |
|
|
C EmPmRfile :: File containing surface fresh water flux |
68 |
dimitri |
1.210 |
C NOTE: for backward compatibility EmPmRfile is specified in |
69 |
|
|
C m/s when using external_fields_load.F. It is converted |
70 |
|
|
C to kg/m2/s by multiplying by rhoConstFresh. |
71 |
jmc |
1.141 |
C saltFluxFile :: File containing surface salt flux |
72 |
mlosch |
1.73 |
C pLoadFile :: File containing pressure loading |
73 |
gforget |
1.217 |
C eddyPsiXFile :: File containing zonal Eddy streamfunction data |
74 |
|
|
C eddyPsiYFile :: File containing meridional Eddy streamfunction data |
75 |
edhill |
1.124 |
C the_run_name :: string identifying the name of the model "run" |
76 |
jmc |
1.205 |
COMMON /PARM_C/ |
77 |
|
|
& buoyancyRelation, eosType, |
78 |
|
|
& pickupSuff, mdsioLocalDir, |
79 |
jmc |
1.191 |
& tRefFile, sRefFile, rhoRefFile, |
80 |
|
|
& delRFile, delRcFile, |
81 |
jmc |
1.162 |
& delXFile, delYFile, horizGridFile, |
82 |
mlosch |
1.176 |
& bathyFile, topoFile, shelfIceFile, |
83 |
dimitri |
1.199 |
& hydrogThetaFile, hydrogSaltFile, diffKrFile, |
84 |
cnh |
1.18 |
& zonalWindFile, meridWindFile, thetaClimFile, |
85 |
jmc |
1.205 |
& saltClimFile, |
86 |
jmc |
1.141 |
& EmPmRfile, saltFluxFile, |
87 |
|
|
& surfQfile, surfQnetFile, surfQswFile, |
88 |
heimbach |
1.151 |
& lambdaThetaFile, lambdaSaltFile, |
89 |
heimbach |
1.50 |
& uVelInitFile, vVelInitFile, pSurfInitFile, |
90 |
mlosch |
1.74 |
& dQdTfile, ploadFile, |
91 |
gforget |
1.217 |
& eddyPsiXFile, eddyPsiYFile, |
92 |
edhill |
1.124 |
& the_run_name |
93 |
jmc |
1.205 |
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation |
94 |
|
|
CHARACTER*(6) eosType |
95 |
|
|
CHARACTER*(10) pickupSuff |
96 |
|
|
CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir |
97 |
jmc |
1.191 |
CHARACTER*(MAX_LEN_FNAM) tRefFile |
98 |
|
|
CHARACTER*(MAX_LEN_FNAM) sRefFile |
99 |
|
|
CHARACTER*(MAX_LEN_FNAM) rhoRefFile |
100 |
|
|
CHARACTER*(MAX_LEN_FNAM) delRFile |
101 |
|
|
CHARACTER*(MAX_LEN_FNAM) delRcFile |
102 |
jmc |
1.162 |
CHARACTER*(MAX_LEN_FNAM) delXFile |
103 |
|
|
CHARACTER*(MAX_LEN_FNAM) delYFile |
104 |
|
|
CHARACTER*(MAX_LEN_FNAM) horizGridFile |
105 |
mlosch |
1.176 |
CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile |
106 |
dimitri |
1.198 |
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile |
107 |
dimitri |
1.199 |
CHARACTER*(MAX_LEN_FNAM) diffKrFile |
108 |
cnh |
1.16 |
CHARACTER*(MAX_LEN_FNAM) zonalWindFile |
109 |
|
|
CHARACTER*(MAX_LEN_FNAM) meridWindFile |
110 |
cnh |
1.18 |
CHARACTER*(MAX_LEN_FNAM) thetaClimFile |
111 |
|
|
CHARACTER*(MAX_LEN_FNAM) saltClimFile |
112 |
adcroft |
1.37 |
CHARACTER*(MAX_LEN_FNAM) surfQfile |
113 |
jmc |
1.120 |
CHARACTER*(MAX_LEN_FNAM) surfQnetFile |
114 |
|
|
CHARACTER*(MAX_LEN_FNAM) surfQswFile |
115 |
adcroft |
1.37 |
CHARACTER*(MAX_LEN_FNAM) EmPmRfile |
116 |
jmc |
1.141 |
CHARACTER*(MAX_LEN_FNAM) saltFluxFile |
117 |
adcroft |
1.42 |
CHARACTER*(MAX_LEN_FNAM) uVelInitFile |
118 |
|
|
CHARACTER*(MAX_LEN_FNAM) vVelInitFile |
119 |
adcroft |
1.43 |
CHARACTER*(MAX_LEN_FNAM) pSurfInitFile |
120 |
heimbach |
1.50 |
CHARACTER*(MAX_LEN_FNAM) dQdTfile |
121 |
mlosch |
1.73 |
CHARACTER*(MAX_LEN_FNAM) ploadFile |
122 |
gforget |
1.217 |
CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile |
123 |
|
|
CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile |
124 |
heimbach |
1.151 |
CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile |
125 |
|
|
CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile |
126 |
jmc |
1.193 |
CHARACTER*(MAX_LEN_PREC/2) the_run_name |
127 |
cnh |
1.7 |
|
128 |
cnh |
1.1 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
129 |
cnh |
1.63 |
C cg2dMaxIters :: Maximum number of iterations in the |
130 |
cnh |
1.1 |
C two-dimensional con. grad solver. |
131 |
cnh |
1.63 |
C cg2dChkResFreq :: Frequency with which to check residual |
132 |
cnh |
1.1 |
C in con. grad solver. |
133 |
jmc |
1.119 |
C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner |
134 |
|
|
C (non-linear free-surf.) |
135 |
cnh |
1.63 |
C cg3dMaxIters :: Maximum number of iterations in the |
136 |
cnh |
1.33 |
C three-dimensional con. grad solver. |
137 |
cnh |
1.63 |
C cg3dChkResFreq :: Frequency with which to check residual |
138 |
cnh |
1.33 |
C in con. grad solver. |
139 |
cnh |
1.63 |
C nIter0 :: Start time-step number of for this run |
140 |
|
|
C nTimeSteps :: Number of timesteps to execute |
141 |
|
|
C writeStatePrec :: Precision used for writing model state. |
142 |
|
|
C writeBinaryPrec :: Precision used for writing binary files |
143 |
|
|
C readBinaryPrec :: Precision used for reading binary files |
144 |
|
|
C nonlinFreeSurf :: option related to non-linear free surface |
145 |
jmc |
1.55 |
C =0 Linear free surface ; >0 Non-linear |
146 |
jmc |
1.84 |
C select_rStar :: option related to r* vertical coordinate |
147 |
|
|
C =0 (default) use r coord. ; > 0 use r* |
148 |
jmc |
1.180 |
C momForcingOutAB :: =1: take momentum forcing contribution |
149 |
|
|
C out of (=0: in) Adams-Bashforth time stepping. |
150 |
|
|
C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution |
151 |
|
|
C out of (=0: in) Adams-Bashforth time stepping. |
152 |
jmc |
1.115 |
C tempAdvScheme :: Temp. Horiz.Advection scheme selector |
153 |
jmc |
1.168 |
C tempVertAdvScheme :: Temp. Vert. Advection scheme selector |
154 |
jmc |
1.115 |
C saltAdvScheme :: Salt. Horiz.advection scheme selector |
155 |
|
|
C saltVertAdvScheme :: Salt. Vert. Advection scheme selector |
156 |
jmc |
1.168 |
C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.) |
157 |
jmc |
1.214 |
C selectVortScheme :: Scheme selector for Vorticity term (Vector Inv.) |
158 |
jmc |
1.211 |
C monitorSelect :: select group of variables to monitor |
159 |
|
|
C =1 : dynvars ; =2 : + vort ; =3 : + surface |
160 |
jmc |
1.115 |
C debugLevel :: debug level selector: higher -> more writing |
161 |
cnh |
1.34 |
|
162 |
cnh |
1.1 |
COMMON /PARM_I/ |
163 |
|
|
& cg2dMaxIters, |
164 |
jmc |
1.119 |
& cg2dChkResFreq, cg2dPreCondFreq, |
165 |
cnh |
1.33 |
& cg3dMaxIters, |
166 |
|
|
& cg3dChkResFreq, |
167 |
adcroft |
1.41 |
& nIter0, nTimeSteps, nEndIter, |
168 |
jmc |
1.205 |
& writeStatePrec, |
169 |
cnh |
1.34 |
& writeBinaryPrec, readBinaryPrec, |
170 |
jmc |
1.84 |
& nonlinFreeSurf, select_rStar, |
171 |
jmc |
1.180 |
& momForcingOutAB, tracForcingOutAB, |
172 |
jmc |
1.115 |
& tempAdvScheme, tempVertAdvScheme, |
173 |
|
|
& saltAdvScheme, saltVertAdvScheme, |
174 |
jmc |
1.214 |
& selectKEscheme, selectVortScheme, |
175 |
jmc |
1.211 |
& monitorSelect, debugLevel |
176 |
cnh |
1.1 |
INTEGER cg2dMaxIters |
177 |
|
|
INTEGER cg2dChkResFreq |
178 |
jmc |
1.119 |
INTEGER cg2dPreCondFreq |
179 |
cnh |
1.33 |
INTEGER cg3dMaxIters |
180 |
|
|
INTEGER cg3dChkResFreq |
181 |
cnh |
1.1 |
INTEGER nIter0 |
182 |
|
|
INTEGER nTimeSteps |
183 |
adcroft |
1.41 |
INTEGER nEndIter |
184 |
cnh |
1.7 |
INTEGER writeStatePrec |
185 |
|
|
INTEGER writeBinaryPrec |
186 |
|
|
INTEGER readBinaryPrec |
187 |
jmc |
1.55 |
INTEGER nonlinFreeSurf |
188 |
jmc |
1.84 |
INTEGER select_rStar |
189 |
jmc |
1.180 |
INTEGER momForcingOutAB, tracForcingOutAB |
190 |
jmc |
1.115 |
INTEGER tempAdvScheme, tempVertAdvScheme |
191 |
|
|
INTEGER saltAdvScheme, saltVertAdvScheme |
192 |
jmc |
1.183 |
INTEGER selectKEscheme |
193 |
jmc |
1.214 |
INTEGER selectVortScheme |
194 |
jmc |
1.211 |
INTEGER monitorSelect |
195 |
heimbach |
1.92 |
INTEGER debugLevel |
196 |
|
|
|
197 |
cnh |
1.1 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
198 |
jmc |
1.215 |
C- Coordinate + Grid params: |
199 |
|
|
C fluidIsAir :: Set to indicate that the fluid major constituent |
200 |
|
|
C is air |
201 |
|
|
C fluidIsWater :: Set to indicate that the fluid major constituent |
202 |
|
|
C is water |
203 |
|
|
C usingPCoords :: Set to indicate that we are working in a pressure |
204 |
|
|
C type coordinate (p or p*). |
205 |
|
|
C usingZCoords :: Set to indicate that we are working in a height |
206 |
|
|
C type coordinate (z or z*) |
207 |
|
|
C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.) |
208 |
|
|
C this requires specific code for restart & exchange |
209 |
cnh |
1.63 |
C usingCartesianGrid :: If TRUE grid generation will be in a cartesian |
210 |
cnh |
1.1 |
C coordinate frame. |
211 |
jmc |
1.206 |
C usingSphericalPolarGrid :: If TRUE grid generation will be in a |
212 |
cnh |
1.1 |
C spherical polar frame. |
213 |
jmc |
1.215 |
C rotateGrid :: rotate grid coordinates to geographical coordinates |
214 |
|
|
C according to Euler angles phiEuler, thetaEuler, psiEuler |
215 |
|
|
C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided) |
216 |
afe |
1.114 |
C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical |
217 |
jmc |
1.192 |
C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation) |
218 |
jmc |
1.215 |
C setInterFDr :: set Interface depth (put cell-Center at the middle) |
219 |
|
|
C setCenterDr :: set cell-Center depth (put Interface at the middle) |
220 |
|
|
C- Momentum params: |
221 |
|
|
C no_slip_sides :: Impose "no-slip" at lateral boundaries. |
222 |
cnh |
1.63 |
C no_slip_bottom :: Impose "no-slip" at bottom boundary. |
223 |
jmc |
1.215 |
C useFullLeith :: Set to true to use full Leith viscosity(may be unstable |
224 |
|
|
C on irregular grids) |
225 |
|
|
C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms |
226 |
|
|
C useAreaViscLength :: Set to true to use old scaling for viscous lengths, |
227 |
|
|
C e.g., L2=Raz. May be preferable for cube sphere. |
228 |
cnh |
1.63 |
C momViscosity :: Flag which turns momentum friction terms on and off. |
229 |
|
|
C momAdvection :: Flag which turns advection of momentum on and off. |
230 |
|
|
C momForcing :: Flag which turns external forcing of momentum on |
231 |
jmc |
1.215 |
C and off. |
232 |
cnh |
1.63 |
C momPressureForcing :: Flag which turns pressure term in momentum equation |
233 |
cnh |
1.9 |
C on and off. |
234 |
cnh |
1.63 |
C metricTerms :: Flag which turns metric terms on or off. |
235 |
jmc |
1.182 |
C useNHMTerms :: If TRUE use non-hydrostatic metric terms. |
236 |
cnh |
1.63 |
C useCoriolis :: Flag which turns the coriolis terms on and off. |
237 |
jmc |
1.215 |
C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off |
238 |
|
|
C useConstantF :: Coriolis parameter set to f0 |
239 |
|
|
C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y |
240 |
|
|
C useSphereF :: Coriolis parameter set to 2.omega.sin(phi) |
241 |
|
|
C useCDscheme :: use CD-scheme to calculate Coriolis terms. |
242 |
|
|
C vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package) |
243 |
|
|
C (default = F = use mom_fluxform package) |
244 |
|
|
C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986) |
245 |
|
|
C useJamartMomAdv :: Use wet-point method for V.I. non-linear term |
246 |
|
|
C upwindVorticity :: bias interpolation of vorticity in the Coriolis term |
247 |
|
|
C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection) |
248 |
|
|
C useAbsVorticity :: work with f+zeta in Coriolis terms |
249 |
|
|
C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection) |
250 |
|
|
C momStepping :: Turns momentum equation time-stepping off |
251 |
|
|
C- Temp. & Salt params: |
252 |
|
|
C tempStepping :: Turns temperature equation time-stepping off |
253 |
|
|
C saltStepping :: Turns salinity equation time-stepping off |
254 |
|
|
C tempAdvection :: Flag which turns advection of temperature on and off. |
255 |
|
|
C tempIsActiveTr :: Pot.Temp. is a dynamically active tracer |
256 |
|
|
C tempForcing :: Flag which turns external forcing of temperature on |
257 |
|
|
C and off. |
258 |
|
|
C saltAdvection :: Flag which turns advection of salinity on and off. |
259 |
|
|
C saltIsActiveTr :: Salinity is a dynamically active tracer |
260 |
|
|
C saltForcing :: Flag which turns external forcing of salinity on |
261 |
|
|
C and off. |
262 |
jmc |
1.206 |
C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux |
263 |
jmc |
1.71 |
C as a real Fresh Water (=> changes the Sea Level) |
264 |
|
|
C if F, converts P+R-E to salt flux (no SL effect) |
265 |
jmc |
1.215 |
C- Time-stepping params: |
266 |
cnh |
1.63 |
C rigidLid :: Set to true to use rigid lid |
267 |
jmc |
1.173 |
C implicitFreeSurface :: Set to true to use implicit free surface |
268 |
cnh |
1.63 |
C exactConserv :: Set to true to conserve exactly the total Volume |
269 |
dfer |
1.194 |
C linFSConserveTr :: Set to true to correct source/sink of tracer |
270 |
jmc |
1.206 |
C at the surface due to Linear Free Surface |
271 |
cnh |
1.63 |
C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the |
272 |
jmc |
1.215 |
C linear relation Phi_surf = Bo_surf*eta |
273 |
|
|
C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm |
274 |
|
|
C nonHydrostatic :: Using non-hydrostatic algorithm |
275 |
|
|
C use3Dsolver :: set to true to use 3-D pressure solver |
276 |
jmc |
1.173 |
C implicitIntGravWave :: treat Internal Gravity Wave implicitly |
277 |
jmc |
1.215 |
C staggerTimeStep :: enable a Stagger time stepping U,V (& W) then T,S |
278 |
cnh |
1.63 |
C implicitDiffusion :: Turns implicit vertical diffusion on |
279 |
|
|
C implicitViscosity :: Turns implicit vertical viscosity on |
280 |
jmc |
1.100 |
C tempImplVertAdv :: Turns on implicit vertical advection for Temperature |
281 |
|
|
C saltImplVertAdv :: Turns on implicit vertical advection for Salinity |
282 |
|
|
C momImplVertAdv :: Turns on implicit vertical advection for Momentum |
283 |
jmc |
1.71 |
C multiDimAdvection :: Flag that enable multi-dimension advection |
284 |
jmc |
1.118 |
C useMultiDimAdvec :: True if multi-dim advection is used at least once |
285 |
jmc |
1.180 |
C momDissip_In_AB :: if False, put Dissipation tendency contribution |
286 |
jmc |
1.170 |
C out off Adams-Bashforth time stepping. |
287 |
|
|
C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always |
288 |
jmc |
1.195 |
C apply AB on tracer tendencies (rather than on Tracer) |
289 |
jmc |
1.215 |
C- Other forcing params - |
290 |
|
|
C balanceEmPmR :: substract global mean of EmPmR at every time step |
291 |
|
|
C balanceQnet :: substract global mean of Qnet at every time step |
292 |
|
|
C balancePrintMean:: print substracted global means to STDOUT |
293 |
cnh |
1.63 |
C doThetaClimRelax :: Set true if relaxation to temperature |
294 |
cnh |
1.18 |
C climatology is required. |
295 |
cnh |
1.63 |
C doSaltClimRelax :: Set true if relaxation to salinity |
296 |
cnh |
1.18 |
C climatology is required. |
297 |
jmc |
1.215 |
C allowFreezing :: Allows surface water to freeze and form ice |
298 |
|
|
C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12) |
299 |
cnh |
1.63 |
C periodicExternalForcing :: Set true if forcing is time-dependant |
300 |
jmc |
1.215 |
C- I/O parameters - |
301 |
cnh |
1.63 |
C globalFiles :: Selects between "global" and "tiled" files |
302 |
dimitri |
1.85 |
C useSingleCpuIO :: On SGI platforms, option globalFiles is either |
303 |
|
|
C slow (f77) or does not work (f90). When |
304 |
|
|
C useSingleCpuIO is set, mdsio_writefield.F |
305 |
|
|
C outputs from master mpi process only. |
306 |
jmc |
1.215 |
C pickupStrictlyMatch :: check and stop if pickup-file do not stricly match |
307 |
|
|
C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup |
308 |
|
|
C usePickupBeforeC54 :: start from old-pickup files, generated with code from |
309 |
|
|
C before checkpoint-54a, Jul 06, 2004. |
310 |
edhill |
1.124 |
C pickup_write_mdsio :: use mdsio to write pickups |
311 |
|
|
C pickup_read_mdsio :: use mdsio to read pickups |
312 |
|
|
C pickup_write_immed :: echo the pickup immediately (for conversion) |
313 |
mlosch |
1.213 |
C writePickupAtEnd :: write pickup at the last timestep |
314 |
edhill |
1.124 |
C timeave_mdsio :: use mdsio for timeave output |
315 |
|
|
C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output |
316 |
edhill |
1.125 |
C monitor_stdio :: use stdio for monitor output |
317 |
jmc |
1.206 |
C dumpInitAndLast :: dumps model state to files at Initial (nIter0) |
318 |
jmc |
1.164 |
C & Last iteration, in addition multiple of dumpFreq iter. |
319 |
mlosch |
1.177 |
|
320 |
jmc |
1.215 |
COMMON /PARM_L/ |
321 |
|
|
& fluidIsAir, fluidIsWater, |
322 |
|
|
& usingPCoords, usingZCoords, useDynP_inEos_Zc, |
323 |
|
|
& usingCartesianGrid, usingSphericalPolarGrid, rotateGrid, |
324 |
afe |
1.114 |
& usingCurvilinearGrid, usingCylindricalGrid, |
325 |
jmc |
1.192 |
& deepAtmosphere, setInterFDr, setCenterDr, |
326 |
jmc |
1.215 |
& no_slip_sides, no_slip_bottom, |
327 |
|
|
& useFullLeith, useStrainTensionVisc, useAreaViscLength, |
328 |
|
|
& momViscosity, momAdvection, momForcing, |
329 |
|
|
& momPressureForcing, metricTerms, useNHMTerms, |
330 |
|
|
& useCoriolis, use3dCoriolis, |
331 |
|
|
& useConstantF, useBetaPlaneF, useSphereF, |
332 |
|
|
& useCDscheme, vectorInvariantMomentum, |
333 |
|
|
& useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv, |
334 |
|
|
& upwindVorticity, highOrderVorticity, |
335 |
|
|
& useAbsVorticity, upwindShear, |
336 |
|
|
& momStepping, tempStepping, saltStepping, |
337 |
|
|
& tempAdvection, tempIsActiveTr, tempForcing, |
338 |
|
|
& saltAdvection, saltIsActiveTr, saltForcing, |
339 |
jmc |
1.68 |
& useRealFreshWaterFlux, |
340 |
dfer |
1.194 |
& rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr, |
341 |
|
|
& uniformLin_PhiSurf, |
342 |
jmc |
1.215 |
& quasiHydrostatic, nonHydrostatic, |
343 |
jmc |
1.178 |
& use3Dsolver, implicitIntGravWave, staggerTimeStep, |
344 |
adcroft |
1.40 |
& implicitDiffusion, implicitViscosity, |
345 |
jmc |
1.100 |
& tempImplVertAdv, saltImplVertAdv, momImplVertAdv, |
346 |
jmc |
1.183 |
& multiDimAdvection, useMultiDimAdvec, |
347 |
jmc |
1.180 |
& momDissip_In_AB, doAB_onGtGs, |
348 |
jmc |
1.215 |
& balanceEmPmR, balanceQnet, balancePrintMean, |
349 |
|
|
& doThetaClimRelax, doSaltClimRelax, |
350 |
|
|
& allowFreezing, useOldFreezing, |
351 |
jmc |
1.183 |
& periodicExternalForcing, |
352 |
jmc |
1.215 |
& globalFiles, useSingleCpuIO, |
353 |
jmc |
1.206 |
& pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2, |
354 |
edhill |
1.124 |
& pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed, |
355 |
mlosch |
1.213 |
& writePickupAtEnd, |
356 |
edhill |
1.155 |
& timeave_mdsio, snapshot_mdsio, monitor_stdio, |
357 |
jmc |
1.164 |
& outputTypesInclusive, dumpInitAndLast, debugMode, |
358 |
jmc |
1.215 |
& inAdMode, inAdTrue, inAdFalse, inAdExact |
359 |
edhill |
1.131 |
|
360 |
jmc |
1.215 |
LOGICAL fluidIsAir |
361 |
|
|
LOGICAL fluidIsWater |
362 |
|
|
LOGICAL usingPCoords |
363 |
|
|
LOGICAL usingZCoords |
364 |
|
|
LOGICAL useDynP_inEos_Zc |
365 |
cnh |
1.1 |
LOGICAL usingCartesianGrid |
366 |
jmc |
1.215 |
LOGICAL usingSphericalPolarGrid, rotateGrid |
367 |
afe |
1.114 |
LOGICAL usingCylindricalGrid |
368 |
adcroft |
1.52 |
LOGICAL usingCurvilinearGrid |
369 |
jmc |
1.192 |
LOGICAL deepAtmosphere |
370 |
jmc |
1.191 |
LOGICAL setInterFDr |
371 |
|
|
LOGICAL setCenterDr |
372 |
adcroft |
1.77 |
LOGICAL useNHMTerms |
373 |
adcroft |
1.36 |
LOGICAL no_slip_sides |
374 |
|
|
LOGICAL no_slip_bottom |
375 |
cnh |
1.1 |
LOGICAL momViscosity |
376 |
|
|
LOGICAL momAdvection |
377 |
|
|
LOGICAL momForcing |
378 |
cnh |
1.9 |
LOGICAL momPressureForcing |
379 |
cnh |
1.1 |
LOGICAL useCoriolis |
380 |
adcroft |
1.58 |
LOGICAL vectorInvariantMomentum |
381 |
cnh |
1.1 |
LOGICAL tempAdvection |
382 |
jmc |
1.216 |
LOGICAL tempIsActiveTr |
383 |
cnh |
1.1 |
LOGICAL tempForcing |
384 |
|
|
LOGICAL saltAdvection |
385 |
jmc |
1.216 |
LOGICAL saltIsActiveTr |
386 |
cnh |
1.1 |
LOGICAL saltForcing |
387 |
jmc |
1.68 |
LOGICAL useRealFreshWaterFlux |
388 |
baylor |
1.165 |
LOGICAL useFullLeith |
389 |
|
|
LOGICAL useStrainTensionVisc |
390 |
baylor |
1.167 |
LOGICAL useAreaViscLength |
391 |
adcroft |
1.52 |
LOGICAL rigidLid |
392 |
cnh |
1.8 |
LOGICAL implicitFreeSurface |
393 |
adcroft |
1.52 |
LOGICAL exactConserv |
394 |
dfer |
1.194 |
LOGICAL linFSConserveTr |
395 |
jmc |
1.55 |
LOGICAL uniformLin_PhiSurf |
396 |
jmc |
1.215 |
LOGICAL quasiHydrostatic |
397 |
|
|
LOGICAL nonHydrostatic |
398 |
jmc |
1.178 |
LOGICAL use3Dsolver |
399 |
jmc |
1.173 |
LOGICAL implicitIntGravWave |
400 |
|
|
LOGICAL staggerTimeStep |
401 |
cnh |
1.10 |
LOGICAL momStepping |
402 |
|
|
LOGICAL tempStepping |
403 |
adcroft |
1.17 |
LOGICAL saltStepping |
404 |
cnh |
1.15 |
LOGICAL metricTerms |
405 |
|
|
LOGICAL useConstantF |
406 |
|
|
LOGICAL useBetaPlaneF |
407 |
|
|
LOGICAL useSphereF |
408 |
jmc |
1.188 |
LOGICAL use3dCoriolis |
409 |
jmc |
1.89 |
LOGICAL useCDscheme |
410 |
jmc |
1.71 |
LOGICAL useEnergyConservingCoriolis |
411 |
|
|
LOGICAL useJamartWetPoints |
412 |
adcroft |
1.113 |
LOGICAL useJamartMomAdv |
413 |
adcroft |
1.111 |
LOGICAL upwindVorticity |
414 |
|
|
LOGICAL highOrderVorticity |
415 |
|
|
LOGICAL useAbsVorticity |
416 |
jmc |
1.159 |
LOGICAL upwindShear |
417 |
adcroft |
1.14 |
LOGICAL implicitDiffusion |
418 |
adcroft |
1.40 |
LOGICAL implicitViscosity |
419 |
jmc |
1.183 |
LOGICAL tempImplVertAdv |
420 |
|
|
LOGICAL saltImplVertAdv |
421 |
jmc |
1.100 |
LOGICAL momImplVertAdv |
422 |
jmc |
1.71 |
LOGICAL multiDimAdvection |
423 |
jmc |
1.118 |
LOGICAL useMultiDimAdvec |
424 |
jmc |
1.180 |
LOGICAL momDissip_In_AB |
425 |
jmc |
1.170 |
LOGICAL doAB_onGtGs |
426 |
jmc |
1.215 |
LOGICAL balanceEmPmR |
427 |
|
|
LOGICAL balanceQnet |
428 |
|
|
LOGICAL balancePrintMean |
429 |
cnh |
1.18 |
LOGICAL doThetaClimRelax |
430 |
|
|
LOGICAL doSaltClimRelax |
431 |
jmc |
1.215 |
LOGICAL allowFreezing |
432 |
|
|
LOGICAL useOldFreezing |
433 |
adcroft |
1.19 |
LOGICAL periodicExternalForcing |
434 |
adcroft |
1.38 |
LOGICAL globalFiles |
435 |
dimitri |
1.85 |
LOGICAL useSingleCpuIO |
436 |
jmc |
1.206 |
LOGICAL pickupStrictlyMatch |
437 |
jmc |
1.117 |
LOGICAL usePickupBeforeC54 |
438 |
jmc |
1.154 |
LOGICAL startFromPickupAB2 |
439 |
edhill |
1.124 |
LOGICAL pickup_read_mdsio, pickup_write_mdsio |
440 |
mlosch |
1.213 |
LOGICAL pickup_write_immed, writePickupAtEnd |
441 |
edhill |
1.125 |
LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio |
442 |
edhill |
1.133 |
LOGICAL outputTypesInclusive |
443 |
jmc |
1.215 |
LOGICAL dumpInitAndLast |
444 |
|
|
LOGICAL debugMode |
445 |
heimbach |
1.143 |
LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact |
446 |
cnh |
1.1 |
|
447 |
|
|
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
448 |
jmc |
1.119 |
C cg2dTargetResidual |
449 |
cnh |
1.63 |
C :: Target residual for cg2d solver; no unit (RHS normalisation) |
450 |
adcroft |
1.52 |
C cg2dTargetResWunit |
451 |
cnh |
1.63 |
C :: Target residual for cg2d solver; W unit (No RHS normalisation) |
452 |
cnh |
1.33 |
C cg3dTargetResidual |
453 |
cnh |
1.63 |
C :: Target residual for cg3d solver. |
454 |
|
|
C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal. |
455 |
cnh |
1.7 |
C Note. 20th May 1998 |
456 |
|
|
C I made a weird discovery! In the model paper we argue |
457 |
|
|
C for the form of the preconditioner used here ( see |
458 |
|
|
C A Finite-volume, Incompressible Navier-Stokes Model |
459 |
|
|
C ...., Marshall et. al ). The algebra gives a simple |
460 |
|
|
C 0.5 factor for the averaging of ac and aCw to get a |
461 |
|
|
C symmettric pre-conditioner. By using a factor of 0.51 |
462 |
|
|
C i.e. scaling the off-diagonal terms in the |
463 |
|
|
C preconditioner down slightly I managed to get the |
464 |
|
|
C number of iterations for convergence in a test case to |
465 |
|
|
C drop form 192 -> 134! Need to investigate this further! |
466 |
|
|
C For now I have introduced a parameter cg2dpcOffDFac which |
467 |
|
|
C defaults to 0.51 but can be set at runtime. |
468 |
cnh |
1.63 |
C delR :: Vertical grid spacing ( units of r ). |
469 |
jmc |
1.70 |
C delRc :: Vertical grid spacing between cell centers (r unit). |
470 |
cnh |
1.63 |
C delX :: Separation between cell faces (m) or (deg), depending |
471 |
cnh |
1.1 |
C delY on input flags. |
472 |
cnh |
1.63 |
C gravity :: Accel. due to gravity ( m/s^2 ) |
473 |
cnh |
1.32 |
C recip_gravity and its inverse |
474 |
cnh |
1.63 |
C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 ) |
475 |
mlosch |
1.75 |
C rhoNil :: Reference density for the linear equation of state |
476 |
jmc |
1.191 |
C rhoConst :: Vertically constant reference density |
477 |
|
|
C rhoFacC :: normalized (by rhoConst) reference density at cell-Center |
478 |
|
|
C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace |
479 |
mlosch |
1.75 |
C rhoConstFresh :: Constant reference density for fresh water (rain) |
480 |
jmc |
1.132 |
C tRef :: reference vertical profile for potential temperature |
481 |
jmc |
1.191 |
C sRef :: reference vertical profile for salinity/specific humidity |
482 |
|
|
C phiRef :: reference potential (pressure/rho, geopotential) profile |
483 |
jmc |
1.173 |
C dBdrRef :: vertical gradient of reference boyancy [(m/s/r)^2)]: |
484 |
|
|
C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2] |
485 |
|
|
C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2] |
486 |
jmc |
1.197 |
C rVel2wUnit :: units conversion factor (Non-Hydrostatic code), |
487 |
|
|
C :: from r-coordinate vertical velocity to vertical velocity [m/s]. |
488 |
|
|
C :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit |
489 |
|
|
C wUnit2rVel :: units conversion factor (Non-Hydrostatic code), |
490 |
|
|
C :: from vertical velocity [m/s] to r-coordinate vertical velocity. |
491 |
|
|
C :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel |
492 |
jmc |
1.203 |
C mass2rUnit :: units conversion factor (surface forcing), |
493 |
|
|
C :: from mass per unit area [kg/m2] to vertical r-coordinate unit. |
494 |
|
|
C :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ; |
495 |
|
|
C :: p-coord: = gravity ( [kg/m2] * g = [Pa] ) ; |
496 |
|
|
C rUnit2mass :: units conversion factor (surface forcing), |
497 |
|
|
C :: from vertical r-coordinate unit to mass per unit area [kg/m2]. |
498 |
|
|
C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ; |
499 |
|
|
C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ; |
500 |
cnh |
1.63 |
C phiMin :: Latitude of southern most cell face. |
501 |
|
|
C thetaMin :: Longitude of western most cell face (this |
502 |
cnh |
1.1 |
C is an "inert" parameter but it is included |
503 |
|
|
C to make geographical references simple.) |
504 |
cnh |
1.63 |
C rSphere :: Radius of sphere for a spherical polar grid ( m ). |
505 |
jmc |
1.191 |
C recip_rSphere :: Reciprocal radius of sphere ( m ). |
506 |
cnh |
1.63 |
C f0 :: Reference coriolis parameter ( 1/s ) |
507 |
cnh |
1.1 |
C ( Southern edge f for beta plane ) |
508 |
cnh |
1.63 |
C beta :: df/dy ( s^-1.m^-1 ) |
509 |
|
|
C omega :: Angular velocity ( rad/s ) |
510 |
jmc |
1.88 |
C rotationPeriod :: Rotation period (s) (= 2.pi/omega) |
511 |
jmc |
1.214 |
C viscAr :: Eddy viscosity coeff. for mixing of |
512 |
|
|
C momentum vertically ( units of r^2/s ) |
513 |
cnh |
1.63 |
C viscAh :: Eddy viscosity coeff. for mixing of |
514 |
cnh |
1.1 |
C momentum laterally ( m^2/s ) |
515 |
mlosch |
1.128 |
C viscAhW :: Eddy viscosity coeff. for mixing of vertical |
516 |
|
|
C momentum laterally, no effect for hydrostatic |
517 |
|
|
C model, defaults to viscAh if unset ( m^2/s ) |
518 |
baylor |
1.186 |
C Not used if variable horiz. viscosity is used. |
519 |
cnh |
1.63 |
C viscA4 :: Biharmonic viscosity coeff. for mixing of |
520 |
cnh |
1.1 |
C momentum laterally ( m^4/s ) |
521 |
mlosch |
1.140 |
C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical |
522 |
|
|
C momentum laterally, no effect for hydrostatic |
523 |
|
|
C model, defaults to viscA4 if unset ( m^2/s ) |
524 |
baylor |
1.186 |
C Not used if variable horiz. viscosity is used. |
525 |
jmc |
1.135 |
C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally |
526 |
|
|
C (act on Divergence part) ( m^2/s ) |
527 |
|
|
C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally |
528 |
|
|
C (act on Vorticity part) ( m^2/s ) |
529 |
|
|
C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally |
530 |
|
|
C (act on Divergence part) ( m^4/s ) |
531 |
|
|
C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally |
532 |
|
|
C (act on Vorticity part) ( m^4/s ) |
533 |
jmc |
1.214 |
C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort)) |
534 |
baylor |
1.166 |
C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div)) |
535 |
jmc |
1.214 |
C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort)) |
536 |
|
|
C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div)) |
537 |
|
|
C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic) |
538 |
|
|
C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic) |
539 |
|
|
C viscAhMax :: Maximum eddy viscosity coeff. for mixing of |
540 |
|
|
C momentum laterally ( m^2/s ) |
541 |
|
|
C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity |
542 |
|
|
C coeff. for mixing of momentum laterally (non-dim) |
543 |
|
|
C viscAhGrid :: non-dimensional grid-size dependent viscosity |
544 |
baylor |
1.146 |
C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ... |
545 |
baylor |
1.166 |
C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc. |
546 |
jmc |
1.214 |
C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of |
547 |
|
|
C momentum laterally ( m^4/s ) |
548 |
|
|
C viscA4ReMax :: Maximum Gridscale Reynolds number for |
549 |
|
|
C biharmonic viscosity coeff. momentum laterally (non-dim) |
550 |
|
|
C viscA4Grid :: non-dimensional grid-size dependent bi-harmonic viscosity |
551 |
dimitri |
1.136 |
C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ... |
552 |
|
|
C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity |
553 |
cnh |
1.63 |
C diffKhT :: Laplacian diffusion coeff. for mixing of |
554 |
cnh |
1.1 |
C heat laterally ( m^2/s ) |
555 |
jmc |
1.214 |
C diffKrNrT :: vertical profile of Laplacian diffusion coeff. |
556 |
jmc |
1.132 |
C for mixing of heat vertically ( units of r^2/s ) |
557 |
cnh |
1.63 |
C diffK4T :: Biharmonic diffusion coeff. for mixing of |
558 |
cnh |
1.1 |
C heat laterally ( m^4/s ) |
559 |
cnh |
1.63 |
C diffKhS :: Laplacian diffusion coeff. for mixing of |
560 |
cnh |
1.1 |
C salt laterally ( m^2/s ) |
561 |
jmc |
1.214 |
C diffKrNrS :: vertical profile of Laplacian diffusion coeff. |
562 |
|
|
C for mixing of salt vertically ( units of r^2/s ), |
563 |
cnh |
1.63 |
C diffK4S :: Biharmonic diffusion coeff. for mixing of |
564 |
cnh |
1.1 |
C salt laterally ( m^4/s ) |
565 |
adcroft |
1.112 |
C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979 |
566 |
|
|
C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979 |
567 |
|
|
C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979 |
568 |
|
|
C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979 |
569 |
dimitri |
1.201 |
C BL79LatVary :: polarwise of this latitude diffKrBL79 is applied with |
570 |
|
|
C gradual transition to diffKrBLEQ towards Equator |
571 |
|
|
C diffKrBLEQsurf :: same as diffKrBL79surf but at Equator |
572 |
|
|
C diffKrBLEQdeep :: same as diffKrBL79deep but at Equator |
573 |
|
|
C diffKrBLEQscl :: same as diffKrBL79scl but at Equator |
574 |
|
|
C diffKrBLEQHo :: same as diffKrBL79Ho but at Equator |
575 |
cnh |
1.63 |
C deltaT :: Default timestep ( s ) |
576 |
|
|
C deltaTClock :: Timestep used as model "clock". This determines the |
577 |
cnh |
1.7 |
C IO frequencies and is used in tagging output. It can |
578 |
|
|
C be totally different to the dynamical time. Typically |
579 |
|
|
C it will be the deep-water timestep for accelerated runs. |
580 |
|
|
C Frequency of checkpointing and dumping of the model state |
581 |
|
|
C are referenced to this clock. ( s ) |
582 |
cnh |
1.63 |
C deltaTMom :: Timestep for momemtum equations ( s ) |
583 |
jmc |
1.139 |
C dTtracerLev :: Timestep for tracer equations ( s ), function of level k |
584 |
adcroft |
1.72 |
C deltaTfreesurf :: Timestep for free-surface equation ( s ) |
585 |
cnh |
1.63 |
C freesurfFac :: Parameter to turn implicit free surface term on or off |
586 |
cnh |
1.8 |
C freesurfac = 1. uses implicit free surface |
587 |
|
|
C freesurfac = 0. uses rigid lid |
588 |
jmc |
1.154 |
C abEps :: Adams-Bashforth-2 stabilizing weight |
589 |
|
|
C alph_AB :: Adams-Bashforth-3 primary factor |
590 |
|
|
C beta_AB :: Adams-Bashforth-3 secondary factor |
591 |
cnh |
1.63 |
C implicSurfPress :: parameter of the Crank-Nickelson time stepping : |
592 |
jmc |
1.48 |
C Implicit part of Surface Pressure Gradient ( 0-1 ) |
593 |
cnh |
1.63 |
C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping : |
594 |
jmc |
1.48 |
C Implicit part of barotropic flow Divergence ( 0-1 ) |
595 |
cnh |
1.63 |
C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...) |
596 |
|
|
C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m) |
597 |
|
|
C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
598 |
|
|
C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
599 |
|
|
C hFacInf :: Threshold (inf and sup) for fraction size of surface cell |
600 |
adcroft |
1.52 |
C hFacSup that control vanishing and creating levels |
601 |
cnh |
1.63 |
C tauCD :: CD scheme coupling timescale ( 1/s ) |
602 |
|
|
C rCD :: CD scheme normalised coupling parameter ( 0-1 ) |
603 |
jmc |
1.150 |
C baseTime :: model base time (time origin) = time @ iteration zero |
604 |
cnh |
1.63 |
C startTime :: Starting time for this integration ( s ). |
605 |
|
|
C endTime :: Ending time for this integration ( s ). |
606 |
|
|
C chkPtFreq :: Frequency of rolling check pointing ( s ). |
607 |
|
|
C pChkPtFreq :: Frequency of permanent check pointing ( s ). |
608 |
|
|
C dumpFreq :: Frequency with which model state is written to |
609 |
cnh |
1.24 |
C post-processing files ( s ). |
610 |
cnh |
1.63 |
C diagFreq :: Frequency with which model writes diagnostic output |
611 |
adcroft |
1.59 |
C of intermediate quantities. |
612 |
cnh |
1.63 |
C afFacMom :: Advection of momentum term tracer parameter |
613 |
|
|
C vfFacMom :: Momentum viscosity tracer parameter |
614 |
|
|
C pfFacMom :: Momentum pressure forcing tracer parameter |
615 |
|
|
C cfFacMom :: Coriolis term tracer parameter |
616 |
|
|
C foFacMom :: Momentum forcing tracer parameter |
617 |
|
|
C mtFacMom :: Metric terms tracer parameter |
618 |
|
|
C cosPower :: Power of cosine of latitude to multiply viscosity |
619 |
|
|
C cAdjFreq :: Frequency of convective adjustment |
620 |
cnh |
1.24 |
C |
621 |
jmc |
1.214 |
C taveFreq :: Frequency with which time-averaged model state |
622 |
jmc |
1.76 |
C is written to post-processing files ( s ). |
623 |
jmc |
1.214 |
C tave_lastIter :: (for state variable only) fraction of the last time |
624 |
|
|
C step (of each taveFreq period) put in the time average. |
625 |
jmc |
1.76 |
C (fraction for 1rst iter = 1 - tave_lastIter) |
626 |
cnh |
1.63 |
C tauThetaClimRelax :: Relaxation to climatology time scale ( s ). |
627 |
|
|
C tauSaltClimRelax :: Relaxation to climatology time scale ( s ). |
628 |
jmc |
1.95 |
C latBandClimRelax :: latitude band where Relaxation to Clim. is applied, |
629 |
|
|
C i.e. where |yC| <= latBandClimRelax |
630 |
cnh |
1.63 |
C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month) |
631 |
|
|
C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year) |
632 |
adcroft |
1.19 |
C (note: externForcingCycle must be an integer |
633 |
|
|
C number times externForcingPeriod) |
634 |
jmc |
1.68 |
C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux |
635 |
|
|
C (use model surface (local) value if set to -1) |
636 |
jmc |
1.214 |
C temp_EvPrRn :: temperature of Rain & Evap. |
637 |
jmc |
1.68 |
C salt_EvPrRn :: salinity of Rain & Evap. |
638 |
jmc |
1.214 |
C (notes: a) tracer content of Rain/Evap only used if both |
639 |
jmc |
1.68 |
C NonLin_FrSurf & useRealFreshWater are set. |
640 |
|
|
C b) use model surface (local) value if set to UNSET_RL) |
641 |
jmc |
1.202 |
C hMixCrit :: criteria for mixed-layer diagnostic |
642 |
|
|
C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s] |
643 |
|
|
C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as |
644 |
|
|
C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel) |
645 |
jmc |
1.214 |
C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides) |
646 |
jmc |
1.169 |
C (default=2: full drag ; =1: gives half-slip BC) |
647 |
jmc |
1.184 |
C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s) |
648 |
|
|
C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m) |
649 |
|
|
C (if using zcoordinate, units becomes linear: m/s, quadratic: [-]) |
650 |
heimbach |
1.185 |
C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS |
651 |
|
|
C is to be replace by a smoother function |
652 |
|
|
C (affects myabs, mymin, mymax) |
653 |
jmc |
1.169 |
C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales |
654 |
|
|
C (i.e. allows convection at different Rayleigh numbers) |
655 |
mlosch |
1.212 |
C phiEuler :: Euler angle, rotation about original z-axis |
656 |
|
|
C thetaEuler :: Euler angle, rotation about new x-axis |
657 |
|
|
C psiEuler :: Euler angle, rotation about new z-axis |
658 |
jmc |
1.183 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit, |
659 |
adcroft |
1.52 |
& cg2dpcOffDFac, cg3dTargetResidual, |
660 |
jmc |
1.96 |
& delR, delRc, delX, delY, |
661 |
jmc |
1.139 |
& deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock, |
662 |
jmc |
1.154 |
& abEps, alph_AB, beta_AB, |
663 |
adcroft |
1.52 |
& phiMin, thetaMin, rSphere, recip_RSphere, f0, beta, |
664 |
baylor |
1.146 |
& viscAh, viscAhW, viscAhMax, |
665 |
|
|
& viscAhGrid, viscAhGridMax, viscAhGridMin, |
666 |
|
|
& viscC2leith, viscC2leithD, |
667 |
baylor |
1.165 |
& viscC2smag, viscC4smag, |
668 |
jmc |
1.135 |
& viscAhD, viscAhZ, viscA4D, viscA4Z, |
669 |
jmc |
1.214 |
& viscA4, viscA4W, viscA4Max, |
670 |
|
|
& viscA4Grid, viscA4GridMax, viscA4GridMin, |
671 |
|
|
& viscAhReMax, viscA4ReMax, |
672 |
baylor |
1.165 |
& viscC4leith, viscC4leithD, viscAr, |
673 |
dimitri |
1.199 |
& diffKhT, diffK4T, diffKrNrT, |
674 |
|
|
& diffKhS, diffK4S, diffKrNrS, |
675 |
adcroft |
1.112 |
& diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho, |
676 |
dimitri |
1.201 |
& BL79LatVary, |
677 |
dimitri |
1.200 |
& diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo, |
678 |
jmc |
1.48 |
& delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow, |
679 |
adcroft |
1.52 |
& hFacMin, hFacMinDz, hFacInf, hFacSup, |
680 |
jmc |
1.203 |
& gravity, recip_gravity, gBaro, |
681 |
jmc |
1.191 |
& rhonil, recip_rhonil, rhoConst, recip_rhoConst, |
682 |
|
|
& rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF, |
683 |
jmc |
1.204 |
& rhoConstFresh, tRef, sRef, phiRef, dBdrRef, |
684 |
jmc |
1.203 |
& rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass, |
685 |
jmc |
1.183 |
& baseTime, startTime, endTime, |
686 |
|
|
& chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq, |
687 |
heimbach |
1.143 |
& diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq, |
688 |
cnh |
1.15 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
689 |
jmc |
1.88 |
& cosPower, cAdjFreq, omega, rotationPeriod, |
690 |
jmc |
1.215 |
& tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax, |
691 |
cnh |
1.27 |
& externForcingCycle, externForcingPeriod, |
692 |
jmc |
1.137 |
& convertFW2Salt, temp_EvPrRn, salt_EvPrRn, |
693 |
jmc |
1.96 |
& hFacMinDr, hFacMinDp, |
694 |
jmc |
1.202 |
& ivdc_kappa, hMixCriteria, Ro_SeaLevel, |
695 |
jmc |
1.169 |
& sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2, |
696 |
jmc |
1.191 |
& smoothAbsFuncRange, |
697 |
mlosch |
1.212 |
& tCylIn, tCylOut, |
698 |
|
|
& phiEuler, thetaEuler, psiEuler |
699 |
cnh |
1.27 |
|
700 |
adcroft |
1.6 |
_RL cg2dTargetResidual |
701 |
adcroft |
1.52 |
_RL cg2dTargetResWunit |
702 |
cnh |
1.33 |
_RL cg3dTargetResidual |
703 |
cnh |
1.7 |
_RL cg2dpcOffDFac |
704 |
cnh |
1.25 |
_RL delR(Nr) |
705 |
jmc |
1.70 |
_RL delRc(Nr+1) |
706 |
adcroft |
1.6 |
_RL delX(Nx) |
707 |
|
|
_RL delY(Ny) |
708 |
|
|
_RL deltaT |
709 |
cnh |
1.7 |
_RL deltaTClock |
710 |
adcroft |
1.6 |
_RL deltaTmom |
711 |
jmc |
1.139 |
_RL dTtracerLev(Nr) |
712 |
adcroft |
1.72 |
_RL deltaTfreesurf |
713 |
jmc |
1.154 |
_RL abEps, alph_AB, beta_AB |
714 |
adcroft |
1.6 |
_RL phiMin |
715 |
|
|
_RL thetaMin |
716 |
|
|
_RL rSphere |
717 |
jmc |
1.191 |
_RL recip_rSphere |
718 |
adcroft |
1.6 |
_RL f0 |
719 |
cnh |
1.8 |
_RL freeSurfFac |
720 |
jmc |
1.48 |
_RL implicSurfPress |
721 |
|
|
_RL implicDiv2Dflow |
722 |
adcroft |
1.22 |
_RL hFacMin |
723 |
|
|
_RL hFacMinDz |
724 |
cnh |
1.28 |
_RL hFacMinDp |
725 |
cnh |
1.27 |
_RL hFacMinDr |
726 |
adcroft |
1.52 |
_RL hFacInf |
727 |
|
|
_RL hFacSup |
728 |
adcroft |
1.6 |
_RL beta |
729 |
jmc |
1.214 |
_RL viscAr |
730 |
adcroft |
1.6 |
_RL viscAh |
731 |
mlosch |
1.128 |
_RL viscAhW |
732 |
jmc |
1.135 |
_RL viscAhD |
733 |
|
|
_RL viscAhZ |
734 |
adcroft |
1.102 |
_RL viscAhMax |
735 |
baylor |
1.166 |
_RL viscAhReMax |
736 |
jmc |
1.214 |
_RL viscAhGrid, viscAhGridMax, viscAhGridMin |
737 |
adcroft |
1.110 |
_RL viscC2leith |
738 |
baylor |
1.146 |
_RL viscC2leithD |
739 |
baylor |
1.147 |
_RL viscC2smag |
740 |
jmc |
1.183 |
_RL viscA4 |
741 |
mlosch |
1.140 |
_RL viscA4W |
742 |
jmc |
1.135 |
_RL viscA4D |
743 |
|
|
_RL viscA4Z |
744 |
adcroft |
1.102 |
_RL viscA4Max |
745 |
baylor |
1.166 |
_RL viscA4ReMax |
746 |
dimitri |
1.136 |
_RL viscA4Grid, viscA4GridMax, viscA4GridMin |
747 |
adcroft |
1.110 |
_RL viscC4leith |
748 |
baylor |
1.146 |
_RL viscC4leithD |
749 |
jmc |
1.214 |
_RL viscC4smag |
750 |
jmc |
1.183 |
_RL diffKhT |
751 |
jmc |
1.132 |
_RL diffKrNrT(Nr) |
752 |
jmc |
1.183 |
_RL diffK4T |
753 |
|
|
_RL diffKhS |
754 |
jmc |
1.132 |
_RL diffKrNrS(Nr) |
755 |
jmc |
1.183 |
_RL diffK4S |
756 |
adcroft |
1.112 |
_RL diffKrBL79surf |
757 |
|
|
_RL diffKrBL79deep |
758 |
|
|
_RL diffKrBL79scl |
759 |
|
|
_RL diffKrBL79Ho |
760 |
dimitri |
1.201 |
_RL BL79LatVary |
761 |
dimitri |
1.200 |
_RL diffKrBLEQsurf |
762 |
|
|
_RL diffKrBLEQdeep |
763 |
|
|
_RL diffKrBLEQscl |
764 |
|
|
_RL diffKrBLEQHo |
765 |
adcroft |
1.6 |
_RL delt |
766 |
|
|
_RL tauCD |
767 |
|
|
_RL rCD |
768 |
|
|
_RL gravity |
769 |
cnh |
1.32 |
_RL recip_gravity |
770 |
cnh |
1.8 |
_RL gBaro |
771 |
jmc |
1.191 |
_RL rhonil, recip_rhonil |
772 |
|
|
_RL rhoConst, recip_rhoConst |
773 |
|
|
_RL rhoFacC(Nr), recip_rhoFacC(Nr) |
774 |
|
|
_RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1) |
775 |
mlosch |
1.75 |
_RL rhoConstFresh |
776 |
cnh |
1.25 |
_RL tRef(Nr) |
777 |
|
|
_RL sRef(Nr) |
778 |
jmc |
1.171 |
_RL phiRef(2*Nr+1) |
779 |
jmc |
1.173 |
_RL dBdrRef(Nr) |
780 |
jmc |
1.197 |
_RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1) |
781 |
jmc |
1.203 |
_RL mass2rUnit, rUnit2mass |
782 |
jmc |
1.150 |
_RL baseTime |
783 |
adcroft |
1.6 |
_RL startTime |
784 |
|
|
_RL endTime |
785 |
|
|
_RL chkPtFreq |
786 |
cnh |
1.7 |
_RL pChkPtFreq |
787 |
adcroft |
1.6 |
_RL dumpFreq |
788 |
heimbach |
1.103 |
_RL adjDumpFreq |
789 |
adcroft |
1.59 |
_RL diagFreq |
790 |
adcroft |
1.20 |
_RL taveFreq |
791 |
jmc |
1.76 |
_RL tave_lastIter |
792 |
adcroft |
1.53 |
_RL monitorFreq |
793 |
heimbach |
1.143 |
_RL adjMonitorFreq |
794 |
cnh |
1.9 |
_RL afFacMom |
795 |
|
|
_RL vfFacMom |
796 |
|
|
_RL pfFacMom |
797 |
|
|
_RL cfFacMom |
798 |
|
|
_RL foFacMom |
799 |
jmc |
1.182 |
_RL mtFacMom |
800 |
adcroft |
1.39 |
_RL cosPower |
801 |
cnh |
1.9 |
_RL cAdjFreq |
802 |
cnh |
1.15 |
_RL omega |
803 |
jmc |
1.88 |
_RL rotationPeriod |
804 |
cnh |
1.18 |
_RL tauThetaClimRelax |
805 |
|
|
_RL tauSaltClimRelax |
806 |
jmc |
1.95 |
_RL latBandClimRelax |
807 |
adcroft |
1.19 |
_RL externForcingCycle |
808 |
|
|
_RL externForcingPeriod |
809 |
jmc |
1.68 |
_RL convertFW2Salt |
810 |
|
|
_RL temp_EvPrRn |
811 |
|
|
_RL salt_EvPrRn |
812 |
adcroft |
1.41 |
_RL ivdc_kappa |
813 |
jmc |
1.202 |
_RL hMixCriteria |
814 |
adcroft |
1.46 |
_RL Ro_SeaLevel |
815 |
jmc |
1.169 |
_RL sideDragFactor |
816 |
adcroft |
1.46 |
_RL bottomDragLinear |
817 |
|
|
_RL bottomDragQuadratic |
818 |
heimbach |
1.185 |
_RL smoothAbsFuncRange |
819 |
jmc |
1.169 |
_RL nh_Am2 |
820 |
afe |
1.142 |
_RL tCylIn |
821 |
|
|
_RL tCylOut |
822 |
mlosch |
1.212 |
_RL phiEuler, thetaEuler, psiEuler |
823 |
adcroft |
1.6 |
|
824 |
jmc |
1.91 |
C-- COMMON /PARM_A/ Thermodynamics constants ? |
825 |
|
|
COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp |
826 |
adcroft |
1.6 |
_RL HeatCapacity_Cp |
827 |
adcroft |
1.36 |
_RL recip_Cp |
828 |
jmc |
1.55 |
|
829 |
jmc |
1.91 |
C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...) |
830 |
|
|
C celsius2K :: convert centigrade (Celsius) degree to Kelvin |
831 |
jmc |
1.83 |
C atm_Po :: standard reference pressure |
832 |
|
|
C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure |
833 |
|
|
C atm_Rd :: gas constant for dry air |
834 |
cnh |
1.63 |
C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS) |
835 |
jmc |
1.94 |
C atm_Rq :: water vapour specific volume anomaly relative to dry air |
836 |
|
|
C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg]) |
837 |
jmc |
1.83 |
C integr_GeoPot :: option to select the way we integrate the geopotential |
838 |
jmc |
1.214 |
C (still a subject of discussions ...) |
839 |
jmc |
1.83 |
C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is |
840 |
|
|
C derived from the orography. Implemented: 0,1 (see INI_P_GROUND) |
841 |
jmc |
1.183 |
COMMON /PARM_ATM/ |
842 |
jmc |
1.91 |
& celsius2K, |
843 |
jmc |
1.94 |
& atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po, |
844 |
jmc |
1.91 |
& integr_GeoPot, selectFindRoSurf |
845 |
|
|
_RL celsius2K |
846 |
jmc |
1.94 |
_RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq |
847 |
jmc |
1.83 |
INTEGER integr_GeoPot, selectFindRoSurf |
848 |
cnh |
1.7 |
|
849 |
adcroft |
1.44 |
C Logical flags for selecting packages |
850 |
mlosch |
1.126 |
LOGICAL useOPPS |
851 |
mlosch |
1.121 |
LOGICAL usePP81 |
852 |
|
|
LOGICAL useMY82 |
853 |
mlosch |
1.126 |
LOGICAL useGGL90 |
854 |
heimbach |
1.45 |
LOGICAL useKPP |
855 |
jmc |
1.196 |
LOGICAL useGAD |
856 |
heimbach |
1.45 |
LOGICAL useGMRedi |
857 |
adcroft |
1.46 |
LOGICAL useOBCS |
858 |
jmc |
1.49 |
LOGICAL useAIM |
859 |
jmc |
1.91 |
LOGICAL useLand |
860 |
jmc |
1.183 |
LOGICAL useCAL |
861 |
|
|
LOGICAL useEXF |
862 |
|
|
LOGICAL useEBM |
863 |
heimbach |
1.56 |
LOGICAL useGrdchk |
864 |
heimbach |
1.45 |
LOGICAL useECCO |
865 |
adcroft |
1.52 |
LOGICAL useSHAP_FILT |
866 |
jmc |
1.67 |
LOGICAL useZONAL_FILT |
867 |
adcroft |
1.62 |
LOGICAL useFLT |
868 |
adcroft |
1.69 |
LOGICAL usePTRACERS |
869 |
mlosch |
1.138 |
LOGICAL useGCHEM |
870 |
stephd |
1.172 |
LOGICAL useRBCS |
871 |
jmc |
1.181 |
LOGICAL useOffLine |
872 |
jmc |
1.183 |
LOGICAL useMATRIX |
873 |
dimitri |
1.86 |
LOGICAL useSBO |
874 |
heimbach |
1.80 |
LOGICAL useSEAICE |
875 |
mlosch |
1.176 |
LOGICAL useShelfIce |
876 |
jmc |
1.183 |
LOGICAL useThSIce |
877 |
jscott |
1.190 |
LOGICAL useATM2d |
878 |
jmc |
1.98 |
LOGICAL useBulkForce |
879 |
molod |
1.99 |
LOGICAL usefizhi |
880 |
|
|
LOGICAL usegridalt |
881 |
jmc |
1.179 |
LOGICAL useDiagnostics |
882 |
edhill |
1.130 |
LOGICAL useMNC |
883 |
edhill |
1.189 |
LOGICAL useREGRID |
884 |
adcroft |
1.158 |
LOGICAL useRunClock |
885 |
edhill |
1.175 |
LOGICAL useEMBED_FILES |
886 |
heimbach |
1.187 |
LOGICAL useMYPACKAGE |
887 |
dimitri |
1.209 |
LOGICAL useSALT_PLUME |
888 |
jmc |
1.219 |
LOGICAL useCheapAML |
889 |
adcroft |
1.44 |
COMMON /PARM_PACKAGES/ |
890 |
jmc |
1.183 |
& useOPPS, usePP81, useMY82, useGGL90, useKPP, |
891 |
jmc |
1.196 |
& useGAD, useGMRedi, useOBCS, useAIM, useLand, |
892 |
jmc |
1.183 |
& useCAL, useEXF, useEBM, useGrdchk, useECCO, |
893 |
|
|
& useSHAP_FILT, useZONAL_FILT, useFLT, |
894 |
|
|
& usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX, |
895 |
jmc |
1.191 |
& useSBO, useSEAICE, useShelfIce, |
896 |
jscott |
1.190 |
& useThSIce, useATM2D, useBulkForce, |
897 |
edhill |
1.189 |
& usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID, |
898 |
jmc |
1.219 |
& useRunClock, useEMBED_FILES, useSALT_PLUME, useCheapAML, |
899 |
|
|
& useMYPACKAGE |
900 |
edhill |
1.105 |
CEH3 ;;; Local Variables: *** |
901 |
|
|
CEH3 ;;; mode:fortran *** |
902 |
|
|
CEH3 ;;; End: *** |