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