/[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.147 by baylor, Thu Mar 10 03:45:11 2005 UTC revision 1.177 by mlosch, Fri Feb 10 07:50:37 2006 UTC
# Line 49  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 78  C     eosType         :: choose the equa Line 84  C     eosType         :: choose the equa
84  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
85  C     the_run_name    :: string identifying the name of the model "run"  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, saltFluxFile,       &                EmPmRfile, saltFluxFile,
93       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
94         &                lambdaThetaFile, lambdaSaltFile,
95       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
96       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
97       &                eddyTauxFile, eddyTauyFile,       &                eddyTauxFile, eddyTauyFile,
# Line 91  C     the_run_name    :: string identify Line 99  C     the_run_name    :: string identify
99       &                mdsioLocalDir,       &                mdsioLocalDir,
100       &                the_run_name       &                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 111  C     the_run_name    :: string identify Line 122  C     the_run_name    :: string identify
122        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
123        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile        CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
124        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile        CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
125          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
126          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
127        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
128        CHARACTER*(MAX_LEN_FNAM) the_run_name        CHARACTER*(MAX_LEN_FNAM) the_run_name
129        CHARACTER*(6) eosType        CHARACTER*(6) eosType
# Line 140  C                           =0 Linear fr Line 153  C                           =0 Linear fr
153  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
154  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
155  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
156  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
157  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
158  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
159    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
160  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
161    
162        COMMON /PARM_I/        COMMON /PARM_I/
# Line 157  C     debugLevel          :: debug level Line 171  C     debugLevel          :: debug level
171       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
172       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
173       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
174         &        selectKEscheme,
175       &        debugLevel       &        debugLevel
176        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
177        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 175  C     debugLevel          :: debug level Line 190  C     debugLevel          :: debug level
190        INTEGER select_rStar        INTEGER select_rStar
191        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
192        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
193          INTEGER selectKEscheme
194        INTEGER debugLevel        INTEGER debugLevel
195    
196  C  C
# Line 193  C                               spherica Line 209  C                               spherica
209  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
210  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
211  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  
212  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
213  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
214  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
# Line 215  C                     and off. Line 230  C                     and off.
230  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
231  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
232  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)
233  C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
234  C                       on irregular grids)  C                       on irregular grids)
235    C     useAreaViscLength :: Set to true to use old scaling for viscous
236    C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
237    C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
238  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
239  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
240  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
241  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
242  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
243    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
244    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
245  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
246  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
247  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
# Line 233  C     useJamartWetPoints :: Use wet-poin Line 253  C     useJamartWetPoints :: Use wet-poin
253  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
254  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
255  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
256  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
257    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
258  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
259  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
260  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 242  C     saltImplVertAdv :: Turns on implic Line 263  C     saltImplVertAdv :: Turns on implic
263  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
264  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
265  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
266  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution
267  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
268    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
269    C                          apply AB on tracer tendencies (rather than on Tracer)
270    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
271  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
272  C                        climatology is required.  C                        climatology is required.
273  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 269  C                       useSingleCpuIO i Line 293  C                       useSingleCpuIO i
293  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
294  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
295  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
 C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  
296  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
297  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
298  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
# Line 280  C     calendarDumps :: When set, approxi Line 303  C     calendarDumps :: When set, approxi
303  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
304  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
305  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
306    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
307    C                        & Last iteration, in addition multiple of dumpFreq iter.
308    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
309    C     balanceQnet     :: substract global mean of Qnet at every time step
310    C     balancePrintMean:: print substracted global means to STDOUT
311    
312        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
313       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
314       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
      & staggerTimeStep,  
315       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
316       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
317       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
318       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
319       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
320       & useFullLeith,       & useFullLeith, useStrainTensionVisc,
321         & useAreaViscLength,
322       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
323         & implicitIntGravWave, staggerTimeStep,
324       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
325       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
326       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
327       & useCDscheme,       & useCDscheme,
328       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
329       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
330       & useAbsVorticity,       & useAbsVorticity, upwindShear,
331       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
332       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
333       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
334         & forcing_In_AB, doAB_onGtGs,
335       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
336       & periodicExternalForcing,       & periodicExternalForcing,
337       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
338       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
339       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
340       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing,
341       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
      & readPickupWithTracer, writePickupWithTracer,  
