/[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.136 by dimitri, Tue Nov 2 23:57:29 2004 UTC revision 1.162 by jmc, Sun Jul 31 22:01:15 2005 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)
# Line 68  C     surfQnetFile    :: File containing Line 72  C     surfQnetFile    :: File containing
72  C     surfQswFile     :: File containing surface shortwave radiation  C     surfQswFile     :: File containing surface shortwave radiation
73  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
74  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
75    C     saltFluxFile    :: File containing surface salt flux
76  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
77    C     eddyTauxFile    :: File containing zonal Eddy stress data
78    C     eddyTauyFile    :: File containing meridional Eddy stress data
79  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
80  C                        get buoyancy.  C                        get buoyancy.
81  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
82  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
85         &                delXFile, delYFile, horizGridFile,
86       &                bathyFile, topoFile,       &                bathyFile, topoFile,
87       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
88       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
89       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
90       &                EmPmRfile, surfQfile, surfQnetFile, surfQswFile,       &                EmPmRfile, saltFluxFile,
91         &                surfQfile, surfQnetFile, surfQswFile,
92         &                lambdaThetaFile, lambdaSaltFile,
93       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
94       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
95         &                eddyTauxFile, eddyTauyFile,
96       &                eosType, pickupSuff,       &                eosType, pickupSuff,
97       &                mdsioLocalDir,       &                mdsioLocalDir,
98       &                the_run_name       &                the_run_name
99        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
100          CHARACTER*(MAX_LEN_FNAM) delXFile
101          CHARACTER*(MAX_LEN_FNAM) delYFile
102          CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
105        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
# Line 97  C     the_run_name    :: string identify Line 111  C     the_run_name    :: string identify
111        CHARACTER*(MAX_LEN_FNAM) surfQnetFile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
112        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
113        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
114          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
115        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
116        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
117        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
118        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
119        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
120        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
121          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
122          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
123          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
124          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
125        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
126        CHARACTER*(MAX_LEN_FNAM) the_run_name        CHARACTER*(MAX_LEN_FNAM) the_run_name
127        CHARACTER*(6) eosType        CHARACTER*(6) eosType
# Line 149  C     debugLevel          :: debug level Line 168  C     debugLevel          :: debug level
168       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
169       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
170       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
      &        tracerAdvScheme,  
171       &        debugLevel       &        debugLevel
172        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
173        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 168  C     debugLevel          :: debug level Line 186  C     debugLevel          :: debug level
186        INTEGER select_rStar        INTEGER select_rStar
187        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
188        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
189        INTEGER debugLevel        INTEGER debugLevel
190    
191  C  C
# Line 198  C     metricTerms   :: Flag which turns Line 215  C     metricTerms   :: Flag which turns
215  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
216  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
217  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.  
218  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
219  C                     and off.  C                     and off.
220  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
221  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
222  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
223  C                     and off.  C                     and off.
224  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
# Line 213  C                     and off. Line 226  C                     and off.
226  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
227  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
228  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)
229    C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable
230    C                       on irregular grids)
231    C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest
232    C              anisotropic length scale.  It is used only for maximum viscosity
233    C              calculations.  Alistair recommends a value of viscA*GridMax=.25
234  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
235  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
236  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 229  C     useJamartWetPoints :: Use wet-poin Line 247  C     useJamartWetPoints :: Use wet-poin
247  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
248  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
249  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
250  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
251    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
252  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
253  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
254  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 240  C     multiDimAdvection :: Flag that ena Line 259  C     multiDimAdvection :: Flag that ena
259  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
260  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
261  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
262    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
263  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
264  C                        climatology is required.  C                        climatology is required.
265  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 265  C                       useSingleCpuIO i Line 285  C                       useSingleCpuIO i
285  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
286  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
287  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)  
288  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
289  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
290  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
291  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
292  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
293  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
294    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
295    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
296    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
297    C                      calendar months and years.  Requires pkg/cal.
298        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
299       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
300       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
301       & staggerTimeStep,       & staggerTimeStep,
302       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
303       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
304       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
305       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
306       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
307         & useFullLeith, useAnisotropicViscAGridMax,
308       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
309       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
310       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
# Line 288  C     monitor_stdio      :: use stdio fo Line 312  C     monitor_stdio      :: use stdio fo
312       & useCDscheme,       & useCDscheme,
313       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
314       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
315       & useAbsVorticity,       & useAbsVorticity, upwindShear,
316       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
317       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
318       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
# Line 297  C     monitor_stdio      :: use stdio fo Line 321  C     monitor_stdio      :: use stdio fo
321       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
322       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
323       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
324       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing,
325       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
      & readPickupWithTracer, writePickupWithTracer,  
