/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.65 by adcroft, Fri Sep 28 03:25:15 2001 UTC revision 1.102 by adcroft, Sat Feb 7 16:27:13 2004 UTC
# Line 69  C     surfQfile       :: File containing Line 69  C     surfQfile       :: File containing
69  C     surfQswfile     :: File containing surface shortwave radiation  C     surfQswfile     :: File containing surface shortwave radiation
70  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
71  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
72    C     pLoadFile       :: File containing pressure loading
73  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
74  C                        get buoyancy.  C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
78       &                bathyFile, topoFile,       &                bathyFile, topoFile,
79       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
# Line 78  C                        get buoyancy. Line 81  C                        get buoyancy.
81       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
82       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
83       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
84       &                dQdTfile       &                dQdTfile, ploadFile,
85         &                eosType, pickupSuff,
86         &                mdsioLocalDir
87        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
88        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
89        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 95  C                        get buoyancy. Line 100  C                        get buoyancy.
100        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
101        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
102        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
103          CHARACTER*(MAX_LEN_FNAM) ploadFile
104          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
105          CHARACTER*(6) eosType
106          CHARACTER*(10) pickupSuff
107    
108  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
109  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 115  C     readBinaryPrec      :: Precision u Line 124  C     readBinaryPrec      :: Precision u
124  C     nCheckLev           :: Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
125  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
126  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
127    C     select_rStar        :: option related to r* vertical coordinate
128    C                           =0 (default) use r coord. ; > 0 use r*
129    
130        COMMON /PARM_I/        COMMON /PARM_I/
131       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 125  C                           =0 Linear fr Line 136  C                           =0 Linear fr
136       &        numStepsPerPickup,       &        numStepsPerPickup,
137       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
138       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
139       &        nonlinFreeSurf,       &        nonlinFreeSurf, select_rStar,
140       &        zonal_filt_sinpow, zonal_filt_cospow,       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme,
141       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme       &        debugLevel
142        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
143        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
144        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 141  C                           =0 Linear fr Line 152  C                           =0 Linear fr
152        INTEGER readBinaryPrec        INTEGER readBinaryPrec
153        INTEGER nCheckLev        INTEGER nCheckLev
154        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
155        INTEGER zonal_filt_sinpow        INTEGER select_rStar
       INTEGER zonal_filt_cospow  
156        INTEGER tempAdvScheme        INTEGER tempAdvScheme
157        INTEGER saltAdvScheme        INTEGER saltAdvScheme
158        INTEGER tracerAdvScheme        INTEGER tracerAdvScheme
159          INTEGER debugLevel
160    
161    C
162          INTEGER debLevZero
163          PARAMETER(debLevZero=0)
164          INTEGER debLevA
165          PARAMETER(debLevA=1)
166          INTEGER debLevB
167          PARAMETER(debLevB=2)
168    
169  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
170  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
# Line 163  C     momPressureForcing :: Flag which t Line 182  C     momPressureForcing :: Flag which t
182  C                          on and off.  C                          on and off.
183  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
184  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
185    C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
186  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
187  C     tempDiffusion :: Flag which turns diffusion of temperature on  C     tempDiffusion :: Flag which turns diffusion of temperature on
188  C                     and off.  C                     and off.
# Line 170  C     tempAdvection :: Flag which turns Line 190  C     tempAdvection :: Flag which turns
190  C                     and off.  C                     and off.
191  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
192  C                     and off.  C                     and off.
193  C     saltDiffusion :: Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
194  C                     and off.  C                     and off.
195  C     saltAdvection :: Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
196  C                     and off.  C                     and off.
197  C     saltForcing   :: Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
198  C                     and off.  C                     and off.
199    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
200    C                         as a real Fresh Water (=> changes the Sea Level)
201    C                         if F, converts P+R-E to salt flux (no SL effect)
202  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
203  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
204  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 188  C     tr1Stepping   :: Turns passive tra Line 211  C     tr1Stepping   :: Turns passive tra
211  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
212  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
213  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
214    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
215    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
216  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
217  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
218    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
219    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
220    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
221    C     multiDimAdvection :: Flag that enable multi-dimension advection
222    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
223    C                      out off Adams-Bashforth time stepping.
224  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
225  C                        climatology is required.  C                        climatology is required.
226  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
227  C                        climatology is required.  C                        climatology is required.
228  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
229  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in pressure
230  C                        coords.  C                        coords. (jmc: is it still used ?)
231  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
232  C                        coords.  C                        coords. (jmc: is it still used ?)
233    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
234    C                         this requires specific code for restart & exchange
235    C     setCenterDr    :: set cell Center depth and put Interface at the middle
236  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
237    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
238  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
239  C     allowFreezing  :: Allows water to freeze and form ice  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
240    C                       slow (f77) or does not work (f90).  When
241    C                       useSingleCpuIO is set, mdsio_writefield.F
242    C                       outputs from master mpi process only.
243    C     allowFreezing  :: Allows surface water to freeze and form ice
244    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
245  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
246        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
247       & usingCurvilinearGrid,       & usingCurvilinearGrid,
# Line 211  C     groundAtK1  :: put the surface(k=1 Line 251  C     groundAtK1  :: put the surface(k=1
251       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
252       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
253       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
254         & useRealFreshWaterFlux,
255       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
256       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
257       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
258       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
259         & useCDscheme,
260         & useEnergyConservingCoriolis, useJamartWetPoints,
261       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
262         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
263         & multiDimAdvection, forcing_In_AB,
264       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
265       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing,
266       & nonHydrostatic, globalFiles,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
267       & allowFreezing, groundAtK1,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
268         & allowFreezing, useOldFreezing, groundAtK1,
269       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, debugMode,
270       & readPickupWithTracer, writePickupWithTracer,       & readPickupWithTracer, writePickupWithTracer
      & multiDimAdvection, useEnergyConservingCoriolis  