342       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
343       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
344       & outputTypesInclusive,       & outputTypesInclusive, dumpInitAndLast, debugMode,
345       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
346       & calendarDumps       & calendarDumps,
347         & balanceEmPmR, balanceQnet, balancePrintMean
348    
349        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
350        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
# Line 323  C                      calendar months a Line 354  C                      calendar months a
354        LOGICAL useNHMTerms        LOGICAL useNHMTerms
355        LOGICAL no_slip_sides        LOGICAL no_slip_sides
356        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
357        LOGICAL momViscosity        LOGICAL momViscosity
358        LOGICAL momAdvection        LOGICAL momAdvection
359        LOGICAL momForcing        LOGICAL momForcing
# Line 336  C                      calendar months a Line 366  C                      calendar months a
366        LOGICAL saltForcing        LOGICAL saltForcing
367        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
368        LOGICAL useFullLeith        LOGICAL useFullLeith
369          LOGICAL useStrainTensionVisc
370          LOGICAL useAreaViscLength
371        LOGICAL rigidLid        LOGICAL rigidLid
372        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
373        LOGICAL exactConserv        LOGICAL exactConserv
374        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
375          LOGICAL implicitIntGravWave
376          LOGICAL staggerTimeStep
377        LOGICAL momStepping        LOGICAL momStepping
378        LOGICAL tempStepping        LOGICAL tempStepping
379        LOGICAL saltStepping        LOGICAL saltStepping
# Line 355  C                      calendar months a Line 389  C                      calendar months a
389        LOGICAL upwindVorticity        LOGICAL upwindVorticity
390        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
391        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
392          LOGICAL upwindShear
393        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
394        LOGICAL implicitViscosity        LOGICAL implicitViscosity
395        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 363  C                      calendar months a Line 398  C                      calendar months a
398        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
399        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
400        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
401          LOGICAL doAB_onGtGs
402        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
403        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
404        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 379  C                      calendar months a Line 415  C                      calendar months a
415        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
416        LOGICAL allowFreezing        LOGICAL allowFreezing
417        LOGICAL useOldFreezing        LOGICAL useOldFreezing
       LOGICAL groundAtK1  
418        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
419        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
420          LOGICAL startFromPickupAB2
421          LOGICAL dumpInitAndLast
422        LOGICAL debugMode        LOGICAL debugMode
       LOGICAL readPickupWithTracer  
       LOGICAL writePickupWithTracer  