326       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
327       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
328       & outputTypesInclusive       & outputTypesInclusive, debugMode,
329         & inAdMode, inAdTrue, inAdFalse, inAdExact,
330         & calendarDumps
331    
332        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
333        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
# Line 319  C     monitor_stdio      :: use stdio fo Line 344  C     monitor_stdio      :: use stdio fo
344        LOGICAL momPressureForcing        LOGICAL momPressureForcing
345        LOGICAL useCoriolis        LOGICAL useCoriolis
346        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
347        LOGICAL tempAdvection        LOGICAL tempAdvection
348        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
349        LOGICAL saltAdvection        LOGICAL saltAdvection
350        LOGICAL saltForcing        LOGICAL saltForcing
351        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
352          LOGICAL useFullLeith, useAnisotropicViscAGridMax
353        LOGICAL rigidLid        LOGICAL rigidLid
354        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
355        LOGICAL exactConserv        LOGICAL exactConserv
# Line 345  C     monitor_stdio      :: use stdio fo Line 369  C     monitor_stdio      :: use stdio fo
369        LOGICAL upwindVorticity        LOGICAL upwindVorticity
370        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
371        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
372          LOGICAL upwindShear
373        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
374        LOGICAL implicitViscosity        LOGICAL implicitViscosity
375        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 369  C     monitor_stdio      :: use stdio fo Line 394  C     monitor_stdio      :: use stdio fo
394        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
395        LOGICAL allowFreezing        LOGICAL allowFreezing
396        LOGICAL useOldFreezing        LOGICAL useOldFreezing
       LOGICAL groundAtK1  
397        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
398        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
399          LOGICAL startFromPickupAB2
400        LOGICAL debugMode        LOGICAL debugMode
       LOGICAL readPickupWithTracer  
       LOGICAL writePickupWithTracer  
401        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
402        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
403        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
404        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
405          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
406          LOGICAL calendarDumps
407    
408  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
409  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 413  C     rhoConst  :: Vertically constant r Line 438  C     rhoConst  :: Vertically constant r
438  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
439  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
440  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
 C     startTime :: Start time for model ( s )  
