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

Legend:
Removed from v.1.59  
changed lines
  Added in v.1.167

  ViewVC Help
Powered by ViewVC 1.1.22