423        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
424        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
425        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
# Line 392  C                      calendar months a Line 427  C                      calendar months a
427        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
428        LOGICAL calendarDumps        LOGICAL calendarDumps
429    
430          LOGICAL balanceEmPmR
431          LOGICAL balanceQnet
432          LOGICAL balancePrintMean
433    
434  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
435  C     cg2dTargetResidual  C     cg2dTargetResidual
436  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 425  C     rhoConst  :: Vertically constant r Line 464  C     rhoConst  :: Vertically constant r
464  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
465  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
466  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
467  C     startTime :: Start time for model ( s )  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
468    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
469    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
470    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
471  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
472  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
473  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 458  C                  (act on Divergence pa Line 500  C                  (act on Divergence pa
500  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
501  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
502  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
503  C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
504  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)
505    C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)
506  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
507  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
508    C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
509    C                   coeff. for mixing of momentum laterally (non-dim)
510  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
511  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
512  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
513  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
514    C     viscA4ReMax :: Maximum Gridscale Reynolds number for
515    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
516  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
517  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
518  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
# Line 501  C     deltaTfreesurf :: Timestep for fre Line 548  C     deltaTfreesurf :: Timestep for fre
548  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
549  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
550  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
551    C     abEps        :: Adams-Bashforth-2 stabilizing weight
552    C     alph_AB      :: Adams-Bashforth-3 primary factor
553    C     beta_AB      :: Adams-Bashforth-3 secondary factor
554  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
555  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
556  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 513  C     hFacInf      :: Threshold (inf and Line 563  C     hFacInf      :: Threshold (inf and
563  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
564  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
565  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
566    C     baseTime      :: model base time (time origin) = time @ iteration zero
567  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
568  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
569  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 536  C     tave_lastIter :: (for state variab Line 587  C     tave_lastIter :: (for state variab
587  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
588  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
589  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 ).  
590  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  
591  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
592  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
593  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
# Line 557  C     recip_horiVertRatio  ( 1 if horiz Line 606  C     recip_horiVertRatio  ( 1 if horiz
606  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
607  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
608  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
609    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
610    C                           (default=2: full drag ; =1: gives half-slip BC)
611  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
612  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
613    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
614    C                      (i.e. allows convection at different Rayleigh numbers)
615        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
616       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
617       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
618       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
619       & abeps, startTime,       & abEps, alph_AB, beta_AB,
620       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
      & fCori, fCoriG, fCoriCos,  
621       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
622       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
623       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
624       & viscC2smag,       & viscC2smag, viscC4smag,
625       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
626       & viscA4, viscA4W,       & viscA4, viscA4W,
627       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
628       & viscC4leith, viscAr, viscAstrain, viscAtension,       & viscAhRemax, viscA4Remax,
629         & viscC4leith, viscC4leithD, viscAr,
630       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
631       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
632       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 581  C      --"-"--  Quadratic  ( linear: 1/s Line 634  C      --"-"--  Quadratic  ( linear: 1/s
634       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
635       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
636       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
637       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
638       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & baseTime, startTime, endTime,
639         & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
640       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
641       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
642       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
643       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, tauThetaClimRelax3Dim,
644       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, tauSaltClimRelax3Dim,
645       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
646       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
647       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
648       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
649       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
650       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
651       & bottomDragLinear,bottomDragQuadratic,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
652       & tCylIn, tCylOut       & tCylIn, tCylOut
653    
654        _RL cg2dTargetResidual        _RL cg2dTargetResidual
# Line 610  C      --"-"--  Quadratic  ( linear: 1/s Line 664  C      --"-"--  Quadratic  ( linear: 1/s
664        _RL deltaTmom        _RL deltaTmom
665        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
666        _RL deltaTfreesurf        _RL deltaTfreesurf
667        _RL abeps        _RL abEps, alph_AB, beta_AB
668        _RL phiMin        _RL phiMin
669        _RL thetaMin        _RL thetaMin
670        _RL rSphere        _RL rSphere
# Line 631  C      --"-"--  Quadratic  ( linear: 1/s Line 685  C      --"-"--  Quadratic  ( linear: 1/s
685        _RL viscAhD        _RL viscAhD
686        _RL viscAhZ        _RL viscAhZ
687        _RL viscAhMax        _RL viscAhMax
688          _RL viscAhReMax
689        _RL viscAhGrid        _RL viscAhGrid
690        _RL viscAhGridMax        _RL viscAhGridMax
691        _RL viscAhGridMin        _RL viscAhGridMin
692        _RL viscC2leith        _RL viscC2leith
693        _RL viscC2leithD        _RL viscC2leithD
694        _RL viscC2smag        _RL viscC2smag
695        _RL viscAstrain        _RL viscC4smag
       _RL viscAtension  
696        _RL viscAr        _RL viscAr
697        _RL viscA4        _RL viscA4
698        _RL viscA4W        _RL viscA4W
699        _RL viscA4D        _RL viscA4D
700        _RL viscA4Z        _RL viscA4Z
701        _RL viscA4Max        _RL viscA4Max
702          _RL viscA4ReMax
703        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
704        _RL viscC4leith        _RL viscC4leith
705        _RL viscC4leithD        _RL viscC4leithD
# Line 672  C      --"-"--  Quadratic  ( linear: 1/s Line 727  C      --"-"--  Quadratic  ( linear: 1/s
727        _RL convertEmP2rUnit        _RL convertEmP2rUnit
728        _RL tRef(Nr)        _RL tRef(Nr)
729        _RL sRef(Nr)        _RL sRef(Nr)
730        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL phiRef(2*Nr+1)
731        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dBdrRef(Nr)
732        _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL baseTime
733        _RL startTime        _RL startTime
734        _RL endTime        _RL endTime
735        _RL chkPtFreq        _RL chkPtFreq
# Line 697  C      --"-"--  Quadratic  ( linear: 1/s Line 752  C      --"-"--  Quadratic  ( linear: 1/s
752        _RL omega        _RL omega
753        _RL rotationPeriod        _RL rotationPeriod
754        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
755        _RL tauSaltClimRelax        _RL tauSaltClimRelax
756        _RL lambdaSaltClimRelax        _RL tauThetaClimRelax3Dim
757          _RL tauSaltClimRelax3Dim
758        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
759        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
760        _RL latBandClimRelax        _RL latBandClimRelax
# Line 712  C      --"-"--  Quadratic  ( linear: 1/s Line 767  C      --"-"--  Quadratic  ( linear: 1/s
767        _RL recip_horiVertRatio        _RL recip_horiVertRatio
768        _RL ivdc_kappa        _RL ivdc_kappa
769        _RL Ro_SeaLevel        _RL Ro_SeaLevel
770          _RL sideDragFactor
771        _RL bottomDragLinear        _RL bottomDragLinear
772        _RL bottomDragQuadratic        _RL bottomDragQuadratic
773          _RL nh_Am2
774        _RL tCylIn        _RL tCylIn
775        _RL tCylOut        _RL tCylOut
776    
# Line 759  C Logical flags for selecting packages Line 816  C Logical flags for selecting packages
816        LOGICAL useFLT        LOGICAL useFLT
817        LOGICAL usePTRACERS        LOGICAL usePTRACERS
818        LOGICAL useGCHEM        LOGICAL useGCHEM
819          LOGICAL useRBCS
820        LOGICAL useSBO        LOGICAL useSBO
821        LOGICAL useSEAICE        LOGICAL useSEAICE
822          LOGICAL useShelfIce
823        LOGICAL useBulkForce        LOGICAL useBulkForce
824        LOGICAL useThSIce        LOGICAL useThSIce
825        LOGICAL usefizhi        LOGICAL usefizhi
# Line 768  C Logical flags for selecting packages Line 827  C Logical flags for selecting packages
827        LOGICAL usediagnostics        LOGICAL usediagnostics
828        LOGICAL useEBM        LOGICAL useEBM
829        LOGICAL useMNC        LOGICAL useMNC
830          LOGICAL useMATRIX
831          LOGICAL useRunClock
832          LOGICAL useEMBED_FILES
833        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
834       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
835       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
836       &        usePTRACERS, useGCHEM,       &        usePTRACERS, useGCHEM, useRBCS,
837       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
838       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
839       &        usePP81, useMY82, useOPPS, useGGL90       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
840         &        useRunClock, useEMBED_FILES
841    
842  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
843  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.147  
changed lines
  Added in v.1.177
  ViewVC Help
Powered by ViewVC 1.1.22