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

Legend:
Removed from v.1.51  
changed lines
  Added in v.1.161

  ViewVC Help
Powered by ViewVC 1.1.22