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

Legend:
Removed from v.1.65.4.4  
changed lines
  Added in v.1.200

  ViewVC Help
Powered by ViewVC 1.1.22