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

Legend:
Removed from v.1.65  
changed lines
  Added in v.1.214

  ViewVC Help
Powered by ViewVC 1.1.22