/[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.211 by jmc, Mon Jan 7 23:44:39 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
18    #include "PARAMS_MACROS.h"
19    
20  C--   Contants  C--   Contants
21  C     Useful physical values  C     Useful physical values
# Line 17  C     Useful physical values Line 25  C     Useful physical values
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
27  C     Symbolic values  C     Symbolic values
28  C     precXXXX - Used to indicate what precision to use for  C     precXXXX :: Used to indicate what precision to use for
29  C                dumping model state.  C                dumping model state.
30        INTEGER precFloat32        INTEGER precFloat32
31        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
32        INTEGER precFloat64        INTEGER precFloat64
33        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 64 )
34    C     UNSET_xxx :: Used to indicate variables that have not been given a value
35  C     Checkpoint data        Real*8 UNSET_FLOAT8
36        INTEGER maxNoChkptLev        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
37        PARAMETER ( maxNoChkptLev = 2 )        Real*4 UNSET_FLOAT4
38          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
39          _RL    UNSET_RL
40          PARAMETER ( UNSET_RL     = 1.234567D5 )
41          _RS    UNSET_RS
42          PARAMETER ( UNSET_RS     = 1.234567E5 )
43          INTEGER UNSET_I
44          PARAMETER ( UNSET_I      = 123456789  )
45    
46  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
47  C     checkPtSuff - List of checkpoint file suffices  C     buoyancyRelation :: Flag used to indicate which relation to use to
48        COMMON /PARM_C/ checkPtSuff  C                         get buoyancy.
49        CHARACTER*(5) checkPtSuff(maxNoChkptLev)  C     eosType         :: choose the equation of state:
50    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
51    C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
52    C                        and read pickup files with this suffix (max 10 Char.)
53    C     mdsioLocalDir   :: read-write tiled file from/to this directory name
54    C                        (+ 4 digits Processor-Rank) instead of current dir.
55    C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
56    C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
57    C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
58    C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
59    C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
60    C     delXFile      :: File containing X-spacing grid definition (1.D array)
61    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
62    C     horizGridFile :: File containing horizontal-grid definition
63    C                        (only when using curvilinear_grid)
64    C     bathyFile       :: File containing bathymetry. If not defined bathymetry
65    C                        is taken from inline function.
66    C     topoFile        :: File containing the topography of the surface (unit=m)
67    C                        (mainly used for the atmosphere = ground height).
68    C     shelfIceFile    :: File containing the topography of the shelfice draught
69    C                        (unit=m)
70    C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
71    C                        for potential temperature.
72    C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
73    C                        for salinity.
74    C     diffKrFile      :: File containing 3D specification of vertical diffusivity
75    C     zonalWindFile   :: File containing zonal wind data
76    C     meridWindFile   :: File containing meridional wind data
77    C     thetaClimFile   :: File containing surface theta climataology used
78    C                       in relaxation term -lambda(theta-theta*)
79    C     saltClimFile    :: File containing surface salt climataology used
80    C                       in relaxation term -lambda(salt-salt*)
81    C     surfQfile       :: File containing surface heat flux, excluding SW
82    C                        (old version, kept for backward compatibility)
83    C     surfQnetFile    :: File containing surface net heat flux
84    C     surfQswFile     :: File containing surface shortwave radiation
85    C     dQdTfile        :: File containing thermal relaxation coefficient
86    C     EmPmRfile       :: File containing surface fresh water flux
87    C           NOTE: for backward compatibility EmPmRfile is specified in
88    C                 m/s when using external_fields_load.F.  It is converted
89    C                 to kg/m2/s by multiplying by rhoConstFresh.
90    C     saltFluxFile    :: File containing surface salt flux
91    C     pLoadFile       :: File containing pressure loading
92    C     eddyTauxFile    :: File containing zonal Eddy stress data
93    C     eddyTauyFile    :: File containing meridional Eddy stress data
94    C     the_run_name    :: string identifying the name of the model "run"
95          COMMON /PARM_C/
96         &                buoyancyRelation, eosType,
97         &                pickupSuff, mdsioLocalDir,
98         &                tRefFile, sRefFile, rhoRefFile,
99         &                delRFile, delRcFile,
100         &                delXFile, delYFile, horizGridFile,
101         &                bathyFile, topoFile, shelfIceFile,
102         &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
103         &                zonalWindFile, meridWindFile, thetaClimFile,
104         &                saltClimFile,
105         &                EmPmRfile, saltFluxFile,
106         &                surfQfile, surfQnetFile, surfQswFile,
107         &                lambdaThetaFile, lambdaSaltFile,
108         &                uVelInitFile, vVelInitFile, pSurfInitFile,
109         &                dQdTfile, ploadFile,
110         &                eddyTauxFile, eddyTauyFile,
111         &                the_run_name
112          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
113          CHARACTER*(6)  eosType
114          CHARACTER*(10) pickupSuff
115          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
116          CHARACTER*(MAX_LEN_FNAM) tRefFile
117          CHARACTER*(MAX_LEN_FNAM) sRefFile
118          CHARACTER*(MAX_LEN_FNAM) rhoRefFile
119          CHARACTER*(MAX_LEN_FNAM) delRFile
120          CHARACTER*(MAX_LEN_FNAM) delRcFile
121          CHARACTER*(MAX_LEN_FNAM) delXFile
122          CHARACTER*(MAX_LEN_FNAM) delYFile
123          CHARACTER*(MAX_LEN_FNAM) horizGridFile
124          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
125          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
126          CHARACTER*(MAX_LEN_FNAM) diffKrFile
127          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
128          CHARACTER*(MAX_LEN_FNAM) meridWindFile
129          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
130          CHARACTER*(MAX_LEN_FNAM) saltClimFile
131          CHARACTER*(MAX_LEN_FNAM) surfQfile
132          CHARACTER*(MAX_LEN_FNAM) surfQnetFile
133          CHARACTER*(MAX_LEN_FNAM) surfQswFile
134          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
135          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
136          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
137          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
138          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
139          CHARACTER*(MAX_LEN_FNAM) dQdTfile
140          CHARACTER*(MAX_LEN_FNAM) ploadFile
141          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
142          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
143          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
144          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
145          CHARACTER*(MAX_LEN_PREC/2) the_run_name
146    
147  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
148  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
149  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
150  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
151  C                           in con. grad solver.  C                           in con. grad solver.
152  C     nIter0              - Start time-step number of for this run  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
153  C     nTimeSteps          - Number of timesteps to execute  C                            (non-linear free-surf.)
154  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     cg3dMaxIters        :: Maximum number of iterations in the
155  C                           of flow fields.  C                           three-dimensional con. grad solver.
156  C     writeStatePrec      - Precision used for writing model state.  C     cg3dChkResFreq      :: Frequency with which to check residual
157  C     writeBinaryPrec     - Precision used for writing binary files  C                           in con. grad solver.
158  C     readBinaryPrec      - Precision used for reading binary files  C     nIter0              :: Start time-step number of for this run
159  C     nCheckLev           - Holds current checkpoint level  C     nTimeSteps          :: Number of timesteps to execute
160    C     writeStatePrec      :: Precision used for writing model state.
161    C     writeBinaryPrec     :: Precision used for writing binary files
162    C     readBinaryPrec      :: Precision used for reading binary files
163    C     nonlinFreeSurf      :: option related to non-linear free surface
164    C                           =0 Linear free surface ; >0 Non-linear
165    C     select_rStar        :: option related to r* vertical coordinate
166    C                           =0 (default) use r coord. ; > 0 use r*
167    C     momForcingOutAB     :: =1: take momentum forcing contribution
168    C                           out of (=0: in) Adams-Bashforth time stepping.
169    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
170    C                           out of (=0: in) Adams-Bashforth time stepping.
171    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
172    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
173    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
174    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
175    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
176    C     monitorSelect       :: select group of variables to monitor
177    C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
178    C     debugLevel          :: debug level selector: higher -> more writing
179    
180        COMMON /PARM_I/        COMMON /PARM_I/
181       &        cg2dMaxIters,       &        cg2dMaxIters,
182       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
183       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
184       &        numStepsPerPickup,       &        cg3dChkResFreq,
185       &        writeStatePrec, nCheckLev,       &        nIter0, nTimeSteps, nEndIter,
186       &        writeBinaryPrec, readBinaryPrec       &        writeStatePrec,
187         &        writeBinaryPrec, readBinaryPrec,
188         &        nonlinFreeSurf, select_rStar,
189         &        momForcingOutAB, tracForcingOutAB,
190         &        tempAdvScheme, tempVertAdvScheme,
191         &        saltAdvScheme, saltVertAdvScheme,
192         &        selectKEscheme,
193         &        monitorSelect, debugLevel
194        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
195        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
196          INTEGER cg2dPreCondFreq
197          INTEGER cg3dMaxIters
198          INTEGER cg3dChkResFreq
199        INTEGER nIter0        INTEGER nIter0
200        INTEGER nTimeSteps        INTEGER nTimeSteps
201        INTEGER numStepsPerPickup        INTEGER nEndIter
202        INTEGER writeStatePrec        INTEGER writeStatePrec
203        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
204        INTEGER readBinaryPrec        INTEGER readBinaryPrec
205        INTEGER nCheckLev        INTEGER nonlinFreeSurf
206          INTEGER select_rStar
207          INTEGER momForcingOutAB, tracForcingOutAB
208          INTEGER tempAdvScheme, tempVertAdvScheme
209          INTEGER saltAdvScheme, saltVertAdvScheme
210          INTEGER selectKEscheme
211          INTEGER monitorSelect
212          INTEGER debugLevel
213    
214    C
215          INTEGER debLevZero
216          PARAMETER(debLevZero=0)
217          INTEGER debLevA
218          PARAMETER(debLevA=1)
219          INTEGER debLevB
220          PARAMETER(debLevB=2)
221    
222  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
223  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
224  C                          coordinate frame.  C                          coordinate frame.
225  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
226  C                               spherical polar frame.  C                               spherical polar frame.
227  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
228  C     momAdvection  - Flag which turns advection of momentum on and off.  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
229  C     momForcing    - Flag which turns external forcing of momentum on  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
230    C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
231    C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
232    C     momViscosity  :: Flag which turns momentum friction terms on and off.
233    C     momAdvection  :: Flag which turns advection of momentum on and off.
234    C     momForcing    :: Flag which turns external forcing of momentum on
235  C                     and off.  C                     and off.
236  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
237  C                          on and off.  C                          on and off.
238  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     metricTerms   :: Flag which turns metric terms on or off.
239  C     tempDiffusion - Flag which turns diffusion of temperature on  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
240  C                     and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
241  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
242  C                     and off.  C                     and off.
243  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
244  C                     and off.  C                     and off.
245  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
246  C                     and off.  C                     and off.
247  C     saltAdvection - Flag which turns advection of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
248  C                     and off.  C                     and off.
249  C     saltForcing   - Flag which turns external forcing of salinit on  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
250  C                     and off.  C                         as a real Fresh Water (=> changes the Sea Level)
251  C     implicitFreeSurface - Set to true to use implcit free surface  C                         if F, converts P+R-E to salt flux (no SL effect)
252  C     rigidLid            - Set to true to use rigid lid  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
253  C     momStepping   - Turns momentum equation time-stepping off  C                       on irregular grids)
254  C     momStepping   - Turns temperature equation time-stepping off  C     useAreaViscLength :: Set to true to use old scaling for viscous
255    C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
256    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
257    C     rigidLid            :: Set to true to use rigid lid
258    C     implicitFreeSurface :: Set to true to use implicit free surface
259    C     exactConserv        :: Set to true to conserve exactly the total Volume
260    C     linFSConserveTr     :: Set to true to correct source/sink of tracer
261    C                            at the surface due to Linear Free Surface
262    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
263    C                           linear relation Phi_surf = Bo_surf*eta
264    C     use3Dsolver   :: set to true to use 3-D pressure solver
265    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
266    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
267    C     momStepping   :: Turns momentum equation time-stepping off
268    C     tempStepping  :: Turns temperature equation time-stepping off
269    C     saltStepping  :: Turns salinity equation time-stepping off
270    C     useConstantF  :: Coriolis parameter set to f0
271    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
272    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
273    C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
274    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
275    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
276    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
277    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
278    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
279    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
280    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
281    C     useAbsVorticity :: work with f+zeta in Coriolis terms
282    C     implicitDiffusion :: Turns implicit vertical diffusion on
283    C     implicitViscosity :: Turns implicit vertical viscosity on
284    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
285    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
286    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
287    C     multiDimAdvection :: Flag that enable multi-dimension advection
288    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
289    C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
290    C                          out off Adams-Bashforth time stepping.
291    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
292    C                          apply AB on tracer tendencies (rather than on Tracer)
293    C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
294    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
295    C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
296    C                           before checkpoint-54a, Jul 06, 2004.
297    C     doThetaClimRelax :: Set true if relaxation to temperature
298    C                        climatology is required.
299    C     doSaltClimRelax  :: Set true if relaxation to salinity
300    C                        climatology is required.
301    C     periodicExternalForcing :: Set true if forcing is time-dependant
302    C     usingPCoords     :: Set to indicate that we are working in a pressure
303    C                        type coordinate (p or p*).
304    C     usingZCoords     :: Set to indicate that we are working in a height
305    C                        type coordinate (z or z*)
306    C     fluidIsAir       :: Set to indicate that the fluid major constituent
307    C                        is air
308    C     fluidIsWater     :: Set to indicate that the fluid major constituent
309    C                        is water
310    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
311    C                         this requires specific code for restart & exchange
312    C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
313    C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
314    C     nonHydrostatic :: Using non-hydrostatic terms
315    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
316    C     globalFiles    :: Selects between "global" and "tiled" files
317    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
318    C                       slow (f77) or does not work (f90).  When
319    C                       useSingleCpuIO is set, mdsio_writefield.F
320    C                       outputs from master mpi process only.
321    C     allowFreezing  :: Allows surface water to freeze and form ice
322    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
323    C     pickup_write_mdsio :: use mdsio to write pickups
324    C     pickup_read_mdsio  :: use mdsio to read  pickups
325    C     pickup_write_immed :: echo the pickup immediately (for conversion)
326    C     timeave_mdsio      :: use mdsio for timeave output
327    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
328    C     monitor_stdio      :: use stdio for monitor output
329    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
330    C                        & Last iteration, in addition multiple of dumpFreq iter.
331    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
332    C     balanceQnet     :: substract global mean of Qnet at every time step
333    C     balancePrintMean:: print substracted global means to STDOUT
334    
335        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
336       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & usingCurvilinearGrid, usingCylindricalGrid,
337       & tempDiffusion, tempAdvection, tempForcing,       & deepAtmosphere, setInterFDr, setCenterDr,
338       & saltDiffusion, saltAdvection, saltForcing,       & no_slip_sides,no_slip_bottom,
339       & implicitFreeSurface, rigidLid, momStepping, tempStepping       & momViscosity, momAdvection, momForcing, useCoriolis,
340         & momPressureForcing, vectorInvariantMomentum,
341         & tempAdvection, tempForcing,
342         & saltAdvection, saltForcing,
343         & useRealFreshWaterFlux,
344         & useFullLeith, useStrainTensionVisc,
345         & useAreaViscLength,
346         & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
347         & uniformLin_PhiSurf,
348         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
349         & momStepping, tempStepping, saltStepping,
350         & metricTerms, useNHMTerms,
351         & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,
352         & useCDscheme,
353         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
354         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
355         & useAbsVorticity, upwindShear,
356         & implicitDiffusion, implicitViscosity,
357         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
358         & multiDimAdvection, useMultiDimAdvec,
359         & momDissip_In_AB, doAB_onGtGs,
360         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
361         & periodicExternalForcing,
362         & fluidIsAir, fluidIsWater,
363         & usingPCoords, usingZCoords, useDynP_inEos_Zc,
364         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
365         & allowFreezing, useOldFreezing,
366         & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
367         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
368         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
369         & outputTypesInclusive, dumpInitAndLast, debugMode,
370         & inAdMode, inAdTrue, inAdFalse, inAdExact,
371         & balanceEmPmR, balanceQnet, balancePrintMean
372    
373        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
374        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
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 tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
391        LOGICAL saltAdvection        LOGICAL saltAdvection
392        LOGICAL saltForcing        LOGICAL saltForcing
393        LOGICAL implicitFreeSurface        LOGICAL useRealFreshWaterFlux
394          LOGICAL useFullLeith
395          LOGICAL useStrainTensionVisc
396          LOGICAL useAreaViscLength
397        LOGICAL rigidLid        LOGICAL rigidLid
398          LOGICAL implicitFreeSurface
399          LOGICAL exactConserv
400          LOGICAL linFSConserveTr
401          LOGICAL uniformLin_PhiSurf
402          LOGICAL use3Dsolver
403          LOGICAL implicitIntGravWave
404          LOGICAL staggerTimeStep
405        LOGICAL momStepping        LOGICAL momStepping
406        LOGICAL tempStepping        LOGICAL tempStepping
407          LOGICAL saltStepping
408          LOGICAL metricTerms
409          LOGICAL useConstantF
410          LOGICAL useBetaPlaneF
411          LOGICAL useSphereF
412          LOGICAL use3dCoriolis
413          LOGICAL useCDscheme
414          LOGICAL useEnergyConservingCoriolis
415          LOGICAL useJamartWetPoints
416          LOGICAL useJamartMomAdv
417          LOGICAL SadournyCoriolis
418          LOGICAL upwindVorticity
419          LOGICAL highOrderVorticity
420          LOGICAL useAbsVorticity
421          LOGICAL upwindShear
422          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 doThetaClimRelax
432          LOGICAL doSaltClimRelax
433          LOGICAL doTr1ClimRelax
434          LOGICAL periodicExternalForcing
435          LOGICAL fluidIsAir
436          LOGICAL fluidIsWater
437          LOGICAL usingPCoords
438          LOGICAL usingZCoords
439          LOGICAL useDynP_inEos_Zc
440          LOGICAL nonHydrostatic
441          LOGICAL quasiHydrostatic
442          LOGICAL globalFiles
443          LOGICAL useSingleCpuIO
444          LOGICAL allowFreezing
445          LOGICAL useOldFreezing
446          LOGICAL pickupStrictlyMatch
447          LOGICAL usePickupBeforeC54
448          LOGICAL startFromPickupAB2
449          LOGICAL dumpInitAndLast
450          LOGICAL debugMode
451          LOGICAL pickup_read_mdsio, pickup_write_mdsio
452          LOGICAL pickup_write_immed
453          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
454          LOGICAL outputTypesInclusive
455          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
456    
457          LOGICAL balanceEmPmR
458          LOGICAL balanceQnet
459          LOGICAL balancePrintMean
460    
461  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
462  C     cg2dTargetResidual  C     cg2dTargetResidual
463  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
464  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
465    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
466    C     cg3dTargetResidual
467    C               :: Target residual for cg3d solver.
468    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
469  C     Note. 20th May 1998  C     Note. 20th May 1998
470  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
471  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 479  C           number of iterations for con
479  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
480  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
481  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
482  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delR      :: Vertical grid spacing ( units of r ).
483  C                 between "w" surfaces.  C     delRc     :: Vertical grid spacing between cell centers (r unit).
484  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
485  C     delY        on input flags.  C     delY        on input flags.
486  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
487  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     recip_gravity and its inverse
488  C     ronil     - Reference density  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
489  C     startTime - Start time for model ( s )  C     rhoNil    :: Reference density for the linear equation of state
490  C     phiMin    - Latitude of southern most cell face.  C     rhoConst  :: Vertically constant reference density
491  C     thetaMin  - Longitude of western most cell face (this  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
492    C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
493    C     rhoConstFresh :: Constant reference density for fresh water (rain)
494    C     tRef      :: reference vertical profile for potential temperature
495    C     sRef      :: reference vertical profile for salinity/specific humidity
496    C     phiRef    :: reference potential (pressure/rho, geopotential) profile
497    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
498    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
499    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
500    C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
501    C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
502    C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
503    C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
504    C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
505    C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
506    C     mass2rUnit :: units conversion factor (surface forcing),
507    C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
508    C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
509    C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
510    C     rUnit2mass :: units conversion factor (surface forcing),
511    C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
512    C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
513    C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
514    C     phiMin    :: Latitude of southern most cell face.
515    C     thetaMin  :: Longitude of western most cell face (this
516  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
517  C                 to make geographical references simple.)  C                 to make geographical references simple.)
518  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
519  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
520    C     f0        :: Reference coriolis parameter ( 1/s )
521  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
522  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
523  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
524    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
525    C     viscAh    :: Eddy viscosity coeff. for mixing of
526  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
527  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
528  C                 momentum vertically ( m^2/s )  C                 momentum laterally, no effect for hydrostatic
529  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C                 model, defaults to viscAh if unset ( m^2/s )
530    C                 Not used if variable horiz. viscosity is used.
531    C     viscAr    :: Eddy viscosity coeff. for mixing of
532    C                 momentum vertically ( units of r^2/s )
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     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)
550    C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)
551    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
552    C                   momentum laterally ( m^2/s )
553    C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
554    C                   coeff. for mixing of momentum laterally (non-dim)
555    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
556    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
557    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
558  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
559  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     viscA4ReMax :: Maximum Gridscale Reynolds number for
560    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
561    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
562    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
563    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
564    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
565    C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
566    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
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     hMixCrit    :: criteria for mixed-layer diagnostic
656    C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
657    C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
658    C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
659    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
660    C                           (default=2: full drag ; =1: gives half-slip BC)
661    C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
662    C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
663    C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
664    C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
665    C                           is to be replace by a smoother function
666    C                           (affects myabs, mymin, mymax)
667    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
668    C                      (i.e. allows convection at different Rayleigh numbers)
669          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
670         & cg2dpcOffDFac, cg3dTargetResidual,
671         & delR, delRc, delX, delY,
672         & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
673         & abEps, alph_AB, beta_AB,
674         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
675         & viscAh, viscAhW, viscAhMax,
676         & viscAhGrid, viscAhGridMax, viscAhGridMin,
677         & viscC2leith, viscC2leithD,
678         & viscC2smag, viscC4smag,
679         & viscAhD, viscAhZ, viscA4D, viscA4Z,
680         & viscA4, viscA4W,
681         & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
682         & viscAhRemax, viscA4Remax,
683         & viscC4leith, viscC4leithD, viscAr,
684         & diffKhT, diffK4T, diffKrNrT,
685         & diffKhS, diffK4S, diffKrNrS,
686         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
687         & BL79LatVary,
688         & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
689         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
690         & hFacMin, hFacMinDz, hFacInf, hFacSup,
691         & gravity, recip_gravity, gBaro,
692         & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
693         & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
694         & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
695         & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
696         & baseTime, startTime, endTime,
697         & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
698         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
699         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
700         & cosPower, cAdjFreq, omega, rotationPeriod,
701         & tauThetaClimRelax, tauSaltClimRelax,
702         & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
703         & externForcingCycle, externForcingPeriod,
704         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
705         & hFacMinDr, hFacMinDp,
706         & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
707         & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
708         & smoothAbsFuncRange,
709         & tCylIn, tCylOut
710    
711        _RL cg2dTargetResidual        _RL cg2dTargetResidual
712          _RL cg2dTargetResWunit
713          _RL cg3dTargetResidual
714        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
715        _RL delZ(Nz)        _RL delR(Nr)
716          _RL delRc(Nr+1)
717        _RL delX(Nx)        _RL delX(Nx)
718        _RL delY(Ny)        _RL delY(Ny)
719        _RL deltaT        _RL deltaT
720        _RL deltaTClock        _RL deltaTClock
721        _RL deltaTmom        _RL deltaTmom
722        _RL deltaTtracer        _RL dTtracerLev(Nr)
723        _RL abeps        _RL deltaTfreesurf
724          _RL abEps, alph_AB, beta_AB
725        _RL phiMin        _RL phiMin
726        _RL thetaMin        _RL thetaMin
727        _RL rSphere        _RL rSphere
728          _RL recip_rSphere
729        _RL f0        _RL f0
730        _RL freeSurfFac        _RL freeSurfFac
731          _RL implicSurfPress
732          _RL implicDiv2Dflow
733          _RL hFacMin
734          _RL hFacMinDz
735          _RL hFacMinDp
736          _RL hFacMinDr
737          _RL hFacInf
738          _RL hFacSup
739        _RL beta        _RL beta
740        _RL viscAh        _RL viscAh
741        _RL viscAz        _RL viscAhW
742        _RL viscA4        _RL viscAhD
743        _RL diffKhT        _RL viscAhZ
744        _RL diffKzT        _RL viscAhMax
745        _RL diffK4T        _RL viscAhReMax
746        _RL diffKhS        _RL viscAhGrid
747        _RL diffKzS        _RL viscAhGridMax
748        _RL diffK4S        _RL viscAhGridMin
749          _RL viscC2leith
750          _RL viscC2leithD
751          _RL viscC2smag
752          _RL viscC4smag
753          _RL viscAr
754          _RL viscA4
755          _RL viscA4W
756          _RL viscA4D
757          _RL viscA4Z
758          _RL viscA4Max
759          _RL viscA4ReMax
760          _RL viscA4Grid, viscA4GridMax, viscA4GridMin
761          _RL viscC4leith
762          _RL viscC4leithD
763          _RL diffKhT
764          _RL diffKrNrT(Nr)
765          _RL diffK4T
766          _RL diffKhS
767          _RL diffKrNrS(Nr)
768          _RL diffK4S
769          _RL diffKrBL79surf
770          _RL diffKrBL79deep
771          _RL diffKrBL79scl
772          _RL diffKrBL79Ho
773          _RL BL79LatVary
774          _RL diffKrBLEQsurf
775          _RL diffKrBLEQdeep
776          _RL diffKrBLEQscl
777          _RL diffKrBLEQHo
778        _RL delt        _RL delt
779        _RL tauCD        _RL tauCD
780        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
781        _RL gravity        _RL gravity
782          _RL recip_gravity
783        _RL gBaro        _RL gBaro
784        _RL rhonil        _RL rhonil,        recip_rhonil
785        _RL tRef(Nz)        _RL rhoConst,      recip_rhoConst
786        _RL sRef(Nz)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
787        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
788          _RL rhoConstFresh
789          _RL tRef(Nr)
790          _RL sRef(Nr)
791          _RL phiRef(2*Nr+1)
792          _RL dBdrRef(Nr)
793          _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
794          _RL mass2rUnit, rUnit2mass
795          _RL baseTime
796        _RL startTime        _RL startTime
797        _RL endTime        _RL endTime
798        _RL chkPtFreq        _RL chkPtFreq
799        _RL pChkPtFreq        _RL pChkPtFreq
800        _RL dumpFreq        _RL dumpFreq
801          _RL adjDumpFreq
802          _RL diagFreq
803          _RL taveFreq
804          _RL tave_lastIter
805          _RL monitorFreq
806          _RL adjMonitorFreq
807        _RL afFacMom        _RL afFacMom
808        _RL vfFacMom        _RL vfFacMom
809        _RL pfFacMom        _RL pfFacMom
810        _RL cfFacMom        _RL cfFacMom
811        _RL foFacMom        _RL foFacMom
812          _RL mtFacMom
813          _RL cosPower
814        _RL cAdjFreq        _RL cAdjFreq
815          _RL omega
816          _RL rotationPeriod
817          _RL tauThetaClimRelax
818          _RL tauSaltClimRelax
819          _RL tauTr1ClimRelax
820          _RL lambdaTr1ClimRelax
821          _RL latBandClimRelax
822          _RL externForcingCycle
823          _RL externForcingPeriod
824          _RL convertFW2Salt
825          _RL temp_EvPrRn
826          _RL salt_EvPrRn
827          _RL ivdc_kappa
828          _RL hMixCriteria
829          _RL Ro_SeaLevel
830          _RL sideDragFactor
831          _RL bottomDragLinear
832          _RL bottomDragQuadratic
833          _RL smoothAbsFuncRange
834          _RL nh_Am2
835          _RL tCylIn
836          _RL tCylOut
837    
838        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
839       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
840        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
841        _RL Lamba_theta        _RL recip_Cp
842    
843    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
844    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
845    C     atm_Po    :: standard reference pressure
846    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
847    C     atm_Rd    :: gas constant for dry air
848    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
849    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
850    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
851    C     integr_GeoPot :: option to select the way we integrate the geopotential
852    C                     (still a subject of discussions ...)
853    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
854    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
855          COMMON /PARM_ATM/
856         &            celsius2K,
857         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
858         &            integr_GeoPot, selectFindRoSurf
859          _RL celsius2K
860          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
861          INTEGER integr_GeoPot, selectFindRoSurf
862    
863  C Equation of State (polynomial coeffients)  C Logical flags for selecting packages
864        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        LOGICAL useOPPS
865        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        LOGICAL usePP81
866  C Linear equation of state        LOGICAL useMY82
867  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).        LOGICAL useGGL90
868  C     sBeta     - Linear EOS haline contraction coefficient.        LOGICAL useKPP
869        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType        LOGICAL useGAD
870        _RL tAlpha        LOGICAL useGMRedi
871        _RL sBeta        LOGICAL useOBCS
872        character*(6) eosType        LOGICAL useAIM
873          LOGICAL useLand
874          LOGICAL useCAL
875          LOGICAL useEXF
876          LOGICAL useEBM
877          LOGICAL useGrdchk
878          LOGICAL useECCO
879          LOGICAL useSHAP_FILT
880          LOGICAL useZONAL_FILT
881          LOGICAL useFLT
882          LOGICAL usePTRACERS
883          LOGICAL useGCHEM
884          LOGICAL useRBCS
885          LOGICAL useOffLine
886          LOGICAL useMATRIX
887          LOGICAL useSBO
888          LOGICAL useSEAICE
889          LOGICAL useShelfIce
890          LOGICAL useThSIce
891          LOGICAL useATM2d
892          LOGICAL useBulkForce
893          LOGICAL usefizhi
894          LOGICAL usegridalt
895          LOGICAL useDiagnostics
896          LOGICAL useMNC
897          LOGICAL useREGRID
898          LOGICAL useRunClock
899          LOGICAL useEMBED_FILES
900          LOGICAL useMYPACKAGE
901          LOGICAL useSALT_PLUME
902          COMMON /PARM_PACKAGES/
903         &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
904         &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
905         &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
906         &        useSHAP_FILT, useZONAL_FILT, useFLT,
907         &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
908         &        useSBO, useSEAICE, useShelfIce,
909         &        useThSIce, useATM2D, useBulkForce,
910         &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
911         &        useRunClock, useEMBED_FILES, useMYPACKAGE, useSALT_PLUME
912    
913    CEH3 ;;; Local Variables: ***
914    CEH3 ;;; mode:fortran ***
915    CEH3 ;;; End: ***

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

  ViewVC Help
Powered by ViewVC 1.1.22