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

Legend:
Removed from v.1.79  
changed lines
  Added in v.1.189

  ViewVC Help
Powered by ViewVC 1.1.22