271        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
272        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
273        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
274        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
275          LOGICAL useNHMTerms
276        LOGICAL no_slip_sides        LOGICAL no_slip_sides
277        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
278        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 242  C     groundAtK1  :: put the surface(k=1 Line 288  C     groundAtK1  :: put the surface(k=1
288        LOGICAL saltDiffusion        LOGICAL saltDiffusion
289        LOGICAL saltAdvection        LOGICAL saltAdvection
290        LOGICAL saltForcing        LOGICAL saltForcing
291          LOGICAL useRealFreshWaterFlux
292        LOGICAL rigidLid        LOGICAL rigidLid
293        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
294        LOGICAL exactConserv        LOGICAL exactConserv
# Line 254  C     groundAtK1  :: put the surface(k=1 Line 301  C     groundAtK1  :: put the surface(k=1
301        LOGICAL useConstantF        LOGICAL useConstantF
302        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
303        LOGICAL useSphereF        LOGICAL useSphereF
304          LOGICAL useCDscheme
305          LOGICAL useEnergyConservingCoriolis
306          LOGICAL useJamartWetPoints
307        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
308        LOGICAL implicitViscosity        LOGICAL implicitViscosity
309          LOGICAL tempImplVertAdv
310          LOGICAL saltImplVertAdv
311          LOGICAL momImplVertAdv
312          LOGICAL multiDimAdvection
313          LOGICAL forcing_In_AB
314        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
315        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
316        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
317        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
318        LOGICAL usingPCoords        LOGICAL usingPCoords
319        LOGICAL usingZCoords        LOGICAL usingZCoords
320          LOGICAL useDynP_inEos_Zc
321          LOGICAL setCenterDr
322        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
323          LOGICAL quasiHydrostatic
324        LOGICAL globalFiles        LOGICAL globalFiles
325          LOGICAL useSingleCpuIO
326        LOGICAL allowFreezing        LOGICAL allowFreezing
327          LOGICAL useOldFreezing
328        LOGICAL groundAtK1        LOGICAL groundAtK1
329        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
330        LOGICAL debugMode        LOGICAL debugMode
331        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
332        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
       LOGICAL multiDimAdvection  
       LOGICAL useEnergyConservingCoriolis  
333    
334  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
335  C     gg2dTargetResidual  C     gg2dTargetResidual
# Line 294  C           number of iterations for con Line 352  C           number of iterations for con
352  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
353  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
354  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  ).  
355  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
356    C     delRc     :: Vertical grid spacing between cell centers (r unit).
357  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
358  C     delY        on input flags.  C     delY        on input flags.
359  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
360  C     recip_gravity and its inverse  C     recip_gravity and its inverse
361  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 )
362  C     ronil     :: Reference density  C     rhoNil    :: Reference density for the linear equation of state
363  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
364    C     rhoConstFresh :: Constant reference density for fresh water (rain)
365  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
366  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
367  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 315  C     f0        :: Reference coriolis pa Line 373  C     f0        :: Reference coriolis pa
373  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
374  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
375  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
376    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
377  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
378  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
 C     viscAz    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( m^2/s )  
 C     viscAp    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( Pa^2/s )  
379  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
380  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
381  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
382  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
383    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
384    C                 momentum laterally ( m^2/s )
385    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
386    C                 momentum laterally ( m^4/s )
387    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
388    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
389  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
390  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKzT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( m^2/s )  
 C     diffKpT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( Pa^2/s )  
