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

Legend:
Removed from v.1.49  
changed lines
  Added in v.1.176

  ViewVC Help
Powered by ViewVC 1.1.22