/[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.118 by jmc, Wed Jul 7 22:22:18 2004 UTC revision 1.151 by heimbach, Wed Apr 6 20:18:19 2005 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 65  C     thetaClimFile   :: File containing Line 62  C     thetaClimFile   :: File containing
62  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
63  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing salt climataology used
64  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
65  C     surfQfile       :: File containing surface heat flux  C     surfQfile       :: File containing surface heat flux, excluding SW
66  C     surfQswfile     :: File containing surface shortwave radiation  C                        (old version, kept for backward compatibility)
67    C     surfQnetFile    :: File containing surface net heat flux
68    C     surfQswFile     :: File containing surface shortwave radiation
69  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
70  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
71    C     saltFluxFile    :: File containing surface salt flux
72  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
73    C     eddyTauxFile    :: File containing zonal Eddy stress data
74    C     eddyTauyFile    :: File containing meridional Eddy stress data
75  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
76  C                        get buoyancy.  C                        get buoyancy.
77  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
78  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
79    C     the_run_name    :: string identifying the name of the model "run"
80        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
81       &                bathyFile, topoFile,       &                bathyFile, topoFile,
82       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
83       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
84       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
85       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, saltFluxFile,
86         &                surfQfile, surfQnetFile, surfQswFile,
87         &                lambdaThetaFile, lambdaSaltFile,
88       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
89       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
90         &                eddyTauxFile, eddyTauyFile,
91       &                eosType, pickupSuff,       &                eosType, pickupSuff,
92       &                mdsioLocalDir       &                mdsioLocalDir,
93         &                the_run_name
94        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
95        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
96        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 93  C                        LINEAR, POLY3, Line 100  C                        LINEAR, POLY3,
100        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
101        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
102        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
103        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
104          CHARACTER*(MAX_LEN_FNAM) surfQswFile
105        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
106          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
107        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
108        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
109        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
110        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
111        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
112        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
113          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
114          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
115          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
116          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
117        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
118          CHARACTER*(MAX_LEN_FNAM) the_run_name
119        CHARACTER*(6) eosType        CHARACTER*(6) eosType
120        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
121    
# Line 110  C     cg2dMaxIters        :: Maximum num Line 124  C     cg2dMaxIters        :: Maximum num
124  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
125  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
126  C                           in con. grad solver.  C                           in con. grad solver.
127    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
128    C                            (non-linear free-surf.)
129  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
130  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
131  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
# Line 134  C     debugLevel          :: debug level Line 150  C     debugLevel          :: debug level
150    
151        COMMON /PARM_I/        COMMON /PARM_I/
152       &        cg2dMaxIters,       &        cg2dMaxIters,
153       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
154       &        cg3dMaxIters,       &        cg3dMaxIters,
155       &        cg3dChkResFreq,       &        cg3dChkResFreq,
156       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
# Line 144  C     debugLevel          :: debug level Line 160  C     debugLevel          :: debug level
160       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
161       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
162       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
      &        tracerAdvScheme,  
163       &        debugLevel       &        debugLevel
164        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
165        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
166          INTEGER cg2dPreCondFreq
167        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
168        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
169        INTEGER nIter0        INTEGER nIter0
# Line 162  C     debugLevel          :: debug level Line 178  C     debugLevel          :: debug level
178        INTEGER select_rStar        INTEGER select_rStar
179        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
180        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
181        INTEGER debugLevel        INTEGER debugLevel
182    
183  C  C
# Line 192  C     metricTerms   :: Flag which turns Line 207  C     metricTerms   :: Flag which turns
207  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
208  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
209  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.  
210  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
211  C                     and off.  C                     and off.
212  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
213  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
214  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
215  C                     and off.  C                     and off.
216  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
# Line 207  C                     and off. Line 218  C                     and off.
218  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
219  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
220  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)
221    C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable
222    C                       on irregular grids)
223  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
224  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
225  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 215  C                           linear relat Line 228  C                           linear relat
228  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
229  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
230  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  
231  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
232  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
233  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
# Line 240  C                        climatology is Line 252  C                        climatology is
252  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
253  C                        climatology is required.  C                        climatology is required.
254  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
255  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
256  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
257  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
258  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
259    C     fluidIsAir       :: Set to indicate that the fluid major constituent
260    C                        is air
261    C     fluidIsWater     :: Set to indicate that the fluid major constituent
262    C                        is water
263  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
264  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
265  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
# Line 257  C                       outputs from mas Line 273  C                       outputs from mas
273  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
274  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
275  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
276    C     pickup_write_mdsio :: use mdsio to write pickups
277    C     pickup_read_mdsio  :: use mdsio to read  pickups
278    C     pickup_write_immed :: echo the pickup immediately (for conversion)
279    C     timeave_mdsio      :: use mdsio for timeave output
280    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
281    C     seaice_mdsio       :: use mdsio for seaice output
282    C     monitor_stdio      :: use stdio for monitor output
283    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
284    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
285    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
286    C                      calendar months and years.  Requires pkg/cal.
287        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
288       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
289       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
290       & staggerTimeStep,       & staggerTimeStep,
291       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
292       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
293       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
294       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
295       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
296         & useFullLeith,
297       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
298       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
299       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
300       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
301       & useCDscheme,       & useCDscheme,
# Line 279  C     groundAtK1  :: put the surface(k=1 Line 307  C     groundAtK1  :: put the surface(k=1
307       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
308       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
309       & periodicExternalForcing,       & periodicExternalForcing,
310         & fluidIsAir, fluidIsWater,
311       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
312       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
313       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
314       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
315       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
316         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
317         & timeave_mdsio, snapshot_mdsio, monitor_stdio, seaice_mdsio,
318         & outputTypesInclusive,
319         & inAdMode, inAdTrue, inAdFalse, inAdExact,
320         & calendarDumps
321    
322        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
323        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
324        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 299  C     groundAtK1  :: put the surface(k=1 Line 334  C     groundAtK1  :: put the surface(k=1
334        LOGICAL momPressureForcing        LOGICAL momPressureForcing
335        LOGICAL useCoriolis        LOGICAL useCoriolis
336        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
337        LOGICAL tempAdvection        LOGICAL tempAdvection
338        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
339        LOGICAL saltAdvection        LOGICAL saltAdvection
340        LOGICAL saltForcing        LOGICAL saltForcing
341        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
342          LOGICAL useFullLeith
343        LOGICAL rigidLid        LOGICAL rigidLid
344        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
345        LOGICAL exactConserv        LOGICAL exactConserv
# Line 313  C     groundAtK1  :: put the surface(k=1 Line 347  C     groundAtK1  :: put the surface(k=1
347        LOGICAL momStepping        LOGICAL momStepping
348        LOGICAL tempStepping        LOGICAL tempStepping
349        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
350        LOGICAL metricTerms        LOGICAL metricTerms
351        LOGICAL useConstantF        LOGICAL useConstantF
352        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 338  C     groundAtK1  :: put the surface(k=1 Line 371  C     groundAtK1  :: put the surface(k=1
371        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
372        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
373        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
374          LOGICAL fluidIsAir
375          LOGICAL fluidIsWater
376        LOGICAL usingPCoords        LOGICAL usingPCoords
377        LOGICAL usingZCoords        LOGICAL usingZCoords
378        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 354  C     groundAtK1  :: put the surface(k=1 Line 389  C     groundAtK1  :: put the surface(k=1
389        LOGICAL debugMode        LOGICAL debugMode
390        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
391        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
392          LOGICAL pickup_read_mdsio, pickup_write_mdsio
393          LOGICAL pickup_write_immed
394          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
395          LOGICAL seaice_mdsio
396          LOGICAL outputTypesInclusive
397          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
398          LOGICAL calendarDumps
399    
400  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
401  C     gg2dTargetResidual  C     cg2dTargetResidual
402  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
403  C     cg2dTargetResWunit  C     cg2dTargetResWunit
404  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 386  C     gBaro     :: Accel. due to gravity Line 428  C     gBaro     :: Accel. due to gravity
428  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
429  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
430  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
431  C     startTime :: Start time for model ( s )  C     tRef      :: reference vertical profile for potential temperature
432    C     sRef      :: reference vertical profile for salinity/specific humidity
433  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
434  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
435  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 400  C     omega     :: Angular velocity ( ra Line 443  C     omega     :: Angular velocity ( ra
443  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
444  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
445  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
446    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
447    C                 momentum laterally, no effect for hydrostatic
448    C                 model, defaults to viscAh if unset ( m^2/s )
449  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
450  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
451  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
452  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
453  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
454    C                 momentum laterally, no effect for hydrostatic
455    C                 model, defaults to viscA4 if unset ( m^2/s )
456    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
457    C                  (act on Divergence part) ( m^2/s )
458    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
459    C                  (act on Vorticity  part) ( m^2/s )
460    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
461    C                  (act on Divergence part) ( m^4/s )
462    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
463    C                  (act on Vorticity  part) ( m^4/s )
464    C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
465    C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
466    C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor
467  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
468  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
469    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
470    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity
471  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
472  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
473  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
474  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
475  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
476    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
477    C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
478    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
479  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
480  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
481  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
482  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
483  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
484  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
485  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
486  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
487  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
488  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
489  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
490  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
491  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
# Line 436  C                    it will be the deep Line 500  C                    it will be the deep
500  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
501  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
502  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
503  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
504  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
505  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
506  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
# Line 453  C     hFacInf      :: Threshold (inf and Line 517  C     hFacInf      :: Threshold (inf and
517  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
518  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
519  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
520    C     baseTime      :: model base time (time origin) = time @ iteration zero
521  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
522  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
523  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 489  C     convertFW2Salt :: salinity, used t Line 554  C     convertFW2Salt :: salinity, used t
554  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
555  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
556  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
557  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
558  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
559  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 503  C      --"-"--  Quadratic  ( linear: 1/s Line 567  C      --"-"--  Quadratic  ( linear: 1/s
567        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
568       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
569       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
570       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
571       & abeps, startTime,       & abeps,
572       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
573       & fCori, fCoriG, fCoriCos,       & viscAh, viscAhW, viscAhMax,
574       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
575       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscC2leith, viscC2leithD,
576       & viscAr, viscAstrain, viscAtension,       & viscC2smag,
577       & diffKhT, diffK4T, diffKrT,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
578       & diffKhS, diffK4S, diffKrS,       & viscA4, viscA4W,
579         & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
580         & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
581         & diffKhT, diffK4T, diffKrNrT,
582         & diffKhS, diffK4S, diffKrNrS,
583       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
584       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
585       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
586       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
587       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
588       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
589       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & baseTime, startTime, endTime,
590       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
591         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
592       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
593       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
594       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
595       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
596       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
597       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
598       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
599       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
600       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
601       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
602       & bottomDragLinear,bottomDragQuadratic,       & bottomDragLinear,bottomDragQuadratic,
603       & tCyl       & tCylIn, tCylOut
604    
605        _RL cg2dTargetResidual        _RL cg2dTargetResidual
606        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 544  C      --"-"--  Quadratic  ( linear: 1/s Line 613  C      --"-"--  Quadratic  ( linear: 1/s
613        _RL deltaT        _RL deltaT
614        _RL deltaTClock        _RL deltaTClock
615        _RL deltaTmom        _RL deltaTmom
616        _RL deltaTtracer        _RL dTtracerLev(Nr)
617        _RL deltaTfreesurf        _RL deltaTfreesurf
618        _RL abeps        _RL abeps
619        _RL phiMin        _RL phiMin
# Line 563  C      --"-"--  Quadratic  ( linear: 1/s Line 632  C      --"-"--  Quadratic  ( linear: 1/s
632        _RL hFacSup        _RL hFacSup
633        _RL beta        _RL beta
634        _RL viscAh        _RL viscAh
635          _RL viscAhW
636          _RL viscAhD
637          _RL viscAhZ
638        _RL viscAhMax        _RL viscAhMax
639        _RL viscAhGrid        _RL viscAhGrid
640          _RL viscAhGridMax
641          _RL viscAhGridMin
642        _RL viscC2leith        _RL viscC2leith
643          _RL viscC2leithD
644          _RL viscC2smag
645        _RL viscAstrain        _RL viscAstrain
646        _RL viscAtension        _RL viscAtension
647        _RL viscAr        _RL viscAr
648        _RL viscA4        _RL viscA4
649          _RL viscA4W
650          _RL viscA4D
651          _RL viscA4Z
652        _RL viscA4Max        _RL viscA4Max
653        _RL viscA4Grid        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
654        _RL viscC4leith        _RL viscC4leith
655          _RL viscC4leithD
656        _RL diffKhT        _RL diffKhT
657        _RL diffKrT        _RL diffKrNrT(Nr)
658        _RL diffK4T        _RL diffK4T
659        _RL diffKhS        _RL diffKhS
660        _RL diffKrS        _RL diffKrNrS(Nr)
661        _RL diffK4S        _RL diffK4S
662        _RL diffKrBL79surf        _RL diffKrBL79surf
663        _RL diffKrBL79deep        _RL diffKrBL79deep
# Line 600  C      --"-"--  Quadratic  ( linear: 1/s Line 680  C      --"-"--  Quadratic  ( linear: 1/s
680        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
681        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
682        _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
683          _RS lambdaThetaClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
684          _RS lambdaSaltClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
685          _RL baseTime
686        _RL startTime        _RL startTime
687        _RL endTime        _RL endTime
688        _RL chkPtFreq        _RL chkPtFreq
# Line 610  C      --"-"--  Quadratic  ( linear: 1/s Line 693  C      --"-"--  Quadratic  ( linear: 1/s
693        _RL taveFreq        _RL taveFreq
694        _RL tave_lastIter        _RL tave_lastIter
695        _RL monitorFreq        _RL monitorFreq
696          _RL adjMonitorFreq
697        _RL afFacMom        _RL afFacMom
698        _RL vfFacMom        _RL vfFacMom
699        _RL pfFacMom        _RL pfFacMom
# Line 621  C      --"-"--  Quadratic  ( linear: 1/s Line 705  C      --"-"--  Quadratic  ( linear: 1/s
705        _RL omega        _RL omega
706        _RL rotationPeriod        _RL rotationPeriod
707        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
708        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL lambdaSaltClimRelax  
709        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
710        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
711        _RL latBandClimRelax        _RL latBandClimRelax
# Line 632  C      --"-"--  Quadratic  ( linear: 1/s Line 714  C      --"-"--  Quadratic  ( linear: 1/s
714        _RL convertFW2Salt        _RL convertFW2Salt
715        _RL temp_EvPrRn        _RL temp_EvPrRn
716        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
717        _RL horiVertRatio        _RL horiVertRatio
718        _RL recip_horiVertRatio        _RL recip_horiVertRatio
719        _RL ivdc_kappa        _RL ivdc_kappa
720        _RL Ro_SeaLevel        _RL Ro_SeaLevel
721        _RL bottomDragLinear        _RL bottomDragLinear
722        _RL bottomDragQuadratic        _RL bottomDragQuadratic
723        _RL tCyl        _RL tCylIn
724          _RL tCylOut
725    
726  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
727        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 667  C             derived from the orography Line 749  C             derived from the orography
749        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
750    
751  C Logical flags for selecting packages  C Logical flags for selecting packages
752          LOGICAL useOPPS
753          LOGICAL usePP81
754          LOGICAL useMY82
755          LOGICAL useGGL90
756        LOGICAL useKPP        LOGICAL useKPP
757        LOGICAL useGMRedi        LOGICAL useGMRedi
758        LOGICAL useOBCS        LOGICAL useOBCS
# Line 678  C Logical flags for selecting packages Line 764  C Logical flags for selecting packages
764        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
765        LOGICAL useFLT        LOGICAL useFLT
766        LOGICAL usePTRACERS        LOGICAL usePTRACERS
767          LOGICAL useGCHEM
768        LOGICAL useSBO        LOGICAL useSBO
769        LOGICAL useSEAICE        LOGICAL useSEAICE
770        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 686  C Logical flags for selecting packages Line 773  C Logical flags for selecting packages
773        LOGICAL usegridalt        LOGICAL usegridalt
774        LOGICAL usediagnostics        LOGICAL usediagnostics
775        LOGICAL useEBM        LOGICAL useEBM
776          LOGICAL useMNC
777        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
778       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
779       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
780       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
781       &        usefizhi,  usegridalt, usediagnostics, useEBM       &        useSBO, useSEAICE, useThSIce, useBulkForce,
782         &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
783  C     Run-time flags for early-initialization of MNC       &        usePP81, useMY82, useOPPS, useGGL90
       LOGICAL  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_use_for_mon  
       CHARACTER*(MAX_LEN_FNAM) mnc_outdir_str  
       CHARACTER*(MAX_LEN_FNAM) mnc_indir_str  
       COMMON /PARM_MNC/  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     mnc_use_for_mon  
   
784    
785  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
786  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.118  
changed lines
  Added in v.1.151

  ViewVC Help
Powered by ViewVC 1.1.22