391  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
392  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
393  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
394  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
395  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
396  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKzS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( m^2/s )  
 C     diffKpS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( Pa^2/s )  
397  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
398  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
399  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
# Line 354  C                    Frequency of checkp Line 407  C                    Frequency of checkp
407  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
408  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
409  C     deltaTtracer :: Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
410    C     deltaTfreesurf :: Timestep for free-surface equation ( s )
411  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
412  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
413  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
# Line 386  C     mtFacMom      :: Metric terms trac Line 440  C     mtFacMom      :: Metric terms trac
440  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
441  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
442  C  C
443  C     taveFreq      :: Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state
444  C                     post-processing files ( s ).  C                      is written to post-processing files ( s ).
445    C     tave_lastIter :: (for state variable only) fraction of the last time
446    C                      step (of each taveFreq period) put in the time average.
447    C                      (fraction for 1rst iter = 1 - tave_lastIter)
448  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
449  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
450  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
451  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
452    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
453    C                         i.e. where |yC| <= latBandClimRelax
454  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
455  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
456  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
457  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
458    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
459    C                       (use model surface (local) value if set to -1)
460    C     temp_EvPrRn :: temperature of Rain & Evap.
461    C     salt_EvPrRn :: salinity of Rain & Evap.
462    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
463    C        (notes: a) tracer content of Rain/Evap only used if both
464    C                     NonLin_FrSurf & useRealFreshWater are set.
465    C                b) use model surface (local) value if set to UNSET_RL)
466  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
467  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
468  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
 C     latFFTFiltLo       :: Low latitude for FFT filtering of latitude  
 C                          circles ( see filter*.F )  
469  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
470  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
471  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
472  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
473        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
474       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
475       & delP, delZ, delR, delX, delY,       & delR, delRc, delX, delY,
476       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
477         & abeps, startTime,
478       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
479       & fCori, fCoriG,       & fCori, fCoriG, fCoriCos,
480       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh,  viscAhMax, viscAhGrid,
481       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscA4,  viscA4Max, viscA4Grid,
482       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAr, viscAstrain, viscAtension,
483         & diffKhT, diffK4T, diffKrT,
484         & diffKhS, diffK4S, diffKrS,
485       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
486       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
487       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
488       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst,
489         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
490       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
491       & diagFreq, taveFreq, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
492       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
493       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
494       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
495       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
496       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
497       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
498       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
499       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & hFacMinDr, hFacMinDp,
500       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,       & horiVertRatio, recip_horiVertRatio,
501         & ivdc_kappa, Ro_SeaLevel,
502       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic
503    
504        _RL cg2dTargetResidual        _RL cg2dTargetResidual
505        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
506        _RL cg3dTargetResidual        _RL cg3dTargetResidual
507        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
508        _RL delR(Nr)        _RL delR(Nr)
509          _RL delRc(Nr+1)
510        _RL delX(Nx)        _RL delX(Nx)
511        _RL delY(Ny)        _RL delY(Ny)
512        _RL deltaT        _RL deltaT
513        _RL deltaTClock        _RL deltaTClock
514        _RL deltaTmom        _RL deltaTmom
515        _RL deltaTtracer        _RL deltaTtracer
516          _RL deltaTfreesurf
517        _RL abeps        _RL abeps
518        _RL phiMin        _RL phiMin
519        _RL thetaMin        _RL thetaMin
# Line 461  C      --"-"--  Quadratic  ( linear: 1/s Line 531  C      --"-"--  Quadratic  ( linear: 1/s
531        _RL hFacSup        _RL hFacSup
532        _RL beta        _RL beta
533        _RL viscAh        _RL viscAh
534          _RL viscAhMax
535          _RL viscAhGrid
536        _RL viscAstrain        _RL viscAstrain
537        _RL viscAtension        _RL viscAtension
       _RL viscAz  
       _RL viscAp  
538        _RL viscAr        _RL viscAr
539        _RL viscA4        _RL viscA4
540          _RL viscA4Max
541          _RL viscA4Grid
542        _RL diffKhT        _RL diffKhT
543        _RL diffKrT        _RL diffKrT
       _RL diffKzT  
       _RL diffKpT  
544        _RL diffK4T        _RL diffK4T
545        _RL diffKhS        _RL diffKhS
546        _RL diffKrS        _RL diffKrS
       _RL diffKzS  
       _RL diffKpS  