441  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
442  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
443  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 434  C     viscAr    :: Eddy viscosity coeff. Line 458  C     viscAr    :: Eddy viscosity coeff.
458  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
459  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
460  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
461    C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
462    C                 momentum laterally, no effect for hydrostatic
463    C                 model, defaults to viscA4 if unset ( m^2/s )
464  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
465  C                  (act on Divergence part) ( m^2/s )  C                  (act on Divergence part) ( m^2/s )
466  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
# Line 442  C     viscA4D   :: Biharmonic viscosity Line 469  C     viscA4D   :: Biharmonic viscosity
469  C                  (act on Divergence part) ( m^4/s )  C                  (act on Divergence part) ( m^4/s )
470  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
471  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
472  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
473    C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
474    C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor
475  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
476  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
477    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
478    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity
479  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
480  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
481  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
482  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
483  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
484  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
485  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
486    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
487  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
488  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
489  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
# Line 476  C                    it will be the deep Line 508  C                    it will be the deep
508  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
509  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
510  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
511  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
512  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
513  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
514  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
515  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
516    C     abEps        :: Adams-Bashforth-2 stabilizing weight
517    C     alph_AB      :: Adams-Bashforth-3 primary factor
518    C     beta_AB      :: Adams-Bashforth-3 secondary factor
519  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
520  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
521  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 493  C     hFacInf      :: Threshold (inf and Line 528  C     hFacInf      :: Threshold (inf and
528  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
529  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
530  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
531    C     baseTime      :: model base time (time origin) = time @ iteration zero
532  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
533  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
534  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 516  C     tave_lastIter :: (for state variab Line 552  C     tave_lastIter :: (for state variab
552  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
553  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
554  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 ).  
555  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 ).  
556  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
557  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
558  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 529  C     convertFW2Salt :: salinity, used t Line 563  C     convertFW2Salt :: salinity, used t
563  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
564  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
565  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
566  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
567  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
568  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 543  C      --"-"--  Quadratic  ( linear: 1/s Line 576  C      --"-"--  Quadratic  ( linear: 1/s
576        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
577       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
578       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
579       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
580       & abeps, startTime,       & abEps, alph_AB, beta_AB,
581       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
582       & fCori, fCoriG, fCoriCos,       & viscAh, viscAhW, viscAhMax,
583       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
584         & viscC2leith, viscC2leithD,
585         & viscC2smag,
586       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
587       & viscA4,  viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4, viscA4W,
588       & viscC4leith, viscAr, viscAstrain, viscAtension,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
589         & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
590       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
591       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
592       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 559  C      --"-"--  Quadratic  ( linear: 1/s Line 595  C      --"-"--  Quadratic  ( linear: 1/s
595       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
596       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
597       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
598       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & baseTime, startTime, endTime,
599       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
600         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
601       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
602       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
603       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax,
604       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax,
605       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
606       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
607       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
608       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
609       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
610       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
611       & bottomDragLinear,bottomDragQuadratic,       & bottomDragLinear,bottomDragQuadratic,nh_Am2,
612       & tCyl       & tCylIn, tCylOut
613    
614          _RL nh_Am2
615        _RL cg2dTargetResidual        _RL cg2dTargetResidual
616        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
617        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 585  C      --"-"--  Quadratic  ( linear: 1/s Line 623  C      --"-"--  Quadratic  ( linear: 1/s
623        _RL deltaT        _RL deltaT
624        _RL deltaTClock        _RL deltaTClock
625        _RL deltaTmom        _RL deltaTmom
626        _RL deltaTtracer        _RL dTtracerLev(Nr)
627        _RL deltaTfreesurf        _RL deltaTfreesurf
628        _RL abeps        _RL abEps, alph_AB, beta_AB
629        _RL phiMin        _RL phiMin
630        _RL thetaMin        _RL thetaMin
631        _RL rSphere        _RL rSphere
# Line 609  C      --"-"--  Quadratic  ( linear: 1/s Line 647  C      --"-"--  Quadratic  ( linear: 1/s
647        _RL viscAhZ        _RL viscAhZ
648        _RL viscAhMax        _RL viscAhMax
649        _RL viscAhGrid        _RL viscAhGrid
650          _RL viscAhGridMax
651          _RL viscAhGridMin
652        _RL viscC2leith        _RL viscC2leith
653          _RL viscC2leithD
654          _RL viscC2smag
655        _RL viscAstrain        _RL viscAstrain
656        _RL viscAtension        _RL viscAtension
657        _RL viscAr        _RL viscAr
658        _RL viscA4        _RL viscA4
659          _RL viscA4W
660        _RL viscA4D        _RL viscA4D
661        _RL viscA4Z        _RL viscA4Z
662        _RL viscA4Max        _RL viscA4Max
663        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
664        _RL viscC4leith        _RL viscC4leith
665          _RL viscC4leithD
666        _RL diffKhT        _RL diffKhT
667        _RL diffKrNrT(Nr)        _RL diffKrNrT(Nr)
668        _RL diffK4T        _RL diffK4T
# Line 643  C      --"-"--  Quadratic  ( linear: 1/s Line 687  C      --"-"--  Quadratic  ( linear: 1/s
687        _RL convertEmP2rUnit        _RL convertEmP2rUnit
688        _RL tRef(Nr)        _RL tRef(Nr)
689        _RL sRef(Nr)        _RL sRef(Nr)
690        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL baseTime
       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
691        _RL startTime        _RL startTime
692        _RL endTime        _RL endTime
693        _RL chkPtFreq        _RL chkPtFreq
# Line 656  C      --"-"--  Quadratic  ( linear: 1/s Line 698  C      --"-"--  Quadratic  ( linear: 1/s
698        _RL taveFreq        _RL taveFreq
699        _RL tave_lastIter        _RL tave_lastIter
700        _RL monitorFreq        _RL monitorFreq
701          _RL adjMonitorFreq
702        _RL afFacMom        _RL afFacMom
703        _RL vfFacMom        _RL vfFacMom
704        _RL pfFacMom        _RL pfFacMom
# Line 667  C      --"-"--  Quadratic  ( linear: 1/s Line 710  C      --"-"--  Quadratic  ( linear: 1/s
710        _RL omega        _RL omega
711        _RL rotationPeriod        _RL rotationPeriod
712        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
713        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL lambdaSaltClimRelax  
714        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
715        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
716        _RL latBandClimRelax        _RL latBandClimRelax
# Line 678  C      --"-"--  Quadratic  ( linear: 1/s Line 719  C      --"-"--  Quadratic  ( linear: 1/s
719        _RL convertFW2Salt        _RL convertFW2Salt
720        _RL temp_EvPrRn        _RL temp_EvPrRn
721        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
722        _RL horiVertRatio        _RL horiVertRatio
723        _RL recip_horiVertRatio        _RL recip_horiVertRatio
724        _RL ivdc_kappa        _RL ivdc_kappa
725        _RL Ro_SeaLevel        _RL Ro_SeaLevel
726        _RL bottomDragLinear        _RL bottomDragLinear
727        _RL bottomDragQuadratic        _RL bottomDragQuadratic
728        _RL tCyl        _RL tCylIn
729          _RL tCylOut
730    
731  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
732        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 728  C Logical flags for selecting packages Line 769  C Logical flags for selecting packages
769        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
770        LOGICAL useFLT        LOGICAL useFLT
771        LOGICAL usePTRACERS        LOGICAL usePTRACERS
772          LOGICAL useGCHEM
773        LOGICAL useSBO        LOGICAL useSBO
774        LOGICAL useSEAICE        LOGICAL useSEAICE
775        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 737  C Logical flags for selecting packages Line 779  C Logical flags for selecting packages
779        LOGICAL usediagnostics        LOGICAL usediagnostics
780        LOGICAL useEBM        LOGICAL useEBM
781        LOGICAL useMNC        LOGICAL useMNC
782          LOGICAL useMATRIX
783          LOGICAL useRunClock
784        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
785       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
786       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
787       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
788       &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,       &        useSBO, useSEAICE, useThSIce, useBulkForce,
789       &        usePP81, useMY82, useOPPS, useGGL90       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
790         &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
791         &        useRunClock
792    
793  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
794  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.136  
changed lines
  Added in v.1.162
  ViewVC Help
Powered by ViewVC 1.1.22