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

Legend:
Removed from v.1.64  
changed lines
  Added in v.1.210

  ViewVC Help
Powered by ViewVC 1.1.22