547        _RL diffK4S        _RL diffK4S
548        _RL delt        _RL delt
549        _RL tauCD        _RL tauCD
# Line 487  C      --"-"--  Quadratic  ( linear: 1/s Line 555  C      --"-"--  Quadratic  ( linear: 1/s
555        _RL recip_rhonil        _RL recip_rhonil
556        _RL rhoConst        _RL rhoConst
557        _RL recip_rhoConst        _RL recip_rhoConst
558        _RL specVol_S(Nr)        _RL rhoConstFresh
559          _RL convertEmP2rUnit
560        _RL tRef(Nr)        _RL tRef(Nr)
       _RL theta_S(Nr)  
561        _RL sRef(Nr)        _RL sRef(Nr)
562        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
563        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
564          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
565        _RL startTime        _RL startTime
566        _RL endTime        _RL endTime
567        _RL chkPtFreq        _RL chkPtFreq
# Line 500  C      --"-"--  Quadratic  ( linear: 1/s Line 569  C      --"-"--  Quadratic  ( linear: 1/s
569        _RL dumpFreq        _RL dumpFreq
570        _RL diagFreq        _RL diagFreq
571        _RL taveFreq        _RL taveFreq
572          _RL tave_lastIter
573        _RL monitorFreq        _RL monitorFreq
574        _RL afFacMom        _RL afFacMom
575        _RL vfFacMom        _RL vfFacMom
# Line 510  C      --"-"--  Quadratic  ( linear: 1/s Line 580  C      --"-"--  Quadratic  ( linear: 1/s
580        _RL cosPower        _RL cosPower
581        _RL cAdjFreq        _RL cAdjFreq
582        _RL omega        _RL omega
583          _RL rotationPeriod
584        _RL tauThetaClimRelax        _RL tauThetaClimRelax
585        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
586        _RL tauSaltClimRelax        _RL tauSaltClimRelax
587        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
588        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
589        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
590          _RL latBandClimRelax
591        _RL externForcingCycle        _RL externForcingCycle
592        _RL externForcingPeriod        _RL externForcingPeriod
593          _RL convertFW2Salt
594          _RL temp_EvPrRn
595          _RL salt_EvPrRn
596          _RL trac_EvPrRn
597        _RL horiVertRatio        _RL horiVertRatio
598        _RL recip_horiVertRatio        _RL recip_horiVertRatio
       _RL latFFTFiltLo  
599        _RL ivdc_kappa        _RL ivdc_kappa
600        _RL Ro_SeaLevel        _RL Ro_SeaLevel
       _RL zonal_filt_lat  
601        _RL bottomDragLinear        _RL bottomDragLinear
602        _RL bottomDragQuadratic        _RL bottomDragQuadratic
603    
604        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
605       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
606        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
607        _RL recip_Cp        _RL recip_Cp
608    
609  C Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
610        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
611        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
612  C Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
613  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_Rd    :: gas constant for dry air
 C     sBeta     :: Linear EOS haline contraction coefficient.  
       COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  
       _RL tAlpha  
       _RL sBeta  
       character*(6) eosType  
   
 C Atmospheric physical parameters (Ideal Gas EOS, ...)  
 C     atm_po    :: standard reference pressure  
 C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure  
614  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
615  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
616    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
617    C     integr_GeoPot :: option to select the way we integrate the geopotential
618  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
619        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
620       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
621        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/
622        INTEGER Integr_GeoPot       &            celsius2K,
623         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
624         &            integr_GeoPot, selectFindRoSurf
625          _RL celsius2K
626          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
627          INTEGER integr_GeoPot, selectFindRoSurf
628    
629  C Logical flags for selecting packages  C Logical flags for selecting packages
630        LOGICAL useKPP        LOGICAL useKPP
631        LOGICAL useGMRedi        LOGICAL useGMRedi
632        LOGICAL useOBCS        LOGICAL useOBCS
633        LOGICAL useAIM        LOGICAL useAIM
634          LOGICAL useLand
635        LOGICAL useGrdchk        LOGICAL useGrdchk
636        LOGICAL useECCO        LOGICAL useECCO
637        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
638          LOGICAL useZONAL_FILT
639        LOGICAL useFLT        LOGICAL useFLT
640          LOGICAL usePTRACERS
641          LOGICAL useSBO
642          LOGICAL useSEAICE
643          LOGICAL useBulkForce
644          LOGICAL useThSIce
645          LOGICAL usefizhi
646          LOGICAL usegridalt
647          LOGICAL usediagnostics
648        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
649       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
650       &        useSHAP_FILT, useGrdchk, useFLT       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
651         &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
652         &        usefizhi,  usegridalt, usediagnostics
Legend:
Removed from v.1.65  
changed lines
  Added in v.1.102
  ViewVC Help
Powered by ViewVC 1.1.22