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

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.230

  ViewVC Help
Powered by ViewVC 1.1.22