/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

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