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